CodeSlayerPreferences

CodeSlayerPreferences — The group preferences.

Synopsis

#include <codeslayer/codeslayer-preferences.h>

#define             CODESLAYER_PREFERENCES_EDITOR_DISPLAY_LINE_NUMBERS
#define             CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_CURRENT_LINE
#define             CODESLAYER_PREFERENCES_EDITOR_DISPLAY_RIGHT_MARGIN
#define             CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_MATCHING_BRACKET
#define             CODESLAYER_PREFERENCES_EDITOR_INSERT_SPACES_INSTEAD_OF_TABS
#define             CODESLAYER_PREFERENCES_EDITOR_ENABLE_AUTOMATIC_INDENTATION
#define             CODESLAYER_PREFERENCES_EDITOR_RIGHT_MARGIN_POSITION
#define             CODESLAYER_PREFERENCES_EDITOR_TAB_WIDTH
#define             CODESLAYER_PREFERENCES_EDITOR_FONT
#define             CODESLAYER_PREFERENCES_EDITOR_THEME
#define             CODESLAYER_PREFERENCES_BOTTOM_PANE_TAB_POSITION
#define             CODESLAYER_PREFERENCES_SIDE_PANE_TAB_POSITION
#define             CODESLAYER_HOME
#define             CODESLAYER_PREFERENCES_EDITOR_WORD_WRAP_TYPES
#define             CODESLAYER_PREFERENCES_EDITOR_TAB_POSITION
#define             CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_DIRS
#define             CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_TYPES
struct              CodeSlayerPreferences;
CodeSlayerPreferences * codeslayer_preferences_new      (GtkWidget *window);
gint                codeslayer_preferences_get_integer  (CodeSlayerPreferences *preferences,
                                                         gchar *key);
void                codeslayer_preferences_set_integer  (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gint value);
gdouble             codeslayer_preferences_get_double   (CodeSlayerPreferences *preferences,
                                                         gchar *key);
void                codeslayer_preferences_set_double   (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gdouble value);
gboolean            codeslayer_preferences_get_boolean  (CodeSlayerPreferences *preferences,
                                                         gchar *key);
void                codeslayer_preferences_set_boolean  (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gboolean value);
gchar *             codeslayer_preferences_get_string   (CodeSlayerPreferences *preferences,
                                                         gchar *key);
void                codeslayer_preferences_set_string   (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         const gchar *value);
void                codeslayer_preferences_save         (CodeSlayerPreferences *preferences);
void                codeslayer_preferences_run_dialog   (CodeSlayerPreferences *preferences);

Object Hierarchy

  GObject
   +----CodeSlayerPreferences

Signals

  "bottom-pane-preferences-changed"                : No Hooks
  "editor-preferences-changed"                     : No Hooks
  "initialize-preferences"                         : No Hooks
  "notebook-preferences-changed"                   : No Hooks
  "projects-preferences-changed"                   : No Hooks
  "side-pane-preferences-changed"                  : No Hooks

Description

Saves the group preferences using the GKeyFile. The file is saved in the users home directory under the .codeslayer/groups/"active group" folder.

Details

CODESLAYER_PREFERENCES_EDITOR_DISPLAY_LINE_NUMBERS

#define CODESLAYER_PREFERENCES_EDITOR_DISPLAY_LINE_NUMBERS "editor_display_line_numbers"

CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_CURRENT_LINE

#define CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_CURRENT_LINE "editor_highlight_current_line"

CODESLAYER_PREFERENCES_EDITOR_DISPLAY_RIGHT_MARGIN

#define CODESLAYER_PREFERENCES_EDITOR_DISPLAY_RIGHT_MARGIN "editor_display_right_margin"

CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_MATCHING_BRACKET

#define CODESLAYER_PREFERENCES_EDITOR_HIGHLIGHT_MATCHING_BRACKET "editor_highlight_matching_bracket"

CODESLAYER_PREFERENCES_EDITOR_INSERT_SPACES_INSTEAD_OF_TABS

#define CODESLAYER_PREFERENCES_EDITOR_INSERT_SPACES_INSTEAD_OF_TABS "editor_insert_spaces_instead_of_tabs"

CODESLAYER_PREFERENCES_EDITOR_ENABLE_AUTOMATIC_INDENTATION

#define CODESLAYER_PREFERENCES_EDITOR_ENABLE_AUTOMATIC_INDENTATION "editor_enable_automatic_indentation"

CODESLAYER_PREFERENCES_EDITOR_RIGHT_MARGIN_POSITION

#define CODESLAYER_PREFERENCES_EDITOR_RIGHT_MARGIN_POSITION "editor_right_margin_position"

CODESLAYER_PREFERENCES_EDITOR_TAB_WIDTH

#define CODESLAYER_PREFERENCES_EDITOR_TAB_WIDTH "editor_tab_width"

