GI.Gtk.Objects.Settings

GtkSettings provide a mechanism to share global settings between applications.

On the X window system, this sharing is realized by an XSettings manager that is usually part of the desktop environment, along with utilities that let the user change these settings. In the absence of an Xsettings manager, 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 KeyFile), 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. When doing so, you need to be aware that settings that are specific to individual widgets may not be available before the widget type has been realized at least once. The following example demonstrates a way to do this:

C code

 gtk_init ();

 // make sure the type is realized
 g_type_class_unref (g_type_class_ref (GTK_TYPE_BUTTON));

 g_object_set (gtk_settings_get_default (), "gtk-enable-animations", FALSE, NULL);

There is one GtkSettings instance per display. It can be obtained with settingsGetForDisplay, but in many cases, it is more convenient to use widgetGetSettings. settingsGetDefault returns the GtkSettings instance for the default display.

Exported types

newtype Settings

Memory-managed wrapper type.

Constructors

Settings (ManagedPtr Settings)

Instances

Eq Settings

Defined in GI.Gtk.Objects.Settings

Methods

(==) :: Settings -> Settings -> Bool

(/=) :: Settings -> Settings -> Bool

IsGValue Settings

Convert Settings to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.Settings

Methods

toGValue :: Settings -> IO GValue

fromGValue :: GValue -> IO Settings

GObject Settings

Defined in GI.Gtk.Objects.Settings

Methods

gobjectType :: IO GType

HasParentTypes Settings

Defined in GI.Gtk.Objects.Settings

type ParentTypes Settings

Defined in GI.Gtk.Objects.Settings

type ParentTypes Settings = '[Object, StyleProvider]

class (GObject o, IsDescendantOf Settings o) => IsSettings o

Type class for types which can be safely cast to Settings, for instance with toSettings.

Instances

(GObject o, IsDescendantOf Settings o) => IsSettings o

Defined in GI.Gtk.Objects.Settings

toSettings :: (MonadIO m, IsSettings o) => o -> m Settings

Cast to Settings, for types for which this is known to be safe. For general casts, use castTo.

noSettings :: Maybe Settings

A convenience alias for Nothing :: Maybe Settings.

Methods

Overloaded methods

getDefault

settingsGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe Settings)

Returns: a Settings object. If there is no default display, then returns Nothing.

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

getForDisplay

settingsGetForDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplay a)

=> a

display: a Display.

-> m Settings

Returns: a Settings object.

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

resetProperty

settingsResetProperty

Arguments

:: (HasCallStack, MonadIO m, IsSettings a)

=> a

settings: a Settings object

-> Text

name: the name of the setting to reset

-> m ()

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.

Properties

gtkAlternativeButtonOrder

No description available in the introspection data.

constructSettingsGtkAlternativeButtonOrder :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-alternative-button-order” property. This is rarely needed directly, but it is used by new.

getSettingsGtkAlternativeButtonOrder :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-alternative-button-order” property. When overloading is enabled, this is equivalent to

get settings #gtkAlternativeButtonOrder

setSettingsGtkAlternativeButtonOrder :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-alternative-button-order” property. When overloading is enabled, this is equivalent to

