Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

color_hash: HashTable<string | number | symbol, string | number | boolean>

Holds a hash table representation of the #GtkSettings:gtk-color-scheme setting, mapping color names to #GdkColors.

g_type_instance: TypeInstance
gtk_alternative_button_order: boolean
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.

gtk_auto_mnemonics: boolean

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

gtk_button_images: boolean
gtk_can_change_accels: boolean
gtk_color_palette: string
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 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; ...

gtk_cursor_blink: boolean

Whether the cursor should blink.

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

gtk_cursor_blink_time: number
gtk_cursor_blink_timeout: number

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 #GtkSettings:gtk-cursor-blink to %FALSE.

gtk_cursor_theme_name: string
gtk_cursor_theme_size: number
gtk_dnd_drag_threshold: number
gtk_double_click_distance: number
gtk_double_click_time: number
gtk_enable_accels: boolean

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

gtk_enable_animations: boolean
gtk_enable_event_sounds: boolean

Whether to play any event sounds at all.

See the Sound Theme spec for more information on event sounds and sound themes.

GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.

gtk_enable_input_feedback_sounds: boolean

Whether to play event sounds as feedback to user input.

See the Sound Theme spec for more information on event sounds and sound themes.

GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.

gtk_enable_mnemonics: boolean

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

gtk_enable_tooltips: boolean

Whether tooltips should be shown on widgets.

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.

gtk_entry_select_on_focus: boolean
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.

gtk_fallback_icon_theme: string
gtk_file_chooser_backend: string
gtk_font_name: string
gtk_fontconfig_timestamp: number
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().

gtk_icon_theme_name: string
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 #GtkIMContext and see the #GtkSettings:gtk-show-input-method-menu property.

gtk_im_preedit_style: Gtk.IMPreeditStyle
gtk_im_status_style: Gtk.IMStatusStyle
gtk_key_theme_name: string
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.

gtk_keynav_wrap_around: boolean

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

gtk_label_select_on_focus: boolean
gtk_menu_bar_accel: string
gtk_menu_bar_popup_delay: number
gtk_menu_images: boolean
gtk_menu_popdown_delay: number
gtk_menu_popup_delay: number
gtk_modules: string
gtk_primary_button_warps_slider: boolean

Whether a click in a #GtkRange trough should scroll to the click position or scroll by a single page in the respective direction.

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

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.

gtk_recent_files_limit: number

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

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.

gtk_scrolled_window_placement: Gtk.CornerType

Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement.

gtk_show_input_method_menu: boolean
gtk_show_unicode_menu: boolean
gtk_sound_theme_name: string

The XDG sound theme to use for event sounds.

See the Sound Theme spec for more information on event sounds and sound themes.

GTK+ itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.

gtk_split_cursor: boolean
gtk_theme_name: string
gtk_timeout_expand: number
gtk_timeout_initial: number
gtk_timeout_repeat: number
gtk_toolbar_icon_size: Gtk.IconSize
gtk_toolbar_style: Gtk.ToolbarStyle
gtk_tooltip_browse_mode_timeout: number

Amount of time, in milliseconds, after which the browse mode will be disabled.

See #GtkSettings:gtk-tooltip-browse-timeout for more information about browse mode.

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 #GtkSettings:gtk-tooltip-browse-mode-timeout), it will take the amount of milliseconds specified by this setting to popup the tooltip for the new object.

gtk_tooltip_timeout: number

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

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.

