kpsettings

kpsettings —

Synopsis




gboolean    kp_settings_init                (const gchar *filename);
void        kp_settings_deinit              (void);
void        kp_settings_save                (void);
void        kp_settings_remove_setting      (const gchar *setting);
gint        kp_settings_get_int             (const gchar *setting);
gchar*      kp_settings_get_str             (const gchar *setting);
gboolean    kp_settings_get_bool            (const gchar *setting);
GSList*     kp_settings_get_list            (const gchar *setting);
void        kp_settings_set_str             (const gchar *setting,
                                             const gchar *val,
                                             gboolean replace);
void        kp_settings_set_int             (const gchar *setting,
                                             gint value);
void        kp_settings_set_bool            (const gchar *setting,
                                             gboolean value);
void        kp_settings_add_to_list         (const gchar *setting,
                                             const gchar *value);
void        kp_settings_remove_from_list    (const gchar *setting,
                                             const gchar *value);
void        kp_settings_list_free           (GSList *list);

Description

Details

kp_settings_init ()

gboolean    kp_settings_init                (const gchar *filename);

filename :
Returns :

kp_settings_deinit ()

void        kp_settings_deinit              (void);


kp_settings_save ()

void        kp_settings_save                (void);

Save the settings to the disk.


kp_settings_remove_setting ()

void        kp_settings_remove_setting      (const gchar *setting);

setting :

kp_settings_get_int ()

gint        kp_settings_get_int             (const gchar *setting);

setting :
Returns :

kp_settings_get_str ()

gchar*      kp_settings_get_str             (const gchar *setting);

Get the value of the setting as string.

setting : The name of the setting
Returns : String that must not be freed, it is not copied.

kp_settings_get_bool ()

gboolean    kp_settings_get_bool            (const gchar *setting);

Get the value of this setting as boolean.

setting : The name of the setting
Returns : TRUE if setting's value is true or if there is no setting setting.

kp_settings_get_list ()

GSList*     kp_settings_get_list            (const gchar *setting);

setting :
Returns :

kp_settings_set_str ()

void        kp_settings_set_str             (const gchar *setting,
                                             const gchar *val,
                                             gboolean replace);

Sets setting to be val. If replace is TRUE and setting with name setting already exists, that setting will be replaced with the new one. If replace is FALSE and there is already a setting with that name, they will go both to the hashtable and key will be like: "setting" and value will be like: "value1;value2;value3".

setting : The name of the setting
val : Value of the setting, can be almost anything
replace : if TRUE and the setting is set, it will be replaced and otherwise not.

kp_settings_set_int ()

void        kp_settings_set_int             (const gchar *setting,
                                             gint value);

Set the value.

setting : The name of the setting
value : Any integer value

kp_settings_set_bool ()

void        kp_settings_set_bool            (const gchar *setting,
                                             gboolean value);

Just set the value of some setting to TRUE or FALSE.

setting : The name of the setting
value : TRUE or FALSE

kp_settings_add_to_list ()

void        kp_settings_add_to_list         (const gchar *setting,
                                             const gchar *value);

Adds the value to list of values or creates a new setting if there is no such setting in the hashtable.

setting : Name of the setting
value : Value to add to the list

kp_settings_remove_from_list ()

void        kp_settings_remove_from_list    (const gchar *setting,
                                             const gchar *value);

Removes the value from list of values or removes the setting from the hashtable.

setting : Name of the setting
value : Value to remove from the list

kp_settings_list_free ()

void        kp_settings_list_free           (GSList *list);

list :