comparison: doc/reference/pidgin/signals_gtkconv.xml
doc/reference/pidgin/signals_gtkconv.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-gtkconv"> | |
| 6 <title>Conversation signals</title> | |
| 7 | |
| 8 <refsect1 id="gtkconvs.signals" role="signal_proto"> | |
| 9 <title role="signal_proto.title">List of signals</title> | |
| 10 <synopsis> | |
| 11 "<link linkend="gtkconvs-conversation-dragging">conversation-dragging</link>" | |
| 12 "<link linkend="gtkconvs-conversation-timestamp">conversation-timestamp</link>" | |
| 13 "<link linkend="gtkconvs-displaying-im-msg">displaying-im-msg</link>" | |
| 14 "<link linkend="gtkconvs-displayed-im-msg">displayed-im-msg</link>" | |
| 15 "<link linkend="gtkconvs-displaying-chat-msg">displaying-chat-msg</link>" | |
| 16 "<link linkend="gtkconvs-displayed-chat-msg">displayed-chat-msg</link>" | |
| 17 "<link linkend="gtkconvs-conversation-switched">conversation-switched</link>" | |
| 18 "<link linkend="gtkconvs-conversation-hiding">conversation-hiding</link>" | |
| 19 "<link linkend="gtkconvs-conversation-displayed">conversation-displayed</link>" | |
| 20 </synopsis> | |
| 21 </refsect1> | |
| 22 | |
| 23 <refsect1 id="gtkconvs.signal-details" role="signals"> | |
| 24 <title role="signals.title">Signal details</title> | |
| 25 | |
| 26 <refsect2 id="gtkconvs-conversation-dragging" role="signal"> | |
| 27 <title>The <literal>"conversation-dragging"</literal> signal</title> | |
| 28 <programlisting> | |
| 29 void user_function (PidginWindow *source, | |
| 30 PidginWindow *destination, | |
| 31 gpointer user_data) | |
| 32 </programlisting> | |
| 33 <para> | |
| 34 Emitted when a conversation is being drag and dropped between windows. | |
| 35 </para> | |
| 36 <variablelist role="params"> | |
| 37 <varlistentry> | |
| 38 <term><parameter>source</parameter> :</term> | |
| 39 <listitem><simpara>The window where the conversation is.</simpara></listitem> | |
| 40 </varlistentry> | |
| 41 <varlistentry> | |
| 42 <term><parameter>destination</parameter> :</term> | |
| 43 <listitem><simpara>The window where the conversation will be moved to.</simpara></listitem> | |
| 44 </varlistentry> | |
| 45 <varlistentry> | |
| 46 <term><parameter>user_data</parameter> :</term> | |
| 47 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 48 </varlistentry> | |
| 49 </variablelist> | |
| 50 </refsect2> | |
| 51 | |
| 52 <refsect2 id="gtkconvs-conversation-timestamp" role="signal"> | |
| 53 <title>The <literal>"conversation-timestamp"</literal> signal</title> | |
| 54 <programlisting> | |
| 55 char * user_function (PurpleConversation *conv, | |
| 56 time_t when, | |
| 57 gboolean show_date, | |
| 58 gpointer user_data) | |
| 59 </programlisting> | |
| 60 <para> | |
| 61 Emitted to allow plugins to customize the timestamp on a message. | |
| 62 </para> | |
| 63 <variablelist role="params"> | |
| 64 <varlistentry> | |
| 65 <term><parameter>conv</parameter> :</term> | |
| 66 <listitem><simpara>The conversation the message belongs to.</simpara></listitem> | |
| 67 </varlistentry> | |
| 68 <varlistentry> | |
| 69 <term><parameter>when</parameter> :</term> | |
| 70 <listitem><simpara>The time to be converted to a string.</simpara></listitem> | |
| 71 </varlistentry> | |
| 72 <varlistentry> | |
| 73 <term><parameter>show_date</parameter> :</term> | |
| 74 <listitem><simpara>Whether the date should be displayed.</simpara></listitem> | |
| 75 </varlistentry> | |
| 76 <varlistentry> | |
| 77 <term><parameter>user_data</parameter> :</term> | |
| 78 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 79 </varlistentry> | |
| 80 <varlistentry> | |
| 81 <term><emphasis>Returns</emphasis> :</term> | |
| 82 <listitem><simpara>A textual representation of the time, or <literal>NULL</literal> to use a default format.</simpara></listitem> | |
| 83 </varlistentry> | |
| 84 </variablelist> | |
| 85 </refsect2> | |
| 86 | |
| 87 <refsect2 id="gtkconvs-displaying-im-msg" role="signal"> | |
| 88 <title>The <literal>"displaying-im-msg"</literal> signal</title> | |
| 89 <programlisting> | |
| 90 gboolean user_function (PurpleAccount *account, | |
| 91 const char *who, | |
| 92 char **message, | |
| 93 PurpleConversation *conv, | |
| 94 PurpleMessageFlags flags, | |
| 95 gpointer user_data) | |
| 96 </programlisting> | |
| 97 <para> | |
| 98 Emitted just before a message is displayed in an IM conversation. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>. | |
| 99 </para> | |
| 100 <note><para> | |
| 101 Make sure to free <literal>*message</literal> before you replace it! | |
| 102 </para></note> | |
| 103 <variablelist role="params"> | |
| 104 <varlistentry> | |
| 105 <term><parameter>account</parameter> :</term> | |
| 106 <listitem><simpara>The account.</simpara></listitem> | |
| 107 </varlistentry> | |
| 108 <varlistentry> | |
| 109 <term><parameter>who</parameter> :</term> | |
| 110 <listitem><simpara>The name of the user.</simpara></listitem> | |
| 111 </varlistentry> | |
| 112 <varlistentry> | |
| 113 <term><parameter>message</parameter> :</term> | |
| 114 <listitem><simpara>A pointer to the message.</simpara></listitem> | |
| 115 </varlistentry> | |
| 116 <varlistentry> | |
| 117 <term><parameter>conv</parameter> :</term> | |
| 118 <listitem><simpara>The conversation.</simpara></listitem> | |
| 119 </varlistentry> | |
| 120 <varlistentry> | |
| 121 <term><parameter>flags</parameter> :</term> | |
| 122 <listitem><simpara>Flags for this message.</simpara></listitem> | |
| 123 </varlistentry> | |
| 124 <varlistentry> | |
| 125 <term><parameter>user_data</parameter> :</term> | |
| 126 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 127 </varlistentry> | |
| 128 <varlistentry> | |
| 129 <term><emphasis>Returns</emphasis> :</term> | |
| 130 <listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem> | |
| 131 </varlistentry> | |
| 132 </variablelist> | |
| 133 </refsect2> | |
| 134 | |
| 135 <refsect2 id="gtkconvs-displayed-im-msg" role="signal"> | |
| 136 <title>The <literal>"displayed-im-msg"</literal> signal</title> | |
| 137 <programlisting> | |
| 138 void user_function (PurpleAccount *account, | |
| 139 const char *who, | |
| 140 char *message, | |
| 141 PurpleConversation *conv, | |
| 142 PurpleMessageFlags flags, | |
| 143 gpointer user_data) | |
| 144 </programlisting> | |
| 145 <para> | |
| 146 Emitted after a message is displayed in an IM conversation. | |
| 147 </para> | |
| 148 <variablelist role="params"> | |
| 149 <varlistentry> | |
| 150 <term><parameter>account</parameter> :</term> | |
| 151 <listitem><simpara>The account.</simpara></listitem> | |
| 152 </varlistentry> | |
| 153 <varlistentry> | |
| 154 <term><parameter>who</parameter> :</term> | |
| 155 <listitem><simpara>The name of the user.</simpara></listitem> | |
| 156 </varlistentry> | |
| 157 <varlistentry> | |
| 158 <term><parameter>message</parameter> :</term> | |
| 159 <listitem><simpara>The message.</simpara></listitem> | |
| 160 </varlistentry> | |
| 161 <varlistentry> | |
| 162 <term><parameter>conv</parameter> :</term> | |
| 163 <listitem><simpara>The conversation.</simpara></listitem> | |
| 164 </varlistentry> | |
| 165 <varlistentry> | |
| 166 <term><parameter>flags</parameter> :</term> | |
| 167 <listitem><simpara>Flags for this message.</simpara></listitem> | |
| 168 </varlistentry> | |
| 169 <varlistentry> | |
| 170 <term><parameter>user_data</parameter> :</term> | |
| 171 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 172 </varlistentry> | |
| 173 </variablelist> | |
| 174 </refsect2> | |
| 175 | |
| 176 <refsect2 id="gtkconvs-displaying-chat-msg" role="signal"> | |
| 177 <title>The <literal>"displaying-chat-msg"</literal> signal</title> | |
| 178 <programlisting> | |
| 179 gboolean user_function (PurpleAccount *account, | |
| 180 const char *who, | |
| 181 char **message, | |
| 182 PurpleConversation *conv, | |
| 183 PurpleMessageFlags flags, | |
| 184 gpointer user_data) | |
| 185 </programlisting> | |
| 186 <para> | |
| 187 Emitted just before a message is displayed in a chat. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>. | |
| 188 </para> | |
| 189 <note><para> | |
| 190 Make sure to free <literal>*message</literal> before you replace it! | |
| 191 </para></note> | |
| 192 <variablelist role="params"> | |
| 193 <varlistentry> | |
| 194 <term><parameter>account</parameter> :</term> | |
| 195 <listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem> | |
| 196 </varlistentry> | |
| 197 <varlistentry> | |
| 198 <term><parameter>who</parameter> :</term> | |
| 199 <listitem><simpara>The name of the user.</simpara></listitem> | |
| 200 </varlistentry> | |
| 201 <varlistentry> | |
| 202 <term><parameter>message</parameter> :</term> | |
| 203 <listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem> | |
| 204 </varlistentry> | |
| 205 <varlistentry> | |
| 206 <term><parameter>conv</parameter> :</term> | |
| 207 <listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem> | |
| 208 </varlistentry> | |
| 209 <varlistentry> | |
| 210 <term><parameter>flags</parameter> :</term> | |
| 211 <listitem><simpara>Flags for this message.</simpara></listitem> | |
| 212 </varlistentry> | |
| 213 <varlistentry> | |
| 214 <term><parameter>user_data</parameter> :</term> | |
| 215 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 216 </varlistentry> | |
| 217 <varlistentry> | |
| 218 <term><emphasis>Returns</emphasis> :</term> | |
| 219 <listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem> | |
| 220 </varlistentry> | |
| 221 </variablelist> | |
| 222 </refsect2> | |
| 223 | |
| 224 <refsect2 id="gtkconvs-displayed-chat-msg" role="signal"> | |
| 225 <title>The <literal>"displayed-chat-msg"</literal> signal</title> | |
| 226 <programlisting> | |
| 227 void user_function (PurpleAccount *account, | |
| 228 const char *who, | |
| 229 char *message, | |
| 230 PurpleConversation *conv, | |
| 231 PurpleMessageFlags flags, | |
| 232 gpointer user_data) | |
| 233 </programlisting> | |
| 234 <para> | |
| 235 Emitted after a message is displayed in a chat conversation. | |
| 236 </para> | |
| 237 <variablelist role="params"> | |
| 238 <varlistentry> | |
| 239 <term><parameter>account</parameter> :</term> | |
| 240 <listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem> | |
| 241 </varlistentry> | |
| 242 <varlistentry> | |
| 243 <term><parameter>who</parameter> :</term> | |
| 244 <listitem><simpara>The name of the user.</simpara></listitem> | |
| 245 </varlistentry> | |
| 246 <varlistentry> | |
| 247 <term><parameter>message</parameter> :</term> | |
| 248 <listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem> | |
| 249 </varlistentry> | |
| 250 <varlistentry> | |
| 251 <term><parameter>conv</parameter> :</term> | |
| 252 <listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem> | |
| 253 </varlistentry> | |
| 254 <varlistentry> | |
| 255 <term><parameter>flags</parameter> :</term> | |
| 256 <listitem><simpara>Flags for this message.</simpara></listitem> | |
| 257 </varlistentry> | |
| 258 <varlistentry> | |
| 259 <term><parameter>user_data</parameter> :</term> | |
| 260 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 261 </varlistentry> | |
| 262 </variablelist> | |
| 263 </refsect2> | |
| 264 | |
| 265 <refsect2 id="gtkconvs-conversation-switched" role="signal"> | |
| 266 <title>The <literal>"conversation-switched"</literal> signal</title> | |
| 267 <programlisting> | |
| 268 void user_function (PurpleConversation *conv, | |
| 269 gpointer user_data) | |
| 270 </programlisting> | |
| 271 <para> | |
| 272 Emitted when a window switched from one conversation to another. | |
| 273 </para> | |
| 274 <variablelist role="params"> | |
| 275 <varlistentry> | |
| 276 <term><parameter>new_conv</parameter> :</term> | |
| 277 <listitem><simpara>The now active conversation.</simpara></listitem> | |
| 278 </varlistentry> | |
| 279 <varlistentry> | |
| 280 <term><parameter>user_data</parameter> :</term> | |
| 281 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 282 </varlistentry> | |
| 283 </variablelist> | |
| 284 </refsect2> | |
| 285 | |
| 286 <refsect2 id="gtkconvs-conversation-hiding" role="signal"> | |
| 287 <title>The <literal>"conversation-hiding"</literal> signal</title> | |
| 288 <programlisting> | |
| 289 void user_function (PidginConversation *gtkconv, | |
| 290 gpointer user_data) | |
| 291 </programlisting> | |
| 292 <para> | |
| 293 Emitted immediately before an existing conversation is hidden. | |
| 294 </para> | |
| 295 <variablelist role="params"> | |
| 296 <varlistentry> | |
| 297 <term><parameter>gtkconv</parameter> :</term> | |
| 298 <listitem><simpara>The PidginConversation.</simpara></listitem> | |
| 299 </varlistentry> | |
| 300 <varlistentry> | |
| 301 <term><parameter>user_data</parameter> :</term> | |
| 302 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 303 </varlistentry> | |
| 304 </variablelist> | |
| 305 </refsect2> | |
| 306 | |
| 307 <refsect2 id="gtkconvs-conversation-displayed" role="signal"> | |
| 308 <title>The <literal>"conversation-displayed"</literal> signal</title> | |
| 309 <programlisting> | |
| 310 void user_function (PidginConversation *gtkconv, | |
| 311 gpointer user_data) | |
| 312 </programlisting> | |
| 313 <para> | |
| 314 Emitted right after the Pidgin UI is attached to a new or a hidden conversation. | |
| 315 </para> | |
| 316 <variablelist role="params"> | |
| 317 <varlistentry> | |
| 318 <term><parameter>gtkconv</parameter> :</term> | |
| 319 <listitem><simpara>The PidginConversation.</simpara></listitem> | |
| 320 </varlistentry> | |
| 321 <varlistentry> | |
| 322 <term><parameter>user_data</parameter> :</term> | |
| 323 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> | |
| 324 </varlistentry> | |
| 325 </variablelist> | |
| 326 </refsect2> | |
| 327 | |
| 328 </refsect1> | |
| 329 | |
| 330 </chapter> |
