YelpSettings

YelpSettings

Synopsis

                    YelpSettingsPriv;
                    YelpSettings;
enum                YelpSettingsColor;
enum                YelpSettingsFont;
enum                YelpSettingsIcon;
YelpSettings *      yelp_settings_get_default           (void);
gchar *             yelp_settings_get_color             (YelpSettings *settings,
                                                         YelpSettingsColor color);
gchar **            yelp_settings_get_colors            (YelpSettings *settings);
void                yelp_settings_set_colors            (YelpSettings *settings,
                                                         YelpSettingsColor first_color,
                                                         ...);
const gchar*        yelp_settings_get_color_param       (YelpSettingsColor color);
gchar *             yelp_settings_get_font              (YelpSettings *settings,
                                                         YelpSettingsFont font);
gchar *             yelp_settings_get_font_family       (YelpSettings *settings,
                                                         YelpSettingsFont font);
gint                yelp_settings_get_font_size         (YelpSettings *settings,
                                                         YelpSettingsFont font);
void                yelp_settings_set_fonts             (YelpSettings *settings,
                                                         YelpSettingsFont first_font,
                                                         ...);
gint                yelp_settings_get_font_adjustment   (YelpSettings *settings);
void                yelp_settings_set_font_adjustment   (YelpSettings *settings,
                                                         gint adjustment);
gint                yelp_settings_get_icon_size         (YelpSettings *settings);
void                yelp_settings_set_icon_size         (YelpSettings *settings,
                                                         gint size);
gchar *             yelp_settings_get_icon              (YelpSettings *settings,
                                                         YelpSettingsIcon icon);
void                yelp_settings_set_icons             (YelpSettings *settings,
                                                         YelpSettingsIcon first_icon,
                                                         ...);
const gchar *       yelp_settings_get_icon_param        (YelpSettingsIcon icon);
gchar **            yelp_settings_get_all_params        (YelpSettings *settings,
                                                         gint extra,
                                                         gint *end);
gboolean            yelp_settings_get_show_text_cursor  (YelpSettings *settings);
void                yelp_settings_set_show_text_cursor  (YelpSettings *settings,
                                                         gboolean show);
gboolean            yelp_settings_get_editor_mode       (YelpSettings *settings);
void                yelp_settings_set_editor_mode       (YelpSettings *settings,
                                                         gboolean editor_mode);

Object Hierarchy

  GObject
   +----YelpSettings

Description

Details

YelpSettingsPriv

typedef struct _YelpSettingsPriv YelpSettingsPriv;


YelpSettings

typedef struct _YelpSettings YelpSettings;


enum YelpSettingsColor

typedef enum {
    YELP_SETTINGS_COLOR_BASE,
    YELP_SETTINGS_COLOR_TEXT,
    YELP_SETTINGS_COLOR_TEXT_LIGHT,
    YELP_SETTINGS_COLOR_LINK,
    YELP_SETTINGS_COLOR_LINK_VISITED,
    YELP_SETTINGS_COLOR_GRAY_BASE,
    YELP_SETTINGS_COLOR_DARK_BASE,
    YELP_SETTINGS_COLOR_GRAY_BORDER,
    YELP_SETTINGS_COLOR_BLUE_BASE,
    YELP_SETTINGS_COLOR_BLUE_BORDER,
    YELP_SETTINGS_COLOR_RED_BASE,
    YELP_SETTINGS_COLOR_RED_BORDER,
    YELP_SETTINGS_COLOR_YELLOW_BASE,
    YELP_SETTINGS_COLOR_YELLOW_BORDER,
    YELP_SETTINGS_NUM_COLORS
} YelpSettingsColor;


enum YelpSettingsFont

typedef enum {
    YELP_SETTINGS_FONT_VARIABLE,
    YELP_SETTINGS_FONT_FIXED,
    YELP_SETTINGS_NUM_FONTS
} YelpSettingsFont;


