summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDieter Verfaillie <dieterv@optionexplicit.be>2011-02-17 07:14:38 +0100
committerDieter Verfaillie <dieterv@optionexplicit.be>2011-02-21 21:43:55 +0100
commitb98c83f676d2523cb1f81e882012da4ec2e8c629 (patch)
treeea4814a0403b0f95d052e8ac5c40752a498974e3 /docs
parent4004143583d582dca822ba8a022468d686219554 (diff)
downloadpygtk-b98c83f676d2523cb1f81e882012da4ec2e8c629.tar.gz
reference: pygtk-gtkaccessible.xml: add new methods
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog1
-rw-r--r--docs/reference/pygtk-gtkaccessible.xml80
2 files changed, 65 insertions, 16 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index e79cfb84..faf2caa1 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,6 +1,7 @@
2011-01-13 Dieter Verfaillie <dieterv@optionexplicit.be>
* pygtk-gtkaboutdialog.xml: fix (s|g)et_name and (s|g)et_program_name.
+ * pygtk-gtkaccessible.xml: add new methods
2011-01-12 Dieter Verfaillie <dieterv@optionexplicit.be>
diff --git a/docs/reference/pygtk-gtkaccessible.xml b/docs/reference/pygtk-gtkaccessible.xml
index b69f70aa..9a334217 100644
--- a/docs/reference/pygtk-gtkaccessible.xml
+++ b/docs/reference/pygtk-gtkaccessible.xml
@@ -13,14 +13,18 @@
<classsynopsis language="python">
<ooclass><classname>gtk.Accessible</classname></ooclass>
- <ooclass><classname><link
-linkend="class-atkobject">atk.Object</link></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>
+ <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>
@@ -30,15 +34,12 @@ linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroye
+-- <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">
@@ -46,7 +47,7 @@ linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroye
<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>
<refsect1>
<title>Description</title>
@@ -57,19 +58,66 @@ linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroye
<refsect1>
<title>Methods</title>
- <refsect2 id="method-gtkaccessible--connect-widget-destroyed">
+ <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>
+ <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>
+ the widget corresponding to a <classname>gtk.Accessible</classname> is
+ destroyed.</para>
</refsect2>
- </refsect1>
+ <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>