annotate doc/conversation-signals.dox @ 32666:974722699032

merge of 'a8f0eef7e999fe67029a8df6e8a41d9a1c564388' and 'fc93ce764b1029c91f84961e1b909a8d267e225e'
author Marcus Lundblad <ml@update.uu.se>
date Mon, 25 Apr 2011 20:13:05 +0000
parents e68d6c7990c1
children a9e077fb65e9
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
23169
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
10 @signal blocked-im-msg
8736
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
11 @signal writing-chat-msg
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
12 @signal wrote-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 @signal sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @signal sent-chat-msg
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
15 @signal receiving-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signal received-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @signal conversation-created
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
18 @signal conversation-updated
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @signal deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @signal buddy-typing
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
21 @signal buddy-typing-stopped
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @signal chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @signal chat-buddy-joined
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
24 @signal chat-buddy-flags
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signal chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @signal chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signal chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @signal chat-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @signal chat-invited
23169
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
30 @signal chat-invite-blocked
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 @signal chat-joined
23103
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
32 @signal chat-join-failed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signal chat-left
9517
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
34 @signal chat-topic-changed
17735
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
35 @signal conversation-extended-menu
29766
29502959f74a Add the attention-UI-related signals to the documentation
Marcus Lundblad <ml@update.uu.se>
parents: 23169
diff changeset
36 @signal sent-attention
29502959f74a Add the attention-UI-related signals to the documentation
Marcus Lundblad <ml@update.uu.se>
parents: 23169
diff changeset
37 @signal got-attention
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 17735
diff changeset
40 @see conversation.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 17735
diff changeset
41
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
42 @signaldef writing-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
43 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
44 gboolean (*writing_im_msg)(PurpleAccount *account, const char *who,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
45 char **message, PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
46 PurpleMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
47 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
48 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
49 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
50 message is changed, then the changed message is displayed and logged
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
51 instead of the original message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
52 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
53 Make sure to free @a *message before you replace it!
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
54 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
55 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
56 @param message A pointer to the message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
57 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
58 @param flags Flags for this message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
59 @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
60 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
61
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
62 @signaldef wrote-im-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
63 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
64 void (*wrote_im_msg)(PurpleAccount *account, const char *who,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
65 char *message, PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
66 PurpleMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
67 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
68 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
69 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
70 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
71 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
72 @param message The message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
73 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
74 @param flags Flags for this message.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
75 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
76
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 @signaldef sending-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
79 void (*sending_im_msg)(PurpleAccount *account, const char *receiver,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
80 char **message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
81 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
83 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
84 message string, so the plugin can replace the message before being sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 @note
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
86 Make sure to free @a *message before you replace it!
8276
3c49a619969f [gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents: 8078
diff changeset
87 @param account The account the message is being sent on.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
88 @param receiver The username of the receiver.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
89 @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
90 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
91
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
92 @signaldef sent-im-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
93 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
94 void (*sent_im_msg)(PurpleAccount *account, const char *receiver,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
95 const char *message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
96 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
97 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
98 Emitted after sending an IM to a user.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
99 @param account The account the message was sent on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
100 @param receiver The username of the receiver.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 @param message The message that was sent.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
104 @signaldef receiving-im-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
106 gboolean (*receiving_im_msg)(PurpleAccount *account, char **sender,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
107 char **message, PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
108 PurpleMessageFlags *flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
109 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
110 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
111 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
112 sender, the message, or the flags by modifying the pointer to the
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
113 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
114 returning @c TRUE.
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
115 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
116 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
117 @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
118 @param account The account the message was received on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
119 @param sender A pointer to the username of the sender.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
120 @param message A pointer to the message that was sent.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
121 @param conv The IM conversation.
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
122 @param flags A pointer to the IM message flags.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
123 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
124
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
125 @signaldef received-im-msg
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
126 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
127 void (*received_im_msg)(PurpleAccount *account, char *sender, char *message,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
128 PurpleConversation *conv, PurpleMessageFlags flags);
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
129 @endsignalproto
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
130 @signaldesc
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
131 Emitted after an IM is received.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
132 @param account The account the message was received on.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
133 @param sender The username of the sender.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
134 @param message The message that was sent.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
135 @param conv The IM conversation.
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
136 @param flags The IM message flags.
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
137 @endsignaldef
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
138
23169
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
139 @signaldef blocked-im-msg
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
140 @signalproto
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
141 void (*blocked_im_msg)(PurpleAccount *account, const char *sender,
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
142 const char *message, PurpleMessageFlags flags, time_t when);
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
143 @endsignalproto
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
144 @signaldesc
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
145 Emitted after an IM is blocked due to privacy settings.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
146 @param account The account the message was received on.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
147 @param sender The username of the sender.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
148 @param message The message that was blocked.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
149 @param flags The IM message flags.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
150 @param when The time the message was sent.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
151 @since 2.5.0
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
152 @endsignaldef
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
153
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
154 @signaldef writing-chat-msg
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
155 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
156 gboolean (*writing_chat_msg)(PurpleAccount *account, const char *who,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
157 char **message, PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
158 PurpleMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
159 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
160 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
161 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
162 message is changed, then the changed message is displayed and logged
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
163 instead of the original message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
164 @note
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
165 Make sure to free @a *message before you replace it!
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
166 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
167 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
168 @param message A pointer to the message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
169 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
170 @param flags Flags for this message.
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
171 @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
172 @endsignaldef
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
173
8736
374477c0dd76 [gaim-migrate @ 9491]
Luke Schierer <lschiere@pidgin.im>
parents: 8276
diff changeset
174 @signaldef wrote-chat-msg
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
175 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
176 void (*wrote_chat_msg)(PurpleAccount *account, const char *who,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
177 char *message, PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
178 PurpleMessageFlags flags);
8078
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
179 @endsignalproto
ab0750ac5154 [gaim-migrate @ 8777]
Mark Doliner <mark@kingant.net>
parents: 7512
diff changeset
180 @signaldesc
13233
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
181 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
182 @param account The account.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
183 @param who The name of the user.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
184 @param message The message.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
185 @param conv The conversation.
f09c6e8df82c [gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents: 12850
diff changeset
186 @param flags Flags for this message.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
187 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
188
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
189 @signaldef sending-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
190 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
191 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
192 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
193 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
194 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
195 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
196 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
197 Make sure to free @a *message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
198 @param account The account the message is being sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
199 @param message A pointer to the message that will be sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
200 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
201 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
202
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
203 @signaldef sent-chat-msg
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
204 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
205 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
206 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
207 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
208 Emitted after sending a message to a chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
209 @param account The account the message was sent on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
210 @param message The message that was sent.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
211 @param id The ID of the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
212 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
213
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
214 @signaldef receiving-chat-msg
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
215 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
216 gboolean (*receiving_chat_msg)(PurpleAccount *account, char **sender,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
217 char **message, PurpleConversation *conv, int *flags);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
218 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
219 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
220 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
221 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
222 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
223 returning @c TRUE.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
224 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
225 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
226 @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
227 @param account The account the message was received on.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
228 @param sender A pointer to the username of the sender.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
229 @param message A pointer to the message that was sent.
7512
72a795d4b143 [gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents: 6838
diff changeset
230 @param conv The chat conversation.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
231 @param flags A pointer to the chat message flags
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
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
234 @signaldef received-chat-msg
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
235 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
236 void (*received_chat_msg)(PurpleAccount *account, char *sender, char *message,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
237 PurpleConversation *conv, PurpleMessageFlags flags);
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
238 @endsignalproto
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
239 @signaldesc
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
240 Emitted after a chat message is received.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
241 @param account The account the message was received on.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
242 @param sender The username of the sender.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
243 @param message The message that was sent.
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
244 @param conv The chat conversation.
10104
60db14d54914 [gaim-migrate @ 11131]
Stu Tomlinson <stu@nosnilmot.com>
parents: 9587
diff changeset
245 @param flags The chat message flags.
8999
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
246 @endsignaldef
8f838ae3e710 [gaim-migrate @ 9774]
Luke Schierer <lschiere@pidgin.im>
parents: 8736
diff changeset
247
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
248 @signaldef conversation-created
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
250 void (*conversation_created)(PurpleConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
252 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
253 Emitted when a new conversation is created.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
254 @param conv The new conversation.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
255 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
256
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
257 @signaldef conversation-updated
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
258 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
259 void (*conversation_updated)(PurpleConversation *conv,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
260 PurpleConvUpdateType type);
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
261 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
262 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
263 Emitted when a conversation is updated.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
264 @param conv The conversation that was updated.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
265 @param type The type of update that was made.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
266 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11707
diff changeset
267
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
268 @signaldef deleting-conversation
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
269 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
270 void (*deleting_conversation)(PurpleConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
271 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
272 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
273 Emitted just before a conversation is to be destroyed.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
274 @param conv The conversation that's about to be destroyed.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
275 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
276
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
277 @signaldef buddy-typing
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
278 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
279 void (*buddy_typing)(PurpleAccount *account, const char *name);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
280 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
281 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
282 Emitted when a buddy starts typing in a conversation window.
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
283 @param account The account of the user which is typing.
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
284 @param name The name of the user which is typing.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
285 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
286
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
287 @signaldef buddy-typing-stopped
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
288 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
289 void (*buddy_typing_stopped)(PurpleAccount *account, const char *name);
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
290 @endsignalproto
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
291 @signaldesc
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
292 Emitted when a buddy stops typing in a conversation window.
11707
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
293 @param account The account of the user which stopped typing.
b7af9100af6c [gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents: 11474
diff changeset
294 @param name The name of the user which stopped typing.
6838
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
295 @endsignaldef
551a8111977a [gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents: 6781
diff changeset
296
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
297 @signaldef chat-buddy-joining
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
298 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
299 gboolean (*chat_buddy_joining)(PurpleConversation *conv, const char *name,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
300 PurpleConvChatBuddyFlags flags);
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.
9587
5e1c76f3d232 [gaim-migrate @ 10430]
Luke Schierer <lschiere@pidgin.im>
parents: 9554
diff changeset
305 @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
306 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
307 @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
308 @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
309 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
310
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
311 @signaldef chat-buddy-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
312 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
313 void (*chat_buddy_joined)(PurpleConversation *conv, const char *name,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
314 PurpleConvChatBuddyFlags flags,
12850
49b2347863b2 [gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents: 12639
diff changeset
315 gboolean new_arrival);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
317 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
318 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
319 @param conv The chat conversation.
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
320 @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
321 @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
322 @param new_arrival If the buddy is a new arrival.
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
323 @endsignaldef
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
324
23103
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
325 @signaldef chat-join-failed
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
326 @signalproto
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
327 void (*chat_join_failed)(PurpleConnection *gc, GHashTable *components);
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
328 @endsignalproto
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
329 @signaldesc
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
330 Emitted when an account fails to join a chat room
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
331 @param gc The PurpleConnection of the account which failed to join the chat.
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
332 @param data The components passed to serv_join_chat() originally.
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
333 The hash function should be g_str_hash() and the equal
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
334 function should be g_str_equal().
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
335 @endsignaldef
591ef3693345 As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents: 22759
diff changeset
336
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
337 @signaldef chat-buddy-flags
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
338 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
339 void (*chat_buddy_flags)(PurpleConversation *conv, const char *name,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
340 PurpleConvChatBuddyFlags oldflags,
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
341 PurpleConvChatBuddyFlags newflags);
9554
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
342 @endsignalproto
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
343 @signaldesc
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
344 Emitted when a user in a chat changes flags.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
345 @param conv The chat conversation.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
346 @param name The name of the user.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
347 @param oldflags The old flags.
8b2451878e26 [gaim-migrate @ 10387]
Luke Schierer <lschiere@pidgin.im>
parents: 9517
diff changeset
348 @param newflags The new flags.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
350
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
351 @signaldef chat-buddy-leaving
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
352 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
353 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
354 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
355 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
356 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
357 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
358 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
359 @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
360 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
361 @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
362 @param reason The optional reason why the user is leaving.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
363 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
364
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
365 @signaldef chat-buddy-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
366 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
367 void (*chat_buddy_left)(PurpleConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
368 const char *reason);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
369 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
370 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
371 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
372 This may include an optional reason why the user is leaving.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
373 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
374 @param name The name of the user that left the chat.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
375 @param reason The optional reason why the user left the chat.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
376 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
377
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
378 @signaldef chat-inviting-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
379 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
380 void (*chat_inviting_user)(PurpleConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
381 char **invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
382 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
383 @signaldesc
6608
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
384 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
385 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
386 the invite message.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
387 @note
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
388 Make sure to free @a *invite_message before you replace it!
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
389 @param conv The chat conversation.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
390 @param name The name of the user being invited.
bc219e9efb9a [gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents: 6606
diff changeset
391 @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
392 invited.
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-invited-user
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
396 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
397 void (*chat_invited_user)(PurpleConversation *conv, const char *name,
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
398 const char *invite_message);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
399 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
400 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
401 Emitted when a user invited another user to a chat.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
402 @param conv The chat conversation.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
403 @param conv The name of the user that was invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
404 @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
405 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
406
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
407 @signaldef chat-invited
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
408 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
409 gint (*chat_invited)(PurpleAccount *account, const char *inviter,
9514
1fac0336890c [gaim-migrate @ 10341]
Luke Schierer <lschiere@pidgin.im>
parents: 9484
diff changeset
410 const char *chat, const char *invite_message
11474
7e9635b73ed6 [gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents: 11064
diff changeset
411 const GHashTable *components);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
412 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
413 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
414 Emitted when an account was invited to a chat.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
415 @param account The account being invited.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
416 @param inviter The username of the person inviting the account.
9484
4ecff68380ea [gaim-migrate @ 10309]
Tim Ringenbach <marv@pidgin.im>
parents: 9483
diff changeset
417 @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
418 @param invite_message The optional invite message.
9514
1fac0336890c [gaim-migrate @ 10341]
Luke Schierer <lschiere@pidgin.im>
parents: 9484
diff changeset
419 @param components The components necessary if you want to call
16201
36b09c6f7957 Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents: 16183
diff changeset
420 serv_join_chat()
11064
e4459e8ccfb5 [gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents: 10104
diff changeset
421 @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
422 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
423 default behavior will be maintained: the user will be prompted.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
424 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
425
23169
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
426 @signaldef chat-invite-blocked
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
427 @signalproto
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
428 void (*chat_invite_blocked)(PurpleAccount *account, const char *inviter,
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
429 const char *name, const char *message, GHashTable *data);
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
430 @endsignalproto
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
431 @signaldesc
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
432 Emitted when an invitation to join a chat is blocked.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
433 @param account The account the invitation was sent to.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
434 @param inviter The name of the person sending the invitation.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
435 @param name The name of the chat invited to.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
436 @param message The invitation message sent.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
437 @param data Hashtable containing data about the invited chat.
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
438 @since 2.5.0
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
439 @endsignaldef
ff8ec3d58367 Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 23103
diff changeset
440
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
441 @signaldef chat-joined
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
442 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
443 void (*chat_joined)(PurpleConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
444 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
445 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
446 Emitted when an account joins a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
447 @param conv The conversation that joined the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
448 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
449
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
450 @signaldef chat-left
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
451 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
452 void (*chat_left)(PurpleConversation *conv);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
453 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
454 @signaldesc
6609
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
455 Emitted when an account leaves a chat room.
d470295a4945 [gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents: 6608
diff changeset
456 @param conv The conversation that left the chat room.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
457 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
458
9517
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
459 @signaldef chat-topic-changed
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
460 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13251
diff changeset
461 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic);
9517
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
462 @endsignalproto
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
463 @signaldesc
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
464 Emitted when the topic is changed in a chat.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
465 @param conv The conversation whose topic changed.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
466 @param who The name of the person that changed the topic.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
467 @param topic The new topic.
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
468 @endsignaldef
0524b36c701a [gaim-migrate @ 10344]
Luke Schierer <lschiere@pidgin.im>
parents: 9514
diff changeset
469
17735
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
470 @signaldef conversation-extended-menu
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
471 @signalproto
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
472 void (*conversation_extended_menu)(PurpleConversation *conv, GList **list);
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
473 @endsignalproto
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
474 @signaldesc
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
475 Emitted when the UI requests a list of plugin actions for a
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
476 conversation.
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
477 @param conv The conversation.
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
478 @param list A pointer to the list of actions.
20875
4511d15a8f80 Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 20807
diff changeset
479 @since 2.1.0
17735
da2bab3b9fab New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16201
diff changeset
480 @endsignaldef
29768
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
481
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
482 @signaldef sent-attention
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
483 @signalproto
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
484 void (*got_attention)(PurpleAccount *account, const char *who,
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
485 PurpleConversation *conv, guint type)
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
486 @endsignalproto
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
487 @signaldesc
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
488 Emitted when receiving an attention message (buzz, nudge, etc.).
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
489 @param account The account
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
490 @param who The name of the person receiving the attention
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
491 @param conv The conversation
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
492 @param type The attention type (an index starting at 0)
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
493 @since 2.7.0
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
494 @endsignaldef
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
495
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
496 @signaldef got-attention
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
497 @signalproto
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
498 void (*got_attention)(PurpleAccount *account, const char *who,
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
499 PurpleConversation *conv, guint type)
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
500 @endsignalproto
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
501 @signaldesc
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
502 Emitted when receiving an attention message (buzz, nudge, etc.).
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
503 @param account The account
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
504 @param who The name of the person sending the attention
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
505 @param conv The conversation
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
506 @param type The attention type (an index starting at 0)
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
507 @since 2.7.0
e68d6c7990c1 Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents: 29767
diff changeset
508 @endsignaldef
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
509 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 17735
diff changeset
510 // vim: syntax=c.doxygen tw=75 et