diff -r 254e2d4e6056 -r 13cf9f35c2aa doc/reference/pidgin/signals_gtkconv.xml --- a/doc/reference/pidgin/signals_gtkconv.xml Tue Oct 22 02:51:40 2013 +0530 +++ b/doc/reference/pidgin/signals_gtkconv.xml Tue Oct 22 02:52:36 2013 +0530 @@ -3,146 +3,319 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ ]> - Conversation signals +Conversation signals + +List of signals + + "conversation-dragging" + "conversation-timestamp" + "displaying-im-msg" + "displayed-im-msg" + "displaying-chat-msg" + "displayed-chat-msg" + "conversation-switched" + "conversation-hiding" + "conversation-displayed" + + + + +Signal details + + + The <literal>"conversation-dragging"</literal> signal - @signals - @signal conversation-dragging - @signal conversation-timestamp - @signal displaying-im-msg - @signal displayed-im-msg - @signal displaying-chat-msg - @signal displayed-chat-msg - @signal conversation-switched - @signal conversation-hiding - @signal conversation-displayed - @endsignals - - @see gtkconv.h - - @signaldef conversation-dragging - @signalproto -void (*conversation_dragging)(PidginWindow *source, PidginWindow *destination); - @endsignalproto - @signaldesc - Emitted when a conversation is being drag and dropped between windows. - @param source The window where the conversation is. - @param destination The window where the conversation will be moved to. - @endsignaldef +void user_function (PidginWindow *source, + PidginWindow *destination, + gpointer user_data) + +Emitted when a conversation is being drag and dropped between windows. + + + + source : + The window where the conversation is. + + + destination : + The window where the conversation will be moved to. + + + user_data : + user data set when the signal handler was connected. + + + - @signaldef conversation-timestamp - @signalproto -char *(*conversation_timestamp)(PurpleConversation *conv, time_t when, - gboolean show_date); - @endsignalproto - @signaldesc - Emitted to allow plugins to customize the timestamp on a message. - @param conv The conversation the message belongs to. - @param when The time to be converted to a string. - @param show_date Whether the date should be displayed. - @return A textual representation of the time, or @c NULL to use a - default format. - @endsignaldef - + + The <literal>"conversation-timestamp"</literal> signal + +char * user_function (PurpleConversation *conv, + time_t when, + gboolean show_date, + gpointer user_data) + +Emitted to allow plugins to customize the timestamp on a message. + + + + conv : + The conversation the message belongs to. + + + when : + The time to be converted to a string. + + + show_date : + Whether the date should be displayed. + + + user_data : + user data set when the signal handler was connected. + + + Returns : + A textual representation of the time, or NULL to use a default format. + + + - @signaldef displaying-im-msg - @signalproto -gboolean (*displaying_im_msg)(PurpleAccount *account, const char *who, - char **message, PurpleConversation *conv, - PurpleMessageFlags flags); - @endsignalproto - @signaldesc - Emitted just before a message is displayed in an IM conversation. - @a message 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 @c TRUE. - @note - Make sure to free @a *message before you replace it! - @param account The account. - @param who The name of the user. - @param message A pointer to the message. - @param conv The conversation. - @param flags Flags for this message. - @return @c TRUE if the message should be canceled, or @c FALSE otherwise. - @endsignaldef + + The <literal>"displaying-im-msg"</literal> signal + +gboolean user_function (PurpleAccount *account, + const char *who, + char **message, + PurpleConversation *conv, + PurpleMessageFlags flags, + gpointer user_data) + +Emitted just before a message is displayed in an IM conversation. message 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 TRUE. + + Note : +Make sure to free *message before you replace it! + + + + account : + The account. + + + who : + The name of the user. + + + message : + A pointer to the message. + + + conv : + The conversation. + + + flags : + Flags for this message. + + + user_data : + user data set when the signal handler was connected. + + + Returns : + TRUE if the message should be canceled, or FALSE otherwise. + + + - @signaldef displayed-im-msg - @signalproto -void (*displayed_im_msg)(PurpleAccount *account, const char *who, - char *message, PurpleConversation *conv, - PurpleMessageFlags flags); - @endsignalproto - @signaldesc - Emitted after a message is displayed in an IM conversation. - @param account The account. - @param who The name of the user. - @param message The message. - @param conv The conversation. - @param flags Flags for this message. - @endsignaldef + + The <literal>"displayed-im-msg"</literal> signal + +void user_function (PurpleAccount *account, + const char *who, + char *message, + PurpleConversation *conv, + PurpleMessageFlags flags, + gpointer user_data) + +Emitted after a message is displayed in an IM conversation. + + + + account : + The account. + + + who : + The name of the user. + + + message : + The message. + + + conv : + The conversation. + + + flags : + Flags for this message. + + + user_data : + user data set when the signal handler was connected. + + + - @signaldef displaying-chat-msg - @signalproto -gboolean (*displaying_chat_msg)(PurpleAccount *account, const char *who, - char **message, PurpleConversation *conv, - PurpleMessageFlags flags); - @endsignalproto - @signaldesc - Emitted just before a message is displayed in a chat. - @a message 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 @c TRUE. - @note - Make sure to free @a *message before you replace it! - @param account The account the message is being displayed and sent on. - @param who The name of the user. - @param message A pointer to the message that will be displayed and sent. - @param conv The conversation the message is being displayed and sent on. - @param flags Flags for this message. - @return @c TRUE if the message should be canceled, or @c FALSE otherwise. - @endsignaldef + + The <literal>"displaying-chat-msg"</literal> signal + +gboolean user_function (PurpleAccount *account, + const char *who, + char **message, + PurpleConversation *conv, + PurpleMessageFlags flags, + gpointer user_data) + +Emitted just before a message is displayed in a chat. message 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 TRUE. + + Note : +Make sure to free *message before you replace it! + + + + account : + The account the message is being displayed and sent on. + + + who : + The name of the user. + + + message : + A pointer to the message that will be displayed and sent. + + + conv : + The conversation the message is being displayed and sent on. + + + flags : + Flags for this message. + + + user_data : + user data set when the signal handler was connected. + + + Returns : + TRUE if the message should be canceled, or FALSE otherwise. + + + - @signaldef displayed-chat-msg - @signalproto -void (*displayed_chat_msg)(PurpleAccount *account, const char *who, - char *message, PurpleConversation *conv, - PurpleMessageFlags flags); - @endsignalproto - @signaldesc - Emitted after a message is displayed in a chat conversation. - @param account The account the message is being displayed and sent on. - @param who The name of the user. - @param message A pointer to the message that will be displayed and sent. - @param conv The conversation the message is being displayed and sent on. - @param flags Flags for this message. - @endsignaldef + + The <literal>"displayed-chat-msg"</literal> signal + +void user_function (PurpleAccount *account, + const char *who, + char *message, + PurpleConversation *conv, + PurpleMessageFlags flags, + gpointer user_data) + +Emitted after a message is displayed in a chat conversation. + + + + account : + The account the message is being displayed and sent on. + + + who : + The name of the user. + + + message : + A pointer to the message that will be displayed and sent. + + + conv : + The conversation the message is being displayed and sent on. + + + flags : + Flags for this message. + + + user_data : + user data set when the signal handler was connected. + + + - @signaldef conversation-switched - @signalproto -void (*conversation_switched)(PurpleConversation *conv); - @endsignalproto - @signaldesc - Emitted when a window switched from one conversation to another. - @param new_conv The now active conversation. - @endsignaldef + + The <literal>"conversation-switched"</literal> signal + +void user_function (PurpleConversation *conv, + gpointer user_data) + +Emitted when a window switched from one conversation to another. + + + + new_conv : + The now active conversation. + + + user_data : + user data set when the signal handler was connected. + + + - @signaldef conversation-hiding - @signalproto -void (*conversation_hiding)(PidginConversation *gtkconv); - @endsignalproto - @signaldesc - Emitted immediately before an existing conversation is hidden. - @param gtkconv The PidginConversation - @endsignaldef + + The <literal>"conversation-hiding"</literal> signal + +void user_function (PidginConversation *gtkconv, + gpointer user_data) + +Emitted immediately before an existing conversation is hidden. + + + + gtkconv : + The PidginConversation. + + + user_data : + user data set when the signal handler was connected. + + + - @signaldef conversation-displayed - @signalproto -void (*conversation_displayed)(PidginConversation *gtkconv); - @endsignalproto - @signaldesc - Emitted right after the Pidgin UI is attached to a new or a hidden conversation. - @param gtkconv The PidginConversation - @endsignaldef + + The <literal>"conversation-displayed"</literal> signal + +void user_function (PidginConversation *gtkconv, + gpointer user_data) + +Emitted right after the Pidgin UI is attached to a new or a hidden conversation. + + + + gtkconv : + The PidginConversation. + + + user_data : + user data set when the signal handler was connected. + + + - + +