annotate doc/conversation-signals.dox @ 8078:ab0750ac5154

[gaim-migrate @ 8777] I've been staring at this convo signals stuff for too long. Can someone double check this? committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sun, 11 Jan 2004 23:45:23 +0000
parents 72a795d4b143
children 3c49a619969f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page conversation-signals Conversation Signals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 @signal displaying-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal displayed-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal sending-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal sent-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @signal received-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 @signal displaying-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 @signal displayed-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 @signal sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signal sent-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 @signal received-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @signal conversation-switching
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @signal conversation-switched
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signal conversation-created
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @signal deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @signal buddy-typing
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
19 @signal buddy-typing-stopped
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @signal chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @signal chat-buddy-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @signal chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @signal chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signal chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signal chat-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @signal chat-invited
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signal chat-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @signal chat-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
31 @signaldef writing-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
32 @signalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
33 gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
34 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
35 @signaldesc
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
36 Emitted before a message is displayed in an IM conversation or sent to a remote user.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
37 @a message is a pointer to a string, so the plugin can replace the
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
38 message that will be displayed along with the message that will be sent.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
39 This can also be used to cancel an outgoing message by returning @c TRUE.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
40 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
41 Make sure to free @a *message before you replace it!
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
42 @param account The account the message is being displayed and sent on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
43 @param conv The conversation the message is being displayed and sent on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
44 @param message A pointer to the message that will be displayed and sent.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
45 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
46 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
47
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
48 @signaldef wrote-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
49 @signalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
50 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
51 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
52 @signaldesc
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
53 Emitted after a message is entered by the user, but before it is sent and displyed.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
54 When sending an IM, the order that the im-msg callbacks will be called is:
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
55 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg,
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
56 sending-im-msg, and finally sent-im-msg.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
57 @param account The account the message was displayed on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
58 @param conv The conversation the message was displayed on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
59 @param message The message that was displayed.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
60 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
61
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 @signaldef displaying-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @signalproto
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
64 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 Emitted just before a message is displayed in an IM conversation.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68 @a message is a pointer to a string, so the plugin can replace the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
69 message that will be displayed. This can also be used to cancel displaying
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
70 a message by returning @c TRUE.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
71 @note
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
72 Make sure to free @a *message before you replace it!
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
73 @param account The account the message is being displayed on.
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
74 @param conv The conversation the message is being displayed on.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
75 @param message A pointer to the message that will be displayed.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
76 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
79 @signaldef displayed-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 @signalproto
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
81 void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
83 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
84 Emitted after a message is displayed in an IM conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 @param account The account the message was displayed on.
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
86 @param conv The conversation the message was displayed on.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
87 @param message The message that was displayed.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
88 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
89
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
90 @signaldef sending-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
91 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
92 void (*sending_im_msg)(GaimAccount *account, const char *receiver,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
93 char **message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
94 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
95 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
96 Emitted before sending an IM to a user. @a message is a pointer to the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97 message string, so the plugin can replace the message before being sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 @note
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
99 Make sure to free @a *message before you replace it!
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
100 @param conv The account the message is being sent on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
101 @param receiver The username of the receiver.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
102 @param message A pointer to the outgoing message. This can be modified.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
104
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 @signaldef sent-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
106 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
107 void (*sent_im_msg)(GaimAccount *account, const char *receiver,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
108 const char *message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
109 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
110 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
111 Emitted after sending an IM to a user.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
112 @param account The account the message was sent on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
113 @param receiver The username of the receiver.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
114 @param message The message that was sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
115 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
116
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
117 @signaldef received-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
118 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
119 gboolean (*received_im_msg)(GaimAccount *account, char **sender,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
120 char **message, int *flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
121 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
122 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
123 Emitted when an IM is received. The callback can replace the name of the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
124 sender, the message, or the flags by modifying the pointer to the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
125 strings and integer. This can also be used to cancel a message by
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
126 returning @c TRUE.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
127 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
128 Make sure to free @a *sender and @a *message before you replace them!
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
129 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
130 @param account The account the message was received on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
131 @param sender A pointer to the username of the sender.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
132 @param message A pointer to the message that was sent.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
133 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
134
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
135 @signaldef writing-chat-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
136 @signalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
137 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
138 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
139 @signaldesc
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
140 Emitted before a message is displayed in a chat conversation or sent to
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
141 a remote chat. @a message is a pointer to a string, so the plugin can
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
142 replace the message that will be displayed along with the message that
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
143 will be sent. This can also be used to cancel an outgoing message by
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
144 returning @c TRUE.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
145 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
146 Make sure to free @a *message before you replace it!
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
147 @param account The account the message is being displayed and sent on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
148 @param conv The conversation the message is being displayed and sent on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
149 @param message A pointer to the message that will be displayed and sent.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
150 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
151 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
152
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
153 @signaldef wrote-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
154 @signalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
155 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
156 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
157 @signaldesc
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
158 Emitted after a message is entered by the user, but before it is sent and displyed.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
159 When sending an IM, the order that the im-msg callbacks will be called is:
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
160 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg,
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
161 sending-im-msg, and finally sent-im-msg.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
162 @param account The account the message was displayed on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
163 @param conv The conversation the message was displayed on.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
164 @param message The message that was displayed.
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
165 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
166
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
167 @signaldef displaying-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
168 @signalproto
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
169 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
170 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
171 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
172 Emitted just before a message is displayed in a chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
173 @a message is a pointer to a string, so the plugin can replace the
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
174 message that will be displayed. This can also be used to cancel displaying
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
175 a message by returning @c TRUE.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
176 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
177 Make sure to free @a *message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
178 @param account The account the message is being displayed on.
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
179 @param conv The conversation the message is being displayed on.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
180 @param message A pointer to the message that will be displayed.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
181 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
182 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
183
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
184 @signaldef displayed-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
185 @signalproto
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
186 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
187 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
188 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
189 Emitted after a message is displayed in a chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
190 @param account The account the message was displayed on.
6781
0489da496f33 [gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents: 6610
diff changeset
191 @param conv The conversation the message was displayed on.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
192 @param message The message that was displayed.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
193 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
194
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
195 @signaldef sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
196 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
197 void (*sending_chat_msg)(GaimAccount *account, char **message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
198 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
199 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
200 Emitted before sending a message to a chat. @a message is a pointer to the
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
201 message string, so the plugin can replace the message before being sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
202 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
203 Make sure to free @a *message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
204 @param account The account the message is being sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
205 @param message A pointer to the message that will be sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
206 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
207 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
208
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
209 @signaldef sent-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
210 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
211 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
212 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
213 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
214 Emitted after sending a message to a chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
215 @param account The account the message was sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
216 @param message The message that was sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
217 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
218 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
219
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
220 @signaldef received-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
221 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
222 gboolean (*received_chat_msg)(GaimAccount *account, char **sender,
7512
72a795d4b143 [gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents: 6838
diff changeset
223 char **message, GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
224 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
225 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
226 Emitted when a chat message is received. The callback can replace the
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
227 name of the sender or the messageby modifying the pointer to the
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
228 strings. This can also be used to cancel displaying a message by
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
229 returning @c TRUE.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
230 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
231 Make sure to free @a *sender and @a *message before you replace them!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
232 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
233 @param account The account the message was received on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
234 @param sender A pointer to the username of the sender.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
235 @param message A pointer to the message that was sent.
7512
72a795d4b143 [gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents: 6838
diff changeset
236 @param conv The chat conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
237 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
238
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
239 @signaldef conversation-switching
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
240 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
241 void (*conversation_switching)(GaimConversation *old_conv,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
242 GaimConversation *new_conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
243 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
244 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
245 Emitted when a window is about to switch from one conversation to
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
246 another.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
247 @param old_conv The old active conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
248 @param new_conv The soon-to-be active conversation
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
250
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 @signaldef conversation-switched
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
252 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
253 void (*conversation_switched)(GaimConversation *old_conv,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
254 GaimConversation *new_conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
255 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
256 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
257 Emitted when a window switched from one conversation to another.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
258 @param old_conv The old active conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
259 @param new_conv The now active conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
260 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
261
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
262 @signaldef conversation-created
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
263 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
264 void (*conversation_created)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
265 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
266 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
267 Emitted when a new conversation is created.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
268 @param conv The new conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
269 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
270
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
271 @signaldef deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
272 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
273 void (*deleting_conversation)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
274 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
275 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
276 Emitted just before a conversation is to be destroyed.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
277 @param conv The conversation that's about to be destroyed.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
278 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
279
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
280 @signaldef buddy-typing
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
281 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
282 void (*buddy_typing)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
283 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
284 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
285 Emitted when a buddy starts typing in a conversation window.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
286 @param conv The IM conversation a buddy is typing in.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
287 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
288
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
289 @signaldef buddy-typing-stopped
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
290 @signalproto
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
291 void (*buddy_typing)(GaimConversation *conv);
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
292 @endsignalproto
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
293 @signaldesc
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
294 Emitted when a buddy stops typing in a conversation window.
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
295 @param conv The IM conversation a buddy is typing in.
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
296 @endsignaldef
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
297
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
298 @signaldef chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
299 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
300 void (*chat_buddy_joining)(GaimConversation *conv, const char *name);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
301 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
302 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
303 Emitted when a buddy is joining a chat, before the list of
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
304 users in the chat updates to include the new user.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
305 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
306 @param name The name of the user that is joining the conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
307 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
308
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
309 @signaldef chat-buddy-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
310 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
311 void (*chat_buddy_joined)(GaimConversation *conv, const char *name);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
312 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
313 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
314 Emitted when a buddy joined a chat, after the users list is updated.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
315 @param conv The chat conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
317
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
318 @signaldef chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
319 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
320 void (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
321 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
322 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
323 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
324 Emitted when a user is leaving a chat, before the user list is updated.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
325 This may include an optional reason why the user is leaving.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
326 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
327 @param name The name of the user that is leaving the chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
328 @param reason The optional reason why the user is leaving.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
329 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
330
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
331 @signaldef chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
332 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
333 void (*chat_buddy_left)(GaimConversation *conv, const char *name,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
334 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
335 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
336 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
337 Emitted when a user leaves a chat, after the user list is updated.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
338 This may include an optional reason why the user is leaving.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
339 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
340 @param name The name of the user that left the chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
341 @param reason The optional reason why the user left the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
342 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
344 @signaldef chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
345 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
346 void (*chat_inviting_user)(GaimConversation *conv, const char *name,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
347 char **invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
348 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
350 Emitted when a user is being invited to the chat. The callback can
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
351 replace the invite message to the invitee by modifying the pointer to
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
352 the invite message.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
353 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
354 Make sure to free @a *invite_message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
355 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
356 @param name The name of the user being invited.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
357 @param invite_message A pointer to the reason why a user is being
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
358 invited.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
359 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
360
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
361 @signaldef chat-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
362 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
363 void (*chat_invited_user)(GaimConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
364 const char *invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
365 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
366 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
367 Emitted when a user invited another user to a chat.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
368 @param conv The chat conversation.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
369 @param conv The name of the user that was invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
370 @param invite_message The message to be sent to the user when invited.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
371 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
372
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
373 @signaldef chat-invited
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
374 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
375 void (*chat_invited)(GaimAccount *account, const char *inviter,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
376 const char *invite, const char *invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
377 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
378 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
379 Emitted when an account was invited to a chat.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
380 @param account The account being invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
381 @param inviter The username of the person inviting the account.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
382 @param invitee The username of the account being invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
383 @param invite_message The optional invite message.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
384 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
385
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
386 @signaldef chat-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
387 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
388 void (*chat_joined)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
389 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
390 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
391 Emitted when an account joins a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
392 @param conv The conversation that joined the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
393 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
394
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
395 @signaldef chat-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
396 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
397 void (*chat_left)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
398 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
399 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
400 Emitted when an account leaves a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
401 @param conv The conversation that left the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
402 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
403
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
404 */
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
405 // vim: syntax=c tw=75 et