Struct Settings

pub struct Settings { /* private fields */ }

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 Gio::Settings.

On macOS, the settings are obtained from NSUserDefaults.

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-font-rendering

How GTK font rendering is set up.

When set to [enum@Gtk.FontRendering.MANUAL], GTK respects the low-level font-related settings (gtk-hint-font-metrics, gtk-xft-antialias, gtk-xft-hinting, gtk-xft-hintstyle and gtk-xft-rgba) as much as practical.

When set to [enum@Gtk.FontRendering.AUTOMATIC], GTK will consider factors such as screen resolution and scale in deciding how to render fonts.

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

gtk-shell-shows-app-menu

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-show-status-shapes

When true, widgets like switches include shapes to indicate their on/off state.

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.

Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.

Readable | Writeable

Implements

[trait@glib::ObjectExt], StyleProviderExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl Settings

pub fn builder() -> SettingsBuilder

Creates a new builder-pattern struct instance to construct Settings objects.

This method returns an instance of SettingsBuilder which can be used to create Settings objects.

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

Undoes the effect of calling g_object_set() to install an application-specific value for a setting.

After this call, the setting will again follow the session-wide value for this setting.

name

the name of the setting to reset

pub fn is_gtk_alternative_button_order(&self) -> bool

Whether buttons in dialogs should use the alternative button order.

pub fn set_gtk_alternative_button_order( &self, gtk_alternative_button_order: bool, )

Whether buttons in dialogs should use the alternative button order.

pub fn is_gtk_alternative_sort_arrows(&self) -> bool

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.

pub fn set_gtk_alternative_sort_arrows(&self, gtk_alternative_sort_arrows: bool)

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.

pub fn is_gtk_application_prefer_dark_theme(&self) -> bool

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…).

pub fn set_gtk_application_prefer_dark_theme( &self, gtk_application_prefer_dark_theme: bool, )

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…).

pub fn gtk_cursor_aspect_ratio(&self) -> f64

The aspect ratio of the text caret.

pub fn set_gtk_cursor_aspect_ratio(&self, gtk_cursor_aspect_ratio: f64)

The aspect ratio of the text caret.

pub fn is_gtk_cursor_blink(&self) -> bool

Whether the cursor should blink.

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

pub fn set_gtk_cursor_blink(&self, gtk_cursor_blink: bool)

Whether the cursor should blink.

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

pub fn gtk_cursor_blink_time(&self) -> i32

Length of the cursor blink cycle, in milliseconds.

pub fn set_gtk_cursor_blink_time(&self, gtk_cursor_blink_time: i32)

Length of the cursor blink cycle, in milliseconds.

pub fn gtk_cursor_blink_timeout(&self) -> i32

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.

pub fn set_gtk_cursor_blink_timeout(&self, gtk_cursor_blink_timeout: i32)

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.

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

Name of the cursor theme to use.

Use None to use the default theme.

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

Name of the cursor theme to use.

Use None to use the default theme.

pub fn gtk_cursor_theme_size(&self) -> i32

The size to use for cursors.

0 means to use the default size.

pub fn set_gtk_cursor_theme_size(&self, gtk_cursor_theme_size: i32)

The size to use for cursors.

0 means to use the default size.

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

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.

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

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.

pub fn is_gtk_dialogs_use_header(&self) -> bool

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.

pub fn set_gtk_dialogs_use_header(&self, gtk_dialogs_use_header: bool)

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.

pub fn gtk_dnd_drag_threshold(&self) -> i32

The number of pixels the cursor can move before dragging.

pub fn set_gtk_dnd_drag_threshold(&self, gtk_dnd_drag_threshold: i32)

The number of pixels the cursor can move before dragging.

pub fn gtk_double_click_distance(&self) -> i32

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

pub fn set_gtk_double_click_distance(&self, gtk_double_click_distance: i32)

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

pub fn gtk_double_click_time(&self) -> i32

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

pub fn set_gtk_double_click_time(&self, gtk_double_click_time: i32)

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

pub fn is_gtk_enable_accels(&self) -> bool

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

pub fn set_gtk_enable_accels(&self, gtk_enable_accels: bool)

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

pub fn is_gtk_enable_animations(&self) -> bool

Whether to enable toolkit-wide animations.

pub fn set_gtk_enable_animations(&self, gtk_enable_animations: bool)

Whether to enable toolkit-wide animations.

pub fn is_gtk_enable_event_sounds(&self) -> bool

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.

pub fn set_gtk_enable_event_sounds(&self, gtk_enable_event_sounds: bool)

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.

