Mercurial > pidgin.yaz
annotate src/event.h @ 6407:ba0b99a72be2
[gaim-migrate @ 6913]
Added API commands for adding or removing a batch of users at once to/from
a chat. IRC no longer has half a billion "Diablo-D3 has entered the room."
messages anymore.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Thu, 07 Aug 2003 20:47:29 +0000 |
parents | 5239a3b4ab33 |
children |
rev | line source |
---|---|
5205 | 1 /** |
2 * @file event.h Event API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Copyright (C) 2003 Christian Hammond <chipx86@gnupdate.org> | |
6063 | 8 * |
5205 | 9 * This program is free software; you can redistribute it and/or modify |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 #ifndef _GAIM_EVENT_H_ | |
24 #define _GAIM_EVENT_H_ | |
25 | |
26 #include <glib.h> | |
27 | |
28 /** | |
29 * Event types | |
30 */ | |
31 typedef enum gaim_event | |
32 { | |
33 event_signon = 0, | |
34 event_signoff, | |
35 event_away, | |
36 event_back, | |
37 event_im_recv, | |
38 event_im_send, | |
39 event_buddy_signon, | |
40 event_buddy_signoff, | |
41 event_buddy_away, | |
42 event_buddy_back, | |
43 event_buddy_idle, | |
44 event_buddy_unidle, | |
45 event_blist_update, | |
46 event_chat_invited, | |
47 event_chat_join, | |
48 event_chat_leave, | |
49 event_chat_buddy_join, | |
50 event_chat_buddy_leave, | |
51 event_chat_recv, | |
52 event_chat_send, | |
53 event_warned, | |
54 event_error, | |
55 event_quit, | |
56 event_new_conversation, | |
57 event_set_info, | |
58 event_draw_menu, | |
59 event_im_displayed_sent, | |
60 event_im_displayed_rcvd, | |
61 event_chat_send_invite, | |
62 event_got_typing, | |
63 event_del_conversation, | |
64 event_connecting, | |
6063 | 65 event_conversation_switch |
5205 | 66 /* any others? it's easy to add... */ |
67 | |
68 } GaimEvent; | |
69 | |
70 typedef int (*GaimSignalBroadcastFunc)(GaimEvent event, void *data, | |
71 va_list args); | |
72 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
73 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
74 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
75 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
76 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
77 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
78 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
79 /** @name Signal API */ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
80 /**************************************************************************/ |
5205 | 81 /** |
82 * Connects a signal handler to a gaim event. | |
83 * | |
84 * @param module The optional module handle. | |
85 * @param event The event to connect to. | |
86 * @param func The callback function. | |
87 * @param data The data to pass to the callback function. | |
88 * | |
89 * @see gaim_signal_disconnect() | |
90 */ | |
91 void gaim_signal_connect(void *module, GaimEvent event, | |
92 void *func, void *data); | |
93 | |
94 /** | |
95 * Disconnects a signal handler from a gaim event. | |
96 * | |
97 * @param module The optional module handle. | |
98 * @param event The event to disconnect from. | |
99 * @param func The registered function to disconnect. | |
100 * | |
101 * @see gaim_signal_connect() | |
102 */ | |
103 void gaim_signal_disconnect(void *module, GaimEvent event, | |
104 void *func); | |
105 | |
106 /** | |
107 * Removes all callbacks associated with a handle. | |
108 * | |
109 * @param handle The handle. | |
110 */ | |
111 void gaim_signals_disconnect_by_handle(void *handle); | |
112 | |
113 /** | |
114 * Registers a function that re-broadcasts events. | |
115 * | |
116 * @param func The function. | |
117 * @param data Data to be passed to the callback. | |
118 */ | |
119 void gaim_signals_register_broadcast_func(GaimSignalBroadcastFunc func, | |
120 void *data); | |
121 | |
122 /** | |
123 * Unregisters a function that re-broadcasts events. | |
124 * | |
125 * @param func The function. | |
126 */ | |
127 void gaim_signals_unregister_broadcast_func(GaimSignalBroadcastFunc func); | |
128 | |
129 /** | |
5230
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
130 * Returns a list of all signal callbacks. |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
131 * |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
132 * @return A list of all signal callbacks. |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
133 */ |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
134 GList *gaim_signals_get_callbacks(void); |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
135 |
779ffffb584a
[gaim-migrate @ 5600]
Christian Hammond <chipx86@chipx86.com>
parents:
5205
diff
changeset
|
136 /** |
5205 | 137 * Broadcasts an event to all registered signal handlers. |
138 * | |
139 * @param event The event to broadcast | |
140 * | |
141 * @see gaim_signal_connect() | |
142 * @see gaim_signal_disconnect() | |
143 */ | |
144 int gaim_event_broadcast(GaimEvent event, ...); | |
145 | |
146 /** | |
147 * Returns a human-readable representation of an event name. | |
148 * | |
149 * @param event The event. | |
150 * | |
151 * @return A human-readable string of the name. | |
152 */ | |
153 const char *gaim_event_get_name(GaimEvent event); | |
154 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
155 /*@}*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
156 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
157 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
158 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
159 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5230
diff
changeset
|
160 |
5205 | 161 #endif /* _GAIM_EVENT_H_ */ |