summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2005-09-18 01:53:20 +0000
committerJohn Finlay <finlay@src.gnome.org>2005-09-18 01:53:20 +0000
commit2a7d1909259ba18ff17e059090c647a111f34a7c (patch)
treeec50e5d8a102f55d9363d17e45eacdd566246c66
parenta66bbba01ca6882757d03eff265ee94a24f5b45f (diff)
downloadpygtk-2a7d1909259ba18ff17e059090c647a111f34a7c.tar.gz
Add descriptions.
* pygtk-gobject-functions.xml (spawn_async, child_watch_add) (main_depth, get_current_time) : Add descriptions. * pygtk-gobject-constants.xml (Spawn Flag Constants): Add. * pygtk-gtkobject.xml (gtk.binding_entry_remove): Add. * pygtk-gtk-functions.xml (gtk.binding_entry_add_signal): Move function description to gtk.Object class description. Fix varname errors (#316022 Nikos Kouremenos). * pygtk2-ref.xml: Change date and bump version number. * pygtk-hierarchy.xml: Update. * pygtk-pangocairocairocontext.xml : Add class description. * pygtk-pangocairocairofontmap.xml : Add class description. * pygtk-pangocairo-constants.xml : Add. * pygtk-pangocairo-functions.xml : Add. * pygtk-pangolayoutline.xml : Add class description. * pygtk-pangolayoutiter.xml (get_line): Add. * pygtk-gdkdrawable.xml (cairo_create): Add. * pygtk-pangorenderer.xml: Add pango.Renderer class description. * pygtk-gdkpangorenderer.xml: Add gtk.gdk.PangoRenderer class description. * pygtk-pango-constants.xml (pango.RENDER_PART): Add. * pygtk-gdkdragcontext.xml (set_icon_name): Remove. * pygtk-gdkwindow.xml (set_urgency_hint): Remove. * pygtk-gtktreeview.xml (get_visible_range): Remove. * pygtk-gtkwidget.xml (drag_source_add_image_targets) (drag_source_add_uri_targets, drag_source_set_icon_name): Remove. * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order): Remove. * pygtk-gtk-functions.xml (gtk.alternative_dialog_button_order): Remove. * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image) (wait_is_image_available): Remove. * pygtk-gtkaboutdialog.xml (gtk.about_dialog_set_email_hook) (gtk.about_dialog_set_url_hook): Add description of callback function.
-rw-r--r--docs/reference/ChangeLog60
-rw-r--r--docs/reference/pygtk-gdk-classes.xml2
-rw-r--r--docs/reference/pygtk-gdk-functions.xml88
-rw-r--r--docs/reference/pygtk-gdkdragcontext.xml8
-rw-r--r--docs/reference/pygtk-gdkdrawable.xml32
-rw-r--r--docs/reference/pygtk-gdkwindow.xml8
-rw-r--r--docs/reference/pygtk-gobject-constants.xml68
-rw-r--r--docs/reference/pygtk-gobject-functions.xml336
-rw-r--r--docs/reference/pygtk-gtk-functions.xml79
-rw-r--r--docs/reference/pygtk-gtkaboutdialog.xml29
-rw-r--r--docs/reference/pygtk-gtkclipboard.xml30
-rw-r--r--docs/reference/pygtk-gtkdialog.xml14
-rw-r--r--docs/reference/pygtk-gtkiconsource.xml12
-rw-r--r--docs/reference/pygtk-gtkiconview.xml4
-rw-r--r--docs/reference/pygtk-gtkobject.xml108
-rw-r--r--docs/reference/pygtk-gtkselectiondata.xml2
-rw-r--r--docs/reference/pygtk-gtktoolbutton.xml4
-rw-r--r--docs/reference/pygtk-gtktreeview.xml8
-rw-r--r--docs/reference/pygtk-gtkwidget.xml28
-rw-r--r--docs/reference/pygtk-hierarchy.xml7
-rw-r--r--docs/reference/pygtk-pango-classes.xml2
-rw-r--r--docs/reference/pygtk-pango-constants.xml45
-rw-r--r--docs/reference/pygtk-pangolayout.xml67
-rw-r--r--docs/reference/pygtk-pangolayoutiter.xml31
-rw-r--r--docs/reference/pygtk2-ref.xml12
25 files changed, 949 insertions, 135 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 95e4d267..f82c5ecf 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,63 @@
+ ======== 2.8.1 ============
+2005-09-17 John Finlay <finlay@moeraki.com>
+
+ * pygtk-gobject-functions.xml (spawn_async, child_watch_add)
+ (main_depth, get_current_time) : Add descriptions.
+
+ * pygtk-gobject-constants.xml (Spawn Flag Constants): Add.
+
+ * pygtk-gtkobject.xml (gtk.binding_entry_remove): Add.
+ * pygtk-gtk-functions.xml (gtk.binding_entry_add_signal):
+ Move function description to gtk.Object class description. Fix
+ varname errors (#316022 Nikos Kouremenos).
+
+ * pygtk2-ref.xml: Change date and bump version number.
+
+ * pygtk-hierarchy.xml: Update.
+
+ * pygtk-pangocairocairocontext.xml : Add class description.
+
+ * pygtk-pangocairocairofontmap.xml : Add class description.
+
+ * pygtk-pangocairo-constants.xml : Add.
+
+ * pygtk-pangocairo-functions.xml : Add.
+
+ * pygtk-pangolayoutline.xml : Add class description.
+
+ * pygtk-pangolayoutiter.xml (get_line): Add.
+
+2005-09-16 John Finlay <finlay@moeraki.com>
+
+ * pygtk-gdkdrawable.xml (cairo_create): Add.
+
+ * pygtk-pangorenderer.xml: Add pango.Renderer class description.
+
+ * pygtk-gdkpangorenderer.xml: Add gtk.gdk.PangoRenderer class
+ description.
+
+ * pygtk-pango-constants.xml (pango.RENDER_PART): Add.
+
+ * pygtk-gdkdragcontext.xml (set_icon_name): Remove.
+
+ * pygtk-gdkwindow.xml (set_urgency_hint): Remove.
+
+ * pygtk-gtktreeview.xml (get_visible_range): Remove.
+
+ * pygtk-gtkwidget.xml (drag_source_add_image_targets)
+ (drag_source_add_uri_targets, drag_source_set_icon_name): Remove.
+
+ * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order): Remove.
+
+ * pygtk-gtk-functions.xml (gtk.alternative_dialog_button_order):
+ Remove.
+
+ * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image)
+ (wait_is_image_available): Remove.
+
+ * pygtk-gtkaboutdialog.xml (gtk.about_dialog_set_email_hook)
+ (gtk.about_dialog_set_url_hook): Add description of callback function.
+
======== 2.8.0 ============
2005-09-07 John Finlay <finlay@moeraki.com>
diff --git a/docs/reference/pygtk-gdk-classes.xml b/docs/reference/pygtk-gdk-classes.xml
index 7b38499c..613d1c25 100644
--- a/docs/reference/pygtk-gdk-classes.xml
+++ b/docs/reference/pygtk-gdk-classes.xml
@@ -7,6 +7,7 @@
<!-- GDK CLASSES -->
<xi:include href="pygtk-gdkatom.xml"/>
+ <xi:include href="pygtk-gdkcairocontext.xml"/>
<xi:include href="pygtk-gdkcolor.xml"/>
<xi:include href="pygtk-gdkcolormap.xml"/>
<xi:include href="pygtk-gdkcursor.xml"/>
@@ -19,6 +20,7 @@
<xi:include href="pygtk-gdkgc.xml"/>
<xi:include href="pygtk-gdkimage.xml"/>
<xi:include href="pygtk-gdkkeymap.xml"/>
+ <xi:include href="pygtk-gdkpangorenderer.xml"/>
<xi:include href="pygtk-gdkpixbuf.xml"/>
<xi:include href="pygtk-gdkpixbufanimation.xml"/>
<xi:include href="pygtk-gdkpixbufanimationiter.xml"/>
diff --git a/docs/reference/pygtk-gdk-functions.xml b/docs/reference/pygtk-gdk-functions.xml
index 4386b878..469ff609 100644
--- a/docs/reference/pygtk-gdk-functions.xml
+++ b/docs/reference/pygtk-gdk-functions.xml
@@ -166,6 +166,17 @@ linkend="function-gdk--unicode-to-keyval">gtk.gdk.unicode_to_keyval</link></meth
</refsect2>
<refsect2>
+ <title><link linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link> Functions</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gdk--gdk-pango-renderer-get-default">gtk.gdk.gdk_pango_renderer_get_default</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ </refsect2>
+
+ <refsect2>
<title><link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> Functions</title>
<programlisting><methodsynopsis language="python">
@@ -556,6 +567,14 @@ linkend="function-gdk--get-display">gtk.gdk.get_display</link></methodname>
<methodname><link
linkend="function-gdk--get-display-arg-name">gtk.gdk.get_display_arg_name</link></methodname>
<methodparam></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gdk--gdk-pango-context-get-for-screen">gtk.gdk.gdk_pango_context_get_for_screen</link></methodname>
+ <methodparam><parameter
+ role="keyword">screen</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gdk--gdk-pango-context-get">gtk.gdk.gdk_pango_context_get</link></methodname>
</methodsynopsis></programlisting>
</refsect2>
@@ -1425,6 +1444,75 @@ returns the display name specified in the command line arguments, if any or
</refsect2>
+ <refsect2 id="function-gdk--gdk-pango-context-get-for-screen">
+ <title>gtk.gdk.gdk_pango_context_get_for_screen</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.gdk.gdk_pango_context_get_for_screen</methodname>
+ <methodparam><parameter
+ role="keyword">screen</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
+ <listitem><simpara>a <link
+linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a new <link
+linkend="class-pangocontext"><classname>pango.Context</classname></link>
+object</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.8 and above</para>
+ </note>
+
+ <para>The
+<function>gtk.gdk.gdk_pango_context_get_for_screen</function>() function
+creates a new <link
+linkend="class-pangocontext"><classname>pango.Context</classname></link>
+object for the <link
+linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
+specified by <parameter>screen</parameter>. Normally you should use the
+<link
+linkend="method-gtkwidget--get-pango-context"><methodname>get_pango_context</methodname>()</link>
+method instead of this function, to get the appropriate Pango context for
+the widget you intend to render text onto.</para>
+
+ </refsect2>
+
+ <refsect2 id="function-gdk--gdk-pango-context-get">
+ <title>gtk.gdk.gdk_pango_context_get</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.gdk.gdk_pango_context_get</methodname>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a new <link
+linkend="class-pangocontext"><classname>pango.Context</classname></link>
+for the default display.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.8 and above</para>
+ </note>
+
+ <para>The <function>gtk.gdk.gdk_pango_context_get</function>()
+function creates a new <link
+linkend="class-pangocontext"><classname>pango.Context</classname></link> for
+the default display. Normally you should use the <link
+linkend="method-gtkwidget--get-pango-context"><methodname>get_pango_context</methodname>()</link>
+method instead of this function, to get the appropriate Pango context for
+the widget you intend to render text onto.</para>
+
+ </refsect2>
+
</refsect1>
</refentry>
diff --git a/docs/reference/pygtk-gdkdragcontext.xml b/docs/reference/pygtk-gdkdragcontext.xml
index 6e4734b5..f21a2d0c 100644
--- a/docs/reference/pygtk-gdkdragcontext.xml
+++ b/docs/reference/pygtk-gdkdragcontext.xml
@@ -156,9 +156,10 @@ linkend="method-gdkdragcontext--set-icon-stock">set_icon_stock</link></methodnam
<methodparam><parameter
role="keyword">hot_y</parameter></methodparam>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
<methodname><link
-linkend="method-gdkdragcontext--set-icon-name">set_icon_name</link></methodname>
+linkend="method-gdkdragcontext- -set-icon-name">set_icon_name</link></methodname>
<methodparam><parameter
role="keyword">icon_name</parameter></methodparam>
<methodparam><parameter
@@ -166,6 +167,7 @@ linkend="method-gdkdragcontext--set-icon-name">set_icon_name</link></methodname>
<methodparam><parameter
role="keyword">hot_y</parameter></methodparam>
</methodsynopsis>
+END NOT IMPLEMENTED -->
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkdragcontext--set-icon-default">set_icon_default</link></methodname>
@@ -1059,7 +1061,8 @@ stock icon.</para>
</refsect2>
- <refsect2 id="method-gdkdragcontext--set-icon-name">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gdkdragcontext- -set-icon-name">
<title>gtk.gdk.DragContext.set_icon_name</title>
<programlisting><methodsynopsis language="python">
@@ -1105,6 +1108,7 @@ more information. Note that the size of the icon depends on the icon theme
<parameter>hot_y</parameter> have to be used with care.</para>
</refsect2>
+END NOT IMPLEMENTED -->
<refsect2 id="method-gdkdragcontext--set-icon-default">
<title>gtk.gdk.DragContext.set_icon_default</title>
diff --git a/docs/reference/pygtk-gdkdrawable.xml b/docs/reference/pygtk-gdkdrawable.xml
index db17f185..f72fccf0 100644
--- a/docs/reference/pygtk-gdkdrawable.xml
+++ b/docs/reference/pygtk-gdkdrawable.xml
@@ -357,6 +357,11 @@ linkend="method-gdkdrawable--draw-gray-image">draw_gray_image</link></methodname
</methodsynopsis>
END NOT IMPLEMENTED -->
+ <methodsynopsis language="python">
+ <methodname><link
+linkend="method-gdkdrawable--cairo-create">cairo_create</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -2066,6 +2071,33 @@ grayscale image on the drawable at the location specified by
</refsect2>
END NOT IMPLEMENTED -->
+ <refsect2 id="method-gdkdrawable--cairo-create">
+ <title>gtk.gdk.Drawable.cairo_create</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>cairo_create</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a <link
+linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.8 and above.</para>
+ </note>
+
+ <para>The <methodname>cairo_create</methodname>() method returns a
+<link
+linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link>
+object to be used for drawing on the drawable using Cairo drawing
+operations.</para>
+
+ </refsect2>
+
</refsect1>
</refentry>
diff --git a/docs/reference/pygtk-gdkwindow.xml b/docs/reference/pygtk-gdkwindow.xml
index df59eba1..53ae9198 100644
--- a/docs/reference/pygtk-gdkwindow.xml
+++ b/docs/reference/pygtk-gdkwindow.xml
@@ -628,10 +628,12 @@ END NOT IMPLEMENTED -->
<methodname><link linkend="method-gdkwindow--set-focus-on-map">set_focus_on_map</link></methodname>
<methodparam><parameter role="keyword">focus_on_map</parameter></methodparam>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-urgency-hint">set_urgency_hint</link></methodname>
+ <methodname><link linkend="method-gdkwindow- -set-urgency-hint">set_urgency_hint</link></methodname>
<methodparam><parameter role="keyword">urgent</parameter></methodparam>
</methodsynopsis>
+END NOT IMPLEMENTED -->
</classsynopsis>
<programlisting>
@@ -3796,7 +3798,8 @@ extension specification should respect it.</para>
</refsect2>
- <refsect2 id="method-gdkwindow--set-urgency-hint">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gdkwindow- -set-urgency-hint">
<title>gtk.gdk.Window.set_urgency_hint</title>
<programlisting><methodsynopsis language="python">
@@ -3823,6 +3826,7 @@ a hint for the desktop environment to the value specified by
indicating that it needs urgent user attention.</para>
</refsect2>
+END NOT IMPLEMENTED -->
</refsect1>
diff --git a/docs/reference/pygtk-gobject-constants.xml b/docs/reference/pygtk-gobject-constants.xml
index 02ed5a93..27ab5c2e 100644
--- a/docs/reference/pygtk-gobject-constants.xml
+++ b/docs/reference/pygtk-gobject-constants.xml
@@ -16,6 +16,7 @@
<xref linkend="gobject-param-constants" endterm="gobject-param-constants-title"></xref>
<xref linkend="gobject-priority-constants" endterm="gobject-priority-constants-title"></xref>
<xref linkend="gobject-signal-constants" endterm="gobject-signal-constants-title"></xref>
+<xref linkend="gobject-spawn-flag-constants" endterm="gobject-spawn-flag-constants-title"></xref>
<xref linkend="gobject-type-constants" endterm="gobject-type-constants-title"></xref>
<xref linkend="gobject-version-constants" endterm="gobject-version-constants-title"></xref>
</programlisting>
@@ -240,6 +241,73 @@ emission.</para>
</refsect2>
+ <refsect2 id="gobject-spawn-flag-constants">
+ <title id="gobject-spawn-flag-constants-title">GObject Spawn Flag Constants</title>
+
+ <para>The Spawn Flag constants are a set of bit-flags that can be
+passed to the <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+function.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_LEAVE_DESCRIPTORS_OPEN</literal></term>
+ <listitem>
+ <simpara>the parent's open file descriptors will be inherited by
+the child; otherwise all descriptors except stdin/stdout/stderr will be
+closed before calling <function>exec</function>() in the child.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal></term>
+ <listitem>
+ <simpara>the child will not be automatically reaped; you must
+call <function>waitpid</function>() or handle <literal>SIGCHLD</literal>
+yourself, or the child will become a zombie.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_SEARCH_PATH</literal></term>
+ <listitem>
+ <simpara><parameter>argv</parameter>[0] need not be an absolute
+path, it will be looked for in the user's <envar>PATH</envar>.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal></term>
+ <listitem>
+ <simpara>the child's standard output will be discarded, instead
+of going to the same location as the parent's standard output.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal></term>
+ <listitem>
+ <simpara>the child's standard error will be discarded.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal></term>
+ <listitem>
+ <simpara>the child will inherit the parent's standard input (by
+default, the child's standard input is attached to /dev/null).</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gobject.SPAWN_FILE_AND_ARGV_ZERO</literal></term>
+ <listitem>
+ <simpara>the first element of <parameter>argv</parameter> is the
+file to execute, while the remaining elements are the actual argument vector
+to pass to the file. Normally <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+uses <parameter>argv</parameter>[0] as the file to execute, and passes all
+of <parameter>argv</parameter> to the child.</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect2>
+
<refsect2 id="gobject-type-constants">
<title id="gobject-type-constants-title">GObject Built-in Type Constants</title>
diff --git a/docs/reference/pygtk-gobject-functions.xml b/docs/reference/pygtk-gobject-functions.xml
index bf8b8e90..6a186765 100644
--- a/docs/reference/pygtk-gobject-functions.xml
+++ b/docs/reference/pygtk-gobject-functions.xml
@@ -114,6 +114,30 @@ linkend="function-gobject--main-context-default">gobject.main_context_default</l
<methodname><link
linkend="function-gobject--markup-escape-text">gobject.markup_escape_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link linkend="function-gobject--child-watch-add">gobject.child_watch_add</link></methodname>
+ <methodparam><parameter role="keyword">pid</parameter></methodparam>
+ <methodparam><parameter role="keyword">function</parameter></methodparam>
+ <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">priority</parameter><initializer>gobject.PRIORITY_DEFAULT</initializer></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gobject--spawn-async">gobject.spawn_async</link></methodname>
+ <methodparam><parameter role="keyword">argv</parameter></methodparam>
+ <methodparam><parameter role="keyword">envp</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">working_directory</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter><initializer>0</initializer></methodparam>
+ <methodparam><parameter role="keyword">child_setup</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_input</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_output</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_error</parameter><initializer>None</initializer></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gobject--get-current-time">gobject.get_current_time</link></methodname>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gobject--main-depth">gobject.main_depth</link></methodname>
</methodsynopsis></programlisting>
</refsect1>
@@ -1032,6 +1056,318 @@ line endings and attribute values.</para>
</refsect2>
+ <refsect2 id="function-gobject--child-watch-add">
+ <title>gobject.child_watch_add</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gobject.child_watch_add</methodname>
+ <methodparam><parameter role="keyword">pid</parameter></methodparam>
+ <methodparam><parameter role="keyword">function</parameter></methodparam>
+ <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">priority</parameter><initializer>gobject.PRIORITY_DEFAULT</initializer></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter role="keyword">pid</parameter>&nbsp;:</term>
+ <listitem><simpara>process id of a child process to watch</simpara></listitem>
+ </varlistentry>
+ <varlistentry><term><parameter role="keyword">function</parameter>&nbsp;:</term>
+ <listitem><simpara>the function to call</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">data</parameter>&nbsp;:</term>
+ <listitem><simpara>the optional data to pass to
+<parameter>function</parameter></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">priority</parameter>&nbsp;:</term>
+ <listitem><simpara>the priority of the idle source - one of the
+<xref linkend="gobject-priority-constants"
+endterm="gobject-priority-constants-title"></xref></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>the id of event source.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This function is available in PyGTK 2.6 and above.</para>
+ </note>
+
+ <para>The <function>gobject.child_watch_add</function>() function sets
+the function specified by <parameter>function</parameter> to be called with
+the user data specified by <parameter>data</parameter> when the child
+indicated by <parameter>pid</parameter> exits. The signature for the
+callback is:</para>
+
+ <programlisting>
+def callback(pid, condition, user_data)
+</programlisting>
+
+ <para>where <parameter>pid</parameter> is is the child process id,
+<parameter>condition</parameter> is the status information about the child
+process and <parameter>user_data</parameter> is <parameter>data</parameter>
+PyGTK supports only a single callback per process id.</para>
+
+ </refsect2>
+
+ <refsect2 id="function-gobject--spawn-async">
+ <title>gobject.spawn_async</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gobject.spawn_async</methodname>
+ <methodparam><parameter role="keyword">argv</parameter></methodparam>
+ <methodparam><parameter role="keyword">envp</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">working_directory</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter><initializer>0</initializer></methodparam>
+ <methodparam><parameter role="keyword">child_setup</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_input</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_output</parameter><initializer>None</initializer></methodparam>
+ <methodparam><parameter role="keyword">standard_error</parameter><initializer>None</initializer></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter role="keyword">argv</parameter>&nbsp;:</term>
+ <listitem><simpara>a sequence of strings containing the arguments
+of the child process</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">envp</parameter>&nbsp;:</term>
+ <listitem><simpara>the child's environment or
+<literal>None</literal> to inherit the parent's
+environment.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">working_directory</parameter>&nbsp;:</term>
+ <listitem><simpara>the child's current working directory, or
+<literal>None</literal> to inherit parent's</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
+ <listitem><simpara>flags from the <xref
+linkend="gobject-spawn-flag-constants"
+endterm="gobject-spawn-flag-constants-title"></xref>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">child_setup</parameter>&nbsp;:</term>
+ <listitem><simpara>a function to run in the child just before
+calling <function>exec</function>()</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
+ <listitem><simpara>the user data for the
+<parameter>child_setup</parameter> function</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">standard_input</parameter>&nbsp;:</term>
+ <listitem><simpara>if <literal>TRUE</literal> return the file
+descriptor for the child's stdin</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">standard_output</parameter>&nbsp;:</term>
+ <listitem><simpara>if <literal>TRUE</literal> return the file
+descriptor for the child's stdout</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">standard_error</parameter>&nbsp;:</term>
+ <listitem><simpara>if <literal>TRUE</literal> return the file
+descriptor for the child's stderr</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a 4-tuple containing the child's process id and
+the stdin, stdout and stderr file descriptor integers.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This function is available in PyGTK 2.6 and above.</para>
+ </note>
+
+ <para>The <function>gobject.spawn_async</function>() function executes
+a child program asynchronously (your program will not block waiting for the
+child to exit). The child program is specified by the only argument that
+must be provided, <parameter>argv</parameter>. <parameter>argv</parameter>
+should be a sequence of strings, to be passed as the argument vector for the
+child. The first string in <parameter>argv</parameter> is of course the name
+of the program to execute. By default, the name of the program must be a
+full path; the <envar>PATH</envar> shell variable will only be searched if
+you pass the <literal>gobject.SPAWN_SEARCH_PATH</literal> flag in
+<parameter>flags</parameter>. The function returns a 4-tuple containing the
+child's process id and the file descriptors for the child's stdin, stdout
+and stderr. The stdin, stdout and stderr file descriptors are returned only
+ofthe corresponding <parameter>standard_input</parameter>,
+<parameter>standard_output</parameter> or
+<parameter>standard_error</parameter> params are
+<literal>TRUE</literal>.</para>
+
+ <para>On Windows, the low-level child process creation API
+(<function>CreateProcess</function>()) doesn't use argument vectors, but a
+command line. The C runtime library's <function>spawn*</function>() family
+of functions (which <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+eventually calls) paste the argument vector elements into a command line,
+and the C runtime startup code does a corresponding reconstruction of an
+argument vector from the command line, to be passed to
+<function>main</function>(). Complications arise when you have argument
+vector elements that contain spaces of double quotes. The
+<function>spawn*</function>() functions don't do any quoting or escaping,
+but on the other hand the startup code does do unquoting and unescaping in
+order to enable receiving arguments with embedded spaces or double
+quotes. To work around this asymmetry, the <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+function will do quoting and escaping on argument vector elements that need
+it before calling the C runtime <function>spawn</function>()
+function.</para>
+
+ <para><parameter>envp</parameter> is a sequence of strings, where each
+ string has the form <literal>KEY=VALUE</literal>. This will become the
+ child's environment. If <parameter>envp</parameter> is
+ <parameter>None</parameter> or not specified, the child inherits its
+ parent's environment.</para>
+
+ <para><parameter>flags</parameter> should be the bitwise
+<literal>OR</literal> of the <xref linkend="gobject-spawn-flag-constants"
+endterm="gobject-spawn-flag-constants-title"></xref> you want to affect the
+function's behaviour. The <literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal>
+flag means that the child will not automatically be reaped; you must use a
+GChildWatch source to be notified about the death of the child
+process. Eventually you must call g_spawn_close_pid() on the child_pid, in
+order to free resources which may be associated with the child process. (On
+Unix, using a GChildWatch source is equivalent to calling
+<function>waitpid</function>() or handling the <literal>SIGCHLD</literal>
+signal manually. On Windows, calling g_spawn_close_pid() is equivalent to
+calling <function>CloseHandle</function>() on the process handle
+returned).</para>
+
+ <para><literal>gobject.SPAWN_LEAVE_DESCRIPTORS_OPEN</literal> means
+that the parent's open file descriptors will be inherited by the child;
+otherwise all descriptors except stdin/stdout/stderr will be closed before
+calling <function>exec</function>() in the
+child. <literal>gobject.SPAWN_SEARCH_PATH</literal> means that
+<parameter>argv</parameter>[0] need not be an absolute path, it will be
+looked for in the user's
+<envar>PATH</envar>. <literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal>
+means that the child's standard output will be discarded, instead of going
+to the same location as the parent's standard output. If you use this flag,
+<parameter>standard_output</parameter> must be
+<literal>None</literal>. <literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal>
+means that the child's standard error will be discarded, instead of going to
+the same location as the parent's standard error. If you use this flag,
+<parameter>standard_error</parameter> must be
+<literal>None</literal>. <literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal>
+means that the child will inherit the parent's standard input (by default,
+the child's standard input is attached to
+<filename>/dev/null</filename>). If you use this flag,
+<parameter>standard_input</parameter> must be
+<literal>None</literal>. <literal>gobject.SPAWN_FILE_AND_ARGV_ZERO</literal>
+means that the first element of <parameter>argv</parameter> is the file to
+execute, while the remaining elements are the actual argument vector to pass
+to the file. Normally the <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+function uses <parameter>argv</parameter>[0] as the file to execute, and
+passes all of <parameter>argv</parameter> to the child.</para>
+
+ <para><parameter>child_setup</parameter> and
+<parameter>user_data</parameter> are a function and user data. On POSIX
+platforms, the function is called in the child after GLib has performed all
+the setup it plans to perform (including creating pipes, closing file
+descriptors, etc.) but before calling <function>exec</function>(). That is,
+<parameter>child_setup</parameter> is called just before calling
+<function>exec</function>() in the child. Obviously actions taken in this
+function will only affect the child, not the parent. On Windows, there is no
+separate <function>fork</function>() and <function>exec</function>()
+functionality. Child processes are created and run right away with one API
+call,
+<function>CreateProcess</function>(). <parameter>child_setup</parameter> is
+called in the parent process just before creating the child process. You
+should carefully consider what you do in <parameter>child_setup</parameter>
+if you intend your software to be portable to Windows.</para>
+
+ <para>The returned child process id can be used to send signals to the
+child, or to wait for the child if you specified the
+<literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal> flag. On Windows, child
+pid will be returned only if you specified the
+<literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal> flag.</para>
+
+ <para>The caller of the <link
+linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
+must close any returned file descriptors when they are no longer in
+use.</para>
+
+ <para>If <parameter>standard_input</parameter> is
+<literal>None</literal>, the child's standard input is attached to
+<filename>/dev/null</filename> unless
+<literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal> is set.</para>
+
+ <para>If <parameter>standard_error</parameter> is
+<literal>None</literal>, the child's standard error goes to the same
+location as the parent's standard error unless
+<literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal> is set.</para>
+
+ <para>If <parameter>standard_output</parameter> is
+<literal>None</literal>, the child's standard output goes to the same
+location as the parent's standard output unless
+<literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal> is set.</para>
+
+ <para>If an error occurs, the gobject.GError exception will be
+raised.</para>
+
+ </refsect2>
+
+ <refsect2 id="function-gobject--get-current-time">
+ <title>gobject.get_current_time</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gobject.get_current_time</methodname>
+ </methodsynopsis></programlisting>
+ <variablelist role="params">
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>the current time as the number of seconds and
+microseconds from the epoch.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This function is available in PyGTK 2.8 and above.</para>
+ </note>
+
+ <para>The <function>gobject.get_current_time</function>() function
+reurns the current time of day as the number of seconds and microseconds
+from the epoch.</para>
+
+ </refsect2>
+
+ <refsect2 id="function-gobject--main-depth">
+ <title>gobject.main_depth</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gobject.main_depth</methodname>
+ </methodsynopsis></programlisting>
+ <variablelist role="params">
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>he depth of the stack of calls to the main
+context.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+ <note>
+ <para>This function is available in PyGTK 2.8 and above.</para>
+ </note>
+
+ <para>The <function>main_depth</function>() function returns the depth
+of the stack of calls in the main context. That is, when called from the
+toplevel, it gives 0. When called from within a callback from the <link
+linkend="method-gobjectmaincontext--iteration"><methodname>gobject.MainContext.iteration</methodname>()</link>
+method (or the <link
+linkend="method-gobjectmainloop--run"><methodname>gobject.MainLoop.run</methodname>()</link>
+method, etc.) it returns 1. When called from within a callback to a
+recursive call to the <link
+linkend="method-gobjectmaincontext--iteration"><methodname>gobject.MainContext.iteration</methodname>()</link>
+method), it returns 2. And so forth.</para>
+
+ </refsect2>
+
</refsect1>
</refentry>
diff --git a/docs/reference/pygtk-gtk-functions.xml b/docs/reference/pygtk-gtk-functions.xml
index 6422054c..9075f0ba 100644
--- a/docs/reference/pygtk-gtk-functions.xml
+++ b/docs/reference/pygtk-gtk-functions.xml
@@ -184,6 +184,19 @@ linkend="function-gtk--clipboard-get">gtk.clipboard_get</link></methodname>
</refsect2>
+<!-- NOT IMPLEMENTED
+ <refsect2>
+ <title><link linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> Functions</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gtk- -alternative-dialog-button-order">gtk.alternative_dialog_button_order</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter><initializer>None</initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ </refsect2>
+ END NOT IMPLEMENTED -->
+
<refsect2>
<title><link linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> Functions</title>
@@ -322,6 +335,14 @@ linkend="function-gtk--bindings-activate">gtk.bindings_activate_event</link></me
role="keyword">object</parameter></methodparam>
<methodparam><parameter
role="keyword">event</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gtk--binding-entry-add-signal">gtk.binding_entry_add_signal</link></methodname>
+ <methodparam><parameter>object</parameter></methodparam>
+ <methodparam><parameter>keyval</parameter></methodparam>
+ <methodparam><parameter>modifiers</parameter></methodparam>
+ <methodparam><parameter>signal_name</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect2>
@@ -556,14 +577,6 @@ linkend="function-gtk--window-set-default-icon-name">gtk.window_set_default_icon
<programlisting><methodsynopsis language="python">
<methodname><link
-linkend="function-gtk--binding-entry-add-signal">gtk.binding_entry_add_signal</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>keyval</parameter></methodparam>
- <methodparam><parameter>modifiers</parameter></methodparam>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
linkend="function-gtk--check-version">gtk.check_version</link></methodname>
<methodparam><parameter
role="keyword">required_major</parameter></methodparam>
@@ -666,56 +679,6 @@ that are not associated with a specific class are described below.</para>
<refsect1>
<title>Functions</title>
- <refsect2 id="function-gtk--binding-entry-add-signal">
- <title>gtk.binding_entry_add_signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.binding_entry_add_signal</methodname>
- <methodparam><parameter>class</parameter></methodparam>
- <methodparam><parameter>keyval</parameter></methodparam>
- <methodparam><parameter>modifiers</parameter></methodparam>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">object</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link>
-class the binding entry will be associated with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">signal_name</parameter>&nbsp;:</term>
- <listitem><simpara>the signal name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more pairs of value type-value
-pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.binding_entry_add_signal</function>() function
-adds a binding (specified by <parameter>keyval</parameter> and
-<parameter>modifiers</parameter>) to the binding set of the specified object
-<parameter>class</parameter>. The signal specified by
-<parameter>signal_name</parameter> will be emitted with the optional
-arguments specified by the argument pairs denoted by ... that are value type
-and value. This function is used when creating a new widget class to set up
-key bindings.</para>
-
- </refsect2>
-
<refsect2 id="function-gtk--check-version">
<title>gtk.check_version</title>
diff --git a/docs/reference/pygtk-gtkaboutdialog.xml b/docs/reference/pygtk-gtkaboutdialog.xml
index 2e88bc0a..87264a64 100644
--- a/docs/reference/pygtk-gtkaboutdialog.xml
+++ b/docs/reference/pygtk-gtkaboutdialog.xml
@@ -1094,6 +1094,21 @@ activated.</simpara></listitem>
function installs a global function (specified by
<parameter>func</parameter>) to be called whenever the user activates an
email link in an about dialog.</para>
+
+ <para>The signature of the callback function
+<parameter>func</parameter> is:</para>
+
+ <programlisting>
+def func(dialog, link, user_data)
+</programlisting>
+
+ <para>where <parameter>link</parameter> is the email address
+destination of the activated link, <parameter>dialog</parameter> is the
+<link
+linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
+containing <parameter>link</parameter> and <parameter>user_data</parameter>
+is the <parameter>data</parameter> argument passed to <link
+linkend="function-gtk--about-dialog-set-email-hook"><function>gtk.about_dialog_set_email_hook</function>()</link>.</para>
</refsect2>
@@ -1128,6 +1143,20 @@ activated.</simpara></listitem>
installs a global function (specified by <parameter>func</parameter>) to be
called whenever the user activates a URL link in an about dialog.</para>
+ <para>The signature of the callback function
+<parameter>func</parameter> is:</para>
+
+ <programlisting>
+def func(dialog, link, user_data)
+</programlisting>
+
+ <para>where <parameter>link</parameter> is the URL destination of the
+activated link, <parameter>dialog</parameter> is the <link
+linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
+containing <parameter>link</parameter> and <parameter>user_data</parameter>
+is the <parameter>data</parameter> argument passed to <link
+linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link>.</para>
+
</refsect2>
</refsect1>
diff --git a/docs/reference/pygtk-gtkclipboard.xml b/docs/reference/pygtk-gtkclipboard.xml
index 3f2869e9..790eb917 100644
--- a/docs/reference/pygtk-gtkclipboard.xml
+++ b/docs/reference/pygtk-gtkclipboard.xml
@@ -82,23 +82,25 @@
<methodsynopsis language="python">
<methodname><link linkend="method-gtkclipboard--store">store</link></methodname>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-image">request_image</link></methodname>
+ <methodname><link linkend="method-gtkclipboard- -request-image">request_image</link></methodname>
<methodparam><parameter role="keyword">callback</parameter></methodparam>
<methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-image">wait_for_image</link></methodname>
+ <methodname><link linkend="method-gtkclipboard- -wait-for-image">wait_for_image</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--set-image">set_image</link></methodname>
+ <methodname><link linkend="method-gtkclipboard- -set-image">set_image</link></methodname>
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-is-image-available">wait_is_image_available</link></methodname>
+ <methodname><link linkend="method-gtkclipboard- -wait-is-image-available">wait_is_image_available</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+END NOT IMPLEMENTED -->
</classsynopsis>
<programlisting>
@@ -875,7 +877,8 @@ quit.</para>
</refsect2>
- <refsect2 id="method-gtkclipboard--request-image">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gtkclipboard- -request-image">
<title>gtk.Clipboard.request_image</title>
<programlisting><methodsynopsis language="python">
@@ -898,7 +901,7 @@ one way or the other.)</simpara></listitem>
</variablelist>
<note>
- <para>This method is available in PyGTK 2.8 and above.</para>
+ <para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>request_image</methodname>() method requests the
@@ -925,7 +928,7 @@ the contents of the clipboard could not be converted into an image.</para>
</refsect2>
- <refsect2 id="method-gtkclipboard--wait-for-image">
+ <refsect2 id="method-gtkclipboard- -wait-for-image">
<title>gtk.Clipboard.wait_for_image</title>
<programlisting><methodsynopsis language="python">
@@ -945,7 +948,7 @@ image.)</simpara></listitem>
</variablelist>
<note>
- <para>This method is available in PyGTK 2.8 and above.</para>
+ <para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>wait_for_image</methodname>() method requests
@@ -956,7 +959,7 @@ timeouts, etc, may be dispatched during the wait.</para>
</refsect2>
- <refsect2 id="method-gtkclipboard--set-image">
+ <refsect2 id="method-gtkclipboard- -set-image">
<title>gtk.Clipboard.set_image</title>
<programlisting><methodsynopsis language="python">
@@ -972,7 +975,7 @@ linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara
</variablelist>
<note>
- <para>This method is available in PyGTK 2.8 and above.</para>
+ <para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_image</methodname>() method sets the
@@ -984,7 +987,7 @@ the requested format.</para>
</refsect2>
- <refsect2 id="method-gtkclipboard--wait-is-image-available">
+ <refsect2 id="method-gtkclipboard- -wait-is-image-available">
<title>gtk.Clipboard.wait_is_image_available</title>
<programlisting><methodsynopsis language="python">
@@ -1000,7 +1003,7 @@ available.</simpara></listitem>
</variablelist>
<note>
- <para>This method is available in PyGTK 2.8 and above.</para>
+ <para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>wait_is_image_available</methodname>() method
@@ -1011,10 +1014,11 @@ received using the main loop, so events, timeouts, etc, may be dispatched
during the wait.</para>
<para>This method is a little faster than calling the <link
-linkend="method-gtkclipboard--wait-for-image"><methodname>wait_for_image()</methodname></link>
+linkend="method-gtkclipboard- -wait-for-image"><methodname>wait_for_image()</methodname></link>
since it doesn't need to retrieve the actual image data.</para>
</refsect2>
+END NOT IMPLEMENTED -->
</refsect1>
diff --git a/docs/reference/pygtk-gtkdialog.xml b/docs/reference/pygtk-gtkdialog.xml
index 9c1d5c54..61c01525 100644
--- a/docs/reference/pygtk-gtkdialog.xml
+++ b/docs/reference/pygtk-gtkdialog.xml
@@ -96,16 +96,18 @@ linkend="method-gtkdialog--get-response-for-widget">get_response_for_widget</lin
role="keyword">widget</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
-
+
+<!-- NOT IMPLEMENTED
<programlisting>
<emphasis role="bold">Functions</emphasis>
-
+
<methodsynopsis language="python">
<methodname><link
-linkend="function-gtk--alternative-dialog-button-order">gtk.alternative_dialog_button_order</link></methodname>
+linkend="function-gtk- -alternative-dialog-button-order">gtk.alternative_dialog_button_order</link></methodname>
<methodparam><parameter role="keyword">screen</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
-
+ END NOT IMPLEMENTED -->
+
</refsect1>
<refsect1>
@@ -770,10 +772,11 @@ returns the response id of the widget specified by
</refsect1>
+<!-- NOT IMPLEMENTED
<refsect1>
<title>Functions</title>
- <refsect2 id="function-gtk--alternative-dialog-button-order">
+ <refsect2 id="function-gtk- -alternative-dialog-button-order">
<title>gtk.alternative_dialog_button_order</title>
<programlisting><methodsynopsis language="python">
@@ -811,6 +814,7 @@ used.</para>
</refsect2>
</refsect1>
+END NOT IMPLEMENTED -->
<refsect1>
<title>Signals</title>
diff --git a/docs/reference/pygtk-gtkiconsource.xml b/docs/reference/pygtk-gtkiconsource.xml
index d2927f6f..cb46bfb0 100644
--- a/docs/reference/pygtk-gtkiconsource.xml
+++ b/docs/reference/pygtk-gtkiconsource.xml
@@ -688,11 +688,17 @@ to</simpara></listitem>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
- <para>The <methodname>set_icon_name</methodname>() method sets the
-anme of the icon to look up in the current icon theme to use as a base image
-when creating icon variants for <link
+ <para>The <methodname>set_icon_name</methodname>() method uses the
+name specified by <parameter>icon_name</parameter> to look up an icon in the
+current icon theme to use as a base image when creating icon variants for
+<link
linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>.</para>
+<!-- NOT IMPLEMENTED
+ <para>In PyGTK 2.10 and above, <parameter>icon_name</parameter> may be
+<literal>None</literal>.</para>
+END NOT IMPLEMENTED -->
+
</refsect2>
<refsect2 id="method-gtkiconsource--get-icon-name">
diff --git a/docs/reference/pygtk-gtkiconview.xml b/docs/reference/pygtk-gtkiconview.xml
index 92543b57..799e48f2 100644
--- a/docs/reference/pygtk-gtkiconview.xml
+++ b/docs/reference/pygtk-gtkiconview.xml
@@ -1881,8 +1881,8 @@ drag-and-drop.</para>
<variablelist>
<varlistentry>
<term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the item to highlight, or
-<literal>None</literal>.</simpara></listitem>
+ <listitem><simpara>the path of the item to highlight<!-- NOT IMPLEMENTED , or
+<literal>None</literal> END NOT IMPLEMENTED -->.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">pos</parameter>&nbsp;:</term>
diff --git a/docs/reference/pygtk-gtkobject.xml b/docs/reference/pygtk-gtkobject.xml
index 1042ba08..af1bfa57 100644
--- a/docs/reference/pygtk-gtkobject.xml
+++ b/docs/reference/pygtk-gtkobject.xml
@@ -54,7 +54,24 @@ linkend="function-gtk--bindings-activate-event">gtk.bindings_activate_event</lin
role="keyword">object</parameter></methodparam>
<methodparam><parameter
role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gtk--binding-entry-add-signal">gtk.binding_entry_add_signal</link></methodname>
+ <methodparam><parameter>object</parameter></methodparam>
+ <methodparam><parameter>keyval</parameter></methodparam>
+ <methodparam><parameter>modifiers</parameter></methodparam>
+ <methodparam><parameter>signal_name</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gtk--binding-entry-remove">gtk.binding_entry_remove</link></methodname>
+ <methodparam><parameter
+ role="keyword">class_type</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">keyval</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">modifiers</parameter></methodparam>
+ </methodsynopsis></programlisting>
</refsect1>
@@ -496,6 +513,95 @@ it.</para>
</refsect2>
+ <refsect2 id="function-gtk--binding-entry-add-signal">
+ <title>gtk.binding_entry_add_signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.binding_entry_add_signal</methodname>
+ <methodparam><parameter>object</parameter></methodparam>
+ <methodparam><parameter>keyval</parameter></methodparam>
+ <methodparam><parameter>modifiers</parameter></methodparam>
+ <methodparam><parameter>signal_name</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>object</parameter>&nbsp;:</term>
+ <listitem><simpara>the <link
+linkend="class-gtkobject"><classname>gtk.Object</classname></link>
+class the binding entry will be associated with</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>keyval</parameter>&nbsp;:</term>
+ <listitem><simpara>the key value</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>modifiers</parameter>&nbsp;:</term>
+ <listitem><simpara>the modifier mask</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>signal_name</parameter>&nbsp;:</term>
+ <listitem><simpara>the signal name</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter>&nbsp;:</term>
+ <listitem><simpara>zero or more pairs of value type-value
+pairs</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>The <function>gtk.binding_entry_add_signal</function>() function
+adds a binding (specified by <parameter>keyval</parameter> and
+<parameter>modifiers</parameter>) to the binding set of the object class
+derived from <parameter>object</parameter>. The signal specified by
+<parameter>signal_name</parameter> will be emitted with the optional
+arguments specified by the argument pairs denoted by ... that are value type
+and value. This function is used when creating a new widget class to set up
+key bindings.</para>
+
+ </refsect2>
+
+ <refsect2 id="function-gtk--binding-entry-remove">
+ <title>gtk.binding_entry_remove</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.binding_entry_remove</methodname>
+ <methodparam><parameter
+ role="keyword">class_type</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">keyval</parameter></methodparam>
+ <methodparam><parameter
+ role="keyword">modifiers</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">class_type</parameter>&nbsp;:</term>
+ <listitem><simpara>the <link
+linkend="class-gtkobject"><classname>gtk.Object</classname></link>
+class the binding entry will be removed from</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
+ <listitem><simpara>the key value</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+role="keyword">modifiers</parameter>&nbsp;:</term>
+ <listitem><simpara>the modifier mask</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.2 and above.</para>
+ </note>
+
+ <para>The <function>gtk.binding_entry_remove</function>() function
+removes the binding (specified by <parameter>keyval</parameter> and
+<parameter>modifiers</parameter>) from the binding set of the object class
+specified by <parameter>class_type</parameter>.</para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
diff --git a/docs/reference/pygtk-gtkselectiondata.xml b/docs/reference/pygtk-gtkselectiondata.xml
index 49013a89..f0d9a41c 100644
--- a/docs/reference/pygtk-gtkselectiondata.xml
+++ b/docs/reference/pygtk-gtkselectiondata.xml
@@ -516,7 +516,7 @@ the selection data was successfully set.</para>
</note>
<para>The <methodname>get_uris</methodname>() method returns the
-contents of the selection data as a list or URIs.</para>
+contents of the selection data as a list of URIs.</para>
</refsect2>
diff --git a/docs/reference/pygtk-gtktoolbutton.xml b/docs/reference/pygtk-gtktoolbutton.xml
index a105238c..445aab30 100644
--- a/docs/reference/pygtk-gtktoolbutton.xml
+++ b/docs/reference/pygtk-gtktoolbutton.xml
@@ -479,8 +479,8 @@ more information.</para>
<variablelist>
<varlistentry>
<term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>a name of a themed icon, or
-<literal>None</literal></simpara></listitem>
+ <listitem><simpara>a name of a themed icon, <!-- NOT IMPLEMENTED or
+<literal>None</literal> END NOT IMPLEMENTED --></simpara></listitem>
</varlistentry>
</variablelist>
diff --git a/docs/reference/pygtk-gtktreeview.xml b/docs/reference/pygtk-gtktreeview.xml
index d946bd19..1468a05b 100644
--- a/docs/reference/pygtk-gtktreeview.xml
+++ b/docs/reference/pygtk-gtktreeview.xml
@@ -444,9 +444,11 @@ END NOT IMPLEMENTED -->
<methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-visible-range">get_visible_range</link></methodname>
+ <methodname><link linkend="method-gtktreeview- -get-visible-range">get_visible_range</link></methodname>
</methodsynopsis>
+END NOT IMPLEMENTED -->
</classsynopsis>
@@ -3248,7 +3250,8 @@ separator.</para>
</refsect2>
- <refsect2 id="method-gtktreeview--get-visible-range">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gtktreeview- -get-visible-range">
<title>gtk.TreeView.get_visible_range</title>
<programlisting><methodsynopsis language="python">
@@ -3273,6 +3276,7 @@ treeview. If no valid paths are available this method returns
<literal>None</literal>.</para>
</refsect2>
+END NOT IMPLEMENTED -->
</refsect1>
diff --git a/docs/reference/pygtk-gtkwidget.xml b/docs/reference/pygtk-gtkwidget.xml
index 6eef8f0e..8643cb83 100644
--- a/docs/reference/pygtk-gtkwidget.xml
+++ b/docs/reference/pygtk-gtkwidget.xml
@@ -150,27 +150,31 @@ linkend="method-gtkwidget--drag-source-set-icon-stock">drag_source_set_icon_stoc
<methodparam><parameter
role="keyword">stock_id</parameter></methodparam>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
<methodname><link
-linkend="method-gtkwidget--drag-source-set-icon-name">drag_source_set_icon_name</link></methodname>
+linkend="method-gtkwidget- -drag-source-set-icon-name">drag_source_set_icon_name</link></methodname>
<methodparam><parameter
role="keyword">icon_name</parameter></methodparam>
</methodsynopsis>
+END NOT IMPLEMENTED -->
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkwidget--drag-source-add-text-targets">drag_source_add_text_targets</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
<methodname><link
-linkend="method-gtkwidget--drag-source-add-image-targets">drag_source_add_image_targets</link></methodname>
+linkend="method-gtkwidget- -drag-source-add-image-targets">drag_source_add_image_targets</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
-linkend="method-gtkwidget--drag-source-add-uri-targets">drag_source_add_uri_targets</link></methodname>
+linkend="method-gtkwidget- -drag-source-add-uri-targets">drag_source_add_uri_targets</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+END NOT IMPLEMENTED -->
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkwidget--drag-begin">drag_begin</link></methodname>
@@ -2525,7 +2529,8 @@ stock icon specified by <parameter>stock_id</parameter>.</para>
</refsect2>
- <refsect2 id="method-gtkwidget--drag-source-set-icon-name">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gtkwidget- -drag-source-set-icon-name">
<title>gtk.Widget.drag_source_set_icon_name</title>
<programlisting><methodsynopsis language="python">
@@ -2552,6 +2557,7 @@ linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
docs for more information.</para>
</refsect2>
+ END NOT IMPLEMENTED -->
<refsect2 id="method-gtkwidget--drag-source-get-target-list">
<title>gtk.Widget.drag_source_get_target_list</title>
@@ -2643,7 +2649,8 @@ method.</para>
</refsect2>
- <refsect2 id="method-gtkwidget--drag-source-add-image-targets">
+<!-- NOT IMPLEMENTED
+ <refsect2 id="method-gtkwidget- -drag-source-add-image-targets">
<title>gtk.Widget.drag_source_add_image_targets</title>
<programlisting><methodsynopsis language="python">
@@ -2660,14 +2667,14 @@ method adds the image targets supported by <link
linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
to the target list of the widget's drag source using an info value of 0. If
you need another value for info, use the <link
-linkend="function-gtk--target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link>
+linkend="function-gtk- -target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link>
function and the <link
-linkend="method-gtkwidget--drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
+linkend="method-gtkwidget- -drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
method.</para>
</refsect2>
- <refsect2 id="method-gtkwidget--drag-source-add-uri-targets">
+ <refsect2 id="method-gtkwidget- -drag-source-add-uri-targets">
<title>gtk.Widget.drag_source_add_uri_targets</title>
<programlisting><methodsynopsis language="python">
@@ -2684,12 +2691,13 @@ method adds the URI targets supported by <link
linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
to the target list of the widget's drag source using an info value of 0. If
you need another value for info, use the <link
-linkend="function-gtk--target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link> function
+linkend="function-gtk- -target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link> function
and the <link
-linkend="method-gtkwidget--drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
+linkend="method-gtkwidget- -drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
method.</para>
</refsect2>
+END NOT IMPLEMENTED -->
<refsect2 id="method-gtkwidget--drag-begin">
<title>gtk.Widget.drag_begin</title>
diff --git a/docs/reference/pygtk-hierarchy.xml b/docs/reference/pygtk-hierarchy.xml
index 604f1a11..40640f87 100644
--- a/docs/reference/pygtk-hierarchy.xml
+++ b/docs/reference/pygtk-hierarchy.xml
@@ -23,6 +23,7 @@
<link linkend="class-pangofontmetrics">pango.FontMetrics</link>
<link linkend="class-pangoglyphstring">pango.GlyphString</link>
<link linkend="class-pangolanguage">pango.Language</link>
+ <link linkend="class-pangolayoutline">pango.LayoutLine</link>
<link linkend="class-pangotabarray">pango.TabArray</link>
<link linkend="class-gobjectginterface">gobject.GInterface</link>
<link linkend="class-gtkcelleditable">gtk.CellEditable</link>
@@ -215,9 +216,15 @@
<link linkend="class-pangofontface">pango.FontFace</link>
<link linkend="class-pangofontfamily">pango.FontFamily</link>
<link linkend="class-pangofontmap">pango.FontMap</link>
+ <link linkend="class-pangocairocairofontmap">pangocairo.CairoFontMap</link>
<link linkend="class-pangofontset">pango.Fontset</link>
<link linkend="class-pangofontsetsimple">pango.FontsetSimple</link>
<link linkend="class-pangolayout">pango.Layout</link>
+ <link linkend="class-pangorenderer">pango.Renderer</link>
+ <link linkend="class-gdkpangorenderer">gtk.gdk.PangoRenderer</link>
<link linkend="class-gobjectgpointer">gobject.GPointer</link><!--
<link linkend="class-gtkctreenode">gtk.CTreeNode</link>-->
+cairo.Context
+ <link linkend="class-pangocairocairocontext">pangocairo.CairoContext</link>
+ <link linkend="class-gdkcairocontext">gtk.gdk.CairoContext</link>
</synopsis>
diff --git a/docs/reference/pygtk-pango-classes.xml b/docs/reference/pygtk-pango-classes.xml
index 189a57b3..80e0203a 100644
--- a/docs/reference/pygtk-pango-classes.xml
+++ b/docs/reference/pygtk-pango-classes.xml
@@ -23,6 +23,8 @@
<xi:include href="pygtk-pangolanguage.xml"/>
<xi:include href="pygtk-pangolayout.xml"/>
<xi:include href="pygtk-pangolayoutiter.xml"/>
+ <xi:include href="pygtk-pangolayoutline.xml"/>
+ <xi:include href="pygtk-pangorenderer.xml"/>
<xi:include href="pygtk-pangotabarray.xml"/>
<xi:include href="pygtk-pango-markup.xml"/>
<xi:include href="pygtk-pango-functions.xml"/>
diff --git a/docs/reference/pygtk-pango-constants.xml b/docs/reference/pygtk-pango-constants.xml
index c89af664..5519ebb5 100644
--- a/docs/reference/pygtk-pango-constants.xml
+++ b/docs/reference/pygtk-pango-constants.xml
@@ -18,6 +18,7 @@
<xref linkend="pango-direction-constants" endterm="pango-direction-constants-title"></xref>
<xref linkend="pango-ellipsize-mode-constants" endterm="pango-ellipsize-mode-constants-title"></xref>
<xref linkend="pango-font-mask-constants" endterm="pango-font-mask-constants-title"></xref>
+<xref linkend="pango-render-part-constants" endterm="pango-render-part-constants-title"></xref>
<xref linkend="pango-scale-constants" endterm="pango-scale-constants-title"></xref>
<xref linkend="pango-stretch-constants" endterm="pango-stretch-constants-title"></xref>
<xref linkend="pango-style-constants" endterm="pango-style-constants-title"></xref>
@@ -397,6 +398,48 @@ that have been set.</para>
</refsect2>
+ <refsect2 id="pango-render-part-constants">
+ <title id="pango-render-part-constants-title">Pango Render Part Constants</title>
+
+ <para></para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>pango.RENDER_PART</literal></term>
+ <listitem>
+ <simpara>The <literal>pango.RENDER_PART</literal> constants
+define different items to render for purposes such as setting
+colors. Available since PyGTK 2.8.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>pango.RENDER_PART_FOREGROUND</literal></term>
+ <listitem>
+ <simpara>The text itself.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>pango.RENDER_PART_BACKGROUND</literal></term>
+ <listitem>
+ <simpara>The area behind the text.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>pango.RENDER_PART_UNDERLINE</literal></term>
+ <listitem>
+ <simpara>The underlined areas.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>pango.RENDER_PART_STRIKETHROUGH</literal></term>
+ <listitem>
+ <simpara>The strikethrough areas.</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect2>
+
<refsect2 id="pango-scale-constants">
<title id="pango-scale-constants-title">Pango Scale Constants</title>
@@ -426,7 +469,7 @@ that have been set.</para>
<varlistentry>
<term><literal>pango.SCALE_X_SMALL</literal></term>
<listitem>
- <simpara>he scale factor for two shrinking steps
+ <simpara>The scale factor for two shrinking steps
(1 / (1.2 * 1.2)).</simpara>
</listitem>
</varlistentry>
diff --git a/docs/reference/pygtk-pangolayout.xml b/docs/reference/pygtk-pangolayout.xml
index 66114a57..c53a7437 100644
--- a/docs/reference/pygtk-pangolayout.xml
+++ b/docs/reference/pygtk-pangolayout.xml
@@ -205,15 +205,15 @@ linkend="method-pangolayout--get-pixel-size">get_pixel_size</link></methodname>
<methodname><link
linkend="method-pangolayout--get-line-count">get_line_count</link></methodname>
<methodparam></methodparam> </methodsynopsis>
-
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-pangolayout--get-line">get_line</link></methodname>
+ <methodparam><parameter role="keyword">line</parameter></methodparam>
+ </methodsynopsis>
<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
- <methodname><link linkend="method-pangolayout- -get-line">get_line</link></methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
<methodname><link linkend="method-pangolayout- -get-lines">get_lines</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
+ <methodparam></methodparam>
+ </methodsynopsis>
END NOT IMPLEMENTED -->
<methodsynopsis language="python">
<methodname><link linkend="method-pangolayout--get-iter">get_iter</link></methodname>
@@ -1226,33 +1226,40 @@ count of lines in the layout.</para>
</refsect2>
- <!-- NOT IMPLEMENTED
- <refsect2 id="method-pangolayout- -get-line">
- <title>pango.Layout.get_line</title>
+ <refsect2 id="method-pangolayout--get-line">
+ <title>pango.Layout.get_line</title>
-<programlisting><methodsynopsis language="python">
- <methodname>get_line</methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a line, which must be between 0 and
-pango_layout_get_line_count(layout) - 1, inclusive.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the requested <literal>PangoLayoutLine</literal>, or <literal>NULL</literal> if the
-index is out of range. This layout line can
-be ref'ed and retained, but will become invalid
-if changes are made to the <link linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Retrieves a particular line from a <link linkend="class-pangolayout"><classname>pango.Layout</classname></link>.
-</para> </refsect2>
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_line</methodname>
+ <methodparam><parameter role="keyword">line</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">line</parameter>&nbsp;:</term>
+ <listitem><simpara>the index of a line, which must be between 0 and
+layout.get_line_count() - 1, inclusive.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>the requested <link
+linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>,
+ or <literal>None</literal> if the index is out of range.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.8 and above.</para>
+ </note>
+ <para>The <methodname>get_line</methodname>() method returns the line
+with the index number specified by <parameter>line</parameter> from the
+layout. The returned layout line will become invalid if changes are made to
+the <link
+linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</para>
+
+ </refsect2>
+ <!-- NOT IMPLEMENTED
<refsect2 id="method-pangolayout- -get-lines">
<title>pango.Layout.get_lines</title>
diff --git a/docs/reference/pygtk-pangolayoutiter.xml b/docs/reference/pygtk-pangolayoutiter.xml
index fd301a0c..a6a0c71c 100644
--- a/docs/reference/pygtk-pangolayoutiter.xml
+++ b/docs/reference/pygtk-pangolayoutiter.xml
@@ -87,6 +87,11 @@ linkend="method-pangolayoutiter--get-run-extents">get_run_extents</link></method
linkend="method-pangolayoutiter--get-line-yrange">get_line_yrange</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link
+linkend="method-pangolayoutiter--get-line-yrange">get_line</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
@@ -437,6 +442,32 @@ coordinates (origin at top left of the entire layout).</para>
</refsect2>
+ <refsect2 id="method-pangolayoutiter--get-line">
+ <title>pango.LayoutIter.get_line</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_line</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a <link
+linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
+containing the current line.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.8 and above.</para>
+ </note>
+
+ <para>The <methodname>get_line</methodname>() method returns a <link
+linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
+containing the current line.</para>
+
+ </refsect2>
+
</refsect1>
</refentry>
diff --git a/docs/reference/pygtk2-ref.xml b/docs/reference/pygtk2-ref.xml
index 716a4070..045867f4 100644
--- a/docs/reference/pygtk2-ref.xml
+++ b/docs/reference/pygtk2-ref.xml
@@ -4,10 +4,10 @@
]>
<book id="pygtk-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
- <pubdate>September 7, 2005</pubdate>
+ <pubdate>September 17, 2005</pubdate>
<title>PyGTK 2.0 Reference Manual</title>
- <edition>PyGTK Reference Manual version 2.8.0 for PyGTK 2.8.x</edition>
- <releaseinfo>Version 2.8.0</releaseinfo>
+ <edition>PyGTK Reference Manual version 2.8.1 for PyGTK 2.8.x</edition>
+ <releaseinfo>Version 2.8.1</releaseinfo>
<authorgroup>
<author>
<firstname>John</firstname>
@@ -20,6 +20,11 @@ module.</para>
</abstract>
<!-- <revhistory>
<revision>
+ <revnumber>2.8.1</revnumber>
+ <date>September 17, 2005</date>
+ <revremark>Release covering PyGTK 2.8.x (GTK+ 2.8)</revremark>
+ </revision>
+ <revision>
<revnumber>2.8.0</revnumber>
<date>September 7, 2005</date>
<revremark>Release covering PyGTK 2.8.x (GTK+ 2.8)</revremark>
@@ -142,6 +147,7 @@ module.</para>
<xi:include href="pygtk-gdk-classes.xml"/>
<xi:include href="pygtk-glade-classes.xml"/>
<xi:include href="pygtk-pango-classes.xml"/>
+ <xi:include href="pygtk-pangocairo-classes.xml"/>
<!--
<xi:include href="pygtk-atk-classes.xml"/>
-->