1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>atkmm: Atk::Selection Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.2 -->
11
<div class="navigation" id="top">
14
<li><a href="index.html"><span>Main Page</span></a></li>
15
<li><a href="pages.html"><span>Related Pages</span></a></li>
16
<li><a href="modules.html"><span>Modules</span></a></li>
17
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
18
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
23
<li><a href="annotated.html"><span>Class List</span></a></li>
24
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
25
<li><a href="functions.html"><span>Class Members</span></a></li>
30
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
31
<li><a class="el" href="classAtk_1_1Selection.html">Selection</a> </li>
37
<a href="#pub-methods">Public Member Functions</a> |
38
<a href="#related">Related Functions</a> </div>
39
<div class="headertitle">
40
<h1>Atk::Selection Class Reference</h1> </div>
42
<div class="contents">
43
<!-- doxytag: class="Atk::Selection" --><!-- doxytag: inherits="Glib::Interface" -->
44
<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="#_details">More...</a></p>
46
<p><code>#include <atkmm/selection.h></code></p>
47
<!-- startSectionHeader --><div class="dynheader">
48
Inheritance diagram for Atk::Selection:<!-- endSectionHeader --></div>
49
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
50
<div class="center"><img src="classAtk_1_1Selection__inherit__graph.png" border="0" usemap="#Atk_1_1Selection_inherit__map" alt="Inheritance graph"/></div>
51
<map name="Atk_1_1Selection_inherit__map" id="Atk_1_1Selection_inherit__map">
52
<area shape="rect" id="node9" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="5,315,133,344"/><area shape="rect" id="node2" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
53
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
55
<p><a href="classAtk_1_1Selection-members.html">List of all members.</a></p>
56
<table class="memberdecls">
57
<tr><td colspan="2"><h2><a name="pub-methods"></a>
58
Public Member Functions</h2></td></tr>
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7f5468ebda2c09cb24170b6a07250b1"></a><!-- doxytag: member="Atk::Selection::gobj" ref="ab7f5468ebda2c09cb24170b6a07250b1" args="()" -->
60
AtkSelection* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ab7f5468ebda2c09cb24170b6a07250b1">gobj</a> ()</td></tr>
61
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ea824fa552f7f63314cf938e762d229"></a><!-- doxytag: member="Atk::Selection::gobj" ref="a4ea824fa552f7f63314cf938e762d229" args="() const " -->
63
const AtkSelection* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a4ea824fa552f7f63314cf938e762d229">gobj</a> () const </td></tr>
64
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
65
<tr><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>
66
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds the specified accessible child of the object to the object's selection. <a href="#ad7049b1172c9dd0b9849bd2d12a5b134"></a><br/></td></tr>
67
<tr><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>
68
<tr><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"></a><br/></td></tr>
69
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
70
<tr><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"></a><br/></td></tr>
71
<tr><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>
72
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of accessible children currently selected. <a href="#a034483b48f55ac37c3eac3f0d3a0a6d2"></a><br/></td></tr>
73
<tr><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>
74
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if the current child of this object is selected. <a href="#a08b260cfe65168478cd8c7b333d2e65a"></a><br/></td></tr>
75
<tr><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>
76
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified child of the object from the object's selection. <a href="#a01feedb0395d111ad41f77a14e94988b"></a><br/></td></tr>
77
<tr><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>
78
<tr><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"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
80
<tr><td colspan="2"><h2><a name="related"></a>
81
Related Functions</h2></td></tr>
82
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
84
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a3c2d7634f421fa3c5747fa0acea5336d"></a><br/></td></tr>
87
<hr/><a name="_details"></a><h2>Detailed Description</h2>
88
<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>
89
<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>
90
<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>
91
<hr/><h2>Member Function Documentation</h2>
92
<a class="anchor" id="ad7049b1172c9dd0b9849bd2d12a5b134"></a><!-- doxytag: member="Atk::Selection::add_selection" ref="ad7049b1172c9dd0b9849bd2d12a5b134" args="(int i)" -->
94
<div class="memproto">
95
<table class="memname">
97
<td class="memname">bool Atk::Selection::add_selection </td>
99
<td class="paramtype">int </td>
100
<td class="paramname"> <em>i</em> )</td>
107
<p>Adds the specified accessible child of the object to the object's selection. </p>
108
<dl><dt><b>Parameters:</b></dt><dd>
109
<table class="params">
110
<tr><td class="paramname">i</td><td>A <code>int</code> specifying the child index. </td></tr>
114
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
118
<a class="anchor" id="afbcb542e8def62329c1e9cb52d5d24a4"></a><!-- doxytag: member="Atk::Selection::clear_selection" ref="afbcb542e8def62329c1e9cb52d5d24a4" args="()" -->
119
<div class="memitem">
120
<div class="memproto">
121
<table class="memname">
123
<td class="memname">bool Atk::Selection::clear_selection </td>
125
<td class="paramname"> )</td>
132
<p>Clears the selection in the object so that no children in the object are selected. </p>
133
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
137
<a class="anchor" id="ad74b10568731d7f6f503397897702484"></a><!-- doxytag: member="Atk::Selection::get_selection" ref="ad74b10568731d7f6f503397897702484" args="(int i)" -->
138
<div class="memitem">
139
<div class="memproto">
140
<table class="memname">
142
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::Selection::get_selection </td>
144
<td class="paramtype">int </td>
145
<td class="paramname"> <em>i</em> )</td>
152
<p>Gets a reference to the accessible object representing the specified selected child of the object. </p>
153
<dl class="note"><dt><b>Note:</b></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>
154
<dl><dt><b>Parameters:</b></dt><dd>
155
<table class="params">
156
<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>
160
<dl class="return"><dt><b>Returns:</b></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>
164
<a class="anchor" id="a034483b48f55ac37c3eac3f0d3a0a6d2"></a><!-- doxytag: member="Atk::Selection::get_selection_count" ref="a034483b48f55ac37c3eac3f0d3a0a6d2" args="() const " -->
165
<div class="memitem">
166
<div class="memproto">
167
<table class="memname">
169
<td class="memname">int Atk::Selection::get_selection_count </td>
171
<td class="paramname"> )</td>
178
<p>Gets the number of accessible children currently selected. </p>
179
<dl class="note"><dt><b>Note:</b></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>
180
<dl class="return"><dt><b>Returns:</b></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>
184
<a class="anchor" id="a08b260cfe65168478cd8c7b333d2e65a"></a><!-- doxytag: member="Atk::Selection::is_child_selected" ref="a08b260cfe65168478cd8c7b333d2e65a" args="(int i) const " -->
185
<div class="memitem">
186
<div class="memproto">
187
<table class="memname">
189
<td class="memname">bool Atk::Selection::is_child_selected </td>
191
<td class="paramtype">int </td>
192
<td class="paramname"> <em>i</em> )</td>
199
<p>Determines if the current child of this object is selected. </p>
200
<dl class="note"><dt><b>Note:</b></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>
201
<dl><dt><b>Parameters:</b></dt><dd>
202
<table class="params">
203
<tr><td class="paramname">i</td><td>A <code>int</code> specifying the child index. </td></tr>
207
<dl class="return"><dt><b>Returns:</b></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>
211
<a class="anchor" id="a01feedb0395d111ad41f77a14e94988b"></a><!-- doxytag: member="Atk::Selection::remove_selection" ref="a01feedb0395d111ad41f77a14e94988b" args="(int i)" -->
212
<div class="memitem">
213
<div class="memproto">
214
<table class="memname">
216
<td class="memname">bool Atk::Selection::remove_selection </td>
218
<td class="paramtype">int </td>
219
<td class="paramname"> <em>i</em> )</td>
226
<p>Removes the specified child of the object from the object's selection. </p>
227
<dl><dt><b>Parameters:</b></dt><dd>
228
<table class="params">
229
<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>
233
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
237
<a class="anchor" id="a92e1b742054e0476c6596617d2f8de20"></a><!-- doxytag: member="Atk::Selection::select_all_selection" ref="a92e1b742054e0476c6596617d2f8de20" args="()" -->
238
<div class="memitem">
239
<div class="memproto">
240
<table class="memname">
242
<td class="memname">bool Atk::Selection::select_all_selection </td>
244
<td class="paramname"> )</td>
251
<p>Causes every child of the object to be selected if the object supports multiple selections. </p>
252
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
256
<a class="anchor" id="a77cfe7a9e587c75b907e6fd5ae87b67b"></a><!-- doxytag: member="Atk::Selection::signal_selection_changed" ref="a77cfe7a9e587c75b907e6fd5ae87b67b" args="()" -->
257
<div class="memitem">
258
<div class="memproto">
259
<table class="memname">
261
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Atk::Selection::signal_selection_changed </td>
263
<td class="paramname"> )</td>
269
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_selection_changed()</code> </dd></dl>
273
<hr/><h2>Friends And Related Function Documentation</h2>
274
<a class="anchor" id="a3c2d7634f421fa3c5747fa0acea5336d"></a><!-- doxytag: member="Atk::Selection::wrap" ref="a3c2d7634f421fa3c5747fa0acea5336d" args="(AtkSelection *object, bool take_copy=false)" -->
275
<div class="memitem">
276
<div class="memproto">
277
<table class="memname">
279
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Selection.html">Atk::Selection</a> > wrap </td>
281
<td class="paramtype">AtkSelection * </td>
282
<td class="paramname"> <em>object</em>, </td>
285
<td class="paramkey"></td>
287
<td class="paramtype">bool </td>
288
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
293
<td></td><td><code> [related]</code></td>
299
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
300
<dl><dt><b>Parameters:</b></dt><dd>
301
<table class="params">
302
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
303
<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>
307
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
312
<hr class="footer"/><address class="footer"><small>Generated on Sat Nov 20 2010 13:35:45 for atkmm by 
313
<a href="http://www.doxygen.org/index.html">
314
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>