~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-atkobject.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<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.73.2"><link rel="start" 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" lang="en"><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
2
 
      API.</p></div><div class="refsect1" lang="en"><a name="id2792640"></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>):
3
 
<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" lang="en"><a name="id2806875"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
2
      API.</p></div><div class="refsect1" lang="en"><a name="id2993344"></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>):
 
3
<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" lang="en"><a name="id3007579"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
  +-- <a class="link" href="class-atkobject.html" title="atk.Object">atk.Object</a>
5
5
</pre></div><div class="refsect1" lang="en"><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><col><col></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: &gt;= 0.
6
6
          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:
15
15
          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
16
16
          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
17
17
          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
18
 
          values: &gt;= 0.  Default value: 0.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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" lang="en"><a name="id2771038"></a><h2>Description</h2><p>This class is the primary class for accessibility support via the
 
18
          values: &gt;= 0.  Default value: 0.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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" lang="en"><a name="id2971742"></a><h2>Description</h2><p>This class is the primary class for accessibility support via the
19
19
    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
20
20
    instances of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>-derived
21
21
    types) are queried for properties which relate basic (and generic)
33
33
    class or ancestor class, or in the case of custom widgets, if the
34
34
    inherited <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
35
35
    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>
36
 
    subclass.</p></div><div class="refsect1" lang="en"><a name="id2773201"></a><h2>Methods</h2><div class="refsect2" lang="en"><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
 
36
    subclass.</p></div><div class="refsect1" lang="en"><a name="id2973905"></a><h2>Methods</h2><div class="refsect2" lang="en"><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
37
37
          name of the object.</td></tr></tbody></table><p>Gets the accessible name of the accessible.</p></div><div class="refsect2" lang="en"><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
38
38
          description of the accessible.</td></tr></tbody></table><p>Gets the accessible description of the accessible.</p></div><div class="refsect2" lang="en"><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>
39
39
          representing the accessible parent of the
69
69
          which is the target of the relation to be
70
70
          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
71
71
          removed.</td></tr></tbody></table><p>Removes a relationship of the specified type with the specified
72
 
      target.</p></div></div><div class="refsect1" lang="en"><a name="id2774118"></a><h2>Signals</h2><div class="refsect2" lang="en"><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
 
72
      target.</p></div></div><div class="refsect1" lang="en"><a name="id2974822"></a><h2>Signals</h2><div class="refsect2" lang="en"><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
73
73
          with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
74
74
          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
75
75
      which has the state <code class="literal">atk.STATE_MANAGES_DESCENDANTS</code>