summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDieter Verfaillie <dieterv@optionexplicit.be>2011-03-01 06:44:09 +0100
committerDieter Verfaillie <dieterv@optionexplicit.be>2011-03-01 06:44:09 +0100
commit8876741af912fdd039994ccd59072a87ef1edf76 (patch)
treeef7c8b37a10d6104eef05b260812bdf353c6a298 /docs
parenta17e452739a39f15d617ea643a370a6ed673b66b (diff)
downloadpygtk-8876741af912fdd039994ccd59072a87ef1edf76.tar.gz
reference: pygtk-gtkfunctions: move gtk.show_uri from pygtk-gtkmountoperation
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/pygtk-gtk-functions.xml63
-rw-r--r--docs/reference/pygtk-gtkaboutdialog.xml3
-rw-r--r--docs/reference/pygtk-gtkmountoperation.xml67
3 files changed, 64 insertions, 69 deletions
diff --git a/docs/reference/pygtk-gtk-functions.xml b/docs/reference/pygtk-gtk-functions.xml
index 1f534c7d..571432f8 100644
--- a/docs/reference/pygtk-gtk-functions.xml
+++ b/docs/reference/pygtk-gtk-functions.xml
@@ -778,7 +778,14 @@ linkend="function-gtk--add-log-handlers">gtk.add_log_handlers</link></methodname
<methodname><link
linkend="function-gtk--set-interactive">gtk.set_interactive</link></methodname>
<methodparam><parameter>interactive</parameter></methodparam>
- </methodsynopsis></programlisting>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link
+linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ <methodparam><parameter role="keyword">uri</parameter></methodparam>
+ <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
+ </methodsynopsis>
+</programlisting>
</refsect2>
@@ -1426,6 +1433,60 @@ results immediately without having to call <function>gtk.main</function>().</par
</refsect2>
+ <refsect2 id="function-gtk--show-uri">
+ <title>gtk.show_uri</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>show_uri</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>uri</parameter></methodparam>
+ <methodparam><parameter>timestamp</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>
+ to show the uri on or <literal>None</literal> for the default screen.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
+ <listitem><simpara>the uri to show.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">timestamp</parameter>&nbsp;:</term>
+ <listitem><simpara>a timestamp to prevent focus stealing.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>show_uri</methodname>() function is a convenience
+ function for launching the default application to show the uri.
+ The uri must be of a form understood by GIO. Typical examples are:
+ </para>
+<programlisting>
+file:///home/gnome/pict.jpg
+http://www.gnome.org
+mailto:me@gnome.org
+</programlisting>
+
+ <para>
+ Ideally the timestamp is taken from the event triggering the
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
+ call. If timestamp is not known you can take gtk.gdk.CURRENT_TIME.
+ </para>
+ <para>
+ This function can be used as a replacement for gnome_vfs_url_show() and gnome_url_show().
+ </para>
+ </refsect2>
+
</refsect1>
</refentry>
diff --git a/docs/reference/pygtk-gtkaboutdialog.xml b/docs/reference/pygtk-gtkaboutdialog.xml
index 5842161b..7b9842f2 100644
--- a/docs/reference/pygtk-gtkaboutdialog.xml
+++ b/docs/reference/pygtk-gtkaboutdialog.xml
@@ -1336,7 +1336,8 @@ linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set
<para>This signal is available in PyGTK 2.24 and above.</para>
</note>
- <para>The "activate-link" signal is emitted when an URI is activated. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri().</para>
+ <para>The "activate-link" signal is emitted when an URI is activated. Applications may connect to it to override the default behaviour, which is to call
+ <link linkend="function-gtk--show-uri"><methodname>gtk.show_uri</methodname></link>().</para>
</refsect2>
</refsect1>
diff --git a/docs/reference/pygtk-gtkmountoperation.xml b/docs/reference/pygtk-gtkmountoperation.xml
index 0025fb8c..dac9305a 100644
--- a/docs/reference/pygtk-gtkmountoperation.xml
+++ b/docs/reference/pygtk-gtkmountoperation.xml
@@ -38,16 +38,6 @@
</classsynopsis>
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
-
</refsect1>
<refsect1>
@@ -284,61 +274,4 @@
</para>
</refsect2>
</refsect1>
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--show-uri">
- <title>gtk.show_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_uri</methodname>
- <methodparam><parameter>screen</parameter></methodparam>
- <methodparam><parameter>uri</parameter></methodparam>
- <methodparam><parameter>timestamp</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>
- to show the uri on or <literal>None</literal> for the default screen.
- </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the uri to show.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp to prevent focus stealing.
- </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.14 and above.</para>
- </note>
-
- <para>
- The <methodname>show_uri</methodname>() function is a convenience
- function for launching the default application to show the uri.
- The uri must be of a form understood by GIO. Typical examples are:
- </para>
-<programlisting>
-file:///home/gnome/pict.jpg
-http://www.gnome.org
-mailto:me@gnome.org
-</programlisting>
-
- <para>
- Ideally the timestamp is taken from the event triggering the
- <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
- call. If timestamp is not known you can take gtk.gdk.CURRENT_TIME.
- </para>
- <para>
- This function can be used as a replacement for gnome_vfs_url_show() and gnome_url_show().
- </para>
- </refsect2>
- </refsect1>
</refentry>