enum YelpSettingsIcon

typedef enum {
    YELP_SETTINGS_ICON_BUG,
    YELP_SETTINGS_ICON_IMPORTANT,
    YELP_SETTINGS_ICON_NOTE,
    YELP_SETTINGS_ICON_TIP,
    YELP_SETTINGS_ICON_WARNING,
    YELP_SETTINGS_NUM_ICONS
} YelpSettingsIcon;


yelp_settings_get_default ()

YelpSettings *      yelp_settings_get_default           (void);

Returns :


yelp_settings_get_color ()

gchar *             yelp_settings_get_color             (YelpSettings *settings,
                                                         YelpSettingsColor color);

settings :

color :

Returns :


yelp_settings_get_colors ()

gchar **            yelp_settings_get_colors            (YelpSettings *settings);

settings :

Returns :


yelp_settings_set_colors ()

void                yelp_settings_set_colors            (YelpSettings *settings,
                                                         YelpSettingsColor first_color,
                                                         ...);

settings :

first_color :

... :


yelp_settings_get_color_param ()

const gchar*        yelp_settings_get_color_param       (YelpSettingsColor color);

color :

Returns :


yelp_settings_get_font ()

gchar *             yelp_settings_get_font              (YelpSettings *settings,
                                                         YelpSettingsFont font);

settings :

font :

Returns :


yelp_settings_get_font_family ()

gchar *             yelp_settings_get_font_family       (YelpSettings *settings,
                                                         YelpSettingsFont font);

settings :

font :

Returns :


yelp_settings_get_font_size ()

gint                yelp_settings_get_font_size         (YelpSettings *settings,
                                                         YelpSettingsFont font);

settings :

font :

Returns :


yelp_settings_set_fonts ()

void                yelp_settings_set_fonts             (YelpSettings *settings,
                                                         YelpSettingsFont first_font,
                                                         ...);

settings :

first_font :

... :


yelp_settings_get_font_adjustment ()

gint                yelp_settings_get_font_adjustment   (YelpSettings *settings);

settings :

Returns :


yelp_settings_set_font_adjustment ()

void                yelp_settings_set_font_adjustment   (YelpSettings *settings,
                                                         gint adjustment);

settings :

adjustment :


yelp_settings_get_icon_size ()

gint                yelp_settings_get_icon_size         (YelpSettings *settings);

settings :

Returns :


yelp_settings_set_icon_size ()

void                yelp_settings_set_icon_size         (YelpSettings *settings,
                                                         gint size);

settings :

size :


yelp_settings_get_icon ()

gchar *             yelp_settings_get_icon              (YelpSettings *settings,
                                                         YelpSettingsIcon icon);

settings :

icon :

Returns :


yelp_settings_set_icons ()

void                yelp_settings_set_icons             (YelpSettings *settings,
                                                         YelpSettingsIcon first_icon,
                                                         ...);

settings :

first_icon :

... :


yelp_settings_get_icon_param ()

const gchar *       yelp_settings_get_icon_param        (YelpSettingsIcon icon);

icon :

Returns :


yelp_settings_get_all_params ()

gchar **            yelp_settings_get_all_params        (YelpSettings *settings,
                                                         gint extra,
                                                         gint *end);

settings :

extra :

end :

Returns :


yelp_settings_get_show_text_cursor ()

gboolean            yelp_settings_get_show_text_cursor  (YelpSettings *settings);

settings :

Returns :


yelp_settings_set_show_text_cursor ()

void                yelp_settings_set_show_text_cursor  (YelpSettings *settings,
                                                         gboolean show);

settings :

show :


yelp_settings_get_editor_mode ()

gboolean            yelp_settings_get_editor_mode       (YelpSettings *settings);

settings :

Returns :


yelp_settings_set_editor_mode ()

void                yelp_settings_set_editor_mode       (YelpSettings *settings,
                                                         gboolean editor_mode);

settings :

editor_mode :