Gtk.Settings¶

class — extends GObject.Object, StyleProvider

Provides a mechanism to share global settings between applications.

GTK relies on the platform-specific API for getting desktop-wide settings.

On Wayland, the settings are obtained via a settings portal that is part of the Linux desktop APIs for application.

On the X window system, this sharing is realized by an XSettings manager.

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 GtkSettings object with g_object_set(). This should be restricted to special cases though; GtkSettings are not meant as an application configuration facility.

There is one GtkSettings instance per display. It can be obtained with Settings.get_for_display, but in many cases, it is more convenient to use Widget.get_settings.

Methods¶

reset_property¶

def reset_property(self, name: str) -> None

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.

Parameters:

name — the name of the setting to reset

Static functions¶

get_default¶

@staticmethod
def get_default() -> Settings | None

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

See Settings.get_for_display.

get_for_display¶

@staticmethod
def get_for_display(display: Gdk.Display) -> Settings

Gets the GtkSettings object for display, creating it if necessary.

Parameters:

display — a GdkDisplay

Properties¶

gtk_alternative_button_order¶

gtk_alternative_button_order: bool  # read/write

Whether buttons in dialogs should use the alternative button order.

gtk_alternative_sort_arrows¶

gtk_alternative_sort_arrows: bool  # read/write

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.

gtk_application_prefer_dark_theme¶

gtk_application_prefer_dark_theme: bool  # read/write

:::warning Deprecated since 4.20 This API is deprecated. :::

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

gtk_cursor_aspect_ratio¶

gtk_cursor_aspect_ratio: float  # read/write

The aspect ratio of the text caret.

gtk_cursor_blink¶

gtk_cursor_blink: bool  # read/write

Whether the cursor should blink.

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

gtk_cursor_blink_time¶

gtk_cursor_blink_time: int  # read/write

Length of the cursor blink cycle, in milliseconds.

gtk_cursor_blink_timeout¶

gtk_cursor_blink_timeout: int  # read/write

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 Settings.gtk-cursor-blink to False.

gtk_cursor_theme_name¶

gtk_cursor_theme_name: str  # read/write

Name of the cursor theme to use.

Use None to use the default theme.

gtk_cursor_theme_size¶

gtk_cursor_theme_size: int  # read/write

The size to use for cursors.

0 means to use the default size.

gtk_decoration_layout¶

gtk_decoration_layout: str  # read/write

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 HeaderBar.decoration-layout property.

gtk_dialogs_use_header¶

gtk_dialogs_use_header: bool  # read/write

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 GtkDialog directly, or message dialogs.

gtk_dnd_drag_threshold¶

gtk_dnd_drag_threshold: int  # read/write

The number of pixels the cursor can move before dragging.

gtk_double_click_distance¶

gtk_double_click_distance: int  # read/write

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

gtk_double_click_time¶

gtk_double_click_time: int  # read/write

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

gtk_enable_accels¶

gtk_enable_accels: bool  # read/write

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

gtk_enable_animations¶

gtk_enable_animations: bool  # read/write

Whether to enable toolkit-wide animations.

gtk_enable_event_sounds¶

gtk_enable_event_sounds: bool  # read/write

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.

gtk_enable_input_feedback_sounds¶

gtk_enable_input_feedback_sounds: bool  # read/write

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.

gtk_enable_primary_paste¶

gtk_enable_primary_paste: bool  # read/write

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

gtk_entry_password_hint_timeout¶

gtk_entry_password_hint_timeout: int  # read/write

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.

gtk_entry_select_on_focus¶

gtk_entry_select_on_focus: bool  # read/write

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

gtk_error_bell¶

gtk_error_bell: bool  # read/write

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.

gtk_font_name¶

gtk_font_name: str  # read/write

The default font to use.

GTK uses the family name and size from this string.

gtk_font_rendering¶

gtk_font_rendering: FontRendering | int  # read/write

How GTK font rendering is set up.

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

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

gtk_fontconfig_timestamp¶

