diff -r 9b0f74b6b3d9 -r 884a5385bb2c doc/reference/pidgin/signals_gtkconv.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/reference/pidgin/signals_gtkconv.xml Fri Jan 31 17:31:59 2014 +0530 @@ -0,0 +1,330 @@ + + + +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 + +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. + + + + + + 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. + + + + + + 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. + + +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. + + + + + + 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. + + + + + + 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. + + +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. + + + + + + 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. + + + + + + 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. + + + + + + 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. + + + + + + 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. + + + + + + +