Gtk.Settings¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
|||
r/w |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Gtk.Settings(**kwargs)¶
- Bases:
- Abstract:
No
GtkSettingsprovides 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.inifiles in/etc/gtk-4.0,$XDG_CONFIG_DIRS/gtk-4.0and$XDG_CONFIG_HOME/gtk-4.0. These files must be valid key files (seeGKeyFile), and have a section called Settings. Themes can also provide default values for settings by installing asettings.inifile next to theirgtk.cssfile.Applications can override system-wide settings by setting the property of the
GtkSettingsobject with g_object_set(). This should be restricted to special cases though;GtkSettingsare not meant as an application configuration facility.There is one
GtkSettingsinstance per display. It can be obtained with [func`Gtk`.Settings.get_for_display], but in many cases, it is more convenient to use [method`Gtk`.Widget.get_settings].- classmethod get_default()[source]¶
- Returns:
a
GtkSettingsobject. If there is no default display, then returnsNone.- Return type:
Gtk.SettingsorNone
Gets the
GtkSettingsobject for the default display, creating it if necessary.See [func`Gtk`.Settings.get_for_display].
- classmethod get_for_display(display)[source]¶
- Parameters:
display (
Gdk.Display) – aGdkDisplay- Returns:
a
GtkSettingsobject- Return type:
Gets the
GtkSettingsobject for display, creating it if necessary.
Property Details¶
- Gtk.Settings.props.gtk_alternative_button_order¶
-
Whether buttons in dialogs should use the alternative button order.
- Gtk.Settings.props.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.
- Gtk.Settings.props.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…).
- Gtk.Settings.props.gtk_cursor_aspect_ratio¶
-
The aspect ratio of the text caret.
- Gtk.Settings.props.gtk_cursor_blink¶
-
Whether the cursor should blink.
Also see the [property`Gtk`.Settings:gtk-cursor-blink-timeout] setting, which allows more flexible control over cursor blinking.
- Gtk.Settings.props.gtk_cursor_blink_time¶
-
Length of the cursor blink cycle, in milliseconds.
- Gtk.Settings.props.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 [property`Gtk`.Settings:gtk-cursor-blink] to
False.
- Gtk.Settings.props.gtk_cursor_theme_name¶
-
Name of the cursor theme to use.
Use
Noneto use the default theme.
- Gtk.Settings.props.gtk_cursor_theme_size¶
-
The size to use for cursors.
0 means to use the default size.
- Gtk.Settings.props.gtk_decoration_layout¶
- Name:
gtk-decoration-layout- Type:
- Default Value:
'menu:minimize,maximize,close'- Flags:
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 [property`Gtk`.HeaderBar:decoration-layout] property.
- Gtk.Settings.props.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
GtkDialogdirectly, or message dialogs.
- Gtk.Settings.props.gtk_dnd_drag_threshold¶
-
The number of pixels the cursor can move before dragging.
- Gtk.Settings.props.gtk_double_click_distance¶
-
The maximum distance allowed between two clicks for them to be considered a double click, in pixels.
- Gtk.Settings.props.gtk_double_click_time¶
-
The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.
- Gtk.Settings.props.gtk_enable_accels¶
-
Whether menu items should have visible accelerators which can be activated.
- Gtk.Settings.props.gtk_enable_animations¶
-
Whether to enable toolkit-wide animations.
- Gtk.Settings.props.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.
- Gtk.Settings.props.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.
- Gtk.Settings.props.gtk_enable_primary_paste¶
-
Whether a middle click on a mouse should paste the ‘PRIMARY’ clipboard content at the cursor location.
- Gtk.Settings.props.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
str. 600 is a good value for enabling it.
- Gtk.Settings.props.gtk_entry_select_on_focus¶
-
Whether to select the contents of an entry when it is focused.
- Gtk.Settings.props.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.
- Gtk.Settings.props.gtk_font_name¶
-
The default font to use.
GTK uses the family name and size from this string.
- Gtk.Settings.props.gtk_fontconfig_timestamp¶
-
Timestamp of the current fontconfig configuration.
- Gtk.Settings.props.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.
New in version 4.6.
- Gtk.Settings.props.gtk_icon_theme_name¶
-
Name of the icon theme to use.
See [class`Gtk`.IconTheme] for details about how GTK handles icon themes.
- Gtk.Settings.props.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 [class`Gtk`.IMContext].
-
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.Settings.props.gtk_label_select_on_focus¶
-
Whether to select the contents of a selectable label when it is focused.
- Gtk.Settings.props.gtk_long_press_time¶
-
The time for a button or touch press to be considered a “long press”.
See [class`Gtk`.GestureLongPress].
- Gtk.Settings.props.gtk_overlay_scrolling¶
-
Whether scrolled windows may use overlaid scrolling indicators.
If this is set to
False, scrolled windows will have permanent scrollbars.
- Gtk.Settings.props.gtk_primary_button_warps_slider¶
-
If the value of this setting is
True, clicking the primary button in aGtkRangetrough 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.Settings.props.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”.
- Gtk.Settings.props.gtk_print_preview_command¶
- Name:
gtk-print-preview-command- Type:
- Default Value:
'evince --unlink-tempfile --preview --print-settings %s %f'- Flags:
A command to run for displaying the print preview.
The command should contain a
%fplaceholder, which will get replaced by the path to the pdf file. The command may also contain a%splaceholder, which will get replaced by the path to a file containing the print settings in the format produced by [method`Gtk`.PrintSettings.to_file].The preview application is responsible for removing the pdf file and the print settings file when it is done.
- Gtk.Settings.props.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.
- Gtk.Settings.props.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.
-
Set to
Trueif the desktop environment is displaying the app menu,Falseif the app should display it itself.
- Gtk.Settings.props.gtk_shell_shows_desktop¶
-
Set to
Trueif the desktop environment is displaying the desktop folder,Falseif not.
-
Set to
Trueif the desktop environment is displaying the menubar,Falseif the app should display it itself.
- Gtk.Settings.props.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.
- Gtk.Settings.props.gtk_split_cursor¶
-
Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
- Gtk.Settings.props.gtk_theme_name¶
-
Name of the theme to load.
See [class`Gtk`.CssProvider] for details about how GTK finds the CSS stylesheet for a theme.
- Gtk.Settings.props.gtk_titlebar_double_click¶
- Name:
gtk-titlebar-double-click- Type:
- Default Value:
'toggle-maximize'- Flags:
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.Settings.props.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.
- Gtk.Settings.props.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.
- Gtk.Settings.props.gtk_xft_antialias¶
-
Whether to antialias fonts.
The values are 0 for no, 1 for yes, or -1 for the system default.
- Gtk.Settings.props.gtk_xft_dpi¶
-
The font resolution, in 1024 * dots/inch.
-1 to use the default value.
- Gtk.Settings.props.gtk_xft_hinting¶
-
Whether to enable font hinting.
The values are 0 for no, 1 for yes, or -1 for the system default.
- Gtk.Settings.props.gtk_xft_hintstyle¶
-
What degree of font hinting to use.
The possible vaues are hintnone, hintslight, hintmedium, hintfull.