docs/reference/pygtk-gtkaccessible.xml


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

<?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-gtkaccessible">
  <refnamediv>
    <refname>gtk.Accessible</refname>
      <refpurpose>accessibility support for widgets.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Accessible</classname></ooclass>
      <ooclass><classname><link linkend="class-atkobject">atk.Object</link></classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroyed</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="method-gtkaccessible--get-widget">get_widget</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="method-gtkaccessible--set-widget">set_widget</link></methodname>
        <methodparam><parameter role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
    </classsynopsis>
  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-atkobject">atk.Object</link>
    +-- <link linkend="class-gtkaccessible">gtk.Accessible</link>
</synopsis>
  </refsect1>

  <refsect1 id="properties-gtkaccessible">
    <title>gtk.Accessible Properties</title>

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

  <refsect1 id="signal-prototypes-gtkaccessible">
    <title>gtk.Accessible 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>The gtk.Accessible class is an abstract base class.</para>
  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkaccessible--connect-widget-destroyed">
      <title>gtk.Accessible.connect_widget_destroyed</title>

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

      <para>This method specifies the callback function to be called when
            the widget corresponding to a <classname>gtk.Accessible</classname> is
            destroyed.</para>

    </refsect2>

    <refsect2 id="method-gtkaccessible--get-widget">
      <title>gtk.Accessible.get_widget</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_widget</methodname>
        <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the <classname>gtk.Widget</classname> corresponding to the <classname>gtk.Accessible</classname></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.22 and above.</para>
      </note>

    <para>The <methodname>get_widget</methodname>() method returns the
          <classname>gtk.Widget</classname> corresponding to the
          <classname>gtk.Accessible</classname>.</para>

    </refsect2>

    <refsect2 id="method-gtkaccessible--set-widget">
      <title>gtk.Accessible.set_widget</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_widget</methodname>
        <methodparam><parameter role="keyword">widget</parameter></methodparam>
        </methodsynopsis></programlisting>
      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
          <listitem><simpara>a <classname>gtk.Widget</classname></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.22 and above.</para>
      </note>

      <para>The <methodname>set_widget</methodname>() method sets the
            <classname>gtk.Widget</classname> corresponding to the
            <classname>gtk.Accessible</classname>.</para>

    </refsect2>
  </refsect1>
</refentry>