comparison: doc/reference/pidgin/signals_gtkimhtml.xml
doc/reference/pidgin/signals_gtkimhtml.xml
- branch
- gtkdoc-conversion
- changeset 35389
- 884a5385bb2c
- child 37033
- ce8b96a22ebe
equal
deleted
inserted
replaced
| 35388:9b0f74b6b3d9 | 35389:884a5385bb2c |
|---|---|
| 1 <?xml version='1.0' encoding="ISO-8859-1"?> | |
| 2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
| 3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ | |
| 4 ]> | |
| 5 <chapter id="chapter-signals-gtkimhtml"> | |
| 6 <title>IMHtml signals</title> | |
| 7 | |
| 8 <refsect1 id="gtkimhtml.signals" role="signal_proto"> | |
| 9 <title role="signal_proto.title">List of signals</title> | |
| 10 <synopsis> | |
| 11 "<link linkend="gtkimhtml-url_clicked">url_clicked</link>" | |
| 12 "<link linkend="gtkimhtml-format_buttons_update">format_buttons_update</link>" | |
| 13 "<link linkend="gtkimhtml-format_function_clear">format_function_clear</link>" | |
| 14 "<link linkend="gtkimhtml-format_function_toggle">format_function_toggle</link>" | |
| 15 "<link linkend="gtkimhtml-format_function_update">format_function_update</link>" | |
| 16 "<link linkend="gtkimhtml-paste">paste</link>" | |
| 17 </synopsis> | |
| 18 </refsect1> | |
| 19 | |
| 20 <refsect1 id="gtkimhtml.signal-details" role="signals"> | |
| 21 <title role="signals.title">Signal details</title> | |
| 22 | |
| 23 <refsect2 id="gtkimhtml-url_clicked" role="signal"> | |
| 24 <title>The <literal>"url_clicked"</literal> signal</title> | |
| 25 <programlisting> | |
| 26 void user_function (GtkIMHtml *imhtml, | |
| 27 char *uri, | |
| 28 gpointer user_data) | |
| 29 </programlisting> | |
| 30 <para> | |
| 31 Emitted when a link is clicked. | |
| 32 </para> | |
| 33 <variablelist role="params"> | |
| 34 <varlistentry> | |
| 35 <term><parameter>imhtml</parameter> :</term> | |
| 36 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 37 </varlistentry> | |
| 38 <varlistentry> | |
| 39 <term><parameter>url</parameter> :</term> | |
| 40 <listitem><simpara>The uri.</simpara></listitem> | |
| 41 </varlistentry> | |
| 42 <varlistentry> | |
| 43 <term><parameter>user_data</parameter> :</term> | |
| 44 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 45 </varlistentry> | |
| 46 </variablelist> | |
| 47 </refsect2> | |
| 48 | |
| 49 <refsect2 id="gtkimhtml-format_buttons_update" role="signal"> | |
| 50 <title>The <literal>"format_buttons_update"</literal> signal</title> | |
| 51 <programlisting> | |
| 52 void user_function (GtkIMHtml *imhtml, | |
| 53 GtkIMHtmlButtons buttons, | |
| 54 gpointer data) | |
| 55 </programlisting> | |
| 56 <para> | |
| 57 Emitted when allowed formatting has changed. | |
| 58 </para> | |
| 59 <variablelist role="params"> | |
| 60 <varlistentry> | |
| 61 <term><parameter>imhtml</parameter> :</term> | |
| 62 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 63 </varlistentry> | |
| 64 <varlistentry> | |
| 65 <term><parameter>buttons</parameter> :</term> | |
| 66 <listitem><simpara>GtkIMHtmlButtons for the GtkIMHtml.</simpara></listitem> | |
| 67 </varlistentry> | |
| 68 <varlistentry> | |
| 69 <term><parameter>data</parameter> :</term> | |
| 70 <listitem><simpara>User defined data.</simpara></listitem> | |
| 71 </varlistentry> | |
| 72 </variablelist> | |
| 73 </refsect2> | |
| 74 | |
| 75 <refsect2 id="gtkimhtml-format_function_clear" role="signal"> | |
| 76 <title>The <literal>"format_function_clear"</literal> signal</title> | |
| 77 <programlisting> | |
| 78 void user_function (GtkIMHtml *imhtml, | |
| 79 gpointer data) | |
| 80 </programlisting> | |
| 81 <para> | |
| 82 Emitted when clearing the formatting for the GtkIMHtml. | |
| 83 </para> | |
| 84 <variablelist role="params"> | |
| 85 <varlistentry> | |
| 86 <term><parameter>imhtml</parameter> :</term> | |
| 87 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 88 </varlistentry> | |
| 89 <varlistentry> | |
| 90 <term><parameter>data</parameter> :</term> | |
| 91 <listitem><simpara>User defined data.</simpara></listitem> | |
| 92 </varlistentry> | |
| 93 </variablelist> | |
| 94 </refsect2> | |
| 95 | |
| 96 <refsect2 id="gtkimhtml-format_function_toggle" role="signal"> | |
| 97 <title>The <literal>"format_function_toggle"</literal> signal</title> | |
| 98 <programlisting> | |
| 99 void user_function (GtkIMHtml *imhtml, | |
| 100 GtkIMHtmlButtons buttons, | |
| 101 gpointer data) | |
| 102 </programlisting> | |
| 103 <para> | |
| 104 Emitted when a format has been toggled. | |
| 105 </para> | |
| 106 <variablelist role="params"> | |
| 107 <varlistentry> | |
| 108 <term><parameter>imhtml</parameter> :</term> | |
| 109 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 110 </varlistentry> | |
| 111 <varlistentry> | |
| 112 <term><parameter>buttons</parameter> :</term> | |
| 113 <listitem><simpara>GtkIMHtmlButtons for the GtkIMHtml.</simpara></listitem> | |
| 114 </varlistentry> | |
| 115 <varlistentry> | |
| 116 <term><parameter>data</parameter> :</term> | |
| 117 <listitem><simpara>User defined data.</simpara></listitem> | |
| 118 </varlistentry> | |
| 119 </variablelist> | |
| 120 </refsect2> | |
| 121 | |
| 122 <refsect2 id="gtkimhtml-format_function_update" role="signal"> | |
| 123 <title>The <literal>"format_function_update"</literal> signal</title> | |
| 124 <programlisting> | |
| 125 void user_function (GtkIMHtml *imhtml, | |
| 126 gpointer data) | |
| 127 </programlisting> | |
| 128 <para> | |
| 129 Emitted when the cursor has moved and formatting has changed. | |
| 130 </para> | |
| 131 <variablelist role="params"> | |
| 132 <varlistentry> | |
| 133 <term><parameter>imhtml</parameter> :</term> | |
| 134 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 135 </varlistentry> | |
| 136 <varlistentry> | |
| 137 <term><parameter>data</parameter> :</term> | |
| 138 <listitem><simpara>User defined data.</simpara></listitem> | |
| 139 </varlistentry> | |
| 140 </variablelist> | |
| 141 </refsect2> | |
| 142 | |
| 143 <refsect2 id="gtkimhtml-paste" role="signal"> | |
| 144 <title>The <literal>"paste"</literal> signal</title> | |
| 145 <programlisting> | |
| 146 void user_function (GtkIMHtml *imhtml, | |
| 147 char *format, | |
| 148 gpointer user_data) | |
| 149 </programlisting> | |
| 150 <para> | |
| 151 Emitted when paste from the clipboard is requested. | |
| 152 </para> | |
| 153 <variablelist role="params"> | |
| 154 <varlistentry> | |
| 155 <term><parameter>imhtml</parameter> :</term> | |
| 156 <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem> | |
| 157 </varlistentry> | |
| 158 <varlistentry> | |
| 159 <term><parameter>format</parameter> :</term> | |
| 160 <listitem><simpara>If 'text', then the formatting of the clipboard content will be removed before pasting. If empty or 'html', then the formatting will not be removed. Any other value for this parameter is ignored and nothing is pasted.</simpara></listitem> | |
| 161 </varlistentry> | |
| 162 <varlistentry> | |
| 163 <term><parameter>user_data</parameter> :</term> | |
| 164 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 165 </varlistentry> | |
| 166 </variablelist> | |
| 167 </refsect2> | |
| 168 | |
| 169 </refsect1> | |
| 170 | |
| 171 </chapter> |