pub fn is_gtk_enable_input_feedback_sounds(&self) -> bool

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.

pub fn set_gtk_enable_input_feedback_sounds( &self, gtk_enable_input_feedback_sounds: bool, )

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.

pub fn is_gtk_enable_primary_paste(&self) -> bool

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

pub fn set_gtk_enable_primary_paste(&self, gtk_enable_primary_paste: bool)

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

pub fn gtk_entry_password_hint_timeout(&self) -> u32

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.

pub fn set_gtk_entry_password_hint_timeout( &self, gtk_entry_password_hint_timeout: u32, )

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.

pub fn is_gtk_entry_select_on_focus(&self) -> bool

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

pub fn set_gtk_entry_select_on_focus(&self, gtk_entry_select_on_focus: bool)

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

pub fn is_gtk_error_bell(&self) -> bool

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.

pub fn set_gtk_error_bell(&self, gtk_error_bell: bool)

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.

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

The default font to use.

GTK uses the family name and size from this string.

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

The default font to use.

GTK uses the family name and size from this string.

pub fn gtk_font_rendering(&self) -> FontRendering

Available on crate feature v4_16 only.

How GTK font rendering is set up.

When set to [enum@Gtk.FontRendering.MANUAL], GTK respects the low-level font-related settings (gtk-hint-font-metrics, gtk-xft-antialias, gtk-xft-hinting, gtk-xft-hintstyle and gtk-xft-rgba) as much as practical.

When set to [enum@Gtk.FontRendering.AUTOMATIC], GTK will consider factors such as screen resolution and scale in deciding how to render fonts.

pub fn set_gtk_font_rendering(&self, gtk_font_rendering: FontRendering)

Available on crate feature v4_16 only.

How GTK font rendering is set up.

When set to [enum@Gtk.FontRendering.MANUAL], GTK respects the low-level font-related settings (gtk-hint-font-metrics, gtk-xft-antialias, gtk-xft-hinting, gtk-xft-hintstyle and gtk-xft-rgba) as much as practical.

When set to [enum@Gtk.FontRendering.AUTOMATIC], GTK will consider factors such as screen resolution and scale in deciding how to render fonts.

pub fn gtk_fontconfig_timestamp(&self) -> u32

Timestamp of the current fontconfig configuration.

pub fn set_gtk_fontconfig_timestamp(&self, gtk_fontconfig_timestamp: u32)

Timestamp of the current fontconfig configuration.

pub fn is_gtk_hint_font_metrics(&self) -> bool

Available on crate feature v4_6 only.

Whether hinting should be applied to font metrics.

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

pub fn set_gtk_hint_font_metrics(&self, gtk_hint_font_metrics: bool)

Available on crate feature v4_6 only.

Whether hinting should be applied to font metrics.

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

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

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

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

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

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

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.

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

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.

pub fn is_gtk_keynav_use_caret(&self) -> bool

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.

pub fn set_gtk_keynav_use_caret(&self, gtk_keynav_use_caret: bool)

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.

pub fn is_gtk_label_select_on_focus(&self) -> bool

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

pub fn set_gtk_label_select_on_focus(&self, gtk_label_select_on_focus: bool)

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

pub fn gtk_long_press_time(&self) -> u32

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

See GestureLongPress.

pub fn set_gtk_long_press_time(&self, gtk_long_press_time: u32)

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

See GestureLongPress.

pub fn is_gtk_overlay_scrolling(&self) -> bool

Whether scrolled windows may use overlaid scrolling indicators.

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

pub fn set_gtk_overlay_scrolling(&self, gtk_overlay_scrolling: bool)

Whether scrolled windows may use overlaid scrolling indicators.

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

pub fn is_gtk_primary_button_warps_slider(&self) -> bool

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.

pub fn set_gtk_primary_button_warps_slider( &self, gtk_primary_button_warps_slider: bool, )

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.

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

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

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

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

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

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.

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

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.

pub fn is_gtk_recent_files_enabled(&self) -> bool

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

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

pub fn set_gtk_recent_files_enabled(&self, gtk_recent_files_enabled: bool)

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

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

pub fn gtk_recent_files_max_age(&self) -> i32

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.

pub fn set_gtk_recent_files_max_age(&self, gtk_recent_files_max_age: i32)

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.

pub fn is_gtk_shell_shows_app_menu(&self) -> bool

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

pub fn set_gtk_shell_shows_app_menu(&self, gtk_shell_shows_app_menu: bool)

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

