prefs.h

Go to the documentation of this file.
00001 
00006 /* purple
00007  *
00008  * Purple is the legal property of its developers, whose names are too numerous
00009  * to list here.  Please refer to the COPYRIGHT file distributed with this
00010  * source distribution.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00025  *
00026  */
00027 #ifndef _PURPLE_PREFS_H_
00028 #define _PURPLE_PREFS_H_
00029 
00030 #include <glib.h>
00031 
00035 typedef enum _PurplePrefType
00036 {
00037     PURPLE_PREF_NONE,        
00038     PURPLE_PREF_BOOLEAN,     
00039     PURPLE_PREF_INT,         
00040     PURPLE_PREF_STRING,      
00041     PURPLE_PREF_STRING_LIST, 
00042     PURPLE_PREF_PATH,        
00043     PURPLE_PREF_PATH_LIST    
00045 } PurplePrefType;
00046 
00062 typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type,
00063         gconstpointer val, gpointer data);
00064 
00070 typedef struct _PurplePrefCallbackData PurplePrefCallbackData;
00071 
00072 
00074 typedef struct _PurplePrefsUiOps PurplePrefsUiOps;
00075 
00076 
00087 struct _PurplePrefsUiOps
00088 {
00089     void (*add_none)(const char *name);
00090     void (*add_bool)(const char *name, gboolean value);
00091     void (*add_int)(const char *name, int value);
00092     void (*add_string)(const char *name, const char *value);
00093     void (*add_string_list)(const char *name, GList *value);
00094 
00095     void (*set_bool)(const char *name, gboolean value);
00096     void (*set_int)(const char *name, int value);
00097     void (*set_string)(const char *name, const char *value);
00098     void (*set_string_list)(const char *name, GList *value);
00099 
00100     gboolean (*get_bool)(const char *name);
00101     int (*get_int)(const char *name);
00102     const char *(*get_string)(const char *name);
00103     GList *(*get_string_list)(const char *name);
00104 
00105     PurplePrefType (*get_type)(const char *name);
00106     GList *(*get_children_names)(const char *name);
00107 
00108     gboolean (*exists)(const char *name);
00109     void (*remove)(const char *name);
00110 
00111     void (*rename)(const char *oldname, const char *newname);
00112     void (*rename_boolean_toggle)(const char *oldname, const char *newname);
00113 
00114     gboolean (*load)(void);
00115     void (*save)(void);
00116     void (*schedule_save)(void);
00117 
00127     void *(*connect_callback)(const char *name, PurplePrefCallbackData *data);
00128 
00137     void (*disconnect_callback)(const char *name, void *ui_data);
00138 
00139     void (*_purple_reserved1)(void);
00140     void (*_purple_reserved2)(void);
00141     void (*_purple_reserved3)(void);
00142     void (*_purple_reserved4)(void);
00143     void (*_purple_reserved5)(void);
00144 };
00145 
00146 
00147 
00148 #ifdef __cplusplus
00149 extern "C" {
00150 #endif
00151 
00152 /**************************************************************************/
00154 /**************************************************************************/
00162 void purple_prefs_set_ui_ops(PurplePrefsUiOps *ops);
00163 
00170 PurplePrefsUiOps *purple_prefs_get_ui_ops(void);
00171 
00174 /**************************************************************************/
00178 /**************************************************************************/
00186 void *purple_prefs_get_handle(void);
00187 
00191 void purple_prefs_init(void);
00192 
00196 void purple_prefs_uninit(void);
00197 
00203 void purple_prefs_add_none(const char *name);
00204 
00211 void purple_prefs_add_bool(const char *name, gboolean value);
00212 
00219 void purple_prefs_add_int(const char *name, int value);
00220 
00227 void purple_prefs_add_string(const char *name, const char *value);
00228 
00238 void purple_prefs_add_string_list(const char *name, GList *value);
00239 
00246 void purple_prefs_add_path(const char *name, const char *value);
00247 
00257 void purple_prefs_add_path_list(const char *name, GList *value);
00258 
00259 
00265 void purple_prefs_remove(const char *name);
00266 
00273 void purple_prefs_rename(const char *oldname, const char *newname);
00274 
00281 void purple_prefs_rename_boolean_toggle(const char *oldname, const char *newname);
00282 
00286 void purple_prefs_destroy(void);
00287 
00302 /* TODO: When this is removed, also remove struct purple_pref->value.generic */
00303 void purple_prefs_set_generic(const char *name, gpointer value);
00304 
00311 void purple_prefs_set_bool(const char *name, gboolean value);
00312 
00319 void purple_prefs_set_int(const char *name, int value);
00320 
00327 void purple_prefs_set_string(const char *name, const char *value);
00328 
00335 void purple_prefs_set_string_list(const char *name, GList *value);
00336 
00343 void purple_prefs_set_path(const char *name, const char *value);
00344 
00351 void purple_prefs_set_path_list(const char *name, GList *value);
00352 
00353 
00360 gboolean purple_prefs_exists(const char *name);
00361 
00368 PurplePrefType purple_prefs_get_type(const char *name);
00369 
00376 gboolean purple_prefs_get_bool(const char *name);
00377 
00384 int purple_prefs_get_int(const char *name);
00385 
00392 const char *purple_prefs_get_string(const char *name);
00393 
00400 GList *purple_prefs_get_string_list(const char *name);
00401 
00408 const char *purple_prefs_get_path(const char *name);
00409 
00416 GList *purple_prefs_get_path_list(const char *name);
00417 
00428 GList *purple_prefs_get_children_names(const char *name);
00429 
00442 guint purple_prefs_connect_callback(void *handle, const char *name, PurplePrefCallback cb,
00443         gpointer data);
00444 
00448 void purple_prefs_disconnect_callback(guint callback_id);
00449 
00453 void purple_prefs_disconnect_by_handle(void *handle);
00454 
00458 void purple_prefs_trigger_callback(const char *name);
00459 
00466 void purple_prefs_trigger_callback_object(PurplePrefCallbackData *data);
00467 
00468 
00472 gboolean purple_prefs_load(void);
00473 
00477 void purple_prefs_update_old(void);
00478 
00481 #ifdef __cplusplus
00482 }
00483 #endif
00484 
00485 #endif /* _PURPLE_PREFS_H_ */