annotate doc/conversation-signals.dox @ 14485:c02ef8dd4416

[gaim-migrate @ 17204] Doxygen comment fix committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sat, 09 Sep 2006 20:40:12 +0000
parents a2ccce52ab3d
children 8cf53d7a0887
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
8736
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
4 @signal writing-im-msg
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
5 @signal wrote-im-msg
6605
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
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
8 @signal receiving-im-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 @signal received-im-msg
8736
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
10 @signal writing-chat-msg
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
11 @signal wrote-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signal sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 @signal sent-chat-msg
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
14 @signal receiving-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @signal received-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signal conversation-created
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
17 @signal conversation-updated
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @signal deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @signal buddy-typing
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
20 @signal buddy-typing-stopped
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @signal chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @signal chat-buddy-joined
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
23 @signal chat-buddy-flags
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signal chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signal chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @signal chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signal chat-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @signal chat-invited
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @signal chat-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @signal chat-left
9517
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
31 @signal chat-topic-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
34 @signaldef writing-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
35 @signalproto
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
36 gboolean (*writing_im_msg)(GaimAccount *account, const char *who,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
37 char **message, GaimConversation *conv,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
38 GaimMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
39 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
40 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
41 Emitted before a message is written in an IM conversation. If the
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
42 message is changed, then the changed message is displayed and logged
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
43 instead of the original message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
44 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
45 Make sure to free @a *message before you replace it!
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
46 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
47 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
48 @param message A pointer to the message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
49 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
50 @param flags Flags for this message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
51 @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
52 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
53
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
54 @signaldef wrote-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
55 @signalproto
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
56 void (*wrote_im_msg)(GaimAccount *account, const char *who,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
57 char *message, GaimConversation *conv,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
58 GaimMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
59 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
60 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
61 Emitted after a message is written and possibly displayed in a conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
62 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
63 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
64 @param message The message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
65 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
66 @param flags Flags for this message.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
69 @signaldef sending-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
70 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
71 void (*sending_im_msg)(GaimAccount *account, const char *receiver,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
72 char **message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
73 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
74 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
75 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
76 message string, so the plugin can replace the message before being sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 @note
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78 Make sure to free @a *message before you replace it!
8276
3c49a619969f [gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents: 8078
diff changeset
79 @param account The account the message is being sent on.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
80 @param receiver The username of the receiver.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
81 @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
82 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
83
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
84 @signaldef sent-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
86 void (*sent_im_msg)(GaimAccount *account, const char *receiver,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
87 const char *message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
88 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
89 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
90 Emitted after sending an IM to a user.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
91 @param account The account the message was sent on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
92 @param receiver The username of the receiver.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
93 @param message The message that was sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
94 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
95
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
96 @signaldef receiving-im-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97 @signalproto
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
98 gboolean (*receiving_im_msg)(GaimAccount *account, char **sender,
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
99 char **message, GaimConversation *conv,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
100 GaimMessageFlags *flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103 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
104 sender, the message, or the flags by modifying the pointer to the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 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
106 returning @c TRUE.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
107 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
108 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
109 @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
110 @param account The account the message was received on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
111 @param sender A pointer to the username of the sender.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
112 @param message A pointer to the message that was sent.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
113 @param conv The IM conversation.
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
114 @param flags A pointer to the IM message flags.
6605
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
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
117 @signaldef received-im-msg
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
118 @signalproto
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
119 void (*received_im_msg)(GaimAccount *account, char *sender, char *message,
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
120 GaimConversation *conv, GaimMessageFlags flags);
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
121 @endsignalproto
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
122 @signaldesc
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
123 Emitted after an IM is received.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
124 @param account The account the message was received on.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
125 @param sender The username of the sender.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
126 @param message The message that was sent.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
127 @param conv The IM conversation.
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
128 @param flags The IM message flags.
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
129 @endsignaldef
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
130
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
131 @signaldef writing-chat-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
132 @signalproto
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
133 gboolean (*writing_chat_msg)(GaimAccount *account, const char *who,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
134 char **message, GaimConversation *conv,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
135 GaimMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
136 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
137 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
138 Emitted before a message is written in a chat conversation. If the
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
139 message is changed, then the changed message is displayed and logged
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
140 instead of the original message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
141 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
142 Make sure to free @a *message before you replace it!
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
143 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
144 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
145 @param message A pointer to the message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
146 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
147 @param flags Flags for this message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
148 @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
149 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
150
8736
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
151 @signaldef wrote-chat-msg
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
152 @signalproto
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
153 void (*wrote_chat_msg)(GaimAccount *account, const char *who,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
154 char *message, GaimConversation *conv,
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
155 GaimMessageFlags flags);
8078
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
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
158 Emitted after a message is written and possibly displayed in a chat.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
159 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
160 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
161 @param message The message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
162 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
163 @param flags Flags for this message.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
164 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
165
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
166 @signaldef sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
167 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
168 void (*sending_chat_msg)(GaimAccount *account, char **message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
169 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
170 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
171 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
172 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
173 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
174 Make sure to free @a *message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
175 @param account The account the message is being sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
176 @param message A pointer to the message that will be sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
177 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
178 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
179
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
180 @signaldef sent-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
181 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
182 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
183 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
184 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
185 Emitted after sending a message to a chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
186 @param account The account the message was sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
187 @param message The message that was sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
188 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
189 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
190
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
191 @signaldef receiving-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
192 @signalproto
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
193 gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender,
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
194 char **message, GaimConversation *conv, int *flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
195 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
196 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
197 Emitted when a chat message is received. The callback can replace the
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
198 name of the sender, the message, or the flags by modifying the pointer to the
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
199 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
200 returning @c TRUE.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
201 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
202 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
203 @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
204 @param account The account the message was received on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
205 @param sender A pointer to the username of the sender.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
206 @param message A pointer to the message that was sent.
7512
72a795d4b143 [gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents: 6838
diff changeset
207 @param conv The chat conversation.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
208 @param flags A pointer to the chat message flags
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
209 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
210
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
211 @signaldef received-chat-msg
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
212 @signalproto
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
213 void (*received_chat_msg)(GaimAccount *account, char *sender, char *message,
13251
a2ccce52ab3d [gaim-migrate @ 15617]
Etan Reisner <pidgin@unreliablesource.net>
parents: 13233
diff changeset
214 GaimConversation *conv, GaimMessageFlags flags);
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
215 @endsignalproto
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
216 @signaldesc
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
217 Emitted after a chat message is received.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
218 @param account The account the message was received on.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
219 @param sender The username of the sender.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
220 @param message The message that was sent.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
221 @param conv The chat conversation.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
222 @param flags The chat message flags.
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
223 @endsignaldef
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
224
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
225 @signaldef conversation-created
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
226 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
227 void (*conversation_created)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
228 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
229 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
230 Emitted when a new conversation is created.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
231 @param conv The new conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
232 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
233
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
234 @signaldef conversation-updated
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
235 @signalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
236 void (*conversation_updated)(GaimConversation *conv,
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
237 GaimConvUpdateType type);
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
238 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
239 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
240 Emitted when a conversation is updated.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
241 @param conv The conversation that was updated.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
242 @param type The type of update that was made.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
243 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
244
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
245 @signaldef deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
246 @signalproto
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
247 void (*deleting_conversation)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
248 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
250 Emitted just before a conversation is to be destroyed.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
251 @param conv The conversation that's about to be destroyed.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
252 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
253
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
254 @signaldef buddy-typing
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
255 @signalproto
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
256 void (*buddy_typing)(GaimAccount *account, const char *name);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
257 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
258 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
259 Emitted when a buddy starts typing in a conversation window.
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
260 @param account The account of the user which is typing.
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
261 @param name The name of the user which is typing.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
262 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
263
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
264 @signaldef buddy-typing-stopped
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
265 @signalproto
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
266 void (*buddy_typing_stopped)(GaimAccount *account, const char *name);
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
267 @endsignalproto
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
268 @signaldesc
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
269 Emitted when a buddy stops typing in a conversation window.
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
270 @param account The account of the user which stopped typing.
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
271 @param name The name of the user which stopped typing.
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
272 @endsignaldef
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
273
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
274 @signaldef chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
275 @signalproto
9587
5e1c76f3d232 [gaim-migrate @ 10430]
Luke Schierer <lschiere@pidgin.im>
parents: 9554
diff changeset
276 gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name,
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
277 GaimConvChatBuddyFlags flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
278 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
279 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
280 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
281 users in the chat updates to include the new user.
9587
5e1c76f3d232 [gaim-migrate @ 10430]
Luke Schierer <lschiere@pidgin.im>
parents: 9554
diff changeset
282 @return @c TRUE if the join should be hidden, or @c FALSE otherwise.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
283 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
284 @param name The name of the user that is joining the conversation.
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
285 @param flags The flags of the user that is joining the conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
286 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
287
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
288 @signaldef chat-buddy-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
289 @signalproto
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
290 void (*chat_buddy_joined)(GaimConversation *conv, const char *name,
12850
49b2347863b2 [gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents: 12639
diff changeset
291 GaimConvChatBuddyFlags flags,
49b2347863b2 [gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents: 12639
diff changeset
292 gboolean new_arrival);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
293 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
294 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
295 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
296 @param conv The chat conversation.
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
297 @param name The name of the user that has joined the conversation.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
298 @param flags The flags of the user that has joined the conversation.
12850
49b2347863b2 [gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents: 12639
diff changeset
299 @param new_arrival If the buddy is a new arrival.
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
300 @endsignaldef
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
301
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
302 @signaldef chat-buddy-flags
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
303 @signalproto
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
304 void (*chat_buddy_flags)(GaimConversation *conv, const char *name,
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
305 GaimConvChatBuddyFlags oldflags,
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
306 GaimConvChatBuddyFlags newflags);
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
307 @endsignalproto
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
308 @signaldesc
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
309 Emitted when a user in a chat changes flags.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
310 @param conv The chat conversation.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
311 @param name The name of the user.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
312 @param oldflags The old flags.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
313 @param newflags The new flags.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
314 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
315
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316 @signaldef chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
317 @signalproto
9587
5e1c76f3d232 [gaim-migrate @ 10430]
Luke Schierer <lschiere@pidgin.im>
parents: 9554
diff changeset
318 gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
319 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
320 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
321 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
322 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
323 This may include an optional reason why the user is leaving.
9587
5e1c76f3d232 [gaim-migrate @ 10430]
Luke Schierer <lschiere@pidgin.im>
parents: 9554
diff changeset
324 @return @c TRUE if the leave should be hidden, or @c FALSE otherwise.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
325 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
326 @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
327 @param reason The optional reason why the user is leaving.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
328 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
329
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
330 @signaldef chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
331 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
332 void (*chat_buddy_left)(GaimConversation *conv, const char *name,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
333 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
334 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
335 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
336 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
337 This may include an optional reason why the user is leaving.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
338 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
339 @param name The name of the user that left the chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
340 @param reason The optional reason why the user left the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
341 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
342
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343 @signaldef chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
344 @signalproto
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
345 void (*chat_inviting_user)(GaimConversation *conv, const char *name,
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
346 char **invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
347 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
348 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
349 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
350 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
351 the invite message.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
352 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
353 Make sure to free @a *invite_message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
354 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
355 @param name The name of the user being invited.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
356 @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
357 invited.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
358 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
359
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
360 @signaldef chat-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
361 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
362 void (*chat_invited_user)(GaimConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
363 const char *invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
364 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
365 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
366 Emitted when a user invited another user to a chat.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
367 @param conv The chat conversation.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
368 @param conv The name of the user that was invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
369 @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
370 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
371
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
372 @signaldef chat-invited
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
373 @signalproto
11064
e4459e8ccfb5 [gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents: 10104
diff changeset
374 gint (*chat_invited)(GaimAccount *account, const char *inviter,
9514
1fac0336890c [gaim-migrate @ 10341]
Luke Schierer <lschiere@pidgin.im>
parents: 9484
diff changeset
375 const char *chat, const char *invite_message
11474
7e9635b73ed6 [gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents: 11064
diff changeset
376 const GHashTable *components);
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.
9484
4ecff68380ea [gaim-migrate @ 10309]
Tim Ringenbach <marv@pidgin.im>
parents: 9483
diff changeset
382 @param chat The name of the chat you're being invited to.
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
383 @param invite_message The optional invite message.
9514
1fac0336890c [gaim-migrate @ 10341]
Luke Schierer <lschiere@pidgin.im>
parents: 9484
diff changeset
384 @param components The components necessary if you want to call
1fac0336890c [gaim-migrate @ 10341]
Luke Schierer <lschiere@pidgin.im>
parents: 9484
diff changeset
385 serv_join_chat
11064
e4459e8ccfb5 [gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents: 10104
diff changeset
386 @return Less than zero if the invitation should be rejected, greater than
e4459e8ccfb5 [gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents: 10104
diff changeset
387 zero if the invitation should be accepted. If zero is returned, the
e4459e8ccfb5 [gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents: 10104
diff changeset
388 default behavior will be maintained: the user will be prompted.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
389 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
390
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
391 @signaldef chat-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
392 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
393 void (*chat_joined)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
394 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
395 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
396 Emitted when an account joins a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
397 @param conv The conversation that joined the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
398 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
399
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
400 @signaldef chat-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
401 @signalproto
6610
3beb00af2e1a [gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents: 6609
diff changeset
402 void (*chat_left)(GaimConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
403 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
404 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
405 Emitted when an account leaves a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
406 @param conv The conversation that left the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
407 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
408
9517
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
409 @signaldef chat-topic-changed
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
410 @signalproto
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
411 void (*chat_topic_changed)(GaimConversation *conv, const char *who, const char *topic);
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
412 @endsignalproto
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
413 @signaldesc
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
414 Emitted when the topic is changed in a chat.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
415 @param conv The conversation whose topic changed.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
416 @param who The name of the person that changed the topic.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
417 @param topic The new topic.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
418 @endsignaldef
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
419
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
420 */
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
421 // vim: syntax=c tw=75 et