Mercurial > pidgin3 / file comparison

comparison: doc/reference/pidgin/signals_gtkimhtml.xml

doc/reference/pidgin/signals_gtkimhtml.xml

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

Mercurial Repository: pidgin3

mercurial