gtk_fontconfig_timestamp: int  # read/write

Timestamp of the current fontconfig configuration.

gtk_hint_font_metrics¶

gtk_hint_font_metrics: bool  # read/write

Whether hinting should be applied to font metrics.

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

gtk_icon_theme_name¶

gtk_icon_theme_name: str  # read/write

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

gtk_im_module¶

gtk_im_module: str  # read/write

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.

gtk_interface_color_scheme¶

gtk_interface_color_scheme: InterfaceColorScheme | int  # read/write

The color scheme used for rendering the user interface.

This setting communicates the system-wide preference. The color scheme that is actually used when applying CSS styles can be set with the CssProvider.prefers-color-scheme property.

gtk_interface_contrast¶

gtk_interface_contrast: InterfaceContrast | int  # read/write

The level of contrast to use for the user interface.

This setting communicates the system-wide preference. The contrast level that is actually used when applying CSS styles can be set with the CssProvider.prefers-contrast property.

gtk_interface_reduced_motion¶

gtk_interface_reduced_motion: ReducedMotion | int  # read/write

Whether animations should be reduced to essential motions.

This setting communicates the system-wide preference. The motion level that is actually used when applying CSS styles can be set with the CssProvider.prefers-reduced-motion property.

gtk_keynav_use_caret¶

gtk_keynav_use_caret: bool  # read/write

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.

gtk_label_select_on_focus¶

gtk_label_select_on_focus: bool  # read/write

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

gtk_long_press_time¶

gtk_long_press_time: int  # read/write

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

See GestureLongPress.

gtk_overlay_scrolling¶

gtk_overlay_scrolling: bool  # read/write

Whether scrolled windows may use overlaid scrolling indicators.

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

gtk_primary_button_warps_slider¶

gtk_primary_button_warps_slider: bool  # read/write

If the value of this setting is True, clicking the primary button in a GtkRange 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.

gtk_print_backends¶

gtk_print_backends: str  # read/write

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

gtk_print_preview_command¶

gtk_print_preview_command: str  # read/write

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.

gtk_recent_files_enabled¶

gtk_recent_files_enabled: bool  # read/write

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

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

gtk_recent_files_max_age¶

gtk_recent_files_max_age: int  # read/write

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.

gtk_shell_shows_app_menu¶

gtk_shell_shows_app_menu: bool  # read/write

:::warning Deprecated since 4.20 This API is deprecated. :::

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

gtk_shell_shows_desktop¶

gtk_shell_shows_desktop: bool  # read/write

:::warning Deprecated since 4.20 This API is deprecated. :::

Set to True if the desktop environment is displaying the desktop folder, False if not.

gtk_shell_shows_menubar¶

gtk_shell_shows_menubar: bool  # read/write

:::warning Deprecated since 4.20 This API is deprecated. :::

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

gtk_show_status_shapes¶

gtk_show_status_shapes: bool  # read/write

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

gtk_sound_theme_name¶

gtk_sound_theme_name: str  # read/write

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.

gtk_split_cursor¶

gtk_split_cursor: bool  # read/write

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

gtk_theme_name¶

gtk_theme_name: str  # read/write

Name of the theme to load.

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

gtk_titlebar_double_click¶

gtk_titlebar_double_click: str  # read/write

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.

gtk_titlebar_middle_click¶

gtk_titlebar_middle_click: str  # read/write

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.

gtk_titlebar_right_click¶

gtk_titlebar_right_click: str  # read/write

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.

gtk_xft_antialias¶

gtk_xft_antialias: int  # read/write

Whether to antialias fonts.

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

gtk_xft_dpi¶

gtk_xft_dpi: int  # read/write

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

gtk_xft_hinting¶

gtk_xft_hinting: int  # read/write

Whether to enable font hinting.

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

gtk_xft_hintstyle¶

gtk_xft_hintstyle: str  # read/write

What degree of font hinting to use.

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

gtk_xft_rgba¶

gtk_xft_rgba: str  # read/write

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.