Struct gtk4::Settings

source ·

#[repr(transparent)]
pub struct Settings { /* private fields */ }

Expand description

Settings provides 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.

On Wayland, the settings are obtained either via a settings portal, or by reading desktop settings from DConf.

In the absence of these sharing mechanisms, GTK reads default values for settings from settings.ini files in /etc/gtk-4.0, $XDG_CONFIG_DIRS/gtk-4.0 and $XDG_CONFIG_HOME/gtk-4.0. These files must be valid key files (see GKeyFile), and have a section called Settings. Themes can also provide default values for settings by installing a settings.ini file next to their gtk.css file.

Applications can override system-wide settings by setting the property of the Settings object with g_object_set(). This should be restricted to special cases though; Settings are not meant as an application configuration facility.

There is one Settings instance per display. It can be obtained with for_display(), but in many cases, it is more convenient to use WidgetExt::settings().

Properties

`gtk-alternative-button-order`

Whether buttons in dialogs should use the alternative button order.

Readable | Writeable

`gtk-alternative-sort-arrows`

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.

Readable | Writeable

`gtk-application-prefer-dark-theme`

Whether the application prefers to use a dark theme.

If a GTK theme includes a dark variant, it will be used instead of the configured theme.

Some applications benefit from minimizing the amount of light pollution that interferes with the content. Good candidates for dark themes are photo and video editors that make the actual content get all the attention and minimize the distraction of the chrome.

Dark themes should not be used for documents, where large spaces are white/light and the dark chrome creates too much contrast (web browser, text editor…).

Readable | Writeable

`gtk-cursor-aspect-ratio`

The aspect ratio of the text caret.

Readable | Writeable

`gtk-cursor-blink`

Whether the cursor should blink.

Also see the gtk-cursor-blink-timeout setting, which allows more flexible control over cursor blinking.

Readable | Writeable

`gtk-cursor-blink-time`

Length of the cursor blink cycle, in milliseconds.

Readable | Writeable

`gtk-cursor-blink-timeout`

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.

Readable | Writeable

`gtk-cursor-theme-name`

Name of the cursor theme to use.

Use None to use the default theme.

Readable | Writeable

`gtk-cursor-theme-size`

The size to use for cursors.

0 means to use the default size.

Readable | Writeable

`gtk-decoration-layout`

Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed on the left or right.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu).

For example, “menu:minimize,maximize,close” specifies a menu on the left, and minimize, maximize and close buttons on the right.

Note that buttons will only be shown when they are meaningful. E.g. a menu button only appears when the desktop shell does not show the app menu, and a close button only appears on a window that can be closed.

Also note that the setting can be overridden with the decoration-layout property.

Readable | Writeable

`gtk-dialogs-use-header`

Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom.

This setting does not affect custom dialogs using Dialog directly, or message dialogs.

Readable | Writeable

`gtk-dnd-drag-threshold`

The number of pixels the cursor can move before dragging.

Readable | Writeable

`gtk-double-click-distance`

The maximum distance allowed between two clicks for them to be considered a double click, in pixels.

Readable | Writeable

`gtk-double-click-time`

The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.

Readable | Writeable

`gtk-enable-accels`

Whether menu items should have visible accelerators which can be activated.

Readable | Writeable

`gtk-enable-animations`

Whether to enable toolkit-wide animations.

Readable | Writeable

`gtk-enable-event-sounds`

Whether to play any event sounds at all.

See the Sound Theme Specifications 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.

Readable | Writeable

`gtk-enable-input-feedback-sounds`

Whether to play event sounds as feedback to user input.

See the Sound Theme Specifications 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.

Readable | Writeable

`gtk-enable-primary-paste`

Whether a middle click on a mouse should paste the ‘PRIMARY’ clipboard content at the cursor location.

Readable | Writeable

`gtk-entry-password-hint-timeout`

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.

Readable | Writeable

`gtk-entry-select-on-focus`

Whether to select the contents of an entry when it is focused.

Readable | Writeable

`gtk-error-bell`

When true, keyboard navigation and other input-related errors will cause a beep.

Since the error bell is implemented using gdk_surface_beep(), the windowing system may offer ways to configure the error bell in many ways, such as flashing the window or similar visual effects.

Readable | Writeable

`gtk-font-name`

The default font to use.

GTK uses the family name and size from this string.

Readable | Writeable

`gtk-fontconfig-timestamp`

Timestamp of the current fontconfig configuration.

Readable | Writeable

`gtk-hint-font-metrics`

Whether hinting should be applied to font metrics.

Note that this also turns off subpixel positioning of glyphs, since it conflicts with metrics hinting.

Readable | Writeable

`gtk-icon-theme-name`

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

Readable | Writeable

`gtk-im-module`

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 IMContext.

Readable | Writeable

`gtk-keynav-use-caret`

