YelpSettings

YelpSettings

Properties

gboolean editor-mode Read / Write
gint font-adjustment Read / Write
GtkIconTheme * gtk-icon-theme Read / Write
GtkSettings * gtk-settings Read / Write
gboolean show-text-cursor Read / Write

Object Hierarchy

    GObject
    ╰── YelpSettings

Description

Functions

yelp_settings_get_default ()

YelpSettings *
yelp_settings_get_default (void);

yelp_settings_get_color ()

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

yelp_settings_get_colors ()

gchar **
yelp_settings_get_colors (YelpSettings *settings);

yelp_settings_set_colors ()

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

yelp_settings_get_color_param ()

const gchar *
yelp_settings_get_color_param (YelpSettingsColor color);

yelp_settings_get_font ()

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

yelp_settings_get_font_family ()

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

yelp_settings_get_font_size ()

gint
yelp_settings_get_font_size (YelpSettings *settings,
                             YelpSettingsFont font);

yelp_settings_set_fonts ()

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

yelp_settings_get_font_adjustment ()

gint
yelp_settings_get_font_adjustment (YelpSettings *settings);

yelp_settings_set_font_adjustment ()

void
yelp_settings_set_font_adjustment (YelpSettings *settings,
                                   gint adjustment);

yelp_settings_get_icon_size ()

gint
yelp_settings_get_icon_size (YelpSettings *settings);

yelp_settings_set_icon_size ()

void
yelp_settings_set_icon_size (YelpSettings *settings,
                             gint size);

yelp_settings_get_icon ()

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

yelp_settings_set_icons ()

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

yelp_settings_get_icon_param ()

const gchar *
yelp_settings_get_icon_param (YelpSettingsIcon icon);

yelp_settings_get_all_params ()

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

yelp_settings_get_show_text_cursor ()

gboolean
yelp_settings_get_show_text_cursor (YelpSettings *settings);

yelp_settings_set_show_text_cursor ()

void
yelp_settings_set_show_text_cursor (YelpSettings *settings,
                                    gboolean show);

yelp_settings_get_editor_mode ()

gboolean
yelp_settings_get_editor_mode (YelpSettings *settings);

yelp_settings_set_editor_mode ()

void
yelp_settings_set_editor_mode (YelpSettings *settings,
                               gboolean editor_mode);

yelp_settings_cmp_icons ()

gint
yelp_settings_cmp_icons (const gchar *icon1,
                         const gchar *icon2);

Types and Values

enum YelpSettingsColor

Members

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

   

enum YelpSettingsFont

Members

YELP_SETTINGS_FONT_VARIABLE

   

YELP_SETTINGS_FONT_FIXED

   

YELP_SETTINGS_NUM_FONTS

   

enum YelpSettingsIcon

Members

YELP_SETTINGS_ICON_BUG

   

YELP_SETTINGS_ICON_IMPORTANT

   

YELP_SETTINGS_ICON_NOTE

   

YELP_SETTINGS_ICON_TIP

   

YELP_SETTINGS_ICON_WARNING

   

YELP_SETTINGS_NUM_ICONS

   

YelpSettingsPriv

typedef struct _YelpSettingsPriv YelpSettingsPriv;

Property Details

The “editor-mode” property

  “editor-mode”              gboolean

Enable features useful to editors.

Flags: Read / Write

Default value: FALSE


The “font-adjustment” property

  “font-adjustment”          gint

A size adjustment to add to font sizes.

Flags: Read / Write

Allowed values: [-3,10]

Default value: 0


The “gtk-icon-theme” property

  “gtk-icon-theme”           GtkIconTheme *

A GtkIconTheme object to get icons from.

Flags: Read / Write


The “gtk-settings” property

  “gtk-settings”             GtkSettings *

A GtkSettings object to get settings from.

Flags: Read / Write


The “show-text-cursor” property

  “show-text-cursor”         gboolean

Show the text cursor or caret for accessible navigation.

Flags: Read / Write

Default value: FALSE

Signal Details

The “colors-changed” signal

void
user_function (YelpSettings *yelpsettings,
               gpointer      user_data)

Flags: Run Last


The “fonts-changed” signal

void
user_function (YelpSettings *yelpsettings,
               gpointer      user_data)

Flags: Run Last


The “icons-changed” signal

void
user_function (YelpSettings *yelpsettings,
               gpointer      user_data)

Flags: Run Last