gtk_xft_antialias: number
gtk_xft_dpi: number
gtk_xft_hinting: number
gtk_xft_hintstyle: string
gtk_xft_rgba: string
parent_instance: GObject.Object
property_values: SettingsPropertyValue
queued_settings: GLib.Data
rc_context: Gtk.RcContext
screen: Gdk.Screen
$gtype: GType<Gtk.Settings>
name: string

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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: "notify::color-hash", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-alternative-button-order", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-alternative-sort-arrows", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-auto-mnemonics", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-button-images", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-can-change-accels", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-color-palette", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-color-scheme", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-cursor-blink", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-cursor-blink-time", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-cursor-blink-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-cursor-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-cursor-theme-size", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-dnd-drag-threshold", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-double-click-distance", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-double-click-time", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-accels", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-animations", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-event-sounds", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-input-feedback-sounds", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-mnemonics", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-enable-tooltips", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-entry-password-hint-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-entry-select-on-focus", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-error-bell", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-fallback-icon-theme", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-file-chooser-backend", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-font-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-fontconfig-timestamp", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-icon-sizes", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-icon-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-im-module", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-im-preedit-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-im-status-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-key-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-keynav-cursor-only", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-keynav-wrap-around", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-label-select-on-focus", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-menu-bar-accel", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-menu-bar-popup-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-menu-images", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-menu-popdown-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-menu-popup-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-modules", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-primary-button-warps-slider", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-print-backends", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-print-preview-command", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-recent-files-limit", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-recent-files-max-age", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-scrolled-window-placement", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-show-input-method-menu", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-show-unicode-menu", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-sound-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-split-cursor", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-timeout-expand", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-timeout-initial", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-timeout-repeat", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-toolbar-icon-size", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-toolbar-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-tooltip-browse-mode-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-tooltip-browse-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-tooltip-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-touchscreen-mode", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-xft-antialias", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-xft-dpi", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-xft-hinting", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-xft-hintstyle", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::gtk-xft-rgba", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::color-hash", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-alternative-button-order", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-alternative-sort-arrows", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-auto-mnemonics", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-button-images", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-can-change-accels", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-color-palette", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-color-scheme", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-cursor-blink", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-cursor-blink-time", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-cursor-blink-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-cursor-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-cursor-theme-size", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-dnd-drag-threshold", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-double-click-distance", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-double-click-time", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-accels", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-animations", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-event-sounds", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-input-feedback-sounds", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-mnemonics", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-enable-tooltips", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-entry-password-hint-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-entry-select-on-focus", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-error-bell", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-fallback-icon-theme", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-file-chooser-backend", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-font-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-fontconfig-timestamp", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-icon-sizes", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-icon-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-im-module", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-im-preedit-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-im-status-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-key-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-keynav-cursor-only", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-keynav-wrap-around", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-label-select-on-focus", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-menu-bar-accel", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-menu-bar-popup-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-menu-images", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-menu-popdown-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-menu-popup-delay", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-modules", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-primary-button-warps-slider", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-print-backends", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-print-preview-command", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-recent-files-limit", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-recent-files-max-age", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-scrolled-window-placement", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-show-input-method-menu", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-show-unicode-menu", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-sound-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-split-cursor", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-theme-name", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-timeout-expand", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-timeout-initial", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-timeout-repeat", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-toolbar-icon-size", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-toolbar-style", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-tooltip-browse-mode-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-tooltip-browse-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-tooltip-timeout", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-touchscreen-mode", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-xft-antialias", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-xft-dpi", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-xft-hinting", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-xft-hintstyle", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::gtk-xft-rgba", callback: (($obj: Gtk.Settings, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • emit(sigName: "notify::color-hash", ...args: any[]): void
  • emit(sigName: "notify::gtk-alternative-button-order", ...args: any[]): void
  • emit(sigName: "notify::gtk-alternative-sort-arrows", ...args: any[]): void
  • emit(sigName: "notify::gtk-auto-mnemonics", ...args: any[]): void
  • emit(sigName: "notify::gtk-button-images", ...args: any[]): void
  • emit(sigName: "notify::gtk-can-change-accels", ...args: any[]): void
  • emit(sigName: "notify::gtk-color-palette", ...args: any[]): void
  • emit(sigName: "notify::gtk-color-scheme", ...args: any[]): void
  • emit(sigName: "notify::gtk-cursor-blink", ...args: any[]): void
  • emit(sigName: "notify::gtk-cursor-blink-time", ...args: any[]): void
  • emit(sigName: "notify::gtk-cursor-blink-timeout", ...args: any[]): void
  • emit(sigName: "notify::gtk-cursor-theme-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-cursor-theme-size", ...args: any[]): void
  • emit(sigName: "notify::gtk-dnd-drag-threshold", ...args: any[]): void
  • emit(sigName: "notify::gtk-double-click-distance", ...args: any[]): void
  • emit(sigName: "notify::gtk-double-click-time", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-accels", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-animations", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-event-sounds", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-input-feedback-sounds", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-mnemonics", ...args: any[]): void
  • emit(sigName: "notify::gtk-enable-tooltips", ...args: any[]): void
  • emit(sigName: "notify::gtk-entry-password-hint-timeout", ...args: any[]): void
  • emit(sigName: "notify::gtk-entry-select-on-focus", ...args: any[]): void
  • emit(sigName: "notify::gtk-error-bell", ...args: any[]): void
  • emit(sigName: "notify::gtk-fallback-icon-theme", ...args: any[]): void
  • emit(sigName: "notify::gtk-file-chooser-backend", ...args: any[]): void
  • emit(sigName: "notify::gtk-font-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-fontconfig-timestamp", ...args: any[]): void
  • emit(sigName: "notify::gtk-icon-sizes", ...args: any[]): void
  • emit(sigName: "notify::gtk-icon-theme-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-im-module", ...args: any[]): void
  • emit(sigName: "notify::gtk-im-preedit-style", ...args: any[]): void
  • emit(sigName: "notify::gtk-im-status-style", ...args: any[]): void
  • emit(sigName: "notify::gtk-key-theme-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-keynav-cursor-only", ...args: any[]): void
  • emit(sigName: "notify::gtk-keynav-wrap-around", ...args: any[]): void
  • emit(sigName: "notify::gtk-label-select-on-focus", ...args: any[]): void
  • emit(sigName: "notify::gtk-menu-bar-accel", ...args: any[]): void
  • emit(sigName: "notify::gtk-menu-bar-popup-delay", ...args: any[]): void
  • emit(sigName: "notify::gtk-menu-images", ...args: any[]): void
  • emit(sigName: "notify::gtk-menu-popdown-delay", ...args: any[]): void
  • emit(sigName: "notify::gtk-menu-popup-delay", ...args: any[]): void
  • emit(sigName: "notify::gtk-modules", ...args: any[]): void
  • emit(sigName: "notify::gtk-primary-button-warps-slider", ...args: any[]): void
  • emit(sigName: "notify::gtk-print-backends", ...args: any[]): void
  • emit(sigName: "notify::gtk-print-preview-command", ...args: any[]): void
  • emit(sigName: "notify::gtk-recent-files-limit", ...args: any[]): void
  • emit(sigName: "notify::gtk-recent-files-max-age", ...args: any[]): void
  • emit(sigName: "notify::gtk-scrolled-window-placement", ...args: any[]): void
  • emit(sigName: "notify::gtk-show-input-method-menu", ...args: any[]): void
  • emit(sigName: "notify::gtk-show-unicode-menu", ...args: any[]): void
  • emit(sigName: "notify::gtk-sound-theme-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-split-cursor", ...args: any[]): void
  • emit(sigName: "notify::gtk-theme-name", ...args: any[]): void
  • emit(sigName: "notify::gtk-timeout-expand", ...args: any[]): void
  • emit(sigName: "notify::gtk-timeout-initial", ...args: any[]): void
  • emit(sigName: "notify::gtk-timeout-repeat", ...args: any[]): void
  • emit(sigName: "notify::gtk-toolbar-icon-size", ...args: any[]): void
  • emit(sigName: "notify::gtk-toolbar-style", ...args: any[]): void
  • emit(sigName: "notify::gtk-tooltip-browse-mode-timeout", ...args: any[]): void
  • emit(sigName: "notify::gtk-tooltip-browse-timeout", ...args: any[]): void
  • emit(sigName: "notify::gtk-tooltip-timeout", ...args: any[]): void
  • emit(sigName: "notify::gtk-touchscreen-mode", ...args: any[]): void
  • emit(sigName: "notify::gtk-xft-antialias", ...args: any[]): void
  • emit(sigName: "notify::gtk-xft-dpi", ...args: any[]): void
  • emit(sigName: "notify::gtk-xft-hinting", ...args: any[]): void
  • emit(sigName: "notify::gtk-xft-hintstyle", ...args: any[]): void
  • emit(sigName: "notify::gtk-xft-rgba", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): 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::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

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • getv(names: string[], values: any[]): void
  • 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

  • is_floating(): boolean
  • notify(property_name: string): 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    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

  • 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

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • set_data(key: string, data?: object): 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_double_property(name: string, v_double: number, origin: string): void
  • set_long_property(name: string, v_long: number, origin: string): void
  • set_property(property_name: string, value?: any): void
  • set_string_property(name: string, v_string: string, origin: string): void
  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • thaw_notify(): void
  • 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::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

  • unref(): 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 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 instance. Use g_clear_object() for this.

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): 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

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method