--- a/doc/reference/pidgin/signals_gtkconv.xml Tue Oct 22 22:23:13 2013 +0530
+++ b/doc/reference/pidgin/signals_gtkconv.xml Tue Oct 22 22:38:49 2013 +0530
@@ -25,10 +25,11 @@
<refsect2 id="gtkconvs-conversation-dragging" role="signal">
<title>The <literal>"conversation-dragging"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PidginWindow *source,
PidginWindow *destination,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted when a conversation is being drag and dropped between windows.
</para>
@@ -50,11 +51,12 @@
<refsect2 id="gtkconvs-conversation-timestamp" role="signal">
<title>The <literal>"conversation-timestamp"</literal> signal</title>
- <programlisting>
+<programlisting>
char * user_function (PurpleConversation *conv,
time_t when,
gboolean show_date,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted to allow plugins to customize the timestamp on a message.
</para>
@@ -84,19 +86,20 @@
<refsect2 id="gtkconvs-displaying-im-msg" role="signal">
<title>The <literal>"displaying-im-msg"</literal> signal</title>
- <programlisting>
+<programlisting>
gboolean user_function (PurpleAccount *account,
const char *who,
char **message,
PurpleConversation *conv,
PurpleMessageFlags flags,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
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>.
</para>
- <para><emphasis>Note</emphasis> :
+ <note><para>
Make sure to free <literal>*message</literal> before you replace it!
- </para>
+ </para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
@@ -131,13 +134,14 @@
<refsect2 id="gtkconvs-displayed-im-msg" role="signal">
<title>The <literal>"displayed-im-msg"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PurpleAccount *account,
const char *who,
char *message,
PurpleConversation *conv,
PurpleMessageFlags flags,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted after a message is displayed in an IM conversation.
</para>
@@ -171,19 +175,20 @@
<refsect2 id="gtkconvs-displaying-chat-msg" role="signal">
<title>The <literal>"displaying-chat-msg"</literal> signal</title>
- <programlisting>
+<programlisting>
gboolean user_function (PurpleAccount *account,
const char *who,
char **message,
PurpleConversation *conv,
PurpleMessageFlags flags,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
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>.
</para>
- <para><emphasis>Note</emphasis> :
+ <note><para>
Make sure to free <literal>*message</literal> before you replace it!
- </para>
+ </para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
@@ -218,13 +223,14 @@
<refsect2 id="gtkconvs-displayed-chat-msg" role="signal">
<title>The <literal>"displayed-chat-msg"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PurpleAccount *account,
const char *who,
char *message,
PurpleConversation *conv,
PurpleMessageFlags flags,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted after a message is displayed in a chat conversation.
</para>
@@ -258,9 +264,10 @@
<refsect2 id="gtkconvs-conversation-switched" role="signal">
<title>The <literal>"conversation-switched"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PurpleConversation *conv,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted when a window switched from one conversation to another.
</para>
@@ -278,9 +285,10 @@
<refsect2 id="gtkconvs-conversation-hiding" role="signal">
<title>The <literal>"conversation-hiding"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PidginConversation *gtkconv,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted immediately before an existing conversation is hidden.
</para>
@@ -298,9 +306,10 @@
<refsect2 id="gtkconvs-conversation-displayed" role="signal">
<title>The <literal>"conversation-displayed"</literal> signal</title>
- <programlisting>
+<programlisting>
void user_function (PidginConversation *gtkconv,
- gpointer user_data)</programlisting>
+ gpointer user_data)
+</programlisting>
<para>
Emitted right after the Pidgin UI is attached to a new or a hidden conversation.
</para>