Whether GTK should make sure that text can be navigated with a caret, even if it is not editable.

This is useful when using a screen reader.

Readable | Writeable

`gtk-label-select-on-focus`

Whether to select the contents of a selectable label when it is focused.

Readable | Writeable

`gtk-long-press-time`

The time for a button or touch press to be considered a “long press”.

See GestureLongPress.

Readable | Writeable

`gtk-overlay-scrolling`

Whether scrolled windows may use overlaid scrolling indicators.

If this is set to false, scrolled windows will have permanent scrollbars.

Readable | Writeable

`gtk-primary-button-warps-slider`

If the value of this setting is true, clicking the primary button in a Range trough will move the slider, and hence set the range’s value, to the point that you clicked.

If it is false, a primary click will cause the slider/value to move by the range’s page-size towards the point clicked.

Whichever action you choose for the primary button, the other action will be available by holding Shift and primary-clicking, or clicking the middle mouse button.

Readable | Writeable

`gtk-print-backends`

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”.

Readable | Writeable

`gtk-print-preview-command`

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 PrintSettings::to_file().

The preview application is responsible for removing the pdf file and the print settings file when it is done.

Readable | Writeable

`gtk-recent-files-enabled`

Whether GTK should keep track of items inside the recently used resources list.

If set to false, the list will always be empty.

Readable | Writeable

`gtk-recent-files-max-age`

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.

Readable | Writeable

Set to true if the desktop environment is displaying the app menu, false if the app should display it itself.

Readable | Writeable

`gtk-shell-shows-desktop`

Set to true if the desktop environment is displaying the desktop folder, false if not.

Readable | Writeable

`gtk-shell-shows-menubar`

Set to true if the desktop environment is displaying the menubar, false if the app should display it itself.

Readable | Writeable

`gtk-sound-theme-name`

The XDG sound theme to use for event sounds.

See the Sound Theme Specifications 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.

Readable | Writeable

`gtk-split-cursor`

Whether two cursors should be displayed for mixed left-to-right and right-to-left text.

Readable | Writeable

`gtk-theme-name`

Name of the theme to load.

See CssProvider for details about how GTK finds the CSS stylesheet for a theme.

Readable | Writeable

`gtk-titlebar-double-click`

Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows.

Recognized actions are minimize, toggle-maximize, menu, lower or none.

Readable | Writeable

`gtk-titlebar-middle-click`

Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows.

Recognized actions are minimize, toggle-maximize, menu, lower or none.

Readable | Writeable

`gtk-titlebar-right-click`

Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows.

Recognized actions are minimize, toggle-maximize, menu, lower or none.

Readable | Writeable

`gtk-xft-antialias`

Whether to antialias fonts.

The values are 0 for no, 1 for yes, or -1 for the system default.

Readable | Writeable

`gtk-xft-dpi`

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

Readable | Writeable

`gtk-xft-hinting`

Whether to enable font hinting.

The values are 0 for no, 1 for yes, or -1 for the system default.

Readable | Writeable

`gtk-xft-hintstyle`

What degree of font hinting to use.

The possible vaues are hintnone, hintslight, hintmedium, hintfull.

Readable | Writeable

`gtk-xft-rgba`

The type of subpixel antialiasing to use.

The possible values are none, rgb, bgr, vrgb, vbgr.

Readable | Writeable

Struct gtk4::Settings

Implementations§

impl Settings

pub fn builder() -> SettingsBuilder

pub fn reset_property(&self, name: &str)

pub fn is_gtk_alternative_button_order(&self) -> bool

pub fn set_gtk_alternative_button_order( &self, gtk_alternative_button_order: bool )

pub fn is_gtk_alternative_sort_arrows(&self) -> bool

pub fn set_gtk_alternative_sort_arrows(&self, gtk_alternative_sort_arrows: bool)

pub fn is_gtk_application_prefer_dark_theme(&self) -> bool

pub fn set_gtk_application_prefer_dark_theme( &self, gtk_application_prefer_dark_theme: bool )

pub fn gtk_cursor_aspect_ratio(&self) -> f64

pub fn set_gtk_cursor_aspect_ratio(&self, gtk_cursor_aspect_ratio: f64)

pub fn is_gtk_cursor_blink(&self) -> bool

pub fn set_gtk_cursor_blink(&self, gtk_cursor_blink: bool)

pub fn gtk_cursor_blink_time(&self) -> i32

pub fn set_gtk_cursor_blink_time(&self, gtk_cursor_blink_time: i32)

pub fn gtk_cursor_blink_timeout(&self) -> i32

pub fn set_gtk_cursor_blink_timeout(&self, gtk_cursor_blink_timeout: i32)

pub fn gtk_cursor_theme_name(&self) -> Option<GString>

pub fn set_gtk_cursor_theme_name(&self, gtk_cursor_theme_name: Option<&str>)

