Class (GI Class)

Gtk-3.0GtkSettings

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-3.0, $XDG_CONFIG_DIRS/gtk-3.0 and $XDG_CONFIG_HOME/gtk-3.0. These files must be valid key files (see GLib.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:

  gtk_init (&argc, &argv);

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

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

There is one GtkSettings instance per screen. It can be obtained with gtk_settings_get_for_screen(), but in many cases, it is more convenient to use gtk_widget_get_settings(). gtk_settings_get_default() returns the GtkSettings instance for the default screen.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

color_hash colorHash gtk_alternative_button_order gtk_alternative_sort_arrows gtk_application_prefer_dark_theme gtk_auto_mnemonics gtk_button_images gtk_can_change_accels gtk_color_palette gtk_color_scheme gtk_cursor_aspect_ratio gtk_cursor_blink gtk_cursor_blink_time gtk_cursor_blink_timeout gtk_cursor_theme_name gtk_cursor_theme_size gtk_decoration_layout gtk_dialogs_use_header gtk_dnd_drag_threshold gtk_double_click_distance gtk_double_click_time gtk_enable_accels gtk_enable_animations gtk_enable_event_sounds gtk_enable_input_feedback_sounds gtk_enable_mnemonics gtk_enable_primary_paste gtk_enable_tooltips gtk_entry_password_hint_timeout gtk_entry_select_on_focus gtk_error_bell gtk_fallback_icon_theme gtk_file_chooser_backend gtk_font_name gtk_fontconfig_timestamp gtk_icon_sizes gtk_icon_theme_name gtk_im_module gtk_im_preedit_style gtk_im_status_style gtk_key_theme_name gtk_keynav_cursor_only gtk_keynav_use_caret gtk_keynav_wrap_around gtk_label_select_on_focus gtk_long_press_time gtk_menu_bar_accel gtk_menu_bar_popup_delay gtk_menu_images gtk_menu_popdown_delay gtk_menu_popup_delay gtk_modules gtk_overlay_scrolling gtk_primary_button_warps_slider gtk_print_backends gtk_print_preview_command gtk_recent_files_enabled gtk_recent_files_limit gtk_recent_files_max_age gtk_scrolled_window_placement gtk_shell_shows_app_menu gtk_shell_shows_desktop gtk_shell_shows_menubar gtk_show_input_method_menu gtk_show_unicode_menu gtk_sound_theme_name gtk_split_cursor gtk_theme_name gtk_timeout_expand gtk_timeout_initial gtk_timeout_repeat gtk_titlebar_double_click gtk_titlebar_middle_click gtk_titlebar_right_click gtk_toolbar_icon_size gtk_toolbar_style gtk_tooltip_browse_mode_timeout gtk_tooltip_browse_timeout gtk_tooltip_timeout gtk_touchscreen_mode gtk_visible_focus gtk_xft_antialias gtk_xft_dpi gtk_xft_hinting gtk_xft_hintstyle gtk_xft_rgba gtkAlternativeButtonOrder gtkAlternativeSortArrows gtkApplicationPreferDarkTheme gtkAutoMnemonics gtkButtonImages gtkCanChangeAccels gtkColorPalette gtkColorScheme gtkCursorAspectRatio gtkCursorBlink gtkCursorBlinkTime gtkCursorBlinkTimeout gtkCursorThemeName gtkCursorThemeSize gtkDecorationLayout gtkDialogsUseHeader gtkDndDragThreshold gtkDoubleClickDistance gtkDoubleClickTime gtkEnableAccels gtkEnableAnimations gtkEnableEventSounds gtkEnableInputFeedbackSounds gtkEnableMnemonics gtkEnablePrimaryPaste gtkEnableTooltips gtkEntryPasswordHintTimeout gtkEntrySelectOnFocus gtkErrorBell gtkFallbackIconTheme gtkFileChooserBackend gtkFontconfigTimestamp gtkFontName gtkIconSizes gtkIconThemeName gtkImModule gtkImPreeditStyle gtkImStatusStyle gtkKeynavCursorOnly gtkKeynavUseCaret gtkKeynavWrapAround gtkKeyThemeName gtkLabelSelectOnFocus gtkLongPressTime gtkMenuBarAccel gtkMenuBarPopupDelay gtkMenuImages gtkMenuPopdownDelay gtkMenuPopupDelay gtkModules gtkOverlayScrolling gtkPrimaryButtonWarpsSlider gtkPrintBackends gtkPrintPreviewCommand gtkRecentFilesEnabled gtkRecentFilesLimit gtkRecentFilesMaxAge gtkScrolledWindowPlacement gtkShellShowsAppMenu gtkShellShowsDesktop gtkShellShowsMenubar gtkShowInputMethodMenu gtkShowUnicodeMenu gtkSoundThemeName gtkSplitCursor gtkThemeName gtkTimeoutExpand gtkTimeoutInitial gtkTimeoutRepeat gtkTitlebarDoubleClick gtkTitlebarMiddleClick gtkTitlebarRightClick gtkToolbarIconSize gtkToolbarStyle gtkTooltipBrowseModeTimeout gtkTooltipBrowseTimeout gtkTooltipTimeout gtkTouchscreenMode gtkVisibleFocus gtkXftAntialias gtkXftDpi gtkXftHinting gtkXftHintstyle gtkXftRgba

Methods

Methods - Inherited from GObject

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Gtk.Settings>

Accessors

  • get gtk_alternative_sort_arrows(): boolean

    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.

    Returns boolean

    2.12

  • set gtk_alternative_sort_arrows(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_application_prefer_dark_theme(): boolean

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

    Returns boolean

    3.0

  • set gtk_application_prefer_dark_theme(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_auto_mnemonics(): boolean

    Whether mnemonics should be automatically shown and hidden when the user presses the mnemonic activator.

    Returns boolean

    2.20

    since 3.10: This setting is ignored

  • set gtk_auto_mnemonics(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_can_change_accels(): boolean

    Whether menu accelerators can be changed by pressing a key over the menu item.

    Returns boolean

    since 3.10: This setting is ignored.

  • set gtk_can_change_accels(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_color_palette(): string

    Palette to use in the deprecated color selector.

    Returns string

    since 3.10: Only used by the deprecated color selector widget.

  • set gtk_color_palette(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_color_scheme(): string

    A palette of named colors for use in themes. The format of the string is

    name1: color1
    name2: color2
    ...

    Color names must be acceptable as identifiers in the [gtkrc][gtk3-Resource-Files] syntax, and color specifications must be in the format accepted by gdk_color_parse().

    Note that due to the way the color tables from different sources are merged, color specifications will be converted to hexadecimal form when getting this property.

    Starting with GTK+ 2.12, the entries can alternatively be separated by ';' instead of newlines:

    name1: color1; name2: color2; ...
    

    Returns string

    2.10

    since 3.8: Color scheme support was dropped and is no longer supported. You can still set this property, but it will be ignored.

  • set gtk_color_scheme(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_decoration_layout(): string

    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 Gtk.HeaderBar.decoration_layout property.

    Returns string

    3.12

  • set gtk_decoration_layout(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_dialogs_use_header(): boolean

    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.

    Returns boolean

    3.12

  • set gtk_dialogs_use_header(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_accels(): boolean

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

    Returns boolean

    2.12

  • set gtk_enable_accels(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_event_sounds(): boolean

    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.

    Returns boolean

    2.14

  • set gtk_enable_event_sounds(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_input_feedback_sounds(): boolean

    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.

    Returns boolean

    2.14

  • set gtk_enable_input_feedback_sounds(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_mnemonics(): boolean

    Whether labels and menu items should have visible mnemonics which can be activated.

    Returns boolean

    2.12

    since 3.10: This setting can still be used for application overrides, but will be ignored in the future

  • set gtk_enable_mnemonics(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_primary_paste(): boolean

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

    Returns boolean

    3.4

  • set gtk_enable_primary_paste(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_enable_tooltips(): boolean

    Whether tooltips should be shown on widgets.

    Returns boolean

    2.14

    since 3.10: This setting is ignored.

  • set gtk_enable_tooltips(val: boolean): void

    Parameters

    • val: boolean

    Returns void

Since 2.10gtk_entry_password_hint_timeout

  • get gtk_entry_password_hint_timeout(): number

    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.

    Returns number

    2.10

  • set gtk_entry_password_hint_timeout(val: number): void

    Parameters

    • val: number

    Returns void

gtk_entry_select_on_focus

  • get gtk_error_bell(): boolean

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

    Returns boolean

    2.12

  • set gtk_error_bell(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_fallback_icon_theme(): string

    Name of a icon theme to fall back to.

    Returns string

    since 3.10: This setting is ignored.

  • set gtk_fallback_icon_theme(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_file_chooser_backend(): string

    Name of the GtkFileChooser backend to use by default.

    Returns string

    since 3.10: This setting is ignored. Gtk.FileChooser uses GIO by default.

  • set gtk_file_chooser_backend(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_icon_sizes(): string

    A list of icon sizes. The list is separated by colons, and item has the form:

    size-name = width , height

    E.g. "gtk-menu=16,16:gtk-button=20,20:gtk-dialog=48,48". GTK+ itself use the following named icon sizes: gtk-menu, gtk-button, gtk-small-toolbar, gtk-large-toolbar, gtk-dnd, gtk-dialog. Applications can register their own named icon sizes with gtk_icon_size_register().

    Returns string

    since 3.10: This setting is ignored.

  • set gtk_icon_sizes(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_im_module(): string

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

    Returns string

  • set gtk_im_module(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_keynav_cursor_only(): boolean

    When true, keyboard navigation should be able to reach all widgets by using the cursor keys only. Tab, Shift etc. keys can't be expected to be present on the used input device.

    Returns boolean

    2.12

    since 3.10: Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device().

  • set gtk_keynav_cursor_only(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_keynav_use_caret(): boolean

    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.

    Returns boolean

    3.20

  • set gtk_keynav_use_caret(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_keynav_wrap_around(): boolean

    When true, some widgets will wrap around when doing keyboard navigation, such as menus, menubars and notebooks.

    Returns boolean

    2.12

    since 3.10: This setting is ignored.

  • set gtk_keynav_wrap_around(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_long_press_time(): number

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

    Returns number

    3.14

  • set gtk_long_press_time(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_menu_bar_accel(): string

    Keybinding to activate the menu bar.

    Returns string

    since 3.10: This setting can still be used for application overrides, but will be ignored in the future

  • set gtk_menu_bar_accel(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_menu_bar_popup_delay(): number

    Delay before the submenus of a menu bar appear.

    Returns number

    since 3.10: This setting is ignored.

  • set gtk_menu_bar_popup_delay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_menu_popdown_delay(): number

    The time before hiding a submenu when the pointer is moving towards the submenu.

    Returns number

    since 3.10: This setting is ignored.

  • set gtk_menu_popdown_delay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_menu_popup_delay(): number

    Minimum time the pointer must stay over a menu item before the submenu appear.

    Returns number

    since 3.10: This setting is ignored.

  • set gtk_menu_popup_delay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_overlay_scrolling(): boolean

    Whether scrolled windows may use overlayed scrolling indicators. If this is set to false, scrolled windows will have permanent scrollbars.

    Returns boolean

    3.24.9

  • set gtk_overlay_scrolling(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_primary_button_warps_slider(): boolean

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

    Returns boolean

    3.6

  • set gtk_primary_button_warps_slider(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_print_backends(): string

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

    Returns string

    2.10

  • set gtk_print_backends(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_print_preview_command(): string

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

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

    Returns string

    2.10

  • set gtk_print_preview_command(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_recent_files_enabled(): boolean

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

    Returns boolean

    3.8

  • set gtk_recent_files_enabled(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtk_recent_files_limit(): number

    The number of recently used files that should be displayed by default by Gtk.RecentChooser implementations and by the Gtk.FileChooser. A value of -1 means every recently used file stored.

    Returns number

    2.12

    since 3.10: This setting is ignored

  • set gtk_recent_files_limit(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_recent_files_max_age(): number

    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.

    Returns number

    2.14

  • set gtk_recent_files_max_age(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_sound_theme_name(): string

    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.

    Returns string

    2.14

  • set gtk_sound_theme_name(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_titlebar_double_click(): string

    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.

    Returns string

    3.14

  • set gtk_titlebar_double_click(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_titlebar_middle_click(): string

    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.

    Returns string

    3.14

  • set gtk_titlebar_middle_click(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_titlebar_right_click(): string

    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.

    Returns string

    3.14

  • set gtk_titlebar_right_click(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtk_tooltip_browse_timeout(): number

    Controls the time after which tooltips will appear when browse mode is enabled, in milliseconds.

    Browse mode is enabled when the mouse pointer moves off an object where a tooltip was currently being displayed. If the mouse pointer hits another object before the browse mode timeout expires (see Gtk.Settings.gtk_tooltip_browse_mode_timeout), it will take the amount of milliseconds specified by this setting to popup the tooltip for the new object.

    Returns number

    2.12

    since 3.10: This setting is ignored.

  • set gtk_tooltip_browse_timeout(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_tooltip_timeout(): number

    Time, in milliseconds, after which a tooltip could appear if the cursor is hovering on top of a widget.

    Returns number

    2.12

    since 3.10: This setting is ignored.

  • set gtk_tooltip_timeout(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtk_touchscreen_mode(): boolean

    When true, there are no motion notify events delivered on this screen, and widgets can't use the pointer hovering them for any essential functionality.

    Returns boolean

    2.10

    since 3.4.: Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device().

  • set gtk_touchscreen_mode(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkAlternativeSortArrows(): boolean

    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.

    Returns boolean

    2.12

  • set gtkAlternativeSortArrows(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkApplicationPreferDarkTheme(): boolean

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

    Returns boolean

    3.0

  • set gtkApplicationPreferDarkTheme(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkAutoMnemonics(): boolean

    Whether mnemonics should be automatically shown and hidden when the user presses the mnemonic activator.

    Returns boolean

    2.20

    since 3.10: This setting is ignored

  • set gtkAutoMnemonics(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkCanChangeAccels(): boolean

    Whether menu accelerators can be changed by pressing a key over the menu item.

    Returns boolean

    since 3.10: This setting is ignored.

  • set gtkCanChangeAccels(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkColorPalette(): string

    Palette to use in the deprecated color selector.

    Returns string

    since 3.10: Only used by the deprecated color selector widget.

  • set gtkColorPalette(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkColorScheme(): string

    A palette of named colors for use in themes. The format of the string is

    name1: color1
    name2: color2
    ...

    Color names must be acceptable as identifiers in the [gtkrc][gtk3-Resource-Files] syntax, and color specifications must be in the format accepted by gdk_color_parse().

    Note that due to the way the color tables from different sources are merged, color specifications will be converted to hexadecimal form when getting this property.

    Starting with GTK+ 2.12, the entries can alternatively be separated by ';' instead of newlines:

    name1: color1; name2: color2; ...
    

    Returns string

    2.10

    since 3.8: Color scheme support was dropped and is no longer supported. You can still set this property, but it will be ignored.

  • set gtkColorScheme(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkDecorationLayout(): string

    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 Gtk.HeaderBar.decoration_layout property.

    Returns string

    3.12

  • set gtkDecorationLayout(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkDialogsUseHeader(): boolean

    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.

    Returns boolean

    3.12

  • set gtkDialogsUseHeader(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnableAccels(): boolean

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

    Returns boolean

    2.12

  • set gtkEnableAccels(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnableEventSounds(): boolean

    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.

    Returns boolean

    2.14

  • set gtkEnableEventSounds(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnableInputFeedbackSounds(): boolean

    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.

    Returns boolean

    2.14

  • set gtkEnableInputFeedbackSounds(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnableMnemonics(): boolean

    Whether labels and menu items should have visible mnemonics which can be activated.

    Returns boolean

    2.12

    since 3.10: This setting can still be used for application overrides, but will be ignored in the future

  • set gtkEnableMnemonics(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnablePrimaryPaste(): boolean

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

    Returns boolean

    3.4

  • set gtkEnablePrimaryPaste(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEnableTooltips(): boolean

    Whether tooltips should be shown on widgets.

    Returns boolean

    2.14

    since 3.10: This setting is ignored.

  • set gtkEnableTooltips(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkEntryPasswordHintTimeout(): number

    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.

    Returns number

    2.10

  • set gtkEntryPasswordHintTimeout(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkErrorBell(): boolean

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

    Returns boolean

    2.12

  • set gtkErrorBell(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkFallbackIconTheme(): string

    Name of a icon theme to fall back to.

    Returns string

    since 3.10: This setting is ignored.

  • set gtkFallbackIconTheme(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkIconSizes(): string

    A list of icon sizes. The list is separated by colons, and item has the form:

    size-name = width , height

    E.g. "gtk-menu=16,16:gtk-button=20,20:gtk-dialog=48,48". GTK+ itself use the following named icon sizes: gtk-menu, gtk-button, gtk-small-toolbar, gtk-large-toolbar, gtk-dnd, gtk-dialog. Applications can register their own named icon sizes with gtk_icon_size_register().

    Returns string

    since 3.10: This setting is ignored.

  • set gtkIconSizes(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkImModule(): string

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

    Returns string

  • set gtkImModule(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkKeynavCursorOnly(): boolean

    When true, keyboard navigation should be able to reach all widgets by using the cursor keys only. Tab, Shift etc. keys can't be expected to be present on the used input device.

    Returns boolean

    2.12

    since 3.10: Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device().

  • set gtkKeynavCursorOnly(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkKeynavUseCaret(): boolean

    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.

    Returns boolean

    3.20

  • set gtkKeynavUseCaret(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkKeynavWrapAround(): boolean

    When true, some widgets will wrap around when doing keyboard navigation, such as menus, menubars and notebooks.

    Returns boolean

    2.12

    since 3.10: This setting is ignored.

  • set gtkKeynavWrapAround(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkLongPressTime(): number

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

    Returns number

    3.14

  • set gtkLongPressTime(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkMenuBarAccel(): string

    Keybinding to activate the menu bar.

    Returns string

    since 3.10: This setting can still be used for application overrides, but will be ignored in the future

  • set gtkMenuBarAccel(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkMenuBarPopupDelay(): number

    Delay before the submenus of a menu bar appear.

    Returns number

    since 3.10: This setting is ignored.

  • set gtkMenuBarPopupDelay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkMenuPopdownDelay(): number

    The time before hiding a submenu when the pointer is moving towards the submenu.

    Returns number

    since 3.10: This setting is ignored.

  • set gtkMenuPopdownDelay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkMenuPopupDelay(): number

    Minimum time the pointer must stay over a menu item before the submenu appear.

    Returns number

    since 3.10: This setting is ignored.

  • set gtkMenuPopupDelay(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkOverlayScrolling(): boolean

    Whether scrolled windows may use overlayed scrolling indicators. If this is set to false, scrolled windows will have permanent scrollbars.

    Returns boolean

    3.24.9

  • set gtkOverlayScrolling(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkPrimaryButtonWarpsSlider(): boolean

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

    Returns boolean

    3.6

  • set gtkPrimaryButtonWarpsSlider(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkPrintBackends(): string

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

    Returns string

    2.10

  • set gtkPrintBackends(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkPrintPreviewCommand(): string

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

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

    Returns string

    2.10

  • set gtkPrintPreviewCommand(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkRecentFilesEnabled(): boolean

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

    Returns boolean

    3.8

  • set gtkRecentFilesEnabled(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get gtkRecentFilesLimit(): number

    The number of recently used files that should be displayed by default by Gtk.RecentChooser implementations and by the Gtk.FileChooser. A value of -1 means every recently used file stored.

    Returns number

    2.12

    since 3.10: This setting is ignored

  • set gtkRecentFilesLimit(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkRecentFilesMaxAge(): number

    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.

    Returns number

    2.14

  • set gtkRecentFilesMaxAge(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkSoundThemeName(): string

    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.

    Returns string

    2.14

  • set gtkSoundThemeName(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkTitlebarDoubleClick(): string

    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.

    Returns string

    3.14

  • set gtkTitlebarDoubleClick(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkTitlebarMiddleClick(): string

    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.

    Returns string

    3.14

  • set gtkTitlebarMiddleClick(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkTitlebarRightClick(): string

    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.

    Returns string

    3.14

  • set gtkTitlebarRightClick(val: string): void

    Parameters

    • val: string

    Returns void

  • get gtkTooltipBrowseTimeout(): number

    Controls the time after which tooltips will appear when browse mode is enabled, in milliseconds.

    Browse mode is enabled when the mouse pointer moves off an object where a tooltip was currently being displayed. If the mouse pointer hits another object before the browse mode timeout expires (see Gtk.Settings.gtk_tooltip_browse_mode_timeout), it will take the amount of milliseconds specified by this setting to popup the tooltip for the new object.

    Returns number

    2.12

    since 3.10: This setting is ignored.

  • set gtkTooltipBrowseTimeout(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkTooltipTimeout(): number

    Time, in milliseconds, after which a tooltip could appear if the cursor is hovering on top of a widget.

    Returns number

    2.12

    since 3.10: This setting is ignored.

  • set gtkTooltipTimeout(val: number): void

    Parameters

    • val: number

    Returns void

  • get gtkTouchscreenMode(): boolean

    When true, there are no motion notify events delivered on this screen, and widgets can't use the pointer hovering them for any essential functionality.

    Returns boolean

    2.10

    since 3.4.: Generally, the behavior for touchscreen input should be performed dynamically based on gdk_event_get_source_device().

  • set gtkTouchscreenMode(val: boolean): void

    Parameters

    • val: boolean

    Returns void

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • 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: string

      the name of the setting to reset

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Parameters

    • name: string
    • v_double: number
    • origin: string

    Returns void

  • Parameters

    • name: string
    • v_long: number
    • origin: string

    Returns void

  • Parameters

    • name: string
    • v_string: string
    • origin: string

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Methods - Inherited from GObject

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures