pidgin/pidgin

merge of '77693555855fe9cd3215414f79964dba346cc5fa'
gaim
2008-11-12, Richard Laager
1966704b3e42
merge of '77693555855fe9cd3215414f79964dba346cc5fa'
and '19a87e98e5857ad0289f2c760d460f7f1dbbb42d'
/**
* @file prefs.h Prefs 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_PREFS_H_
#define _GAIM_PREFS_H_
#include <glib.h>
/**
* Pref data types.
*/
typedef enum _GaimPrefType
{
GAIM_PREF_NONE,
GAIM_PREF_BOOLEAN,
GAIM_PREF_INT,
GAIM_PREF_STRING,
GAIM_PREF_STRING_LIST,
GAIM_PREF_PATH,
GAIM_PREF_PATH_LIST
} GaimPrefType;
/**
* Pref change callback type
*/
typedef void (*GaimPrefCallback) (const char *name, GaimPrefType type,
gconstpointer val, gpointer data);
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Prefs API */
/**************************************************************************/
/*@{*/
/**
* Returns the prefs subsystem handle.
*
* @return The prefs subsystem handle.
*/
void *gaim_prefs_get_handle(void);
/**
* Initialize core prefs
*/
void gaim_prefs_init(void);
/**
* Uninitializes the prefs subsystem.
*/
void gaim_prefs_uninit(void);
/**
* Add a new typeless pref.
*
* @param name The name of the pref
*/
void gaim_prefs_add_none(const char *name);
/**
* Add a new boolean pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_bool(const char *name, gboolean value);
/**
* Add a new integer pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_int(const char *name, int value);
/**
* Add a new string pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_string(const char *name, const char *value);
/**
* Add a new string list pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_string_list(const char *name, GList *value);
/**
* Add a new path pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_path(const char *name, const char *value);
/**
* Add a new path list pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void gaim_prefs_add_path_list(const char *name, GList *value);
/**
* Remove a pref.
*
* @param name The name of the pref
*/
void gaim_prefs_remove(const char *name);
/**
* Rename a pref
*
* @param oldname The old name of the pref
* @param newname The new name for the pref
*/
void gaim_prefs_rename(const char *oldname, const char *newname);
/**
* Rename a boolean pref, toggling it's value
*
* @param oldname The old name of the pref
* @param newname The new name for the pref
*/
void gaim_prefs_rename_boolean_toggle(const char *oldname, const char *newname);
/**
* Remove all prefs.
*/
void gaim_prefs_destroy(void);
/**
* Set raw pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_generic(const char *name, gpointer value);
/**
* Set boolean pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_bool(const char *name, gboolean value);
/**
* Set integer pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_int(const char *name, int value);
/**
* Set string pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_string(const char *name, const char *value);
/**
* Set string list pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_string_list(const char *name, GList *value);
/**
* Set path pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_path(const char *name, const char *value);
/**
* Set path list pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void gaim_prefs_set_path_list(const char *name, GList *value);
/**
* Check if a pref exists
*
* @param name The name of the pref
* @return TRUE if the pref exists. Otherwise FALSE.
*/
gboolean gaim_prefs_exists(const char *name);
/**
* Get pref type
*
* @param name The name of the pref
* @return The type of the pref
*/
GaimPrefType gaim_prefs_get_type(const char *name);
/**
* Get boolean pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
gboolean gaim_prefs_get_bool(const char *name);
/**
* Get integer pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
int gaim_prefs_get_int(const char *name);
/**
* Get string pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
const char *gaim_prefs_get_string(const char *name);
/**
* Get string list pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
GList *gaim_prefs_get_string_list(const char *name);
/**
* Get path pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
const char *gaim_prefs_get_path(const char *name);
/**
* Get path list pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
GList *gaim_prefs_get_path_list(const char *name);
/**
* Add a callback to a pref (and its children)
*/
guint gaim_prefs_connect_callback(void *handle, const char *name, GaimPrefCallback cb,
gpointer data);
/**
* Remove a callback to a pref
*/
void gaim_prefs_disconnect_callback(guint callback_id);
/**
* Remove all pref callbacks by handle
*/
void gaim_prefs_disconnect_by_handle(void *handle);
/**
* Trigger callbacks as if the pref changed
*/
void gaim_prefs_trigger_callback(const char *name);
/**
* Read preferences
*/
gboolean gaim_prefs_load(void);
/**
* Rename legacy prefs and delete some that no longer exist.
*/
void gaim_prefs_update_old(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _GAIM_PREFS_H_ */