<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>atkmm: Atk::Selection Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">atkmm  <span id="projectnumber">2.22.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a></li><li class="navelem"><a class="el" href="classAtk_1_1Selection.html">Selection</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#related">Related Functions</a> | <a href="classAtk_1_1Selection-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Atk::Selection Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The ATK interface implemented by container objects whose <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> children can be selected. <a href="classAtk_1_1Selection.html#details">More...</a></p> <p><code>#include <atkmm/selection.h></code></p> <div class="dynheader"> Inheritance diagram for Atk::Selection:</div> <div class="dyncontent"> <div class="center"><img src="classAtk_1_1Selection__inherit__graph.png" border="0" usemap="#Atk_1_1Selection_inherit__map" alt="Inheritance graph"/></div> <map name="Atk_1_1Selection_inherit__map" id="Atk_1_1Selection_inherit__map"> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ab7f5468ebda2c09cb24170b6a07250b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7f5468ebda2c09cb24170b6a07250b1"></a> AtkSelection* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ab7f5468ebda2c09cb24170b6a07250b1">gobj</a> ()</td></tr> <tr class="memdesc:ab7f5468ebda2c09cb24170b6a07250b1"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr class="separator:ab7f5468ebda2c09cb24170b6a07250b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4ea824fa552f7f63314cf938e762d229"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ea824fa552f7f63314cf938e762d229"></a> const AtkSelection* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a4ea824fa552f7f63314cf938e762d229">gobj</a> () const </td></tr> <tr class="memdesc:a4ea824fa552f7f63314cf938e762d229"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr class="separator:a4ea824fa552f7f63314cf938e762d229"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad7049b1172c9dd0b9849bd2d12a5b134"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ad7049b1172c9dd0b9849bd2d12a5b134">add_selection</a> (int i)</td></tr> <tr class="memdesc:ad7049b1172c9dd0b9849bd2d12a5b134"><td class="mdescLeft"> </td><td class="mdescRight">Adds the specified accessible child of the object to the object's selection. <a href="#ad7049b1172c9dd0b9849bd2d12a5b134">More...</a><br/></td></tr> <tr class="separator:ad7049b1172c9dd0b9849bd2d12a5b134"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afbcb542e8def62329c1e9cb52d5d24a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#afbcb542e8def62329c1e9cb52d5d24a4">clear_selection</a> ()</td></tr> <tr class="memdesc:afbcb542e8def62329c1e9cb52d5d24a4"><td class="mdescLeft"> </td><td class="mdescRight">Clears the selection in the object so that no children in the object are selected. <a href="#afbcb542e8def62329c1e9cb52d5d24a4">More...</a><br/></td></tr> <tr class="separator:afbcb542e8def62329c1e9cb52d5d24a4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad74b10568731d7f6f503397897702484"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ad74b10568731d7f6f503397897702484">get_selection</a> (int i)</td></tr> <tr class="memdesc:ad74b10568731d7f6f503397897702484"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the accessible object representing the specified selected child of the object. <a href="#ad74b10568731d7f6f503397897702484">More...</a><br/></td></tr> <tr class="separator:ad74b10568731d7f6f503397897702484"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a034483b48f55ac37c3eac3f0d3a0a6d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a034483b48f55ac37c3eac3f0d3a0a6d2">get_selection_count</a> () const </td></tr> <tr class="memdesc:a034483b48f55ac37c3eac3f0d3a0a6d2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of accessible children currently selected. <a href="#a034483b48f55ac37c3eac3f0d3a0a6d2">More...</a><br/></td></tr> <tr class="separator:a034483b48f55ac37c3eac3f0d3a0a6d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a08b260cfe65168478cd8c7b333d2e65a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a08b260cfe65168478cd8c7b333d2e65a">is_child_selected</a> (int i) const </td></tr> <tr class="memdesc:a08b260cfe65168478cd8c7b333d2e65a"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the current child of this object is selected. <a href="#a08b260cfe65168478cd8c7b333d2e65a">More...</a><br/></td></tr> <tr class="separator:a08b260cfe65168478cd8c7b333d2e65a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a01feedb0395d111ad41f77a14e94988b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a01feedb0395d111ad41f77a14e94988b">remove_selection</a> (int i)</td></tr> <tr class="memdesc:a01feedb0395d111ad41f77a14e94988b"><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified child of the object from the object's selection. <a href="#a01feedb0395d111ad41f77a14e94988b">More...</a><br/></td></tr> <tr class="separator:a01feedb0395d111ad41f77a14e94988b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a92e1b742054e0476c6596617d2f8de20"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a92e1b742054e0476c6596617d2f8de20">select_all_selection</a> ()</td></tr> <tr class="memdesc:a92e1b742054e0476c6596617d2f8de20"><td class="mdescLeft"> </td><td class="mdescRight">Causes every child of the object to be selected if the object supports multiple selections. <a href="#a92e1b742054e0476c6596617d2f8de20">More...</a><br/></td></tr> <tr class="separator:a92e1b742054e0476c6596617d2f8de20"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a77cfe7a9e587c75b907e6fd5ae87b67b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a77cfe7a9e587c75b907e6fd5ae87b67b">signal_selection_changed</a> ()</td></tr> <tr class="separator:a77cfe7a9e587c75b907e6fd5ae87b67b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a490feb16313697327207e6e777041e69"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a490feb16313697327207e6e777041e69"></a> static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a490feb16313697327207e6e777041e69">get_type</a> ()</td></tr> <tr class="memdesc:a490feb16313697327207e6e777041e69"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <br/></td></tr> <tr class="separator:a490feb16313697327207e6e777041e69"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a085fdb9ae8e3431cbaff2f6f0a32d5d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a085fdb9ae8e3431cbaff2f6f0a32d5d5"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a085fdb9ae8e3431cbaff2f6f0a32d5d5">Selection</a> ()</td></tr> <tr class="memdesc:a085fdb9ae8e3431cbaff2f6f0a32d5d5"><td class="mdescLeft"> </td><td class="mdescRight">You should derive from this class to use it. <br/></td></tr> <tr class="separator:a085fdb9ae8e3431cbaff2f6f0a32d5d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abc335734ac36cf271049aafa749369b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc335734ac36cf271049aafa749369b3"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#abc335734ac36cf271049aafa749369b3">on_selection_changed</a> ()</td></tr> <tr class="memdesc:abc335734ac36cf271049aafa749369b3"><td class="mdescLeft"> </td><td class="mdescRight">This is a default handler for the signal <a class="el" href="classAtk_1_1Selection.html#a77cfe7a9e587c75b907e6fd5ae87b67b">signal_selection_changed()</a>. <br/></td></tr> <tr class="separator:abc335734ac36cf271049aafa749369b3"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr class="memitem:a3c2d7634f421fa3c5747fa0acea5336d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Selection.html">Atk::Selection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a3c2d7634f421fa3c5747fa0acea5336d">wrap</a> (AtkSelection* object, bool take_copy=false)</td></tr> <tr class="memdesc:a3c2d7634f421fa3c5747fa0acea5336d"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a3c2d7634f421fa3c5747fa0acea5336d">More...</a><br/></td></tr> <tr class="separator:a3c2d7634f421fa3c5747fa0acea5336d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The ATK interface implemented by container objects whose <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> children can be selected. </p> <p>This should be implemented by UI components with children which are exposed by Atk::Object::ref_child and Atk::Object::get_n_children, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those AtkObject children - for example, selectable lists.</p> <p>Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - <a class="el" href="classAtk_1_1Selection.html" title="The ATK interface implemented by container objects whose Atk::Object children can be selected...">Atk::Selection</a> is limited to the selection/deselection of children. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ad7049b1172c9dd0b9849bd2d12a5b134"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Selection::add_selection </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Adds the specified accessible child of the object to the object's selection. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>A <code>int</code> specifying the child index. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="afbcb542e8def62329c1e9cb52d5d24a4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Selection::clear_selection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clears the selection in the object so that no children in the object are selected. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="ad74b10568731d7f6f503397897702484"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::Selection::get_selection </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Gets a reference to the accessible object representing the specified selected child of the object. </p> <dl class="section note"><dt>Note</dt><dd>callers should not rely on <code>0</code> or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>A <code>int</code> specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> representing the selected accessible , or <code>0</code> if <em>selection</em> does not implement this interface. </dd></dl> </div> </div> <a class="anchor" id="a034483b48f55ac37c3eac3f0d3a0a6d2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Atk::Selection::get_selection_count </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Gets the number of accessible children currently selected. </p> <dl class="section note"><dt>Note</dt><dd>callers should not rely on <code>0</code> or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. </dd></dl> <dl class="section return"><dt>Returns</dt><dd>A <code>int</code> representing the number of items selected, or 0 if <em>selection</em> does not implement this interface. </dd></dl> </div> </div> <a class="anchor" id="a08b260cfe65168478cd8c7b333d2e65a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Selection::is_child_selected </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Determines if the current child of this object is selected. </p> <dl class="section note"><dt>Note</dt><dd>callers should not rely on <code>0</code> or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method. </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>A <code>int</code> specifying the child index. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A <code>bool</code> representing the specified child is selected, or 0 if <em>selection</em> does not implement this interface. </dd></dl> </div> </div> <a class="anchor" id="a01feedb0395d111ad41f77a14e94988b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Selection::remove_selection </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Removes the specified child of the object from the object's selection. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>A <code>int</code> specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="a92e1b742054e0476c6596617d2f8de20"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Selection::select_all_selection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Causes every child of the object to be selected if the object supports multiple selections. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="a77cfe7a9e587c75b907e6fd5ae87b67b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Atk::Selection::signal_selection_changed </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="section user"><dt>Slot Prototype:</dt><dd><code>void on_my_selection_changed()</code> </dd></dl> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="a3c2d7634f421fa3c5747fa0acea5336d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Selection.html">Atk::Selection</a> > wrap </td> <td>(</td> <td class="paramtype">AtkSelection * </td> <td class="paramname"><em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>take_copy</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">related</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">object</td><td>The C instance. </td></tr> <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Apr 24 2013 11:08:12 for atkmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>