core.h File Reference

Gaim Core API. More...

Go to the source code of this file.

Data Structures

struct  GaimCoreUiOps

Typedefs

typedef GaimCore GaimCore

Functions

gboolean gaim_core_init (const char *ui)
 Initializes the core of gaim.
void gaim_core_quit (void)
 Quits the core of gaim, which, depending on the UI, may quit the application using the gaim core.
gboolean gaim_core_quit_cb (gpointer unused)
 Calls gaim_core_quit().
const char * gaim_core_get_version (void)
 Returns the version of the core library.
const char * gaim_core_get_ui (void)
 Returns the ID of the UI that is using the core.
GaimCore * gaim_get_core (void)
 Returns a handle to the gaim core.
void gaim_core_set_ui_ops (GaimCoreUiOps *ops)
 Sets the UI ops for the core.
GaimCoreUiOps * gaim_core_get_ui_ops (void)
 Returns the UI ops for the core.


Detailed Description

Gaim Core API.


Function Documentation

const char* gaim_core_get_ui ( void   ) 

Returns the ID of the UI that is using the core.

Returns:
The ID of the UI that is currently using the core.

GaimCoreUiOps* gaim_core_get_ui_ops ( void   ) 

Returns the UI ops for the core.

Returns:
The core's UI ops structure.

const char* gaim_core_get_version ( void   ) 

Returns the version of the core library.

Returns:
The version of the core library.

gboolean gaim_core_init ( const char *  ui  ) 

Initializes the core of gaim.

This will setup preferences for all the core subsystems.

Parameters:
ui The ID of the UI using the core. This should be a unique ID, registered with the gaim team.
Returns:
TRUE if successful, or FALSE otherwise.

gboolean gaim_core_quit_cb ( gpointer  unused  ) 

Calls gaim_core_quit().

This can be used as the function passed to gaim_timeout_add() when you want to shutdown Gaim in a specified amount of time. When shutting down Gaim from a plugin, you must use this with a timeout value of 0: gaim_timeout_add(0, gaim_core_quitcb, NULL); This is ensures that code from your plugin is not being executed when gaim_core_quit() is called. Otherwise you would get a core dump after gaim_core_quit() executes and control returns to your plugin because gaim_core_quit() frees all plugins.

void gaim_core_set_ui_ops ( GaimCoreUiOps *  ops  ) 

Sets the UI ops for the core.

Parameters:
A UI ops structure for the core.

GaimCore* gaim_get_core ( void   ) 

Returns a handle to the gaim core.

This is used for such things as signals.


Generated on Sun Feb 18 08:38:20 2007 for gaim by  doxygen 1.5.1