/usr/share/gtk-doc/html/pygtk/class-atkobject.html is in python-gtk2-doc 2.24.0-3.
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 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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Object</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-atknoopobjectfactory.html" title="atk.NoOpObjectFactory"><link rel="next" href="class-atkobjectfactory.html" title="atk.ObjectFactory"></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.Object</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atknoopobjectfactory.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkobjectfactory.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Object"><a name="class-atkobject"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Object</h2><p>atk.Object — the base object class for the Accessibility Toolkit
API.</p></div><div class="refsect1" title="Synopsis"><a name="id2906650"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Object</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-name" title="atk.Object.get_name">get_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-description" title="atk.Object.get_description">get_description</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-parent" title="atk.Object.get_parent">get_parent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-n-accessible-children" title="atk.Object.get_n_accessible_children">get_n_accessible_children</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--ref-accessible-child" title="atk.Object.ref_accessible_child">ref_accessible_child</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-atkobject.html#method-atkobject--ref-relation-set" title="atk.Object.ref_relation_set">ref_relation_set</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-role" title="atk.Object.get_role">get_role</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-layer" title="atk.Object.get_layer">get_layer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-mdi-zorder" title="atk.Object.get_mdi_zorder">get_mdi_zorder</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--ref-state-set" title="atk.Object.ref_state_set">ref_state_set</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--get-index-in-parent" title="atk.Object.get_index_in_parent">get_index_in_parent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--set-name" title="atk.Object.set_name">set_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--set-description" title="atk.Object.set_description">set_description</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>description</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--set-parent" title="atk.Object.set_parent">set_parent</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--set-role" title="atk.Object.set_role">set_role</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>role</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--remove-property-change-handler" title="atk.Object.remove_property_change_handler">remove_property_change_handler</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--add-relationship" title="atk.Object.add_relationship">add_relationship</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkobject.html#method-atkobject--remove-relationship" title="atk.Object.remove_relationship">remove_relationship</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id2949609"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-atkobject.html" title="atk.Object">atk.Object</a>
</pre></div><div class="refsect1" title="atk.Object Properties"><a name="properties-atkobject"></a><h2>atk.Object Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"accessible-component-layer"</td><td valign="top">Read</td><td valign="top">The accessible layer of this object. Allowed values: >= 0.
Default value: 0.</td></tr><tr valign="top"><td valign="top">"accessible-component-mdi-zorder"</td><td valign="top">Read</td><td valign="top">The accessible MDI value of this object. Default value:
-2147483648</td></tr><tr valign="top"><td valign="top">"accessible-description"</td><td valign="top">Read-Write</td><td valign="top">Description of an object, formatted for assistive
technology access. Default value: <code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"accessible-hypertext-nlinks"</td><td valign="top">Read</td><td valign="top">The number of links which the current <a class="link" href="class-atkhypertext.html" title="atk.Hypertext"><code class="classname">atk.Hypertext</code></a>
has. Allowed values: >= 0. Default value: 0.</td></tr><tr valign="top"><td valign="top">"accessible-name"</td><td valign="top">Read-Write</td><td valign="top">Object instance's name formatted for assistive technology
access. Default value: <code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"accessible-parent"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the parent has changed.</td></tr><tr valign="top"><td valign="top">"accessible-role"</td><td valign="top">Read-Write</td><td valign="top">The accessible role of this object. Allowed values: >= 0.
Default value: 0.</td></tr><tr valign="top"><td valign="top">"accessible-table-caption"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table caption has changed; this
property should not be used. "accessible-table-caption-object"
should be used instead. Default value:
<code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"accessible-table-caption-object"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table caption has changed</td></tr><tr valign="top"><td valign="top">"accessible-table-column-description"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table column description has
changed. Default value: <code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"accessible-table-column-header"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table column header has
changed</td></tr><tr valign="top"><td valign="top">"accessible-table-row-description"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table row description has
changed. Default value: <code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"accessible-table-row-header"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table row header has changed</td></tr><tr valign="top"><td valign="top">"accessible-table-summary"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the table summary has changed</td></tr><tr valign="top"><td valign="top">"accessible-value"</td><td valign="top">Read-Write</td><td valign="top">Is used to notify that the value has changed. Allowed
values: >= 0. Default value: 0.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="atk.Object Signal Prototypes"><a name="signal-prototypes-atkobject"></a><h2>atk.Object Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><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-atkobject.html#signal-atkobject--active-descendant-changed" title='The "active-descendant-changed" atk.Object Signal'>active-descendant-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>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>object</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><tr><td><p><span class="term">"<a class="link" href="class-atkobject.html#signal-atkobject--children-changed" title='The "children-changed" atk.Object Signal'>children-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>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</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><tr><td><p><span class="term">"<a class="link" href="class-atkobject.html#signal-atkobject--focus-event" title='The "focus-event" atk.Object Signal'>focus-event</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>has_focus</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><tr><td><p><span class="term">"<a class="link" href="class-atkobject.html#signal-atkobject--property-change" title='The "property-change" atk.Object Signal'>property-change</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</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><tr><td><p><span class="term">"<a class="link" href="class-atkobject.html#signal-atkobject--state-change" title='The "state-change" atk.Object Signal'>state-change</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>state</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_set</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><tr><td><p><span class="term">"<a class="link" href="class-atkobject.html#signal-atkobject--visible-data-changed" title='The "visible-data-changed" atk.Object Signal'>visible-data-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>atkobject</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="id2960080"></a><h2>Description</h2><p>This class is the primary class for accessibility support via the
Accessibility ToolKit (ATK). Objects that are instances of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a> (or
instances of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>-derived
types) are queried for properties which relate basic (and generic)
properties of a UI component such as name and description. Instances of
<a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
may also be queried as to whether they implement other ATK interfaces
(e.g. <a class="link" href="class-atkaction.html" title="atk.Action"><code class="classname">atk.Action</code></a>,
<a class="link" href="class-atkcomponent.html" title="atk.Component"><code class="classname">atk.Component</code></a>,
etc.), as appropriate to the role which a given UI component plays in a
user interface.</p><p>All UI components in an applicationthat provide useful information
or services to the user must provide corresponding <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
instances on request (in GTK+, for instance, usually on a call to the
<a class="link" href="class-gtkwidget.html#method-gtkwidget--get-accessible" title="gtk.Widget.get_accessible"><code class="methodname">gtk.Widget.get_accessible()</code></a>
method), either via ATK support built into the toolkit for the widget
class or ancestor class, or in the case of custom widgets, if the
inherited <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
implementation is insufficient, via instances of a new <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
subclass.</p></div><div class="refsect1" title="Methods"><a name="id2996572"></a><h2>Methods</h2><div class="refsect2" title="atk.Object.get_name"><a name="method-atkobject--get-name"></a><h3>atk.Object.get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_name</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>a character string representing the accessible
name of the object.</td></tr></tbody></table><p>Gets the accessible name of the accessible.</p></div><div class="refsect2" title="atk.Object.get_description"><a name="method-atkobject--get-description"></a><h3>atk.Object.get_description</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_description</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>a character string representing the accessible
description of the accessible.</td></tr></tbody></table><p>Gets the accessible description of the accessible.</p></div><div class="refsect2" title="atk.Object.get_parent"><a name="method-atkobject--get-parent"></a><h3>atk.Object.get_parent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_parent</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>a <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
representing the accessible parent of the
accessible</td></tr></tbody></table><p>Gets the accessible parent of the accessible.</p></div><div class="refsect2" title="atk.Object.get_n_accessible_children"><a name="method-atkobject--get-n-accessible-children"></a><h3>atk.Object.get_n_accessible_children</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_accessible_children</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
accessible children of the accessible.</td></tr></tbody></table><p>Gets the number of accessible children of the accessible.</p></div><div class="refsect2" title="atk.Object.ref_accessible_child"><a name="method-atkobject--ref-accessible-child"></a><h3>atk.Object.ref_accessible_child</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">ref_accessible_child</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 integer representing the position of the
child, starting from 0</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 specified accessible child of the
accessible.</td></tr></tbody></table><p>Gets a reference to the specified accessible child of the
object. The accessible children are 0-based so the first accessible
child is at index 0, the second at index 1 and so on.</p></div><div class="refsect2" title="atk.Object.ref_relation_set"><a name="method-atkobject--ref-relation-set"></a><h3>atk.Object.ref_relation_set</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">ref_relation_set</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 <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a>
representing the relation set of the object.</td></tr></tbody></table><p>Gets the <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a>
associated with the object.</p></div><div class="refsect2" title="atk.Object.get_role"><a name="method-atkobject--get-role"></a><h3>atk.Object.get_role</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_role</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>one of the <a class="xref" href="atk-constants.html#atk-role-constants" title="Atk Role Constants">Atk Role Constants</a> which is the role of
the accessible</td></tr></tbody></table><p>Gets the role of the accessible.</p></div><div class="refsect2" title="atk.Object.get_layer"><a name="method-atkobject--get-layer"></a><h3>atk.Object.get_layer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_layer</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>one of the <a class="xref" href="atk-constants.html#atk-layer-constants" title="Atk Layer Constants">Atk Layer Constants</a> which is the layer of
the accessible</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is deprecated. Use the <a class="link" href="class-atkcomponent.html#method-atkcomponent--get-layer" title="atk.Component.get_layer"><code class="methodname">atk.Component.get_layer</code>()</a>
method instead.</p></div><p>Gets the layer of the accessible.</p></div><div class="refsect2" title="atk.Object.get_mdi_zorder"><a name="method-atkobject--get-mdi-zorder"></a><h3>atk.Object.get_mdi_zorder</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_mdi_zorder</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 which is the zorder of the
accessible, i.e. the depth at which the component is shown in
relation to other components in the same
container.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is deprecated. Use the <a class="link" href="class-atkcomponent.html#method-atkcomponent--get-mdi-zorder" title="atk.Component.get_mdi_zorder"><code class="methodname">atk.Component.get_mdi_zorder</code>()</a>
method instead.</p></div><p>Gets the zorder of the accessible. The value
<code class="literal">G_MININT</code> will be returned if the layer of the
accessible is not <code class="literal">atk.LAYER_MDI</code>.</p></div><div class="refsect2" title="atk.Object.ref_state_set"><a name="method-atkobject--ref-state-set"></a><h3>atk.Object.ref_state_set</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">ref_state_set</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>a reference to an <a class="link" href="class-atkstateset.html" title="atk.StateSet"><code class="classname">atk.StateSet</code></a>
which is the state set of the accessible</td></tr></tbody></table><p>Gets a reference to the state set of the accessible.</p></div><div class="refsect2" title="atk.Object.get_index_in_parent"><a name="method-atkobject--get-index-in-parent"></a><h3>atk.Object.get_index_in_parent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_index_in_parent</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 which is the index of the accessible
in its parent</td></tr></tbody></table><p>Gets the 0-based index of this accessible in its parent; returns
-1 if the accessible does not have an accessible parent.</p></div><div class="refsect2" title="atk.Object.set_name"><a name="method-atkobject--set-name"></a><h3>atk.Object.set_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</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>name</code></strong> :</span></p></td><td>a character string to be set as the accessible
name</td></tr></tbody></table><p>Sets the accessible name of the accessible.</p></div><div class="refsect2" title="atk.Object.set_description"><a name="method-atkobject--set-description"></a><h3>atk.Object.set_description</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_description</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>description</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>description</code></strong> :</span></p></td><td>a character string to be set as the accessible
description</td></tr></tbody></table><p>Sets the accessible description of the accessible.</p></div><div class="refsect2" title="atk.Object.set_parent"><a name="method-atkobject--set-parent"></a><h3>atk.Object.set_parent</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_parent</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</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>parent</code></strong> :</span></p></td><td>an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
to be set as the accessible parent</td></tr></tbody></table><p>Sets the accessible parent of the accessible.</p></div><div class="refsect2" title="atk.Object.set_role"><a name="method-atkobject--set-role"></a><h3>atk.Object.set_role</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_role</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>role</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>role</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-role-constants" title="Atk Role Constants">Atk Role Constants</a> to be set as the
role</td></tr></tbody></table><p>Sets the role of the accessible.</p></div><div class="refsect2" title="atk.Object.remove_property_change_handler"><a name="method-atkobject--remove-property-change-handler"></a><h3>atk.Object.remove_property_change_handler</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_property_change_handler</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</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>handler_id</code></strong> :</span></p></td><td>an integer that identifies the handler to be
removed.</td></tr></tbody></table><p>Removes a property change handler.</p></div><div class="refsect2" title="atk.Object.add_relationship"><a name="method-atkobject--add-relationship"></a><h3>atk.Object.add_relationship</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">add_relationship</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</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>relationship</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>target</code></strong> :</span></p></td><td>The <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
which is to be the target of the relation.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True if the relationship is
added.</td></tr></tbody></table><p>Adds a relationship of the specified type with the specified
target.</p></div><div class="refsect2" title="atk.Object.remove_relationship"><a name="method-atkobject--remove-relationship"></a><h3>atk.Object.remove_relationship</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_relationship</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</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>relationship</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>target</code></strong> :</span></p></td><td>The <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
which is the target of the relation to be
removed.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True if the relationship is
removed.</td></tr></tbody></table><p>Removes a relationship of the specified type with the specified
target.</p></div></div><div class="refsect1" title="Signals"><a name="id2966063"></a><h2>Signals</h2><div class="refsect2" title='The "active-descendant-changed" atk.Object Signal'><a name="signal-atkobject--active-descendant-changed"></a><h3>The "active-descendant-changed" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>obj</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>atkobject</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td><td>the newly focused object.</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 "active-descendant-changed" signal is emitted by an object
which has the state <code class="literal">atk.STATE_MANAGES_DESCENDANTS</code>
when the focus object in the object changes. For instance, a table
will emit the signal when the cell in the table which has focus
changes.</p></div><div class="refsect2" title='The "children-changed" atk.Object Signal'><a name="signal-atkobject--children-changed"></a><h3>The "children-changed" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>index</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>child</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>atkobject</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td><td>The index of the added or removed child</td></tr><tr><td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td><td>The child which was added or removed</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 signal "children-changed" is emitted when a child is added
or removed form an object. It supports two details: "add" and
"remove"</p></div><div class="refsect2" title='The "focus-event" atk.Object Signal'><a name="signal-atkobject--focus-event"></a><h3>The "focus-event" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>has_focus</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>atkobject</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>has_focus</code></em> :</span></p></td><td>A boolean value which indicates whether the object gained or lost focus.</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 signal "focus-event" is emitted when an object gains or
loses focus.</p></div><div class="refsect2" title='The "property-change" atk.Object Signal'><a name="signal-atkobject--property-change"></a><h3>The "property-change" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</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>atkobject</code></em> :</span></p></td><td>the object that received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td><td>The new value of the property that
changed.</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 signal "property-change" is emitted when an object's
property value changes. The detail identifies the name of the property
whose value has changed.</p></div><div class="refsect2" title='The "state-change" atk.Object Signal'><a name="signal-atkobject--state-change"></a><h3>The "state-change" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>state</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_set</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>atkobject</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td><td>The name of the state which has
changed</td></tr><tr><td><p><span class="term"><em class="parameter"><code>is_set</code></em> :</span></p></td><td>A boolean which indicates whether the state has
been set or unset.</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 "state-change" signal is emitted when an object's state
changes. The detail value identifies the state type which has
changed.</p></div><div class="refsect2" title='The "visible-data-changed" atk.Object Signal'><a name="signal-atkobject--visible-data-changed"></a><h3>The "visible-data-changed" atk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkobject</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>atkobject</code></em> :</span></p></td><td>the object that 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 "visible-data-changed" signal is emitted when the visual
appearance of the object changed.</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-atknoopobjectfactory.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-atkobjectfactory.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.NoOpObjectFactory </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.ObjectFactory</td></tr></table></div></body></html>
|