prefs.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple 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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 */
#ifndef _PURPLE_PREFS_H_
#define _PURPLE_PREFS_H_
 
#include <glib.h>
 
typedef enum _PurplePrefType
{
    PURPLE_PREF_NONE,        
    PURPLE_PREF_BOOLEAN,     
    PURPLE_PREF_INT,         
    PURPLE_PREF_STRING,      
    PURPLE_PREF_STRING_LIST, 
    PURPLE_PREF_PATH,        
    PURPLE_PREF_PATH_LIST    
} PurplePrefType;
 
typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type,
        gconstpointer val, gpointer data);
 
typedef struct _PurplePrefCallbackData PurplePrefCallbackData;
 
 
typedef struct _PurplePrefsUiOps PurplePrefsUiOps;
 
 
struct _PurplePrefsUiOps
{
    void (*add_none)(const char *name);
    void (*add_bool)(const char *name, gboolean value);
    void (*add_int)(const char *name, int value);
    void (*add_string)(const char *name, const char *value);
    void (*add_string_list)(const char *name, GList *value);
 
    void (*set_bool)(const char *name, gboolean value);
    void (*set_int)(const char *name, int value);
    void (*set_string)(const char *name, const char *value);
    void (*set_string_list)(const char *name, GList *value);
 
    gboolean (*get_bool)(const char *name);
    int (*get_int)(const char *name);
    const char *(*get_string)(const char *name);
    GList *(*get_string_list)(const char *name);
 
    PurplePrefType (*get_type)(const char *name);
    GList *(*get_children_names)(const char *name);
 
    gboolean (*exists)(const char *name);
    void (*remove)(const char *name);
 
    void (*rename)(const char *oldname, const char *newname);
    void (*rename_boolean_toggle)(const char *oldname, const char *newname);
 
    gboolean (*load)(void);
    void (*save)(void);
    void (*schedule_save)(void);
 
    void *(*connect_callback)(const char *name, PurplePrefCallbackData *data);
 
    void (*disconnect_callback)(const char *name, void *ui_data);
 
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    void (*_purple_reserved4)(void);
    void (*_purple_reserved5)(void);
};
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
void purple_prefs_set_ui_ops(PurplePrefsUiOps *ops);
 
PurplePrefsUiOps *purple_prefs_get_ui_ops(void);
 
/**************************************************************************/
/**************************************************************************/
void *purple_prefs_get_handle(void);
 
void purple_prefs_init(void);
 
void purple_prefs_uninit(void);
 
void purple_prefs_add_none(const char *name);
 
void purple_prefs_add_bool(const char *name, gboolean value);
 
void purple_prefs_add_int(const char *name, int value);
 
void purple_prefs_add_string(const char *name, const char *value);
 
void purple_prefs_add_string_list(const char *name, GList *value);
 
void purple_prefs_add_path(const char *name, const char *value);
 
void purple_prefs_add_path_list(const char *name, GList *value);
 
 
void purple_prefs_remove(const char *name);
 
void purple_prefs_rename(const char *oldname, const char *newname);
 
void purple_prefs_rename_boolean_toggle(const char *oldname, const char *newname);
 
void purple_prefs_destroy(void);
 
/* TODO: When this is removed, also remove struct purple_pref->value.generic */
void purple_prefs_set_generic(const char *name, gpointer value);
 
void purple_prefs_set_bool(const char *name, gboolean value);
 
void purple_prefs_set_int(const char *name, int value);
 
void purple_prefs_set_string(const char *name, const char *value);
 
void purple_prefs_set_string_list(const char *name, GList *value);
 
void purple_prefs_set_path(const char *name, const char *value);
 
void purple_prefs_set_path_list(const char *name, GList *value);
 
 
gboolean purple_prefs_exists(const char *name);
 
PurplePrefType purple_prefs_get_type(const char *name);
 
gboolean purple_prefs_get_bool(const char *name);
 
int purple_prefs_get_int(const char *name);
 
const char *purple_prefs_get_string(const char *name);
 
GList *purple_prefs_get_string_list(const char *name);
 
const char *purple_prefs_get_path(const char *name);
 
GList *purple_prefs_get_path_list(const char *name);
 
GList *purple_prefs_get_children_names(const char *name);
 
guint purple_prefs_connect_callback(void *handle, const char *name, PurplePrefCallback cb,
        gpointer data);
 
void purple_prefs_disconnect_callback(guint callback_id);
 
void purple_prefs_disconnect_by_handle(void *handle);
 
void purple_prefs_trigger_callback(const char *name);
 
void purple_prefs_trigger_callback_object(PurplePrefCallbackData *data);
 
 
gboolean purple_prefs_load(void);
 
void purple_prefs_update_old(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_PREFS_H_ */