CODESLAYER_PREFERENCES_EDITOR_FONT

#define CODESLAYER_PREFERENCES_EDITOR_FONT "editor_font"

CODESLAYER_PREFERENCES_EDITOR_THEME

#define CODESLAYER_PREFERENCES_EDITOR_THEME "editor_theme"

CODESLAYER_PREFERENCES_BOTTOM_PANE_TAB_POSITION

#define CODESLAYER_PREFERENCES_BOTTOM_PANE_TAB_POSITION "bottom_pane_tab_position"

CODESLAYER_PREFERENCES_SIDE_PANE_TAB_POSITION

#define CODESLAYER_PREFERENCES_SIDE_PANE_TAB_POSITION "side_pane_tab_position"

CODESLAYER_HOME

#define CODESLAYER_HOME ".codeslayer"

CODESLAYER_PREFERENCES_EDITOR_WORD_WRAP_TYPES

#define CODESLAYER_PREFERENCES_EDITOR_WORD_WRAP_TYPES "editor_word_wrap_types"

CODESLAYER_PREFERENCES_EDITOR_TAB_POSITION

#define CODESLAYER_PREFERENCES_EDITOR_TAB_POSITION "editor_tab_position"

CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_DIRS

#define CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_DIRS "projects_exclude_dirs"

CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_TYPES

#define CODESLAYER_PREFERENCES_PROJECTS_EXCLUDE_TYPES "projects_exclude_types"

struct CodeSlayerPreferences

struct CodeSlayerPreferences;

codeslayer_preferences_new ()

CodeSlayerPreferences * codeslayer_preferences_new      (GtkWidget *window);

Creates a new CodeSlayerPreferences.

window :

 a GtkWindow.

Returns :

 a new CodeSlayerPreferences.

codeslayer_preferences_get_integer ()

gint                codeslayer_preferences_get_integer  (CodeSlayerPreferences *preferences,
                                                         gchar *key);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

Returns :

 the value as an integer for the given key.

codeslayer_preferences_set_integer ()

void                codeslayer_preferences_set_integer  (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gint value);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

value :

 a property value as a gint.

codeslayer_preferences_get_double ()

gdouble             codeslayer_preferences_get_double   (CodeSlayerPreferences *preferences,
                                                         gchar *key);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

Returns :

 the value as a double for the given key.

codeslayer_preferences_set_double ()

void                codeslayer_preferences_set_double   (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gdouble value);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

value :

 a property value as a gdouble.

codeslayer_preferences_get_boolean ()

gboolean            codeslayer_preferences_get_boolean  (CodeSlayerPreferences *preferences,
                                                         gchar *key);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

Returns :

 the value as a boolean for the given key.

codeslayer_preferences_set_boolean ()

void                codeslayer_preferences_set_boolean  (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         gboolean value);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

value :

 a property value as a gboolean.

codeslayer_preferences_get_string ()

gchar *             codeslayer_preferences_get_string   (CodeSlayerPreferences *preferences,
                                                         gchar *key);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

Returns :

 the value as a string for the given key.

codeslayer_preferences_set_string ()

void                codeslayer_preferences_set_string   (CodeSlayerPreferences *preferences,
                                                         gchar *key,
                                                         const gchar *value);

preferences :

 a CodeSlayerPreferences.

key :

 a property name.

value :

 a property value as a gchar pointer.

codeslayer_preferences_save ()

void                codeslayer_preferences_save         (CodeSlayerPreferences *preferences);

Save the users preference to disk.

preferences :

 a CodeSlayerPreferences.

codeslayer_preferences_run_dialog ()

void                codeslayer_preferences_run_dialog   (CodeSlayerPreferences *preferences);

Show the preferences dialog.

preferences :

 a CodeSlayerPreferences.

Signal Details

The "bottom-pane-preferences-changed" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::bottom-pane-preferences-changed signal lets all observers know that something in the preferences, related to the CodeSlayerSidePane, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.

The "editor-preferences-changed" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::editor-preferences-changed signal lets all observers know that something in the preferences, related to the CodeSlayerEditor, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.

The "initialize-preferences" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::initialize-preferences signal lets all observers know that the preferences need to be applied. CodeSlayerSidePane, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.

The "notebook-preferences-changed" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::notebook-preferences-changed signal lets all observers know that something in the preferences, related to the CodeSlayerNotebook, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.

The "projects-preferences-changed" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::projects-preferences-changed signal lets all observers know that something in the preferences, related to the CodeSlayerProjects, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.

The "side-pane-preferences-changed" signal

void                user_function                      (CodeSlayerPreferences *codeslayerpreferences,
                                                        gpointer               user_data)                  : No Hooks

The ::side-pane-preferences-changed signal lets all observers know that something in the preferences, related to the CodeSlayerSidePane, changed.

codeslayerpreferences :

 the preference that received the signal

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.18