Mercurial > pidgin
comparison libgaim/eventloop.h @ 14192:60b1bc8dbf37
[gaim-migrate @ 16863]
Renamed 'core' to 'libgaim'
committer: Tailor Script <tailor@pidgin.im>
author | Evan Schoenberg <evan.s@dreskin.net> |
---|---|
date | Sat, 19 Aug 2006 01:50:10 +0000 |
parents | |
children | a6aad36ca735 |
comparison
equal
deleted
inserted
replaced
14191:009db0b357b5 | 14192:60b1bc8dbf37 |
---|---|
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 | |
28 #include <glib.h> | |
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 /** | |
57 * Removes a callback timer. | |
58 * @see gaim_timeout_remove, g_source_remove | |
59 */ | |
60 guint (*timeout_remove)(guint handle); | |
61 | |
62 /** | |
63 * Adds an input handler. | |
64 * @see gaim_input_add, g_io_add_watch_full | |
65 */ | |
66 guint (*input_add)(int fd, GaimInputCondition cond, | |
67 GaimInputFunction func, gpointer user_data); | |
68 | |
69 /** | |
70 * Removes an input handler. | |
71 * @see gaim_input_remove, g_source_remove | |
72 */ | |
73 guint (*input_remove)(guint handle); | |
74 }; | |
75 | |
76 /**************************************************************************/ | |
77 /** @name Event Loop API */ | |
78 /**************************************************************************/ | |
79 /*@{*/ | |
80 /** | |
81 * Creates a callback timer. | |
82 * The timer will repeat until the function returns @c FALSE. The | |
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. | |
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 */ | |
91 guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); | |
92 | |
93 /** | |
94 * Removes a timeout handler. | |
95 * | |
96 * @param handle The handle, as returned by gaim_timeout_add. | |
97 * | |
98 * @return Something. | |
99 */ | |
100 guint gaim_timeout_remove(guint handle); | |
101 | |
102 /** | |
103 * Adds an input handler. | |
104 * | |
105 * @param fd The input file descriptor. | |
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 (will be greater than 0). | |
111 * @see g_io_add_watch_full | |
112 */ | |
113 guint gaim_input_add(int fd, GaimInputCondition cond, | |
114 GaimInputFunction func, gpointer user_data); | |
115 | |
116 /** | |
117 * Removes an input handler. | |
118 * | |
119 * @param handle The handle of the input handler. Note that this is the return | |
120 * value from gaim_input_add, <i>not</i> the file descriptor. | |
121 */ | |
122 guint gaim_input_remove(guint handle); | |
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_ */ |