Mercurial > pidgin
annotate src/eventloop.h @ 10749:3839df4f7074
[gaim-migrate @ 12351]
This fixes the auto-reconnect plugin bug. The whole "wants_to_die"
thing feels a little dirty. Eh, it's fine for now.
Also, the gtkstatusbox starts off in the "available" state instead
of using the GaimStatus of whatever account is online. This negates
the effect of saving the GaimStatuses for an account.
More tomorrow...
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 27 Mar 2005 05:17:18 +0000 |
parents | af06746954de |
children | fcb3f77df50d |
rev | line source |
---|---|
8273 | 1 /** |
2 * @file eventloop.h Gaim Event Loop API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_EVENTLOOP_H_ | |
26 #define _GAIM_EVENTLOOP_H_ | |
27 | |
10023 | 28 #include <glib.h> |
8273 | 29 |
30 #ifdef __cplusplus | |
31 extern "C" { | |
32 #endif | |
33 | |
34 /** | |
35 * An input condition. | |
36 */ | |
37 typedef enum | |
38 { | |
39 GAIM_INPUT_READ = 1 << 0, /**< A read condition. */ | |
40 GAIM_INPUT_WRITE = 1 << 1 /**< A write condition. */ | |
41 | |
42 } GaimInputCondition; | |
43 | |
44 typedef void (*GaimInputFunction)(gpointer, gint, GaimInputCondition); | |
45 | |
46 typedef struct _GaimEventLoopUiOps GaimEventLoopUiOps; | |
47 | |
48 struct _GaimEventLoopUiOps | |
49 { | |
50 /** | |
51 * Creates a callback timer. | |
52 * @see g_timeout_add, gaim_timeout_add | |
53 **/ | |
54 guint (*timeout_add)(guint interval, GSourceFunc function, gpointer data); | |
55 | |
56 /** | |
8287
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
57 * Removes a callback timer. |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
58 * @see gaim_timeout_remove, g_source_remove |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
59 */ |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
60 guint (*timeout_remove)(guint handle); |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
61 |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
62 /** |
8273 | 63 * Adds an input handler. |
64 * @see gaim_input_add, g_io_add_watch_full | |
65 */ | |
8280
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
66 guint (*input_add)(int fd, GaimInputCondition cond, |
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
67 GaimInputFunction func, gpointer user_data); |
8273 | 68 |
69 /** | |
70 * Removes an input handler. | |
71 * @see gaim_input_remove, g_source_remove | |
72 */ | |
8797 | 73 guint (*input_remove)(guint handle); |
8273 | 74 }; |
75 | |
76 /**************************************************************************/ | |
77 /** @name Event Loop API */ | |
78 /**************************************************************************/ | |
79 /*@{*/ | |
80 /** | |
81 * Creates a callback timer. | |
10071 | 82 * The timer will repeat until the function returns @c FALSE. The |
8273 | 83 * first call will be at the end of the first interval. |
84 * @param interval The time between calls of the function, in | |
85 * milliseconds. | |
86 * @param function The function to call. | |
10071 | 87 * @param data data to pass to @a function. |
88 * @return A handle to the timer which can be passed to | |
89 * gaim_timeout_remove to remove the timer. | |
90 */ | |
8273 | 91 guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); |
92 | |
93 /** | |
8287
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
94 * Removes a timeout handler. |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
95 * |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
96 * @param handle The handle, as returned by gaim_timeout_add. |
8387
98c9a35541ed
[gaim-migrate @ 9115]
Christian Hammond <chipx86@chipx86.com>
parents:
8287
diff
changeset
|
97 * |
98c9a35541ed
[gaim-migrate @ 9115]
Christian Hammond <chipx86@chipx86.com>
parents:
8287
diff
changeset
|
98 * @return Something. |
8287
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
99 */ |
8387
98c9a35541ed
[gaim-migrate @ 9115]
Christian Hammond <chipx86@chipx86.com>
parents:
8287
diff
changeset
|
100 guint gaim_timeout_remove(guint handle); |
8287
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
101 |
ef881489396e
[gaim-migrate @ 9011]
Christian Hammond <chipx86@chipx86.com>
parents:
8280
diff
changeset
|
102 /** |
8273 | 103 * Adds an input handler. |
104 * | |
8280
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
105 * @param fd The input file descriptor. |
8273 | 106 * @param cond The condition type. |
107 * @param func The callback function for data. | |
108 * @param user_data User-specified data. | |
109 * | |
110 * @return The resulting handle. | |
111 * @see g_io_add_watch_full | |
112 */ | |
8280
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
113 guint gaim_input_add(int fd, GaimInputCondition cond, |
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
114 GaimInputFunction func, gpointer user_data); |
8273 | 115 |
116 /** | |
117 * Removes an input handler. | |
118 * | |
8280
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
119 * @param handle The handle of the input handler. Note that this is the return |
084ed9f7ac19
[gaim-migrate @ 9004]
Christian Hammond <chipx86@chipx86.com>
parents:
8273
diff
changeset
|
120 * value from gaim_input_add, <i>not</i> the file descriptor. |
8273 | 121 */ |
8797 | 122 guint gaim_input_remove(guint handle); |
8273 | 123 |
124 /*@}*/ | |
125 | |
126 | |
127 /**************************************************************************/ | |
128 /** @name UI Registration Functions */ | |
129 /**************************************************************************/ | |
130 /*@{*/ | |
131 /** | |
132 * Sets the UI operations structure to be used for accounts. | |
133 * | |
134 * @param ops The UI operations structure. | |
135 */ | |
136 void gaim_eventloop_set_ui_ops(GaimEventLoopUiOps *ops); | |
137 | |
138 /** | |
139 * Returns the UI operations structure used for accounts. | |
140 * | |
141 * @return The UI operations structure in use. | |
142 */ | |
143 GaimEventLoopUiOps *gaim_eventloop_get_ui_ops(void); | |
144 | |
145 /*@}*/ | |
146 | |
147 #ifdef __cplusplus | |
148 } | |
149 #endif | |
150 | |
151 #endif /* _GAIM_EVENTLOOP_H_ */ |