summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDieter Verfaillie <dieterv@optionexplicit.be>2011-02-21 22:02:35 +0100
committerDieter Verfaillie <dieterv@optionexplicit.be>2011-02-21 22:02:35 +0100
commit44537210ec9ba18e28c5923999331aedf521f145 (patch)
treef84dd5df280d41cf7c3cae0eb9a0b3c77693d4b3 /docs
parentc7efda1b6b5a27b8a718ded29d892f4add1cfaab (diff)
downloadpygtk-44537210ec9ba18e28c5923999331aedf521f145.tar.gz
reference: pygtk-gtkaboutdialog.xml: add new activate-link signal
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/pygtk-gtkaboutdialog.xml67
1 files changed, 62 insertions, 5 deletions
diff --git a/docs/reference/pygtk-gtkaboutdialog.xml b/docs/reference/pygtk-gtkaboutdialog.xml
index 0192d591..5842161b 100644
--- a/docs/reference/pygtk-gtkaboutdialog.xml
+++ b/docs/reference/pygtk-gtkaboutdialog.xml
@@ -312,6 +312,21 @@ This property is available in GTK+ 2.6 and above.</entry>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
+
+ <variablelist>
+ <varlistentry>
+ <term>"<link linkend="signal-gtkaboutdialog--activate-link">activate-link</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>aboutdialog</parameter></methodparam>
+ <methodparam><parameter>uri</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
</refsect1>
<refsect1>
@@ -1261,11 +1276,11 @@ activated.</simpara></listitem>
<note>
<para>This function is available in PyGTK 2.6 and above.</para>
</note>
-
+
<para>The <function>gtk.about_dialog_set_url_hook</function> function
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>
@@ -1279,9 +1294,51 @@ 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>
-
+
+ <refsect1>
+ <title>Signals</title>
+
+ <refsect2 id="signal-gtkaboutdialog--activate-link">
+ <title>The "activate-link" gtk.AboutDialog Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>aboutdialog</parameter></methodparam>
+ <methodparam><parameter>uri</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>aboutdialog</parameter>&nbsp;:</term>
+ <listitem><simpara>the aboutdialog that received the signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>uri</parameter>&nbsp;:</term>
+ <listitem><simpara>the URI that is activated</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter>&nbsp;:</term>
+ <listitem><simpara>the first user parameter (if any) specified with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link> method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter>&nbsp;:</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <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>
+
+ </refsect2>
+ </refsect1>
+
</refentry>