signals.h File Reference

Signal API

gaim. More...

#include <glib.h>
#include "value.h"

Include dependency graph for signals.h:

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

Go to the source code of this file.

Signal API

#define GAIM_SIGNAL_PRIORITY_DEFAULT   0
 Signal Connect Priorities.
#define GAIM_SIGNAL_PRIORITY_HIGHEST   9999
#define GAIM_SIGNAL_PRIORITY_LOWEST   -9999
gulong gaim_signal_register (void *instance, const char *signal, GaimSignalMarshalFunc marshal, GaimValue *ret_value, int num_values,...)
 Registers a signal in an instance.
void gaim_signal_unregister (void *instance, const char *signal)
 Unregisters a signal in an instance.
void gaim_signals_unregister_by_instance (void *instance)
 Unregisters all signals in an instance.
void gaim_signal_get_values (void *instance, const char *signal, GaimValue **ret_value, int *num_values, GaimValue ***values)
 Returns a list of value types used for a signal.
gulong gaim_signal_connect_priority (void *instance, const char *signal, void *handle, GaimCallback func, void *data, int priority)
 Connects a signal handler to a signal for a particular object.
gulong gaim_signal_connect (void *instance, const char *signal, void *handle, GaimCallback func, void *data)
 Connects a signal handler to a signal for a particular object.
gulong gaim_signal_connect_priority_vargs (void *instance, const char *signal, void *handle, GaimCallback func, void *data, int priority)
 Connects a signal handler to a signal for a particular object.
gulong gaim_signal_connect_vargs (void *instance, const char *signal, void *handle, GaimCallback func, void *data)
 Connects a signal handler to a signal for a particular object.
void gaim_signal_disconnect (void *instance, const char *signal, void *handle, GaimCallback func)
 Disconnects a signal handler from a signal on an object.
void gaim_signals_disconnect_by_handle (void *handle)
 Removes all callbacks associated with a receiver handle.
void gaim_signal_emit (void *instance, const char *signal,...)
 Emits a signal.
void gaim_signal_emit_vargs (void *instance, const char *signal, va_list args)
 Emits a signal, using a va_list of arguments.
void * gaim_signal_emit_return_1 (void *instance, const char *signal,...)
 Emits a signal and returns the return value from the last handler.
void * gaim_signal_emit_vargs_return_1 (void *instance, const char *signal, va_list args)
 Emits a signal and returns the return value from the last handler.
void gaim_signals_init ()
 Initializes the signals subsystem.
void gaim_signals_uninit ()
 Uninitializes the signals subsystem.

Marshal Functions

