Mercurial > pidgin
view doc/gtkconv-signals.dox @ 12897:e9b0c90ce58a
[gaim-migrate @ 15250]
dwightshepherd says in SF Bug #1407720:
"The icon used for the 'clear' option under the
conversation menu is the same icon used for the clear
formating in the formating toolbar. This, imho is
misleadding and can lead to confusion."
I'm changing "Clear" to "Clear Scrollback" in the menu. (I chose "Scrollback" to match `/help clear`.)
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Tue, 17 Jan 2006 00:09:12 +0000 |
parents | a1e241dd50b6 |
children | f09c6e8df82c |
line wrap: on
line source
/** @page gtkconv-signals GtkConv Signals @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 @endsignals <hr> @signaldef conversation-dragging @signalproto void (*conversation_dragging)(GaimGtkWindow *source, GaimGtkWindow *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 @signaldef conversation-timestamp @signalproto char *(*conversation_timestamp)(GaimConversation *conv, struct tm *tm); @endsignalproto @signaldesc Emitted to allow plugins to customize the timestamp on a message. @param conv The conversation the message belongs to. @param tm The time to be converted to a string. @return A textual representation of the time, or @c NULL to use a default format. @endsignaldef @signaldef displaying-im-msg @signalproto gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message, GaimMessageFlags 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 the message is being displayed on. @param conv The conversation the message is being displayed on. @param message A pointer to the message that will be displayed. @param flags The message flags. @return @c TRUE if the message should be canceled, or @c FALSE otherwise. @endsignaldef @signaldef displayed-im-msg @signalproto void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message, GaimMessageFlags flags); @endsignalproto @signaldesc Emitted after a message is displayed in an IM conversation. @param account The account the message was displayed on. @param conv The conversation the message was displayed on. @param message The message that was displayed. @param flags The message flags. @endsignaldef @signaldef displaying-chat-msg @signalproto gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message, GaimMessageFlags 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 on. @param conv The conversation the message is being displayed on. @param message A pointer to the message that will be displayed. @param flags The message flags. @return @c TRUE if the message should be canceled, or @c FALSE otherwise. @endsignaldef @signaldef displayed-chat-msg @signalproto void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message, GaimMessageFlags flags); @endsignalproto @signaldesc Emitted after a message is displayed in a chat conversation. @param account The account the message was displayed on. @param conv The conversation the message was displayed on. @param message The message that was displayed. @param flags The message flags. @endsignaldef @signaldef conversation-switched @signalproto void (*conversation_switched)(GaimConversation *conv); @endsignalproto @signaldesc Emitted when a window switched from one conversation to another. @param new_conv The now active conversation. @endsignaldef */ // vim: syntax=c tw=75 et