set settings [ #gtkAlternativeButtonOrder := value ]

gtkAlternativeSortArrows

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.

constructSettingsGtkAlternativeSortArrows :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-alternative-sort-arrows” property. This is rarely needed directly, but it is used by new.

getSettingsGtkAlternativeSortArrows :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-alternative-sort-arrows” property. When overloading is enabled, this is equivalent to

get settings #gtkAlternativeSortArrows

setSettingsGtkAlternativeSortArrows :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-alternative-sort-arrows” property. When overloading is enabled, this is equivalent to

set settings [ #gtkAlternativeSortArrows := value ]

gtkApplicationPreferDarkTheme

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

constructSettingsGtkApplicationPreferDarkTheme :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-application-prefer-dark-theme” property. This is rarely needed directly, but it is used by new.

getSettingsGtkApplicationPreferDarkTheme :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-application-prefer-dark-theme” property. When overloading is enabled, this is equivalent to

get settings #gtkApplicationPreferDarkTheme

setSettingsGtkApplicationPreferDarkTheme :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-application-prefer-dark-theme” property. When overloading is enabled, this is equivalent to

set settings [ #gtkApplicationPreferDarkTheme := value ]

gtkCursorBlink

Whether the cursor should blink.

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

constructSettingsGtkCursorBlink :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-cursor-blink” property. This is rarely needed directly, but it is used by new.

getSettingsGtkCursorBlink :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-cursor-blink” property. When overloading is enabled, this is equivalent to

get settings #gtkCursorBlink

setSettingsGtkCursorBlink :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-cursor-blink” property. When overloading is enabled, this is equivalent to

set settings [ #gtkCursorBlink := value ]

gtkCursorBlinkTime

No description available in the introspection data.

constructSettingsGtkCursorBlinkTime :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-cursor-blink-time” property. This is rarely needed directly, but it is used by new.

getSettingsGtkCursorBlinkTime :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-cursor-blink-time” property. When overloading is enabled, this is equivalent to

get settings #gtkCursorBlinkTime

setSettingsGtkCursorBlinkTime :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-cursor-blink-time” property. When overloading is enabled, this is equivalent to

set settings [ #gtkCursorBlinkTime := value ]

gtkCursorBlinkTimeout

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.

constructSettingsGtkCursorBlinkTimeout :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-cursor-blink-timeout” property. This is rarely needed directly, but it is used by new.

getSettingsGtkCursorBlinkTimeout :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-cursor-blink-timeout” property. When overloading is enabled, this is equivalent to

get settings #gtkCursorBlinkTimeout

setSettingsGtkCursorBlinkTimeout :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-cursor-blink-timeout” property. When overloading is enabled, this is equivalent to

set settings [ #gtkCursorBlinkTimeout := value ]

gtkCursorThemeName

No description available in the introspection data.

clearSettingsGtkCursorThemeName :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-cursor-theme-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkCursorThemeName

constructSettingsGtkCursorThemeName :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-cursor-theme-name” property. This is rarely needed directly, but it is used by new.

getSettingsGtkCursorThemeName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-cursor-theme-name” property. When overloading is enabled, this is equivalent to

get settings #gtkCursorThemeName

setSettingsGtkCursorThemeName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-cursor-theme-name” property. When overloading is enabled, this is equivalent to

set settings [ #gtkCursorThemeName := value ]

gtkCursorThemeSize

No description available in the introspection data.

constructSettingsGtkCursorThemeSize :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-cursor-theme-size” property. This is rarely needed directly, but it is used by new.

getSettingsGtkCursorThemeSize :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-cursor-theme-size” property. When overloading is enabled, this is equivalent to

get settings #gtkCursorThemeSize

setSettingsGtkCursorThemeSize :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-cursor-theme-size” property. When overloading is enabled, this is equivalent to

set settings [ #gtkCursorThemeSize := value ]

gtkDecorationLayout

This setting determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed at the left of 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.

clearSettingsGtkDecorationLayout :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-decoration-layout” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkDecorationLayout

constructSettingsGtkDecorationLayout :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-decoration-layout” property. This is rarely needed directly, but it is used by new.

getSettingsGtkDecorationLayout :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-decoration-layout” property. When overloading is enabled, this is equivalent to

get settings #gtkDecorationLayout

setSettingsGtkDecorationLayout :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-decoration-layout” property. When overloading is enabled, this is equivalent to

set settings [ #gtkDecorationLayout := value ]

gtkDialogsUseHeader

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.

constructSettingsGtkDialogsUseHeader :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-dialogs-use-header” property. This is rarely needed directly, but it is used by new.

getSettingsGtkDialogsUseHeader :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-dialogs-use-header” property. When overloading is enabled, this is equivalent to

get settings #gtkDialogsUseHeader

setSettingsGtkDialogsUseHeader :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-dialogs-use-header” property. When overloading is enabled, this is equivalent to

set settings [ #gtkDialogsUseHeader := value ]

gtkDndDragThreshold

No description available in the introspection data.

constructSettingsGtkDndDragThreshold :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-dnd-drag-threshold” property. This is rarely needed directly, but it is used by new.

getSettingsGtkDndDragThreshold :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-dnd-drag-threshold” property. When overloading is enabled, this is equivalent to

get settings #gtkDndDragThreshold

setSettingsGtkDndDragThreshold :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-dnd-drag-threshold” property. When overloading is enabled, this is equivalent to

set settings [ #gtkDndDragThreshold := value ]

gtkDoubleClickDistance

No description available in the introspection data.

constructSettingsGtkDoubleClickDistance :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-double-click-distance” property. This is rarely needed directly, but it is used by new.

getSettingsGtkDoubleClickDistance :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-double-click-distance” property. When overloading is enabled, this is equivalent to

get settings #gtkDoubleClickDistance

setSettingsGtkDoubleClickDistance :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-double-click-distance” property. When overloading is enabled, this is equivalent to

set settings [ #gtkDoubleClickDistance := value ]

gtkDoubleClickTime

No description available in the introspection data.

constructSettingsGtkDoubleClickTime :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-double-click-time” property. This is rarely needed directly, but it is used by new.

getSettingsGtkDoubleClickTime :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-double-click-time” property. When overloading is enabled, this is equivalent to

get settings #gtkDoubleClickTime

setSettingsGtkDoubleClickTime :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-double-click-time” property. When overloading is enabled, this is equivalent to

set settings [ #gtkDoubleClickTime := value ]

gtkEnableAccels

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

constructSettingsGtkEnableAccels :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-enable-accels” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEnableAccels :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-enable-accels” property. When overloading is enabled, this is equivalent to

get settings #gtkEnableAccels

setSettingsGtkEnableAccels :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-enable-accels” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEnableAccels := value ]

gtkEnableAnimations

No description available in the introspection data.

constructSettingsGtkEnableAnimations :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-enable-animations” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEnableAnimations :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-enable-animations” property. When overloading is enabled, this is equivalent to

get settings #gtkEnableAnimations

setSettingsGtkEnableAnimations :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-enable-animations” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEnableAnimations := value ]

gtkEnableEventSounds

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.

constructSettingsGtkEnableEventSounds :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-enable-event-sounds” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEnableEventSounds :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-enable-event-sounds” property. When overloading is enabled, this is equivalent to

get settings #gtkEnableEventSounds

setSettingsGtkEnableEventSounds :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-enable-event-sounds” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEnableEventSounds := value ]

gtkEnableInputFeedbackSounds

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.

constructSettingsGtkEnableInputFeedbackSounds :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-enable-input-feedback-sounds” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEnableInputFeedbackSounds :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-enable-input-feedback-sounds” property. When overloading is enabled, this is equivalent to

get settings #gtkEnableInputFeedbackSounds

setSettingsGtkEnableInputFeedbackSounds :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-enable-input-feedback-sounds” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEnableInputFeedbackSounds := value ]

gtkEnablePrimaryPaste

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

constructSettingsGtkEnablePrimaryPaste :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-enable-primary-paste” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEnablePrimaryPaste :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-enable-primary-paste” property. When overloading is enabled, this is equivalent to

get settings #gtkEnablePrimaryPaste

setSettingsGtkEnablePrimaryPaste :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-enable-primary-paste” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEnablePrimaryPaste := value ]

gtkEntryPasswordHintTimeout

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.

constructSettingsGtkEntryPasswordHintTimeout :: IsSettings o => Word32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-entry-password-hint-timeout” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEntryPasswordHintTimeout :: (MonadIO m, IsSettings o) => o -> m Word32

Get the value of the “gtk-entry-password-hint-timeout” property. When overloading is enabled, this is equivalent to

get settings #gtkEntryPasswordHintTimeout

setSettingsGtkEntryPasswordHintTimeout :: (MonadIO m, IsSettings o) => o -> Word32 -> m ()

Set the value of the “gtk-entry-password-hint-timeout” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEntryPasswordHintTimeout := value ]

gtkEntrySelectOnFocus

No description available in the introspection data.

constructSettingsGtkEntrySelectOnFocus :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-entry-select-on-focus” property. This is rarely needed directly, but it is used by new.

getSettingsGtkEntrySelectOnFocus :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-entry-select-on-focus” property. When overloading is enabled, this is equivalent to

get settings #gtkEntrySelectOnFocus

setSettingsGtkEntrySelectOnFocus :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-entry-select-on-focus” property. When overloading is enabled, this is equivalent to

set settings [ #gtkEntrySelectOnFocus := value ]

gtkErrorBell

When True, keyboard navigation and other input-related errors will cause a beep. Since the error bell is implemented using surfaceBeep, the windowing system may offer ways to configure the error bell in many ways, such as flashing the window or similar visual effects.

constructSettingsGtkErrorBell :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-error-bell” property. This is rarely needed directly, but it is used by new.

getSettingsGtkErrorBell :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-error-bell” property. When overloading is enabled, this is equivalent to

get settings #gtkErrorBell

setSettingsGtkErrorBell :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-error-bell” property. When overloading is enabled, this is equivalent to

set settings [ #gtkErrorBell := value ]

gtkFontName

The default font to use. GTK uses the family name and size from this string.

clearSettingsGtkFontName :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-font-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkFontName

constructSettingsGtkFontName :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-font-name” property. This is rarely needed directly, but it is used by new.

getSettingsGtkFontName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-font-name” property. When overloading is enabled, this is equivalent to

get settings #gtkFontName

setSettingsGtkFontName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-font-name” property. When overloading is enabled, this is equivalent to

set settings [ #gtkFontName := value ]

gtkFontconfigTimestamp

No description available in the introspection data.

constructSettingsGtkFontconfigTimestamp :: IsSettings o => Word32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-fontconfig-timestamp” property. This is rarely needed directly, but it is used by new.

getSettingsGtkFontconfigTimestamp :: (MonadIO m, IsSettings o) => o -> m Word32

Get the value of the “gtk-fontconfig-timestamp” property. When overloading is enabled, this is equivalent to

get settings #gtkFontconfigTimestamp

setSettingsGtkFontconfigTimestamp :: (MonadIO m, IsSettings o) => o -> Word32 -> m ()

Set the value of the “gtk-fontconfig-timestamp” property. When overloading is enabled, this is equivalent to

set settings [ #gtkFontconfigTimestamp := value ]

gtkIconThemeName

No description available in the introspection data.

clearSettingsGtkIconThemeName :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-icon-theme-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkIconThemeName

constructSettingsGtkIconThemeName :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-icon-theme-name” property. This is rarely needed directly, but it is used by new.

getSettingsGtkIconThemeName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-icon-theme-name” property. When overloading is enabled, this is equivalent to

get settings #gtkIconThemeName

setSettingsGtkIconThemeName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-icon-theme-name” property. When overloading is enabled, this is equivalent to

set settings [ #gtkIconThemeName := value ]

gtkImModule

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.

clearSettingsGtkImModule :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-im-module” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkImModule

constructSettingsGtkImModule :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-im-module” property. This is rarely needed directly, but it is used by new.

getSettingsGtkImModule :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-im-module” property. When overloading is enabled, this is equivalent to

get settings #gtkImModule

setSettingsGtkImModule :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-im-module” property. When overloading is enabled, this is equivalent to

set settings [ #gtkImModule := value ]

gtkKeynavUseCaret

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.

constructSettingsGtkKeynavUseCaret :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-keynav-use-caret” property. This is rarely needed directly, but it is used by new.

getSettingsGtkKeynavUseCaret :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-keynav-use-caret” property. When overloading is enabled, this is equivalent to

get settings #gtkKeynavUseCaret

setSettingsGtkKeynavUseCaret :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-keynav-use-caret” property. When overloading is enabled, this is equivalent to

set settings [ #gtkKeynavUseCaret := value ]

gtkLabelSelectOnFocus

No description available in the introspection data.

constructSettingsGtkLabelSelectOnFocus :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-label-select-on-focus” property. This is rarely needed directly, but it is used by new.

getSettingsGtkLabelSelectOnFocus :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-label-select-on-focus” property. When overloading is enabled, this is equivalent to

get settings #gtkLabelSelectOnFocus

setSettingsGtkLabelSelectOnFocus :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-label-select-on-focus” property. When overloading is enabled, this is equivalent to

set settings [ #gtkLabelSelectOnFocus := value ]

gtkLongPressTime

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

constructSettingsGtkLongPressTime :: IsSettings o => Word32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-long-press-time” property. This is rarely needed directly, but it is used by new.

getSettingsGtkLongPressTime :: (MonadIO m, IsSettings o) => o -> m Word32

Get the value of the “gtk-long-press-time” property. When overloading is enabled, this is equivalent to

get settings #gtkLongPressTime

setSettingsGtkLongPressTime :: (MonadIO m, IsSettings o) => o -> Word32 -> m ()

Set the value of the “gtk-long-press-time” property. When overloading is enabled, this is equivalent to

set settings [ #gtkLongPressTime := value ]

gtkPrimaryButtonWarpsSlider

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 (since GTK 3.22.25) clicking the middle mouse button.

constructSettingsGtkPrimaryButtonWarpsSlider :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-primary-button-warps-slider” property. This is rarely needed directly, but it is used by new.

getSettingsGtkPrimaryButtonWarpsSlider :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-primary-button-warps-slider” property. When overloading is enabled, this is equivalent to

get settings #gtkPrimaryButtonWarpsSlider

setSettingsGtkPrimaryButtonWarpsSlider :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-primary-button-warps-slider” property. When overloading is enabled, this is equivalent to

set settings [ #gtkPrimaryButtonWarpsSlider := value ]

gtkPrintBackends

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

clearSettingsGtkPrintBackends :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-print-backends” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkPrintBackends

constructSettingsGtkPrintBackends :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-print-backends” property. This is rarely needed directly, but it is used by new.

getSettingsGtkPrintBackends :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-print-backends” property. When overloading is enabled, this is equivalent to

get settings #gtkPrintBackends

setSettingsGtkPrintBackends :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-print-backends” property. When overloading is enabled, this is equivalent to

set settings [ #gtkPrintBackends := value ]

gtkPrintPreviewCommand

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

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

clearSettingsGtkPrintPreviewCommand :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-print-preview-command” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkPrintPreviewCommand

constructSettingsGtkPrintPreviewCommand :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-print-preview-command” property. This is rarely needed directly, but it is used by new.

getSettingsGtkPrintPreviewCommand :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-print-preview-command” property. When overloading is enabled, this is equivalent to

get settings #gtkPrintPreviewCommand

setSettingsGtkPrintPreviewCommand :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-print-preview-command” property. When overloading is enabled, this is equivalent to

set settings [ #gtkPrintPreviewCommand := value ]

gtkRecentFilesEnabled

Whether GTK should keep track of items inside the recently used resources list. If set to False, the list will always be empty.

constructSettingsGtkRecentFilesEnabled :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-recent-files-enabled” property. This is rarely needed directly, but it is used by new.

getSettingsGtkRecentFilesEnabled :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-recent-files-enabled” property. When overloading is enabled, this is equivalent to

get settings #gtkRecentFilesEnabled

setSettingsGtkRecentFilesEnabled :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-recent-files-enabled” property. When overloading is enabled, this is equivalent to

set settings [ #gtkRecentFilesEnabled := value ]

gtkRecentFilesMaxAge

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.

constructSettingsGtkRecentFilesMaxAge :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-recent-files-max-age” property. This is rarely needed directly, but it is used by new.

getSettingsGtkRecentFilesMaxAge :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-recent-files-max-age” property. When overloading is enabled, this is equivalent to

get settings #gtkRecentFilesMaxAge

setSettingsGtkRecentFilesMaxAge :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-recent-files-max-age” property. When overloading is enabled, this is equivalent to

set settings [ #gtkRecentFilesMaxAge := value ]

gtkShellShowsAppMenu

No description available in the introspection data.

constructSettingsGtkShellShowsAppMenu :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-shell-shows-app-menu” property. This is rarely needed directly, but it is used by new.

getSettingsGtkShellShowsAppMenu :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-shell-shows-app-menu” property. When overloading is enabled, this is equivalent to

get settings #gtkShellShowsAppMenu

setSettingsGtkShellShowsAppMenu :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-shell-shows-app-menu” property. When overloading is enabled, this is equivalent to

set settings [ #gtkShellShowsAppMenu := value ]

gtkShellShowsDesktop

No description available in the introspection data.

constructSettingsGtkShellShowsDesktop :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-shell-shows-desktop” property. This is rarely needed directly, but it is used by new.

getSettingsGtkShellShowsDesktop :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-shell-shows-desktop” property. When overloading is enabled, this is equivalent to

get settings #gtkShellShowsDesktop

setSettingsGtkShellShowsDesktop :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-shell-shows-desktop” property. When overloading is enabled, this is equivalent to

set settings [ #gtkShellShowsDesktop := value ]

gtkShellShowsMenubar

No description available in the introspection data.

constructSettingsGtkShellShowsMenubar :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-shell-shows-menubar” property. This is rarely needed directly, but it is used by new.

getSettingsGtkShellShowsMenubar :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-shell-shows-menubar” property. When overloading is enabled, this is equivalent to

get settings #gtkShellShowsMenubar

setSettingsGtkShellShowsMenubar :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-shell-shows-menubar” property. When overloading is enabled, this is equivalent to

set settings [ #gtkShellShowsMenubar := value ]

gtkSoundThemeName

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.

clearSettingsGtkSoundThemeName :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-sound-theme-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkSoundThemeName

constructSettingsGtkSoundThemeName :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-sound-theme-name” property. This is rarely needed directly, but it is used by new.

getSettingsGtkSoundThemeName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-sound-theme-name” property. When overloading is enabled, this is equivalent to

get settings #gtkSoundThemeName

setSettingsGtkSoundThemeName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-sound-theme-name” property. When overloading is enabled, this is equivalent to

set settings [ #gtkSoundThemeName := value ]

gtkSplitCursor

No description available in the introspection data.

constructSettingsGtkSplitCursor :: IsSettings o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-split-cursor” property. This is rarely needed directly, but it is used by new.

getSettingsGtkSplitCursor :: (MonadIO m, IsSettings o) => o -> m Bool

Get the value of the “gtk-split-cursor” property. When overloading is enabled, this is equivalent to

get settings #gtkSplitCursor

setSettingsGtkSplitCursor :: (MonadIO m, IsSettings o) => o -> Bool -> m ()

Set the value of the “gtk-split-cursor” property. When overloading is enabled, this is equivalent to

set settings [ #gtkSplitCursor := value ]

gtkThemeName

No description available in the introspection data.

clearSettingsGtkThemeName :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-theme-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkThemeName

constructSettingsGtkThemeName :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-theme-name” property. This is rarely needed directly, but it is used by new.

getSettingsGtkThemeName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-theme-name” property. When overloading is enabled, this is equivalent to

get settings #gtkThemeName

setSettingsGtkThemeName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-theme-name” property. When overloading is enabled, this is equivalent to

set settings [ #gtkThemeName := value ]

gtkTitlebarDoubleClick

This setting 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.

clearSettingsGtkTitlebarDoubleClick :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-titlebar-double-click” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkTitlebarDoubleClick

constructSettingsGtkTitlebarDoubleClick :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-titlebar-double-click” property. This is rarely needed directly, but it is used by new.

getSettingsGtkTitlebarDoubleClick :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-titlebar-double-click” property. When overloading is enabled, this is equivalent to

get settings #gtkTitlebarDoubleClick

setSettingsGtkTitlebarDoubleClick :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-titlebar-double-click” property. When overloading is enabled, this is equivalent to

set settings [ #gtkTitlebarDoubleClick := value ]

gtkTitlebarMiddleClick

This setting 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.

clearSettingsGtkTitlebarMiddleClick :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-titlebar-middle-click” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkTitlebarMiddleClick

constructSettingsGtkTitlebarMiddleClick :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-titlebar-middle-click” property. This is rarely needed directly, but it is used by new.

getSettingsGtkTitlebarMiddleClick :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-titlebar-middle-click” property. When overloading is enabled, this is equivalent to

get settings #gtkTitlebarMiddleClick

setSettingsGtkTitlebarMiddleClick :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-titlebar-middle-click” property. When overloading is enabled, this is equivalent to

set settings [ #gtkTitlebarMiddleClick := value ]

gtkTitlebarRightClick

This setting 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.

clearSettingsGtkTitlebarRightClick :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-titlebar-right-click” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkTitlebarRightClick

constructSettingsGtkTitlebarRightClick :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-titlebar-right-click” property. This is rarely needed directly, but it is used by new.

getSettingsGtkTitlebarRightClick :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-titlebar-right-click” property. When overloading is enabled, this is equivalent to

get settings #gtkTitlebarRightClick

setSettingsGtkTitlebarRightClick :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-titlebar-right-click” property. When overloading is enabled, this is equivalent to

set settings [ #gtkTitlebarRightClick := value ]

gtkXftAntialias

No description available in the introspection data.

constructSettingsGtkXftAntialias :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-xft-antialias” property. This is rarely needed directly, but it is used by new.

getSettingsGtkXftAntialias :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-xft-antialias” property. When overloading is enabled, this is equivalent to

get settings #gtkXftAntialias

setSettingsGtkXftAntialias :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-xft-antialias” property. When overloading is enabled, this is equivalent to

set settings [ #gtkXftAntialias := value ]

gtkXftDpi

No description available in the introspection data.

constructSettingsGtkXftDpi :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-xft-dpi” property. This is rarely needed directly, but it is used by new.

getSettingsGtkXftDpi :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-xft-dpi” property. When overloading is enabled, this is equivalent to

get settings #gtkXftDpi

setSettingsGtkXftDpi :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-xft-dpi” property. When overloading is enabled, this is equivalent to

set settings [ #gtkXftDpi := value ]

gtkXftHinting

No description available in the introspection data.

constructSettingsGtkXftHinting :: IsSettings o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-xft-hinting” property. This is rarely needed directly, but it is used by new.

getSettingsGtkXftHinting :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “gtk-xft-hinting” property. When overloading is enabled, this is equivalent to

get settings #gtkXftHinting

setSettingsGtkXftHinting :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “gtk-xft-hinting” property. When overloading is enabled, this is equivalent to

set settings [ #gtkXftHinting := value ]

gtkXftHintstyle

No description available in the introspection data.

clearSettingsGtkXftHintstyle :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-xft-hintstyle” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkXftHintstyle

constructSettingsGtkXftHintstyle :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-xft-hintstyle” property. This is rarely needed directly, but it is used by new.

getSettingsGtkXftHintstyle :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-xft-hintstyle” property. When overloading is enabled, this is equivalent to

get settings #gtkXftHintstyle

setSettingsGtkXftHintstyle :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-xft-hintstyle” property. When overloading is enabled, this is equivalent to

set settings [ #gtkXftHintstyle := value ]

gtkXftRgba

No description available in the introspection data.

clearSettingsGtkXftRgba :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “gtk-xft-rgba” property to Nothing. When overloading is enabled, this is equivalent to

clear #gtkXftRgba

constructSettingsGtkXftRgba :: IsSettings o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gtk-xft-rgba” property. This is rarely needed directly, but it is used by new.

getSettingsGtkXftRgba :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “gtk-xft-rgba” property. When overloading is enabled, this is equivalent to

get settings #gtkXftRgba

setSettingsGtkXftRgba :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “gtk-xft-rgba” property. When overloading is enabled, this is equivalent to

set settings [ #gtkXftRgba := value ]