Mercurial > pidgin.yaz
view src/prefs.h @ 8273:f24172f53650
[gaim-migrate @ 8997]
This is Scott Lamb's eventloop abstraction patch. If it breaks things,
Scott Lamb will be glad to take the punishment. If it doesn't, it should
make integration into other event loops easier. Well, no, not easier,
harder actually, but it'll be done more appropriately and less hackily..
er, hacky. Is hackily a word?
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Tue, 17 Feb 2004 02:17:48 +0000 |
parents | 63c7a16a2c09 |
children | 543b19a96ac5 |
line wrap: on
line source
/** * @file prefs.h Prefs 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 * */ #ifndef _PREFS_H_ #define _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 } GaimPrefType; /** * Pref change callback type */ typedef void (*GaimPrefCallback) (const char *name, GaimPrefType type, gpointer val, gpointer data); #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Prefs API */ /**************************************************************************/ /*@{*/ /** * Initialize core prefs */ void gaim_prefs_init(); /** * 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); /** * 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); /** * Remove all prefs. */ void gaim_prefs_destroy(); /** * 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 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); /** * 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 pref value * * @param name The name of the pref * @return The value of the pref */ GList *gaim_prefs_get_string_list(const char *name); /** * Add a callback to a pref (and its children) */ guint gaim_prefs_connect_callback(const char *name, GaimPrefCallback cb, gpointer data); /** * Remove a callback to a pref */ void gaim_prefs_disconnect_callback(guint callback_id); /** * Trigger callbacks as if the pref changed */ void gaim_prefs_trigger_callback(const char *name); /** * Read preferences */ gboolean gaim_prefs_load(); /** * Force an immediate write of preferences */ void gaim_prefs_sync(); /** * Rename legacy prefs */ void gaim_prefs_rename_old(); /*@}*/ #ifdef __cplusplus } #endif #endif /* _PREFS_H_ */