pub fn gtk_cursor_theme_size(&self) -> i32

pub fn set_gtk_cursor_theme_size(&self, gtk_cursor_theme_size: i32)

pub fn gtk_decoration_layout(&self) -> Option<GString>

pub fn set_gtk_decoration_layout(&self, gtk_decoration_layout: Option<&str>)

pub fn is_gtk_dialogs_use_header(&self) -> bool

pub fn set_gtk_dialogs_use_header(&self, gtk_dialogs_use_header: bool)

pub fn gtk_dnd_drag_threshold(&self) -> i32

pub fn set_gtk_dnd_drag_threshold(&self, gtk_dnd_drag_threshold: i32)

pub fn gtk_double_click_distance(&self) -> i32

pub fn set_gtk_double_click_distance(&self, gtk_double_click_distance: i32)

pub fn gtk_double_click_time(&self) -> i32

pub fn set_gtk_double_click_time(&self, gtk_double_click_time: i32)

pub fn is_gtk_enable_accels(&self) -> bool

pub fn set_gtk_enable_accels(&self, gtk_enable_accels: bool)

pub fn is_gtk_enable_animations(&self) -> bool

pub fn set_gtk_enable_animations(&self, gtk_enable_animations: bool)

pub fn is_gtk_enable_event_sounds(&self) -> bool

pub fn set_gtk_enable_event_sounds(&self, gtk_enable_event_sounds: bool)

pub fn is_gtk_enable_input_feedback_sounds(&self) -> bool

pub fn set_gtk_enable_input_feedback_sounds( &self, gtk_enable_input_feedback_sounds: bool )

pub fn is_gtk_enable_primary_paste(&self) -> bool

pub fn set_gtk_enable_primary_paste(&self, gtk_enable_primary_paste: bool)

pub fn gtk_entry_password_hint_timeout(&self) -> u32

pub fn set_gtk_entry_password_hint_timeout( &self, gtk_entry_password_hint_timeout: u32 )

pub fn is_gtk_entry_select_on_focus(&self) -> bool

pub fn set_gtk_entry_select_on_focus(&self, gtk_entry_select_on_focus: bool)

pub fn is_gtk_error_bell(&self) -> bool

pub fn set_gtk_error_bell(&self, gtk_error_bell: bool)

pub fn gtk_font_name(&self) -> Option<GString>

pub fn set_gtk_font_name(&self, gtk_font_name: Option<&str>)

pub fn gtk_fontconfig_timestamp(&self) -> u32

pub fn set_gtk_fontconfig_timestamp(&self, gtk_fontconfig_timestamp: u32)

pub fn is_gtk_hint_font_metrics(&self) -> bool

pub fn set_gtk_hint_font_metrics(&self, gtk_hint_font_metrics: bool)

pub fn gtk_icon_theme_name(&self) -> Option<GString>

pub fn set_gtk_icon_theme_name(&self, gtk_icon_theme_name: Option<&str>)

pub fn gtk_im_module(&self) -> Option<GString>

pub fn set_gtk_im_module(&self, gtk_im_module: Option<&str>)

pub fn is_gtk_keynav_use_caret(&self) -> bool

pub fn set_gtk_keynav_use_caret(&self, gtk_keynav_use_caret: bool)

pub fn is_gtk_label_select_on_focus(&self) -> bool

pub fn set_gtk_label_select_on_focus(&self, gtk_label_select_on_focus: bool)

pub fn gtk_long_press_time(&self) -> u32

pub fn set_gtk_long_press_time(&self, gtk_long_press_time: u32)

pub fn is_gtk_overlay_scrolling(&self) -> bool

pub fn set_gtk_overlay_scrolling(&self, gtk_overlay_scrolling: bool)

pub fn is_gtk_primary_button_warps_slider(&self) -> bool

pub fn set_gtk_primary_button_warps_slider( &self, gtk_primary_button_warps_slider: bool )

pub fn gtk_print_backends(&self) -> Option<GString>

pub fn set_gtk_print_backends(&self, gtk_print_backends: Option<&str>)

pub fn gtk_print_preview_command(&self) -> Option<GString>

pub fn set_gtk_print_preview_command( &self, gtk_print_preview_command: Option<&str> )

pub fn is_gtk_recent_files_enabled(&self) -> bool

pub fn set_gtk_recent_files_enabled(&self, gtk_recent_files_enabled: bool)

pub fn gtk_recent_files_max_age(&self) -> i32

pub fn set_gtk_recent_files_max_age(&self, gtk_recent_files_max_age: i32)

pub fn is_gtk_shell_shows_app_menu(&self) -> bool

pub fn set_gtk_shell_shows_app_menu(&self, gtk_shell_shows_app_menu: bool)

pub fn is_gtk_shell_shows_desktop(&self) -> bool