Mercurial > pidgin

comparison doc/conversation-signals.dox @ 6608:bc219e9efb9a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 7132] This is the last bit of documentation I'm doing tonight. I might do some tomorrow, but no promises.. school starts Monday. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Sun, 24 Aug 2003 06:59:35 +0000
parents 34eaa941ecd6
children d470295a4945
comparison
equal deleted inserted replaced
6607:d8fd7c29eaf0 6608:bc219e9efb9a
85 @signaldesc 85 @signaldesc
86 Emitted when an IM is received. The callback can replace the name of the 86 Emitted when an IM is received. The callback can replace the name of the
87 sender, the message, or the flags by modifying the pointer to the 87 sender, the message, or the flags by modifying the pointer to the
88 strings and integer. This can also be used to cancel a message by 88 strings and integer. This can also be used to cancel a message by
89 returning @c TRUE. 89 returning @c TRUE.
90 @note
91 Make sure to free @a *sender and @a *message before you replace them!
90 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. 92 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
91 @param account The account the message was received on. 93 @param account The account the message was received on.
92 @param sender A pointer to the username of the sender. 94 @param sender A pointer to the username of the sender.
93 @param message A pointer to the message that was sent. 95 @param message A pointer to the message that was sent.
94 @endsignaldef 96 @endsignaldef
95 97
96 @signaldef displaying-chat-msg 98 @signaldef displaying-chat-msg
97 @signalproto 99 @signalproto
98 void (*displaying-chat-msg)(GaimConversation *conv); 100 gboolean (*displaying_chat_msg)(GaimAccount *account, char **message);
99 @endsignalproto 101 @endsignalproto
100 @param conv The conversation. 102 @signaldesc
101 @signaldesc 103 Emitted just before a message is displayed in a chat.
102 104 @a message is a pointer to a string, so the plugin can replace the
105 message that will be displayed. This can also be used to cancel displaying
106 a message by returning @c TRUE.
107 @note
108 Make sure to free @a *message before you replace it!
109 @param account The account the message is being displayed on.
110 @param message A pointer to the message that will be displayed.
111 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
103 @endsignaldef 112 @endsignaldef
104 113
105 @signaldef displayed-chat-msg 114 @signaldef displayed-chat-msg
106 @signalproto 115 @signalproto
107 void (*displayed-chat-msg)(GaimConversation *conv); 116 void (*displayed_chat_msg)(GaimAccount *account, const char *message);
108 @endsignalproto 117 @endsignalproto
109 @param conv The conversation. 118 @signaldesc
110 @signaldesc 119 Emitted after a message is displayed in a chat conversation.
111 120 @param account The account the message was displayed on.
121 @param message The message that was displayed.
112 @endsignaldef 122 @endsignaldef
113 123
114 @signaldef sending-chat-msg 124 @signaldef sending-chat-msg
115 @signalproto 125 @signalproto
116 void (*sending-chat-msg)(GaimConversation *conv); 126 void (*sending_chat_msg)(GaimAccount *account, char **message, int id);
117 @endsignalproto 127 @endsignalproto
118 @param conv The conversation. 128 @signaldesc
119 @signaldesc 129 Emitted before sending a message to a chat. @a message is a pointer to the
120 130 message string, so the plugin can replace the message before being sent.
131 @note
132 Make sure to free @a *message before you replace it!
133 @param account The account the message is being sent on.
134 @param message A pointer to the message that will be sent.
135 @param id The ID of the chat.
121 @endsignaldef 136 @endsignaldef
122 137
123 @signaldef sent-chat-msg 138 @signaldef sent-chat-msg
124 @signalproto 139 @signalproto
125 void (*sent-chat-msg)(GaimConversation *conv); 140 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id);
126 @endsignalproto 141 @endsignalproto
127 @param conv The conversation. 142 @signaldesc
128 @signaldesc 143 Emitted after sending a message to a chat.
129 144 @param account The account the message was sent on.
145 @param message The message that was sent.
146 @param id The ID of the chat.
130 @endsignaldef 147 @endsignaldef
131 148
132 @signaldef received-chat-msg 149 @signaldef received-chat-msg
133 @signalproto 150 @signalproto
134 void (*received-chat-msg)(GaimConversation *conv); 151 gboolean (*received_chat_msg)(GaimAccount *account, char **sender, char **message, int id);
135 @endsignalproto 152 @endsignalproto
136 @param conv The conversation. 153 @signaldesc
137 @signaldesc 154 Emitted when a chat message is received. The callback can replace the
138 155 name of the sender or the messageby modifying the pointer to the
156 strings. This can also be used to cancel displaying a message by
157 returning @c TRUE.
158 @note
159 Make sure to free @a *sender and @a *message before you replace them!
160 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
161 @param account The account the message was received on.
162 @param sender A pointer to the username of the sender.
163 @param message A pointer to the message that was sent.
164 @param id The ID of the chat.
139 @endsignaldef 165 @endsignaldef
140 166
141 @signaldef conversation-switching 167 @signaldef conversation-switching
142 @signalproto 168 @signalproto
143 void (*conversation-switching)(GaimConversation *conv); 169 void (*conversation_switching)(GaimConversation *old_conv, GaimConversation *new_conv);
144 @endsignalproto 170 @endsignalproto
145 @param conv The conversation. 171 @signaldesc
146 @signaldesc 172 Emitted when a window is about to switch from one conversation to
147 173 another.
174 @param old_conv The old active conversation.
175 @param new_conv The soon-to-be active conversation
148 @endsignaldef 176 @endsignaldef
149 177
150 @signaldef conversation-switched 178 @signaldef conversation-switched
151 @signalproto 179 @signalproto
152 void (*conversation-switched)(GaimConversation *conv); 180 void (*conversation_switched)(GaimConversation *old_conv, GaimConversation *new_conv);
153 @endsignalproto 181 @endsignalproto
154 @param conv The conversation. 182 @signaldesc
155 @signaldesc 183 Emitted when a window switched from one conversation to another.
156 184 @param old_conv The old active conversation.
185 @param new_conv The now active conversation.
157 @endsignaldef 186 @endsignaldef
158 187
159 @signaldef conversation-created 188 @signaldef conversation-created
160 @signalproto 189 @signalproto
161 void (*conversation-created)(GaimConversation *conv); 190 void (*conversation_created)(GaimConversation *conv);
162 @endsignalproto 191 @endsignalproto
163 @param conv The conversation. 192 @signaldesc
164 @signaldesc 193 Emitted when a new conversation is created.
165 194 @param conv The new conversation.
166 @endsignaldef 195 @endsignaldef
167 196
168 @signaldef deleting-conversation 197 @signaldef deleting-conversation
169 @signalproto 198 @signalproto
170 void (*deleting-conversation)(GaimConversation *conv); 199 void (*deleting_conversation)(GaimConversation *conv);
171 @endsignalproto 200 @endsignalproto
172 @param conv The conversation. 201 @signaldesc
173 @signaldesc 202 Emitted just before a conversation is to be destroyed.
174 203 @param conv The conversation that's about to be destroyed.
175 @endsignaldef 204 @endsignaldef
176 205
177 @signaldef buddy-typing 206 @signaldef buddy-typing
178 @signalproto 207 @signalproto
179 void (*buddy-typing)(GaimConversation *conv); 208 void (*buddy_typing)(GaimConversation *conv);
180 @endsignalproto 209 @endsignalproto
181 @param conv The conversation. 210 @signaldesc
182 @signaldesc 211 Emitted when a buddy starts typing in a conversation window.
183 212 @param conv The IM conversation a buddy is typing in.
184 @endsignaldef 213 @endsignaldef
185 214
186 @signaldef chat-buddy-joining 215 @signaldef chat-buddy-joining
187 @signalproto 216 @signalproto
188 void (*chat-buddy-joining)(GaimConversation *conv); 217 void (*chat_buddy_joining)(GaimConversation *conv, const char *name);
189 @endsignalproto 218 @endsignalproto
190 @param conv The conversation. 219 @signaldesc
191 @signaldesc 220 Emitted when a buddy is joining a chat, before the list of
192 221 users in the chat updates to include the new user.
222 @param conv The chat conversation.
223 @param name The name of the user that is joining the conversation.
193 @endsignaldef 224 @endsignaldef
194 225
195 @signaldef chat-buddy-joined 226 @signaldef chat-buddy-joined
196 @signalproto 227 @signalproto
197 void (*chat-buddy-joined)(GaimConversation *conv); 228 void (*chat_buddy_joined)(GaimConversation *conv, const char *name);
198 @endsignalproto 229 @endsignalproto
199 @param conv The conversation. 230 @signaldesc
200 @signaldesc 231 Emitted when a buddy joined a chat, after the users list is updated.
201 232 @param conv The chat conversation.
202 @endsignaldef 233 @endsignaldef
203 234
204 @signaldef chat-buddy-leaving 235 @signaldef chat-buddy-leaving
205 @signalproto 236 @signalproto
206 void (*chat-buddy-leaving)(GaimConversation *conv); 237 void (*chat_buddy_leaving)(GaimConversation *conv, const char *name, const char *reason);
207 @endsignalproto 238 @endsignalproto
208 @param conv The conversation. 239 @signaldesc
209 @signaldesc 240 Emitted when a user is leaving a chat, before the user list is updated.
210 241 This may include an optional reason why the user is leaving.
242 @param conv The chat conversation.
243 @param name The name of the user that is leaving the chat.
244 @param reason The optional reason why the user is leaving.
211 @endsignaldef 245 @endsignaldef
212 246
213 @signaldef chat-buddy-left 247 @signaldef chat-buddy-left
214 @signalproto 248 @signalproto
215 void (*chat-buddy-left)(GaimConversation *conv); 249 void (*chat_buddy_left)(GaimConversation *conv, const char *name, const char *reason);
216 @endsignalproto 250 @endsignalproto
217 @param conv The conversation. 251 @signaldesc
218 @signaldesc 252 Emitted when a user leaves a chat, after the user list is updated.
219 253 This may include an optional reason why the user is leaving.
254 @param conv The chat conversation.
255 @param name The name of the user that left the chat.
256 @param reason The optional reason why the user left the chat.
220 @endsignaldef 257 @endsignaldef
221 258
222 @signaldef chat-inviting-user 259 @signaldef chat-inviting-user
223 @signalproto 260 @signalproto
224 void (*chat-inviting-user)(GaimConversation *conv); 261 void (*chat_inviting_user)(GaimConversation *conv, const char *name, char **invite_message);
225 @endsignalproto 262 @endsignalproto
226 @param conv The conversation. 263 @signaldesc
227 @signaldesc 264 Emitted when a user is being invited to the chat. The callback can
228 265 replace the invite message to the invitee by modifying the pointer to
266 the invite message.
267 @note
268 Make sure to free @a *invite_message before you replace it!
269 @param conv The chat conversation.
270 @param name The name of the user being invited.
271 @param invite_message A pointer to the reason why a user is being
272 invited.
229 @endsignaldef 273 @endsignaldef
230 274
231 @signaldef chat-invited-user 275 @signaldef chat-invited-user
232 @signalproto 276 @signalproto
233 void (*chat-invited-user)(GaimConversation *conv); 277 void (*chat-invited-user)(GaimConversation *conv);