summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-atkgobjectaccessible.xml
blob: 6cc7fb17ada0b549d8b1ae518c2dad31de4a6779 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-atkgobjectaccessible">

  <refnamediv>
    <refname>atk.GObjectAccessible</refname>
      <refpurpose>this object class is derived from AtkObject and can be
      used as a basis implementing accessible objects.  </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.GObjectAccessible</classname></ooclass>
      <ooclass><classname><link linkend="class-atkobject">atk.Object</link></classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkgobjectaccessible--get-object">get_object</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
</classsynopsis>

<programlisting>
<emphasis role="bold">Functions</emphasis>

<methodsynopsis language="python">
    <methodname><link linkend="function-atk--gobject-accessible-for-object">atk.gobject_accessible_for_object</link></methodname>
    <methodparam><parameter role="keyword">obj</parameter></methodparam>
  </methodsynopsis></programlisting>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-atkobject">atk.Object</link>
    +-- <link linkend="class-atkgobjectaccessible">atk.GObjectAccessible</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-atkgobjectaccessible">
    <title>atk.GObjectAccessible Properties</title>

    <para><link linkend="properties-atkobject">atk.Object Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-atkgobjectaccessible">
    <title>atk.GObjectAccessible Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-atkobject">atk.Object Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>This object class is derived from <link
    linkend="class-atkobject"><classname>atk.Object</classname></link>. It
    can be used as a basis for implementing accessible objects for <link
    linkend="class-gobject"><classname>gobject.GObject</classname></link>
    objects which are not derived from <link
    linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>. One
    example of its use is in providing an accessible object for
    GnomeCanvasItem in the GAIL library.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-atkgobjectaccessible--get-object">
      <title>atk.GObjectAccessible.get_object</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_object</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gobject"><classname>gobject.GObject</classname></link>
          which is the object for the accessible object</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the <link
      linkend="class-gobject"><classname>gobject.GObject</classname></link>
      for the accessible object.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-atk--gobject-accessible-for-object">
      <title>atk.gobject_accessible_for_object</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>atk.gobject_accessible_for_object</methodname>
	  <methodparam><parameter
			 role="keyword">obj</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">obj</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gobject"><classname>gobject.GObject</classname></link></simpara></listitem>
	</varlistentry>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-atkobject"><classname>atk.Object</classname></link>
	  which is the accessible object for
	  <parameter>obj</parameter></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>Gets the accessible object for the specified
      <parameter>obj</parameter>.</para>

    </refsect2>

  </refsect1>

</refentry>