/usr/share/gtk-doc/html/pygtk/class-atkselection.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Selection</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkrelationset.html" title="atk.RelationSet"><link rel="next" href="class-atkstateset.html" title="atk.StateSet"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Selection</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkrelationset.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkstateset.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Selection"><a name="class-atkselection"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Selection</h2><p>atk.Selection — the ATK interface implemented by container objects whose
<a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
children can be selected. </p></div><div class="refsect1" title="Synopsis"><a name="id2977058"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Selection</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--add-selection" title="atk.Selection.add_selection">add_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--clear-selection" title="atk.Selection.clear_selection">clear_selection</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--ref-selection" title="atk.Selection.ref_selection">ref_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--get-selection-count" title="atk.Selection.get_selection_count">get_selection_count</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--is-child-selected" title="atk.Selection.is_child_selected">is_child_selected</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--remove-selection" title="atk.Selection.remove_selection">remove_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkselection.html#method-atkselection--select-all-selection" title="atk.Selection.select_all_selection">select_all_selection</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="atk.Selection Signal Prototypes"><a name="signal-prototypes-atkselection"></a><h2>atk.Selection Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atkselection.html#signal-atkselection--selection-changed" title='The "selection-changed" atk.Selection Signal'>selection-changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkselection</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id2975366"></a><h2>Description</h2><p><a class="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
should be implemented by UI components with children which are exposed
by the <a class="link" href="class-atkobject.html#method-atkobject--ref-accessible-child" title="atk.Object.ref_accessible_child"><code class="methodname">ref_accessible_child</code>()</a>
and <a class="link" href="class-atkobject.html#method-atkobject--get-n-accessible-children" title="atk.Object.get_n_accessible_children"><code class="methodname">get_n_accessible_children</code>()</a>
methods, if the use of the parent UI component ordinarily involves
selection of one or more of the objects corresponding to those <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
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="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
is limited to the selection/deselection of children.</p></div><div class="refsect1" title="Methods"><a name="id2972425"></a><h2>Methods</h2><div class="refsect2" title="atk.Selection.add_selection"><a name="method-atkselection--add-selection"></a><h3>atk.Selection.add_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">add_selection</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>i</code></strong> :</span></p></td><td>an index specifying the child
index.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if success,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Adds the specified accessible child of the object to the
object's selection.</p></div><div class="refsect2" title="atk.Selection.clear_selection"><a name="method-atkselection--clear-selection"></a><h3>atk.Selection.clear_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">clear_selection</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if success,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Clears the selection in the object so that no children in the
object are selected.</p></div><div class="refsect2" title="atk.Selection.ref_selection"><a name="method-atkselection--ref-selection"></a><h3>atk.Selection.ref_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">ref_selection</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>i</code></strong> :</span></p></td><td>an index specifying the index in the selection
set. (e.g. the ith selection as opposed to the ith
child).</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
representing the selected accessible , or <code class="literal">None</code>
if the selection does not implement this
interface.</td></tr></tbody></table><p>Gets a reference to the accessible object representing the
specified selected child of the object. Note: callers should not rely
on <code class="literal">None</code> or on a zero value for indication of
whether the <a class="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
interface is implemented.</p></div><div class="refsect2" title="atk.Selection.get_selection_count"><a name="method-atkselection--get-selection-count"></a><h3>atk.Selection.get_selection_count</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_selection_count</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer representing the number of items
selected, or 0 if the selection does not implement this
interface.</td></tr></tbody></table><p>Gets the number of accessible children currently selected.
Note: callers should not rely on <code class="literal">None</code> or on a zero
value for indication of whether the <a class="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
interface is implemented.</p></div><div class="refsect2" title="atk.Selection.is_child_selected"><a name="method-atkselection--is-child-selected"></a><h3>atk.Selection.is_child_selected</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">is_child_selected</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>i</code></strong> :</span></p></td><td>an index specifying the child
index.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the specified child
is selected, or 0 if the selection does not implement this
interface.</td></tr></tbody></table><p>Determines if the current child of this object is selected Note:
callers should not rely on <code class="literal">None</code> or on a zero value
for indication of whether the <a class="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
interface is implemented.</p></div><div class="refsect2" title="atk.Selection.remove_selection"><a name="method-atkselection--remove-selection"></a><h3>atk.Selection.remove_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_selection</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>i</code></strong> :</span></p></td><td>an index specifying the index in the selection
set. (e.g. the ith selection as opposed to the ith
child).</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if success,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Removes the specified child of the object from the object's
selection.</p></div><div class="refsect2" title="atk.Selection.select_all_selection"><a name="method-atkselection--select-all-selection"></a><h3>atk.Selection.select_all_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">select_all_selection</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if success,
<code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Causes every child of the object to be selected if the object
supports multiple selections.</p></div></div><div class="refsect1" title="Signals"><a name="id2960890"></a><h2>Signals</h2><div class="refsect2" title='The "selection-changed" atk.Selection Signal'><a name="signal-atkselection--selection-changed"></a><h3>The "selection-changed" atk.Selection Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkselection</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>atkselection</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>The "selection-changed" signal is emitted by an object which
implements <a class="link" href="class-atkselection.html" title="atk.Selection"><code class="classname">atk.Selection</code></a>
interface when the selection changes.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-atkrelationset.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkstateset.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.RelationSet </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.StateSet</td></tr></table></div></body></html>
|