doc/conversation-signals.dox

changeset 6781
655eacaa1353
parent 6610
74bcebaa7c54
child 6838
b6061dc100cf
equal deleted inserted replaced
6780:66775151d7a7 6781:655eacaa1353
27 @signal chat-left 27 @signal chat-left
28 @endsignals 28 @endsignals
29 29
30 @signaldef displaying-im-msg 30 @signaldef displaying-im-msg
31 @signalproto 31 @signalproto
32 gboolean (*displaying_im_msg)(GaimAccount *account, char **message); 32 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
33 @endsignalproto 33 @endsignalproto
34 @signaldesc 34 @signaldesc
35 Emitted just before a message is displayed in an IM conversation. 35 Emitted just before a message is displayed in an IM conversation.
36 @a message is a pointer to a string, so the plugin can replace the 36 @a message is a pointer to a string, so the plugin can replace the
37 message that will be displayed. This can also be used to cancel displaying 37 message that will be displayed. This can also be used to cancel displaying
38 a message by returning @c TRUE. 38 a message by returning @c TRUE.
39 @note 39 @note
40 Make sure to free @a *message before you replace it! 40 Make sure to free @a *message before you replace it!
41 @param account The account the message is being displayed on. 41 @param account The account the message is being displayed on.
42 @param conv The conversation the message is being displayed on.
42 @param message A pointer to the message that will be displayed. 43 @param message A pointer to the message that will be displayed.
43 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. 44 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
44 @endsignaldef 45 @endsignaldef
45 46
46 @signaldef displayed-im-msg 47 @signaldef displayed-im-msg
47 @signalproto 48 @signalproto
48 void (*displayed_im_msg)(GaimAccount *account, const char *message); 49 void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
49 @endsignalproto 50 @endsignalproto
50 @signaldesc 51 @signaldesc
51 Emitted after a message is displayed in an IM conversation. 52 Emitted after a message is displayed in an IM conversation.
52 @param account The account the message was displayed on. 53 @param account The account the message was displayed on.
54 @param conv The conversation the message was displayed on.
53 @param message The message that was displayed. 55 @param message The message that was displayed.
54 @endsignaldef 56 @endsignaldef
55 57
56 @signaldef sending-im-msg 58 @signaldef sending-im-msg
57 @signalproto 59 @signalproto
98 @param message A pointer to the message that was sent. 100 @param message A pointer to the message that was sent.
99 @endsignaldef 101 @endsignaldef
100 102
101 @signaldef displaying-chat-msg 103 @signaldef displaying-chat-msg
102 @signalproto 104 @signalproto
103 gboolean (*displaying_chat_msg)(GaimAccount *account, char **message); 105 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
104 @endsignalproto 106 @endsignalproto
105 @signaldesc 107 @signaldesc
106 Emitted just before a message is displayed in a chat. 108 Emitted just before a message is displayed in a chat.
107 @a message is a pointer to a string, so the plugin can replace the 109 @a message is a pointer to a string, so the plugin can replace the
108 message that will be displayed. This can also be used to cancel displaying 110 message that will be displayed. This can also be used to cancel displaying
109 a message by returning @c TRUE. 111 a message by returning @c TRUE.
110 @note 112 @note
111 Make sure to free @a *message before you replace it! 113 Make sure to free @a *message before you replace it!
112 @param account The account the message is being displayed on. 114 @param account The account the message is being displayed on.
115 @param conv The conversation the message is being displayed on.
113 @param message A pointer to the message that will be displayed. 116 @param message A pointer to the message that will be displayed.
114 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. 117 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
115 @endsignaldef 118 @endsignaldef
116 119
117 @signaldef displayed-chat-msg 120 @signaldef displayed-chat-msg
118 @signalproto 121 @signalproto
119 void (*displayed_chat_msg)(GaimAccount *account, const char *message); 122 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
120 @endsignalproto 123 @endsignalproto
121 @signaldesc 124 @signaldesc
122 Emitted after a message is displayed in a chat conversation. 125 Emitted after a message is displayed in a chat conversation.
123 @param account The account the message was displayed on. 126 @param account The account the message was displayed on.
127 @param conv The conversation the message was displayed on.
124 @param message The message that was displayed. 128 @param message The message that was displayed.
125 @endsignaldef 129 @endsignaldef
126 130
127 @signaldef sending-chat-msg 131 @signaldef sending-chat-msg
128 @signalproto 132 @signalproto

mercurial