eventloop.h File Reference

Gaim Event Loop API. More...

#include <glib.h>

Include dependency graph for eventloop.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GaimEventLoopUiOps

Typedefs

typedef void(*) GaimInputFunction (gpointer, gint, GaimInputCondition)
typedef _GaimEventLoopUiOps GaimEventLoopUiOps

Enumerations

enum  GaimInputCondition { GAIM_INPUT_READ = 1 << 0, GAIM_INPUT_WRITE = 1 << 1 }
 An input condition. More...

Functions

Event Loop API
guint gaim_timeout_add (guint interval, GSourceFunc function, gpointer data)
 Creates a callback timer.
guint gaim_timeout_remove (guint handle)
 Removes a timeout handler.
guint gaim_input_add (int fd, GaimInputCondition cond, GaimInputFunction func, gpointer user_data)
 Adds an input handler.
guint gaim_input_remove (guint handle)
 Removes an input handler.
UI Registration Functions
void gaim_eventloop_set_ui_ops (GaimEventLoopUiOps *ops)
 Sets the UI operations structure to be used for accounts.
GaimEventLoopUiOps * gaim_eventloop_get_ui_ops (void)
 Returns the UI operations structure used for accounts.


Detailed Description

Gaim Event Loop API.

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


Enumeration Type Documentation

enum GaimInputCondition

An input condition.

Enumerator:
GAIM_INPUT_READ  A read condition.
GAIM_INPUT_WRITE  A write condition.


Function Documentation

GaimEventLoopUiOps* gaim_eventloop_get_ui_ops ( void   ) 

Returns the UI operations structure used for accounts.

Returns:
The UI operations structure in use.

void gaim_eventloop_set_ui_ops ( GaimEventLoopUiOps *  ops  ) 

Sets the UI operations structure to be used for accounts.

Parameters:
ops The UI operations structure.

guint gaim_input_add ( int  fd,
GaimInputCondition  cond,
GaimInputFunction  func,
gpointer  user_data 
)

Adds an input handler.

Parameters:
fd The input file descriptor.
cond The condition type.
func The callback function for data.
user_data User-specified data.
Returns:
The resulting handle.
See also:
g_io_add_watch_full

guint gaim_input_remove ( guint  handle  ) 

Removes an input handler.

Parameters:
handle The handle of the input handler. Note that this is the return value from gaim_input_add, not the file descriptor.

guint gaim_timeout_add ( guint  interval,
GSourceFunc  function,
gpointer  data 
)

Creates a callback timer.

The timer will repeat until the function returns FALSE. The first call will be at the end of the first interval.

Parameters:
interval The time between calls of the function, in milliseconds.
function The function to call.
data data to pass to function.

guint gaim_timeout_remove ( guint  handle  ) 

Removes a timeout handler.

Parameters:
handle The handle, as returned by gaim_timeout_add.
Returns:
Something.


Generated on Sun Feb 18 07:52:20 2007 for gaim by  doxygen 1.5.1