void gaim_marshal_VOID (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__INT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__INT_INT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_UINT_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_POINTER_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_VOID__POINTER_POINTER_POINTER_UINT_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_INT__INT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_INT__INT_INT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER_POINTER_UINT (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)
void gaim_marshal_BOOLEAN__POINTER_POINTER_POINTER_POINTER_POINTER (GaimCallback cb, va_list args, void *data, void **return_val)

Defines

#define GAIM_CALLBACK(func)   ((GaimCallback)func)

Typedefs

typedef void(*) GaimCallback (void)
typedef void(*) GaimSignalMarshalFunc (GaimCallback cb, va_list args, void *data, void **return_val)


Detailed Description

Signal 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


Function Documentation

gulong gaim_signal_connect ( void *  instance,
const char *  signal,
void *  handle,
GaimCallback  func,
void *  data 
)

Connects a signal handler to a signal for a particular object.

(priority defaults to 0)

Take care not to register a handler function twice. Gaim will not correct any mistakes for you in this area.

Parameters:
instance The instance to connect to.
signal The name of the signal to connect.
handle The handle of the receiver.
func The callback function.
data The data to pass to the callback function.
Returns:
The signal handler ID.
See also:
gaim_signal_disconnect()

gulong gaim_signal_connect_priority ( void *  instance,
const char *  signal,
void *  handle,
GaimCallback  func,
void *  data,
int  priority 
)

Connects a signal handler to a signal for a particular object.

Take care not to register a handler function twice. Gaim will not correct any mistakes for you in this area.

Parameters:
instance The instance to connect to.
signal The name of the signal to connect.
handle The handle of the receiver.
func The callback function.
data The data to pass to the callback function.
priority The order in which the signal should be added to the list
Returns:
The signal handler ID.
See also:
gaim_signal_disconnect()

gulong gaim_signal_connect_priority_vargs ( void *  instance,
const char *  signal,
void *  handle,
GaimCallback  func,
void *  data,
int  priority 
)

Connects a signal handler to a signal for a particular object.

The signal handler will take a va_args of arguments, instead of individual arguments.

Take care not to register a handler function twice. Gaim will not correct any mistakes for you in this area.

Parameters:
instance The instance to connect to.
signal The name of the signal to connect.
handle The handle of the receiver.
func The callback function.
data The data to pass to the callback function.
priority The order in which the signal should be added to the list
Returns:
The signal handler ID.
See also:
gaim_signal_disconnect()

gulong gaim_signal_connect_vargs ( void *  instance,
const char *  signal,
void *  handle,
GaimCallback  func,
void *  data 
)

Connects a signal handler to a signal for a particular object.

(priority defaults to 0) The signal handler will take a va_args of arguments, instead of individual arguments.

Take care not to register a handler function twice. Gaim will not correct any mistakes for you in this area.

Parameters:
instance The instance to connect to.
signal The name of the signal to connect.
handle The handle of the receiver.
func The callback function.
data The data to pass to the callback function.
Returns:
The signal handler ID.
See also:
gaim_signal_disconnect()

void gaim_signal_disconnect ( void *  instance,
const char *  signal,
void *  handle,
GaimCallback  func 
)

Disconnects a signal handler from a signal on an object.

Parameters:
instance The instance to disconnect from.
signal The name of the signal to disconnect.
handle The handle of the receiver.
func The registered function to disconnect.
See also:
gaim_signal_connect()

void gaim_signal_emit ( void *  instance,
const char *  signal,
  ... 
)

Emits a signal.

Parameters:
instance The instance emitting the signal.
signal The signal being emitted.
See also:
gaim_signal_connect()

gaim_signal_disconnect()

void* gaim_signal_emit_return_1 ( void *  instance,
const char *  signal,
  ... 
)

Emits a signal and returns the return value from the last handler.

Parameters:
instance The instance emitting the signal.
signal The signal being emitted.
Returns:
The return value from the last handler.

void gaim_signal_emit_vargs ( void *  instance,
const char *  signal,
va_list  args 
)

Emits a signal, using a va_list of arguments.

Parameters:
instance The instance emitting the signal.
signal The signal being emitted.
args The arguments list.
See also:
gaim_signal_connect()

gaim_signal_disconnect()

void* gaim_signal_emit_vargs_return_1 ( void *  instance,
const char *  signal,
va_list  args 
)

Emits a signal and returns the return value from the last handler.

Parameters:
instance The instance emitting the signal.
signal The signal being emitted.
args The arguments list.
Returns:
The return value from the last handler.

void gaim_signal_get_values ( void *  instance,
const char *  signal,
GaimValue **  ret_value,
int *  num_values,
GaimValue ***  values 
)

Returns a list of value types used for a signal.

Parameters:
instance The instance the signal is registered to.
signal The signal.
ret_value The return value from the last signal handler.
num_values The returned number of values.
values The returned list of values.

gulong gaim_signal_register ( void *  instance,
const char *  signal,
GaimSignalMarshalFunc  marshal,
GaimValue ret_value,
int  num_values,
  ... 
)

Registers a signal in an instance.

Parameters:
instance The instance to register the signal for.
signal The signal name.
marshal The marshal function.
ret_value The return value type, or NULL for no return value.
num_values The number of values to be passed to the callbacks.
... The values to pass to the callbacks.
Returns:
The signal ID local to that instance, or 0 if the signal couldn't be registered.
See also:
GaimValue

void gaim_signal_unregister ( void *  instance,
const char *  signal 
)

Unregisters a signal in an instance.

Parameters:
instance The instance to unregister the signal for.
signal The signal name.

void gaim_signals_disconnect_by_handle ( void *  handle  ) 

Removes all callbacks associated with a receiver handle.

Parameters:
handle The receiver handle.

void gaim_signals_unregister_by_instance ( void *  instance  ) 

Unregisters all signals in an instance.

Parameters:
instance The instance to unregister the signal for.


Generated on Wed Aug 9 23:40:51 2006 for gaim by  doxygen 1.4.7