CodeSlayerSettings

CodeSlayerSettings — The application properties.

Synopsis

#include <codeslayer/codeslayer-settings.h>

#define             CODESLAYER_SETTINGS_HPANED_POSITION
#define             CODESLAYER_SETTINGS_VPANED_POSITION
#define             CODESLAYER_SETTINGS_WINDOW_WIDTH
#define             CODESLAYER_SETTINGS_WINDOW_HEIGHT
#define             CODESLAYER_SETTINGS_WINDOW_X
#define             CODESLAYER_SETTINGS_WINDOW_Y
#define             CODESLAYER_SETTINGS_SEARCH_WIDTH
#define             CODESLAYER_SETTINGS_SEARCH_HEIGHT
#define             CODESLAYER_SETTINGS_SEARCH_X
#define             CODESLAYER_SETTINGS_SEARCH_Y
#define             CODESLAYER_SETTINGS_MAIN_TITLE
#define             CODESLAYER_SETTINGS_SIDE_PANE_VISIBLE
#define             CODESLAYER_SETTINGS_BOTTOM_PANE_VISIBLE
#define             CODESLAYER_SETTINGS_DRAW_SPACES
#define             CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_CASE
#define             CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_WORD
#define             CODESLAYER_SETTINGS_SYNC_WITH_EDITOR
struct              CodeSlayerSettings;
CodeSlayerSettings * codeslayer_settings_new            (void);
gint                codeslayer_settings_get_integer     (CodeSlayerSettings *settings,
                                                         gchar *key);
void                codeslayer_settings_set_integer     (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gint value);
gdouble             codeslayer_settings_get_double      (CodeSlayerSettings *settings,
                                                         gchar *key);
void                codeslayer_settings_set_double      (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gdouble value);
gboolean            codeslayer_settings_get_boolean     (CodeSlayerSettings *settings,
                                                         gchar *key);
void                codeslayer_settings_set_boolean     (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gboolean value);
gchar *             codeslayer_settings_get_string      (CodeSlayerSettings *settings,
                                                         gchar *key);
void                codeslayer_settings_set_string      (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         const gchar *value);
void                codeslayer_settings_save            (CodeSlayerSettings *settings);

Object Hierarchy

  GObject
   +----CodeSlayerSettings

Description

Saves the application settings using the GKeyFile. The file is saved in the users home directory under the .codeslayer folder.

Details

CODESLAYER_SETTINGS_HPANED_POSITION

#define CODESLAYER_SETTINGS_HPANED_POSITION "hpaned_position"

CODESLAYER_SETTINGS_VPANED_POSITION

#define CODESLAYER_SETTINGS_VPANED_POSITION "vpaned_position"

CODESLAYER_SETTINGS_WINDOW_WIDTH

#define CODESLAYER_SETTINGS_WINDOW_WIDTH "window_width"

CODESLAYER_SETTINGS_WINDOW_HEIGHT

#define CODESLAYER_SETTINGS_WINDOW_HEIGHT "window_height"

CODESLAYER_SETTINGS_WINDOW_X

#define CODESLAYER_SETTINGS_WINDOW_X "window_x"

CODESLAYER_SETTINGS_WINDOW_Y

#define CODESLAYER_SETTINGS_WINDOW_Y "window_y"

CODESLAYER_SETTINGS_SEARCH_WIDTH

#define CODESLAYER_SETTINGS_SEARCH_WIDTH "search_width"

CODESLAYER_SETTINGS_SEARCH_HEIGHT

#define CODESLAYER_SETTINGS_SEARCH_HEIGHT "search_height"

CODESLAYER_SETTINGS_SEARCH_X

#define CODESLAYER_SETTINGS_SEARCH_X "search_x"

CODESLAYER_SETTINGS_SEARCH_Y

#define CODESLAYER_SETTINGS_SEARCH_Y "search_y"

CODESLAYER_SETTINGS_MAIN_TITLE

#define CODESLAYER_SETTINGS_MAIN_TITLE "CodeSlayer"

CODESLAYER_SETTINGS_SIDE_PANE_VISIBLE

#define CODESLAYER_SETTINGS_SIDE_PANE_VISIBLE "side_pane_visible"

CODESLAYER_SETTINGS_BOTTOM_PANE_VISIBLE

#define CODESLAYER_SETTINGS_BOTTOM_PANE_VISIBLE "bottom_pane_visible"

CODESLAYER_SETTINGS_DRAW_SPACES

#define CODESLAYER_SETTINGS_DRAW_SPACES "draw_spaces"

CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_CASE

#define CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_CASE "notebook_search_match_case"

CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_WORD

#define CODESLAYER_SETTINGS_NOTEBOOK_SEARCH_MATCH_WORD "notebook_search_match_word"

CODESLAYER_SETTINGS_SYNC_WITH_EDITOR

#define CODESLAYER_SETTINGS_SYNC_WITH_EDITOR "sync_with_editor"

struct CodeSlayerSettings

struct CodeSlayerSettings;

codeslayer_settings_new ()

CodeSlayerSettings * codeslayer_settings_new            (void);

Creates a new CodeSlayerSettings.

Returns :

a new CodeSlayerSettings.

codeslayer_settings_get_integer ()

gint                codeslayer_settings_get_integer     (CodeSlayerSettings *settings,
                                                         gchar *key);

settings :

a CodeSlayerSettings.

key :

a property name.

Returns :

the value as an integer for the given key.

codeslayer_settings_set_integer ()

void                codeslayer_settings_set_integer     (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gint value);

settings :

a CodeSlayerSettings.

key :

a property name.

value :

a property value as a gint.

codeslayer_settings_get_double ()

gdouble             codeslayer_settings_get_double      (CodeSlayerSettings *settings,
                                                         gchar *key);

settings :

a CodeSlayerSettings.

key :

a property name.

Returns :

the value as a double for the given key.

codeslayer_settings_set_double ()

void                codeslayer_settings_set_double      (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gdouble value);

settings :

a CodeSlayerSettings.

key :

a property name.

value :

a property value as a gdouble.

codeslayer_settings_get_boolean ()

gboolean            codeslayer_settings_get_boolean     (CodeSlayerSettings *settings,
                                                         gchar *key);

settings :

a CodeSlayerSettings.

key :

a property name.

Returns :

the value as a boolean for the given key.

codeslayer_settings_set_boolean ()

void                codeslayer_settings_set_boolean     (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         gboolean value);

settings :

a CodeSlayerSettings.

key :

a property name.

value :

a property value as a gboolean.

codeslayer_settings_get_string ()

gchar *             codeslayer_settings_get_string      (CodeSlayerSettings *settings,
                                                         gchar *key);

settings :

a CodeSlayerSettings.

key :

a property name.

Returns :

the value as a string for the given key.

codeslayer_settings_set_string ()

void                codeslayer_settings_set_string      (CodeSlayerSettings *settings,
                                                         gchar *key,
                                                         const gchar *value);

settings :

a CodeSlayerSettings.

key :

a property name.

value :

a property value as a gchar pointer.

codeslayer_settings_save ()

void                codeslayer_settings_save            (CodeSlayerSettings *settings);

Save the users preference to disk.

settings :

a CodeSlayerSettings.