pub fn is_gtk_shell_shows_desktop(&self) -> bool

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

pub fn set_gtk_shell_shows_desktop(&self, gtk_shell_shows_desktop: bool)

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

pub fn is_gtk_shell_shows_menubar(&self) -> bool

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

pub fn set_gtk_shell_shows_menubar(&self, gtk_shell_shows_menubar: bool)

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

pub fn is_gtk_show_status_shapes(&self) -> bool

Available on crate feature v4_14 only.

When true, widgets like switches include shapes to indicate their on/off state.

pub fn set_gtk_show_status_shapes(&self, gtk_show_status_shapes: bool)

Available on crate feature v4_14 only.

When true, widgets like switches include shapes to indicate their on/off state.

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

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.

pub fn set_gtk_sound_theme_name(&self, gtk_sound_theme_name: Option<&str>)

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.

pub fn is_gtk_split_cursor(&self) -> bool

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

pub fn set_gtk_split_cursor(&self, gtk_split_cursor: bool)

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

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

Name of the theme to load.

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

pub fn set_gtk_theme_name(&self, gtk_theme_name: Option<&str>)

Name of the theme to load.

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

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

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.

pub fn set_gtk_titlebar_double_click( &self, gtk_titlebar_double_click: Option<&str>, )

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.

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

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.

pub fn set_gtk_titlebar_middle_click( &self, gtk_titlebar_middle_click: Option<&str>, )

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.

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

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.

pub fn set_gtk_titlebar_right_click( &self, gtk_titlebar_right_click: Option<&str>, )

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.

pub fn gtk_xft_antialias(&self) -> i32

Whether to antialias fonts.

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

pub fn set_gtk_xft_antialias(&self, gtk_xft_antialias: i32)

Whether to antialias fonts.

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

pub fn gtk_xft_dpi(&self) -> i32

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

pub fn set_gtk_xft_dpi(&self, gtk_xft_dpi: i32)

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

pub fn gtk_xft_hinting(&self) -> i32

Whether to enable font hinting.

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

pub fn set_gtk_xft_hinting(&self, gtk_xft_hinting: i32)

Whether to enable font hinting.

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

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

What degree of font hinting to use.

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

pub fn set_gtk_xft_hintstyle(&self, gtk_xft_hintstyle: Option<&str>)

What degree of font hinting to use.

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

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

The type of subpixel antialiasing to use.

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

Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.

pub fn set_gtk_xft_rgba(&self, gtk_xft_rgba: Option<&str>)

The type of subpixel antialiasing to use.

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

Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.

pub fn default() -> Option<Settings>

Gets the Settings object for the default display, creating it if necessary.

See for_display().

Returns

a Settings object. If there is no default display, then returns None.

pub fn for_display(display: &impl IsA<Display>) -> Settings

Gets the Settings object for @display, creating it if necessary.

display

a gdk::Display

Returns

a Settings object

pub fn connect_gtk_alternative_button_order_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_alternative_sort_arrows_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_application_prefer_dark_theme_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_aspect_ratio_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_blink_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_blink_time_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_blink_timeout_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_cursor_theme_size_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_decoration_layout_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_dialogs_use_header_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_dnd_drag_threshold_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_double_click_distance_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_double_click_time_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_enable_accels_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_enable_animations_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_enable_event_sounds_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_enable_input_feedback_sounds_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_enable_primary_paste_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_entry_password_hint_timeout_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_entry_select_on_focus_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_error_bell_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_font_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_font_rendering_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_16 only.

pub fn connect_gtk_fontconfig_timestamp_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_hint_font_metrics_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_6 only.

pub fn connect_gtk_icon_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_im_module_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_keynav_use_caret_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_label_select_on_focus_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_long_press_time_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_overlay_scrolling_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_primary_button_warps_slider_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_print_backends_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_print_preview_command_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_recent_files_enabled_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_recent_files_max_age_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_shell_shows_app_menu_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_shell_shows_desktop_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_shell_shows_menubar_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_show_status_shapes_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_14 only.

pub fn connect_gtk_sound_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_split_cursor_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_titlebar_double_click_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_titlebar_middle_click_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_titlebar_right_click_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_xft_antialias_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_xft_dpi_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_xft_hinting_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_xft_hintstyle_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gtk_xft_rgba_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Settings

type ParamSpec = ParamSpecObject

type SetValue = Settings

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Settings>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Settings

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Settings

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Settings

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Settings

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Settings

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Settings

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Settings

impl IsA<StyleProvider> for Settings