Mercurial > pidgin.yaz
view src/eventloop.h @ 13811:e0e8959d92a0
[gaim-migrate @ 16241]
autotools continues to confuse me
committer: Tailor Script <tailor@pidgin.im>
author | Nathan Walp <nwalp@pidgin.im> |
---|---|
date | Sat, 10 Jun 2006 18:09:57 +0000 |
parents | fcb3f77df50d |
children |
line wrap: on
line source
/** * @file eventloop.h Gaim Event Loop API * @ingroup core * * gaim * * Gaim is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _GAIM_EVENTLOOP_H_ #define _GAIM_EVENTLOOP_H_ #include <glib.h> #ifdef __cplusplus extern "C" { #endif /** * An input condition. */ typedef enum { GAIM_INPUT_READ = 1 << 0, /**< A read condition. */ GAIM_INPUT_WRITE = 1 << 1 /**< A write condition. */ } GaimInputCondition; typedef void (*GaimInputFunction)(gpointer, gint, GaimInputCondition); typedef struct _GaimEventLoopUiOps GaimEventLoopUiOps; struct _GaimEventLoopUiOps { /** * Creates a callback timer. * @see g_timeout_add, gaim_timeout_add **/ guint (*timeout_add)(guint interval, GSourceFunc function, gpointer data); /** * Removes a callback timer. * @see gaim_timeout_remove, g_source_remove */ guint (*timeout_remove)(guint handle); /** * Adds an input handler. * @see gaim_input_add, g_io_add_watch_full */ guint (*input_add)(int fd, GaimInputCondition cond, GaimInputFunction func, gpointer user_data); /** * Removes an input handler. * @see gaim_input_remove, g_source_remove */ guint (*input_remove)(guint handle); }; /**************************************************************************/ /** @name Event Loop API */ /**************************************************************************/ /*@{*/ /** * Creates a callback timer. * The timer will repeat until the function returns @c FALSE. The * first call will be at the end of the first interval. * @param interval The time between calls of the function, in * milliseconds. * @param function The function to call. * @param data data to pass to @a function. * @return A handle to the timer which can be passed to * gaim_timeout_remove to remove the timer. */ guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); /** * Removes a timeout handler. * * @param handle The handle, as returned by gaim_timeout_add. * * @return Something. */ guint gaim_timeout_remove(guint handle); /** * Adds an input handler. * * @param fd The input file descriptor. * @param cond The condition type. * @param func The callback function for data. * @param user_data User-specified data. * * @return The resulting handle (will be greater than 0). * @see g_io_add_watch_full */ guint gaim_input_add(int fd, GaimInputCondition cond, GaimInputFunction func, gpointer user_data); /** * Removes an input handler. * * @param handle The handle of the input handler. Note that this is the return * value from gaim_input_add, <i>not</i> the file descriptor. */ guint gaim_input_remove(guint handle); /*@}*/ /**************************************************************************/ /** @name UI Registration Functions */ /**************************************************************************/ /*@{*/ /** * Sets the UI operations structure to be used for accounts. * * @param ops The UI operations structure. */ void gaim_eventloop_set_ui_ops(GaimEventLoopUiOps *ops); /** * Returns the UI operations structure used for accounts. * * @return The UI operations structure in use. */ GaimEventLoopUiOps *gaim_eventloop_get_ui_ops(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_EVENTLOOP_H_ */