| Top |  |
 |
 |
 |
Functions
Properties
Description
GtkSettings provide a mechanism to share global settings between applications. On the X window system, this sharing is realized by an XSettings manager that is usually part of the desktop environment, along with utilities that let the user change these settings. In the absence of an Xsettings manager, settings can also be specified in RC files.
Applications can override system-wide settings with gtk_settings_set_string_property(),
gtk_settings_set_long_property(), etc. This should be restricted to special
cases though; GtkSettings are not meant as an application configuration
facility. When doing so, you need to be aware that settings that are specific
to individual widgets may not be available before the widget type has been
realized at least once. The following example demonstrates a way to do this:
1 2 3 4 |
gtk_init (&argc, &argv); /* make sure the type is realized */ g_type_class_unref (g_type_class_ref (GTK_TYPE_IMAGE_MENU_ITEM)); g_object_set (gtk_settings_get_default (), "gtk-menu-images", FALSE, NULL); |
There is one GtkSettings instance per screen. It can be obtained with
gtk_settings_get_for_screen(), but in many cases, it is more convenient
to use gtk_widget_get_settings(). gtk_settings_get_default() returns the
GtkSettings instance for the default screen.
Functions
gtk_settings_get_default ()
GtkSettings *
gtk_settings_get_default (void);
Gets the GtkSettings object for the default GDK screen, creating
it if necessary. See gtk_settings_get_for_screen().
gtk_settings_get_for_screen ()
GtkSettings *
gtk_settings_get_for_screen (GdkScreen *screen);
Gets the GtkSettings object for screen
, creating it if necessary.
Since 2.2
gtk_settings_install_property_parser ()
void gtk_settings_install_property_parser (GParamSpec *pspec,GtkRcPropertyParser parser);
gtk_rc_property_parse_color ()
gboolean gtk_rc_property_parse_color (const GParamSpec *pspec,const GString *gstring,GValue *property_value);
A GtkRcPropertyParser for use with gtk_settings_install_property_parser()
or gtk_widget_class_install_style_property_parser() which parses a
color given either by its name or in the form
{ red, green, blue } where red, green and
blue are integers between 0 and 65535 or floating-point numbers
between 0 and 1.
gtk_rc_property_parse_enum ()
gboolean gtk_rc_property_parse_enum (const GParamSpec *pspec,const GString *gstring,GValue *property_value);
A GtkRcPropertyParser for use with gtk_settings_install_property_parser()
or gtk_widget_class_install_style_property_parser() which parses a single
enumeration value.
The enumeration value can be specified by its name, its nickname or its numeric value. For consistency with flags parsing, the value may be surrounded by parentheses.
Parameters
Returns
TRUE if gstring
could be parsed and property_value
has been set to the resulting GEnumValue.
gtk_rc_property_parse_flags ()
gboolean gtk_rc_property_parse_flags (const GParamSpec *pspec,const GString *gstring,GValue *property_value);
A GtkRcPropertyParser for use with gtk_settings_install_property_parser()
or gtk_widget_class_install_style_property_parser() which parses flags.
Flags can be specified by their name, their nickname or
numerically. Multiple flags can be specified in the form
"( flag1 | flag2 | ... )".
Parameters
Returns
TRUE if gstring
could be parsed and property_value
has been set to the resulting flags value.
gtk_rc_property_parse_requisition ()
gboolean gtk_rc_property_parse_requisition (const GParamSpec *pspec,const GString *gstring,GValue *property_value);
A GtkRcPropertyParser for use with gtk_settings_install_property_parser()
or gtk_widget_class_install_style_property_parser() which parses a
requisition in the form
"{ width, height }" for integers width and height.
Parameters
Returns
TRUE if gstring
could be parsed and property_value
has been set to the resulting GtkRequisition.
gtk_rc_property_parse_border ()
gboolean gtk_rc_property_parse_border (const GParamSpec *pspec,const GString *gstring,GValue *property_value);
A GtkRcPropertyParser for use with gtk_settings_install_property_parser()
or gtk_widget_class_install_style_property_parser() which parses
borders in the form
"{ left, right, top, bottom }" for integers
left, right, top and bottom.
gtk_settings_set_property_value ()
void gtk_settings_set_property_value (GtkSettings *settings,const gchar *name,const GtkSettingsValue *svalue);
gtk_settings_set_string_property ()
void gtk_settings_set_string_property (GtkSettings *settings,const gchar *name,const gchar *v_string,const gchar *origin);
gtk_settings_set_long_property ()
void gtk_settings_set_long_property (GtkSettings *settings,const gchar *name,glong v_long,const gchar *origin);
gtk_settings_set_double_property ()
void gtk_settings_set_double_property (GtkSettings *settings,const gchar *name,gdouble v_double,const gchar *origin);
Types and Values
struct GtkSettingsValue
struct GtkSettingsValue {
/* origin should be something like "filename:linenumber" for rc files,
* or e.g. "XProperty" for other sources
*/
gchar *origin;
/* valid types are LONG, DOUBLE and STRING corresponding to the token parsed,
* or a GSTRING holding an unparsed statement
*/
GValue value;
};
Property Details
The “color-hash” property
“color-hash” GHashTable *
Holds a hash table representation of the “gtk-color-scheme” setting, mapping color names to GdkColors.
Flags: Read
Since 2.10
The “gtk-alternative-button-order” property
“gtk-alternative-button-order” gboolean
Whether buttons in dialogs should use the alternative button order.
Flags: Read / Write
Default value: FALSE
The “gtk-alternative-sort-arrows” property
“gtk-alternative-sort-arrows” gboolean
Controls the direction of the sort indicators in sorted list and tree
views. By default an arrow pointing down means the column is sorted
in ascending order. When set to TRUE, this order will be inverted.
Flags: Read / Write
Default value: FALSE
Since 2.12
The “gtk-auto-mnemonics” property
“gtk-auto-mnemonics” gboolean
Whether mnemonics should be automatically shown and hidden when the user presses the mnemonic activator.
Flags: Read / Write
Default value: FALSE
Since 2.20
The “gtk-button-images” property
“gtk-button-images” gboolean
Whether images should be shown on buttons.
Flags: Read / Write
Default value: TRUE
The “gtk-can-change-accels” property
“gtk-can-change-accels” gboolean
Whether menu accelerators can be changed by pressing a key over the menu item.
Flags: Read / Write
Default value: FALSE
The “gtk-color-palette” property
“gtk-color-palette” gchar *
Palette to use in the color selector.
Flags: Read / Write
Default value: "black:white:gray50:red:purple:blue:light blue:green:yellow:orange:lavender:brown:goldenrod4:dodger blue:pink:light green:gray10:gray30:gray75:gray90"
The “gtk-color-scheme” property
“gtk-color-scheme” gchar *
A palette of named colors for use in themes. The format of the string is
name1: color1 name2: color2 ...
Color names must be acceptable as identifiers in the
gtkrc syntax, andcolor specifications must be in the format accepted by
gdk_color_parse().
Note that due to the way the color tables from different sources are merged, color specifications will be converted to hexadecimal form when getting this property.
Starting with GTK+ 2.12, the entries can alternatively be separated by ';' instead of newlines:
name1: color1; name2: color2; ...
Flags: Read / Write
Default value: ""
Since 2.10
The “gtk-cursor-blink” property
“gtk-cursor-blink” gboolean
Whether the cursor should blink.
Also see the “gtk-cursor-blink-timeout” setting, which allows more flexible control over cursor blinking.
Flags: Read / Write
Default value: TRUE
The “gtk-cursor-blink-time” property
“gtk-cursor-blink-time” gint
Length of the cursor blink cycle, in milliseconds.
Flags: Read / Write
Allowed values: >= 100
Default value: 1200
The “gtk-cursor-blink-timeout” property
“gtk-cursor-blink-timeout” gint
Time after which the cursor stops blinking, in seconds. The timer is reset after each user interaction.
Setting this to zero has the same effect as setting
“gtk-cursor-blink” to FALSE.
Flags: Read / Write
Allowed values: >= 1
Default value: 2147483647
Since 2.12
The “gtk-cursor-theme-name” property
“gtk-cursor-theme-name” gchar *
Name of the cursor theme to use, or NULL to use the default theme.
Flags: Read / Write
Default value: NULL
The “gtk-cursor-theme-size” property
“gtk-cursor-theme-size” gint
Size to use for cursors, or 0 to use the default size.
Flags: Read / Write
Allowed values: [0,128]
Default value: 0
The “gtk-dnd-drag-threshold” property
“gtk-dnd-drag-threshold” gint
Number of pixels the cursor can move before dragging.
Flags: Read / Write
Allowed values: >= 1
Default value: 8
The “gtk-double-click-distance” property
“gtk-double-click-distance” gint
Maximum distance allowed between two clicks for them to be considered a double click (in pixels).
Flags: Read / Write
Allowed values: >= 0
Default value: 5
The “gtk-double-click-time” property
“gtk-double-click-time” gint
Maximum time allowed between two clicks for them to be considered a double click (in milliseconds).
Flags: Read / Write
Allowed values: >= 0
Default value: 250
The “gtk-enable-accels” property
“gtk-enable-accels” gboolean
Whether menu items should have visible accelerators which can be activated.
Flags: Read / Write
Default value: TRUE
Since 2.12
The “gtk-enable-animations” property
“gtk-enable-animations” gboolean
Whether to enable toolkit-wide animations.
Flags: Read / Write
Default value: TRUE
The “gtk-enable-event-sounds” property
“gtk-enable-event-sounds” gboolean
Whether to play any event sounds at all.
See the Sound Theme spec for more information on event sounds and sound themes.
GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Flags: Read / Write
Default value: TRUE
Since 2.14
The “gtk-enable-input-feedback-sounds” property
“gtk-enable-input-feedback-sounds” gboolean
Whether to play event sounds as feedback to user input.
See the Sound Theme spec for more information on event sounds and sound themes.
GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Flags: Read / Write
Default value: TRUE
Since 2.14
The “gtk-enable-mnemonics” property
“gtk-enable-mnemonics” gboolean
Whether labels and menu items should have visible mnemonics which can be activated.
Flags: Read / Write
Default value: TRUE
Since 2.12
The “gtk-enable-tooltips” property
“gtk-enable-tooltips” gboolean
Whether tooltips should be shown on widgets.
Flags: Read / Write
Default value: TRUE
Since 2.14
The “gtk-entry-password-hint-timeout” property
“gtk-entry-password-hint-timeout” guint
How long to show the last input character in hidden entries. This value is in milliseconds. 0 disables showing the last char. 600 is a good value for enabling it.
Flags: Read / Write
Default value: 0
Since 2.10
The “gtk-entry-select-on-focus” property
“gtk-entry-select-on-focus” gboolean
Whether to select the contents of an entry when it is focused.
Flags: Read / Write
Default value: TRUE
The “gtk-error-bell” property
“gtk-error-bell” gboolean
When TRUE, keyboard navigation and other input-related errors
will cause a beep. Since the error bell is implemented using
gdk_window_beep(), the windowing system may offer ways to
configure the error bell in many ways, such as flashing the
window or similar visual effects.
Flags: Read / Write
Default value: TRUE
Since 2.12
The “gtk-fallback-icon-theme” property
“gtk-fallback-icon-theme” gchar *
Name of a icon theme to fall back to.
Flags: Read / Write
Default value: NULL
The “gtk-file-chooser-backend” property
“gtk-file-chooser-backend” gchar *
Name of the GtkFileChooser backend to use by default.
Flags: Read / Write
Default value: NULL
The “gtk-font-name” property
“gtk-font-name” gchar *
Name of default font to use.
Flags: Read / Write
Default value: "Sans 10"
The “gtk-fontconfig-timestamp” property
“gtk-fontconfig-timestamp” guint
Timestamp of current fontconfig configuration.
Flags: Read / Write
Default value: 0
The “gtk-icon-sizes” property
“gtk-icon-sizes” gchar *
A list of icon sizes. The list is separated by colons, and item has the form:
size-name = width , height
E.g. "gtk-menu=16,16:gtk-button=20,20:gtk-dialog=48,48".
GTK+ itself use the following named icon sizes: gtk-menu,
gtk-button, gtk-small-toolbar, gtk-large-toolbar, gtk-dnd,
gtk-dialog. Applications can register their own named icon
sizes with gtk_icon_size_register().
Flags: Read / Write
Default value: NULL
The “gtk-icon-theme-name” property
“gtk-icon-theme-name” gchar *
Name of icon theme to use.
Flags: Read / Write
Default value: "hicolor"
The “gtk-im-module” property
“gtk-im-module” gchar *
Which IM (input method) module should be used by default. This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. This also can be a colon-separated list of input methods, which GTK+ will try in turn until it finds one available on the system.
See GtkIMContext and see the “gtk-show-input-method-menu” property.
Flags: Read / Write
Default value: NULL
The “gtk-im-preedit-style” property
“gtk-im-preedit-style” GtkIMPreeditStyle
How to draw the input method preedit string.
Flags: Read / Write
Default value: GTK_IM_PREEDIT_CALLBACK
The “gtk-im-status-style” property
“gtk-im-status-style” GtkIMStatusStyle
How to draw the input method statusbar.
Flags: Read / Write
Default value: GTK_IM_STATUS_CALLBACK
The “gtk-key-theme-name” property
“gtk-key-theme-name” gchar *
Name of key theme RC file to load.
Flags: Read / Write
Default value: NULL
The “gtk-keynav-cursor-only” property
“gtk-keynav-cursor-only” gboolean
When TRUE, keyboard navigation should be able to reach all widgets
by using the cursor keys only. Tab, Shift etc. keys can't be expected
to be present on the used input device.
Flags: Read / Write
Default value: FALSE
Since 2.12
The “gtk-keynav-wrap-around” property
“gtk-keynav-wrap-around” gboolean
When TRUE, some widgets will wrap around when doing keyboard
navigation, such as menus, menubars and notebooks.
Flags: Read / Write
Default value: TRUE
Since 2.12
The “gtk-label-select-on-focus” property
“gtk-label-select-on-focus” gboolean
Whether to select the contents of a selectable label when it is focused.
Flags: Read / Write
Default value: TRUE
The “gtk-menu-bar-accel” property
“gtk-menu-bar-accel” gchar *
Keybinding to activate the menu bar.
Flags: Read / Write
Default value: "F10"
The “gtk-menu-bar-popup-delay” property
“gtk-menu-bar-popup-delay” gint
Delay before the submenus of a menu bar appear.
Flags: Read / Write
Allowed values: >= 0
Default value: 0
The “gtk-menu-images” property
“gtk-menu-images” gboolean
Whether images should be shown in menus.
Flags: Read / Write
Default value: TRUE
The “gtk-menu-popdown-delay” property
“gtk-menu-popdown-delay” gint
The time before hiding a submenu when the pointer is moving towards the submenu.
Flags: Read / Write
Allowed values: >= 0
Default value: 1000
The “gtk-menu-popup-delay” property
“gtk-menu-popup-delay” gint
Minimum time the pointer must stay over a menu item before the submenu appear.
Flags: Read / Write
Allowed values: >= 0
Default value: 225
The “gtk-modules” property
“gtk-modules” gchar *
List of currently active GTK modules.
Flags: Read / Write
Default value: NULL
The “gtk-primary-button-warps-slider” property
“gtk-primary-button-warps-slider” gboolean
Whether a click in a GtkRange trough should scroll to the click position or scroll by a single page in the respective direction.
Flags: Read / Write
Default value: FALSE
Since 2.24
The “gtk-print-backends” property
“gtk-print-backends” gchar *
A comma-separated list of print backends to use in the print dialog. Available print backends depend on the GTK+ installation, and may include "file", "cups", "lpr" or "papi".
Flags: Read / Write
Default value: "file,cups"
Since 2.10
The “gtk-print-preview-command” property
“gtk-print-preview-command” gchar *
A command to run for displaying the print preview. The command
should contain a f placeholder, which will get replaced by
the path to the pdf file. The command may also contain a s
placeholder, which will get replaced by the path to a file
containing the print settings in the format produced by
gtk_print_settings_to_file().
The preview application is responsible for removing the pdf file and the print settings file when it is done.
Flags: Read / Write
Default value: "evince --unlink-tempfile --preview --print-settings %s %f"
Since 2.10
The “gtk-recent-files-limit” property
“gtk-recent-files-limit” gint
The number of recently used files that should be displayed by default by GtkRecentChooser implementations and by the GtkFileChooser. A value of -1 means every recently used file stored.
Flags: Read / Write
Allowed values: >= -1
Default value: 50
Since 2.12
The “gtk-recent-files-max-age” property
“gtk-recent-files-max-age” gint
The maximum age, in days, of the items inside the recently used resources list. Items older than this setting will be excised from the list. If set to 0, the list will always be empty; if set to -1, no item will be removed.
Flags: Read / Write
Allowed values: >= -1
Default value: 30
Since 2.14
The “gtk-scrolled-window-placement” property
“gtk-scrolled-window-placement” GtkCornerType
Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement.
Flags: Read / Write
Default value: GTK_CORNER_TOP_LEFT
Since 2.10
The “gtk-show-input-method-menu” property
“gtk-show-input-method-menu” gboolean
Whether the context menus of entries and text views should offer to change the input method.
Flags: Read / Write
Default value: TRUE
The “gtk-show-unicode-menu” property
“gtk-show-unicode-menu” gboolean
Whether the context menus of entries and text views should offer to insert control characters.
Flags: Read / Write
Default value: TRUE
The “gtk-sound-theme-name” property
“gtk-sound-theme-name” gchar *
The XDG sound theme to use for event sounds.
See the Sound Theme spec for more information on event sounds and sound themes.
GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Flags: Read / Write
Default value: "freedesktop"
Since 2.14
The “gtk-split-cursor” property
“gtk-split-cursor” gboolean
Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
Flags: Read / Write
Default value: TRUE
The “gtk-theme-name” property
“gtk-theme-name” gchar *
Name of theme RC file to load.
Flags: Read / Write
Default value: "Raleigh"
The “gtk-timeout-expand” property
“gtk-timeout-expand” gint
Expand value for timeouts, when a widget is expanding a new region.
Flags: Read / Write
Allowed values: >= 0
Default value: 500
The “gtk-timeout-initial” property
“gtk-timeout-initial” gint
Starting value for timeouts, when button is pressed.
Flags: Read / Write
Allowed values: >= 0
Default value: 200
The “gtk-timeout-repeat” property
“gtk-timeout-repeat” gint
Repeat value for timeouts, when button is pressed.
Flags: Read / Write
Allowed values: >= 0
Default value: 20
The “gtk-toolbar-icon-size” property
“gtk-toolbar-icon-size” GtkIconSize
The size of icons in default toolbars.
Flags: Read / Write
Default value: GTK_ICON_SIZE_LARGE_TOOLBAR
The “gtk-toolbar-style” property
“gtk-toolbar-style” GtkToolbarStyle
Whether default toolbars have text only, text and icons, icons only, etc.
Flags: Read / Write
Default value: GTK_TOOLBAR_BOTH
The “gtk-tooltip-browse-mode-timeout” property
“gtk-tooltip-browse-mode-timeout” gint
Amount of time, in milliseconds, after which the browse mode will be disabled.
See “gtk-tooltip-browse-timeout” for more information about browse mode.
Flags: Read / Write
Allowed values: >= 0
Default value: 500
Since 2.12
The “gtk-tooltip-browse-timeout” property
“gtk-tooltip-browse-timeout” gint
Controls the time after which tooltips will appear when browse mode is enabled, in milliseconds.
Browse mode is enabled when the mouse pointer moves off an object where a tooltip was currently being displayed. If the mouse pointer hits another object before the browse mode timeout expires (see “gtk-tooltip-browse-mode-timeout”), it will take the amount of milliseconds specified by this setting to popup the tooltip for the new object.
Flags: Read / Write
Allowed values: >= 0
Default value: 60
Since 2.12
The “gtk-tooltip-timeout” property
“gtk-tooltip-timeout” gint
Time, in milliseconds, after which a tooltip could appear if the cursor is hovering on top of a widget.
Flags: Read / Write
Allowed values: >= 0
Default value: 500
Since 2.12
The “gtk-touchscreen-mode” property
“gtk-touchscreen-mode” gboolean
When TRUE, there are no motion notify events delivered on this screen,
and widgets can't use the pointer hovering them for any essential
functionality.
Flags: Read / Write
Default value: FALSE
Since 2.10
The “gtk-xft-antialias” property
“gtk-xft-antialias” gint
Whether to antialias Xft fonts; 0=no, 1=yes, -1=default.
Flags: Read / Write
Allowed values: [-1,1]
Default value: -1
The “gtk-xft-dpi” property
“gtk-xft-dpi” gint
Resolution for Xft, in 1024 * dots/inch. -1 to use default value.
Flags: Read / Write
Allowed values: [-1,1048576]
Default value: -1
The “gtk-xft-hinting” property
“gtk-xft-hinting” gint
Whether to hint Xft fonts; 0=no, 1=yes, -1=default.
Flags: Read / Write
Allowed values: [-1,1]
Default value: -1
The “gtk-xft-hintstyle” property
“gtk-xft-hintstyle” gchar *
What degree of hinting to use; hintnone, hintslight, hintmedium, or hintfull.
Flags: Read / Write
Default value: NULL
The “gtk-xft-rgba” property
“gtk-xft-rgba” gchar *
Type of subpixel antialiasing; none, rgb, bgr, vrgb, vbgr.
Flags: Read / Write
Default value: NULL