File: classAtk_1_1Selection.html

package info (click to toggle)
gtkmm2.4 1%3A2.20.3-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 73,860 kB
  • ctags: 20,553
  • sloc: xml: 79,575; sh: 10,120; cpp: 8,347; makefile: 290
file content (549 lines) | stat: -rw-r--r-- 32,071 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
<!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"/>
<title>gtkmm: Atk::Selection Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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 class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Selection.html">Selection</a>
  </div>
</div>
<div class="contents">
<h1>Atk::Selection Class Reference</h1><!-- doxytag: class="Atk::Selection" --><!-- doxytag: inherits="Glib::Interface" -->
<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>

<p>Inherits <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_1Interface.html">Glib::Interface</a>.</p>

<p>Inherited by <a class="el" href="classAtk_1_1NoOpObject.html">Atk::NoOpObject</a>.</p>
<div class="dynheader">
Collaboration diagram for Atk::Selection:</div>
<div class="dynsection">
<div class="center"><img src="classAtk_1_1Selection__coll__graph.png" border="0" usemap="#Atk_1_1Selection_coll__map" alt="Collaboration graph"/></div>
<map name="Atk_1_1Selection_coll__map" id="Atk_1_1Selection_coll__map">
<area shape="rect" 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="13,160,117,189"/><area shape="rect" 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="5,83,125,112"/><area shape="rect" 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,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classAtk_1_1Selection-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a9f2e5ac95e00e958f2ef75bf63335f30">~Selection</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">AtkSelection*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ab7f5468ebda2c09cb24170b6a07250b1">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ab7f5468ebda2c09cb24170b6a07250b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const AtkSelection*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a4ea824fa552f7f63314cf938e762d229">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a4ea824fa552f7f63314cf938e762d229"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ad7049b1172c9dd0b9849bd2d12a5b134">add_selection</a> (int i)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the specified accessible child of the object to the object's selection. <a href="#ad7049b1172c9dd0b9849bd2d12a5b134"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#afbcb542e8def62329c1e9cb52d5d24a4">clear_selection</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</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>
<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>&lt; <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ad74b10568731d7f6f503397897702484">get_selection</a> (int i)</td></tr>
<tr><td class="mdescLeft">&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a034483b48f55ac37c3eac3f0d3a0a6d2">get_selection_count</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of accessible children currently selected. <a href="#a034483b48f55ac37c3eac3f0d3a0a6d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</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><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the current child of this object is selected. <a href="#a08b260cfe65168478cd8c7b333d2e65a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a01feedb0395d111ad41f77a14e94988b">remove_selection</a> (int i)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the specified child of the object from the object's selection. <a href="#a01feedb0395d111ad41f77a14e94988b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a92e1b742054e0476c6596617d2f8de20">select_all_selection</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</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>
<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>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a77cfe7a9e587c75b907e6fd5ae87b67b">signal_selection_changed</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a93a878d016d2f576db3c07390d72e558">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#adfecf829b51fe9a026185c31a408af32">add_selection_vfunc</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a1f4114016410eceb7e6dfe4108969ad6">clear_selection_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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>&lt; <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a917e162fd7d595c0219d7cb8ea9c0d41">get_selection_vfunc</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#ac17e8c71d0bcb0efdd2b4ab47f6a3cd8">get_selection_count_vfunc</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a14bbd1cc2c2149ee8f026e63c4886240">is_child_selected_vfunc</a> (int i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#a96e54b0008b8c814a429cebe4a058ad8">remove_selection_vfunc</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#abd539e193806de2c2071fa14be2dbad2">select_all_selection_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Selection.html#abc335734ac36cf271049aafa749369b3">on_selection_changed</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<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>&lt; <a class="el" href="classAtk_1_1Selection.html">Atk::Selection</a> &gt;&#160;</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><td class="mdescLeft">&#160;</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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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...">Atk::Selection</a> is limited to the selection/deselection of children. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9f2e5ac95e00e958f2ef75bf63335f30"></a><!-- doxytag: member="Atk::Selection::~Selection" ref="a9f2e5ac95e00e958f2ef75bf63335f30" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Atk::Selection::~Selection </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a93a878d016d2f576db3c07390d72e558"></a><!-- doxytag: member="Atk::Selection::add_interface" ref="a93a878d016d2f576db3c07390d72e558" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void Atk::Selection::add_interface </td>
          <td>(</td>
          <td class="paramtype">GType&#160;</td>
          <td class="paramname"> <em>gtype_implementer</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ad7049b1172c9dd0b9849bd2d12a5b134"></a><!-- doxytag: member="Atk::Selection::add_selection" ref="ad7049b1172c9dd0b9849bd2d12a5b134" args="(int i)" -->
<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&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>i</em>&#160;</td><td>A <code>int</code> specifying the child index. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="adfecf829b51fe9a026185c31a408af32"></a><!-- doxytag: member="Atk::Selection::add_selection_vfunc" ref="adfecf829b51fe9a026185c31a408af32" args="(int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Atk::Selection::add_selection_vfunc </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="afbcb542e8def62329c1e9cb52d5d24a4"></a><!-- doxytag: member="Atk::Selection::clear_selection" ref="afbcb542e8def62329c1e9cb52d5d24a4" args="()" -->
<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>&#160;)&#160;</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="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a1f4114016410eceb7e6dfe4108969ad6"></a><!-- doxytag: member="Atk::Selection::clear_selection_vfunc" ref="a1f4114016410eceb7e6dfe4108969ad6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Atk::Selection::clear_selection_vfunc </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ad74b10568731d7f6f503397897702484"></a><!-- doxytag: member="Atk::Selection::get_selection" ref="ad74b10568731d7f6f503397897702484" args="(int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>&lt;<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>&gt; Atk::Selection::get_selection </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</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="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>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>i</em>&#160;</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="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>

</div>
</div>
<a class="anchor" id="a034483b48f55ac37c3eac3f0d3a0a6d2"></a><!-- doxytag: member="Atk::Selection::get_selection_count" ref="a034483b48f55ac37c3eac3f0d3a0a6d2" args="() const " -->
<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>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the number of accessible children currently selected. </p>
<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>
<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>

</div>
</div>
<a class="anchor" id="ac17e8c71d0bcb0efdd2b4ab47f6a3cd8"></a><!-- doxytag: member="Atk::Selection::get_selection_count_vfunc" ref="ac17e8c71d0bcb0efdd2b4ab47f6a3cd8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Atk::Selection::get_selection_count_vfunc </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a917e162fd7d595c0219d7cb8ea9c0d41"></a><!-- doxytag: member="Atk::Selection::get_selection_vfunc" ref="a917e162fd7d595c0219d7cb8ea9c0d41" args="(int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <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>&lt;<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>&gt; Atk::Selection::get_selection_vfunc </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4ea824fa552f7f63314cf938e762d229"></a><!-- doxytag: member="Atk::Selection::gobj" ref="a4ea824fa552f7f63314cf938e762d229" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const AtkSelection* Atk::Selection::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <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_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>

<p>Reimplemented in <a class="el" href="classAtk_1_1NoOpObject.html#af54be60c4815bde603b886cbb876baea">Atk::NoOpObject</a>.</p>

</div>
</div>
<a class="anchor" id="ab7f5468ebda2c09cb24170b6a07250b1"></a><!-- doxytag: member="Atk::Selection::gobj" ref="ab7f5468ebda2c09cb24170b6a07250b1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AtkSelection* Atk::Selection::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <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_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>

<p>Reimplemented in <a class="el" href="classAtk_1_1NoOpObject.html#aaad07a3a8ce4dea968c53f0098498836">Atk::NoOpObject</a>.</p>

</div>
</div>
<a class="anchor" id="a08b260cfe65168478cd8c7b333d2e65a"></a><!-- doxytag: member="Atk::Selection::is_child_selected" ref="a08b260cfe65168478cd8c7b333d2e65a" args="(int i) const " -->
<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&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Determines if the current child of this object is selected. </p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>i</em>&#160;</td><td>A <code>int</code> specifying the child index. </td></tr>
  </table>
  </dd>
</dl>
<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>

</div>
</div>
<a class="anchor" id="a14bbd1cc2c2149ee8f026e63c4886240"></a><!-- doxytag: member="Atk::Selection::is_child_selected_vfunc" ref="a14bbd1cc2c2149ee8f026e63c4886240" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Atk::Selection::is_child_selected_vfunc </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="abc335734ac36cf271049aafa749369b3"></a><!-- doxytag: member="Atk::Selection::on_selection_changed" ref="abc335734ac36cf271049aafa749369b3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Atk::Selection::on_selection_changed </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a01feedb0395d111ad41f77a14e94988b"></a><!-- doxytag: member="Atk::Selection::remove_selection" ref="a01feedb0395d111ad41f77a14e94988b" args="(int i)" -->
<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&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Removes the specified child of the object from the object's selection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>i</em>&#160;</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="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a96e54b0008b8c814a429cebe4a058ad8"></a><!-- doxytag: member="Atk::Selection::remove_selection_vfunc" ref="a96e54b0008b8c814a429cebe4a058ad8" args="(int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Atk::Selection::remove_selection_vfunc </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a92e1b742054e0476c6596617d2f8de20"></a><!-- doxytag: member="Atk::Selection::select_all_selection" ref="a92e1b742054e0476c6596617d2f8de20" args="()" -->
<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>&#160;)&#160;</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="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="abd539e193806de2c2071fa14be2dbad2"></a><!-- doxytag: member="Atk::Selection::select_all_selection_vfunc" ref="abd539e193806de2c2071fa14be2dbad2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Atk::Selection::select_all_selection_vfunc </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a77cfe7a9e587c75b907e6fd5ae87b67b"></a><!-- doxytag: member="Atk::Selection::signal_selection_changed" ref="a77cfe7a9e587c75b907e6fd5ae87b67b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>&lt; void &gt; Atk::Selection::signal_selection_changed </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_selection_changed()</code> </dd></dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a3c2d7634f421fa3c5747fa0acea5336d"></a><!-- doxytag: member="Atk::Selection::wrap" ref="a3c2d7634f421fa3c5747fa0acea5336d" args="(AtkSelection *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <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>&lt; <a class="el" href="classAtk_1_1Selection.html">Atk::Selection</a> &gt; wrap </td>
          <td>(</td>
          <td class="paramtype">AtkSelection *&#160;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</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="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>atkmm/selection.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:42 2010 for gtkmm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>