Gjsify LogoGjsify Logo

A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode.

If your application needs multiple sections, you should give each section a unique [propertyGtk.ShortcutsSection:section-name] and a [propertyGtk.ShortcutsSection:title] that can be shown in the section selector of the [classGtk.ShortcutsWindow].

The [propertyGtk.ShortcutsSection:max-height] property can be used to influence how the groups in the section are distributed over pages and columns.

This widget is only meant to be used with [classGtk.ShortcutsWindow].

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

accessible_role: AccessibleRole

The accessible role of the given GtkAccessible implementation.

The accessible role cannot be changed once set.

baseline_position: Gtk.BaselinePosition

The position of the baseline aligned widgets if extra space is available.

can_focus: boolean

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

can_target: boolean

Whether the widget can receive pointer events.

css_classes: string[]

A list of css classes applied to this widget.

css_name: string

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

cursor: Gdk.Cursor

The cursor used by widget.

focus_on_click: boolean

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

focusable: boolean

Whether this widget itself will accept the input focus.

g_type_instance: TypeInstance
halign: Gtk.Align

How to distribute horizontal space if widget gets extra space.

has_default: boolean

Whether the widget is the default widget.

has_focus: boolean

Whether the widget has the input focus.

has_tooltip: boolean

Enables or disables the emission of the ::query-tooltip signal on widget.

A value of %TRUE indicates that widget can have a tooltip, in this case the widget will be queried using [signalGtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

height_request: number

Override for height request of the widget.

If this is -1, the natural request will be used.

hexpand: boolean

Whether to expand horizontally.

hexpand_set: boolean

Whether to use the hexpand property.

homogeneous: boolean

Whether the children should all be the same size.

layout_manager: Gtk.LayoutManager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

margin_bottom: number

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_end: number

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_start: number

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_top: number

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

max_height: number

The maximum number of lines to allow per column.

This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.

name: string

The name of the widget.

opacity: number

The requested opacity of the widget.

orientation: Gtk.Orientation

The orientation of the orientable.

overflow: Overflow

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

parent: Gtk.Widget

The parent widget of this widget.

parent_instance: any
receives_default: boolean

Whether the widget will receive the default action when it is focused.

root: Gtk.Root

The GtkRoot widget of the widget tree containing this widget.

This will be %NULL if the widget is not contained in a root widget.

scale_factor: number

The scale factor of the widget.

section_name: string

A unique name to identify this section among the sections added to the GtkShortcutsWindow.

Setting the [propertyGtk.ShortcutsWindow:section-name] property to this string will make this section shown in the GtkShortcutsWindow.

sensitive: boolean

Whether the widget responds to input.

spacing: number

The amount of space between children.

title: string

The string to show in the section selector of the GtkShortcutsWindow for this section.

If there is only one section, you don't need to set a title, since the section selector will not be shown in this case.

tooltip_markup: string

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [methodGtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

tooltip_text: string

Sets the text of tooltip to be the given string.

Also see [methodGtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

valign: Gtk.Align

How to distribute vertical space if widget gets extra space.

vexpand: boolean

Whether to expand vertically.

vexpand_set: boolean

Whether to use the vexpand property.

view_name: string

A view name to filter the groups in this section by.

See [propertyGtk.ShortcutsGroup:view].

Applications are expected to use the [propertyGtk.ShortcutsWindow:view-name] property for this purpose.

visible: boolean

Whether the widget is visible.

width_request: number

Override for width request of the widget.

If this is -1, the natural request will be used.

name: string

Methods

  • action_set_enabled(action_name: string, enabled: boolean): void
  • Enable or disable an action installed with gtk_widget_class_install_action().

    Parameters

    • action_name: string

      action name, such as "clipboard.paste"

    • enabled: boolean

      whether the action is now enabled

    Returns void

  • activate(): boolean
  • For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

    The activation will emit the signal set using [methodGtk.WidgetClass.set_activate_signal] during class initialization.

    Activation is what happens when you press Enter on a widget during key navigation.

    If you wish to handle the activation keybinding yourself, it is recommended to use [methodGtk.WidgetClass.add_shortcut] with an action created with [ctorGtk.SignalAction.new].

    If widget isn't activatable, the function returns %FALSE.

    Returns boolean

  • activate_action(name: string, args: GLib.Variant): boolean
  • Looks up the action in the action groups associated with widget and its ancestors, and activates it.

    If the action is in an action group added with [methodGtk.Widget.insert_action_group], the name is expected to be prefixed with the prefix that was used when the group was inserted.

    The arguments must match the actions expected parameter type, as returned by g_action_get_parameter_type().

    Parameters

    • name: string

      the name of the action to activate

    • args: GLib.Variant

      parameters to use

    Returns boolean

  • activate_default(): void
  • Adds controller to widget so that it will receive events.

    You will usually want to call this function right after creating any kind of [classGtk.EventController].

    Parameters

    • controller: Gtk.EventController

      a GtkEventController that hasn't been added to a widget yet

    Returns void

  • add_css_class(css_class: string): void
  • Adds a style class to widget.

    After calling this function, the widgets style will match for css_class, according to CSS matching rules.

    Use [methodGtk.Widget.remove_css_class] to remove the style again.

    Parameters

    • css_class: string

      The style class to add to widget, without the leading '.' used for notation of style classes

    Returns void

  • Adds a widget to the list of mnemonic labels for this widget.

    See [methodGtk.Widget.list_mnemonic_labels]. Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well.

    Parameters

    • label: Gtk.Widget

      a GtkWidget that acts as a mnemonic label for widget

    Returns void

  • Queues an animation frame update and adds a callback to be called before each frame.

    Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a GtkLabel), then you will have to call [methodGtk.Widget.queue_resize] or [methodGtk.Widget.queue_draw] yourself.

    [methodGdk.FrameClock.get_frame_time] should generally be used for timing continuous animations and [methodGdk.FrameTimings.get_predicted_presentation_time] if you are trying to display isolated frames at particular times.

    This is a more convenient alternative to connecting directly to the [signalGdk.FrameClock::update] signal of GdkFrameClock, since you don't have to worry about when a GdkFrameClock is assigned to a widget.

    Parameters

    Returns number

  • allocate(width: number, height: number, baseline: number, transform: Gsk.Transform): void
  • This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

    In this function, the allocation and baseline may be adjusted. The given allocation will be forced to be bigger than the widget's minimum size, as well as at least 0×0 in size.

    For a version that does not take a transform, see [methodGtk.Widget.size_allocate].

    Parameters

    • width: number

      New width of widget

    • height: number

      New height of widget

    • baseline: number

      New baseline of widget, or -1

    • transform: Gsk.Transform

      Transformation to be applied to widget

    Returns void

  • 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

  • Called by widgets as the user moves around the window using keyboard shortcuts.

    The direction argument indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward).

    This function calls the [vfuncGtk.Widget.focus] virtual function; widgets can override the virtual function in order to implement appropriate focus behavior.

    The default focus() virtual function for a widget should return TRUE if moving in direction left the focus on a focusable location inside that widget, and FALSE if moving in direction moved the focus outside the widget. When returning TRUE, widgets normallycall [methodGtk.Widget.grab_focus] to place the focus accordingly; when returning FALSE, they don’t modify the current focus location.

    This function is used by custom widget implementations; if you're writing an app, you’d use [methodGtk.Widget.grab_focus] to move the focus to a particular widget.

    Parameters

    Returns boolean

  • Computes the bounds for widget in the coordinate space of target.

    FIXME: Explain what "bounds" are.

    If the operation is successful, %TRUE is returned. If widget has no bounds or the bounds cannot be expressed in target's coordinate space (for example if both widgets are in different windows), %FALSE is returned and bounds is set to the zero rectangle.

    It is valid for widget and target to be the same widget.

    Parameters

    Returns [boolean, Graphene.Rect]

  • Computes whether a container should give this widget extra space when possible.

    Containers should check this, rather than looking at [methodGtk.Widget.get_hexpand] or [methodGtk.Widget.get_vexpand].

    This function already checks whether the widget is visible, so visibility does not need to be checked separately. Non-visible widgets are not expanded.

    The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do.

    Parameters

    Returns boolean

  • Translates the given point in widget's coordinates to coordinates relative to target’s coordinate system.

    In order to perform this operation, both widgets must share a common ancestor.

    Parameters

    • target: Gtk.Widget

      the GtkWidget to transform into

    • point: Graphene.Point

      a point in widget's coordinate system

    Returns [boolean, Graphene.Point]

  • Computes a matrix suitable to describe a transformation from widget's coordinate system into target's coordinate system.

    The transform can not be computed in certain cases, for example when widget and target do not share a common ancestor. In that case out_transform gets set to the identity matrix.

    Parameters

    • target: Gtk.Widget

      the target widget that the matrix will transform to

    Returns [boolean, Graphene.Matrix]

  • contains(x: number, y: number): boolean
  • Tests if the point at (x, y) is contained in widget.

    The coordinates for (x, y) must be in widget coordinates, so (0, 0) is assumed to be the top left of widget's content area.

    Parameters

    • x: number

      X coordinate to test, relative to widget's origin

    • y: number

      Y coordinate to test, relative to widget's origin

    Returns boolean

  • Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

    If you keep a PangoLayout created in this way around, you need to re-create it when the widget PangoContext is replaced. This can be tracked by listening to changes of the [propertyGtk.Widget:root] property on the widget.

    Parameters

    • text: string

      text to set on the layout

    Returns Pango.Layout

  • disconnect(id: number): void
  • drag_check_threshold(start_x: number, start_y: number, current_x: number, current_y: number): boolean
  • Checks to see if a drag movement has passed the GTK drag threshold.

    Parameters

    • start_x: number

      X coordinate of start of drag

    • start_y: number

      Y coordinate of start of drag

    • current_x: number

      current X coordinate

    • current_y: number

      current Y coordinate

    Returns boolean

  • emit(sigName: "change-current-page", object: number, ...args: any[]): void
  • emit(sigName: "notify::max-height", ...args: any[]): void
  • emit(sigName: "notify::section-name", ...args: any[]): void
  • emit(sigName: "notify::title", ...args: any[]): void
  • emit(sigName: "notify::view-name", ...args: any[]): void
  • emit(sigName: "notify::baseline-position", ...args: any[]): void
  • emit(sigName: "notify::homogeneous", ...args: any[]): void
  • emit(sigName: "notify::spacing", ...args: any[]): void
  • emit(sigName: "notify::can-focus", ...args: any[]): void
  • emit(sigName: "notify::can-target", ...args: any[]): void
  • emit(sigName: "notify::css-classes", ...args: any[]): void
  • emit(sigName: "notify::css-name", ...args: any[]): void
  • emit(sigName: "notify::cursor", ...args: any[]): void
  • emit(sigName: "notify::focus-on-click", ...args: any[]): void
  • emit(sigName: "notify::focusable", ...args: any[]): void
  • emit(sigName: "notify::halign", ...args: any[]): void
  • emit(sigName: "notify::has-default", ...args: any[]): void
  • emit(sigName: "notify::has-focus", ...args: any[]): void
  • emit(sigName: "notify::has-tooltip", ...args: any[]): void
  • emit(sigName: "notify::height-request", ...args: any[]): void
  • emit(sigName: "notify::hexpand", ...args: any[]): void
  • emit(sigName: "notify::hexpand-set", ...args: any[]): void
  • emit(sigName: "notify::layout-manager", ...args: any[]): void
  • emit(sigName: "notify::margin-bottom", ...args: any[]): void
  • emit(sigName: "notify::margin-end", ...args: any[]): void
  • emit(sigName: "notify::margin-start", ...args: any[]): void
  • emit(sigName: "notify::margin-top", ...args: any[]): void
  • emit(sigName: "notify::name", ...args: any[]): void
  • emit(sigName: "notify::opacity", ...args: any[]): void
  • emit(sigName: "notify::overflow", ...args: any[]): void
  • emit(sigName: "notify::parent", ...args: any[]): void
  • emit(sigName: "notify::receives-default", ...args: any[]): void
  • emit(sigName: "notify::root", ...args: any[]): void
  • emit(sigName: "notify::scale-factor", ...args: any[]): void
  • emit(sigName: "notify::sensitive", ...args: any[]): void
  • emit(sigName: "notify::tooltip-markup", ...args: any[]): void
  • emit(sigName: "notify::tooltip-text", ...args: any[]): void
  • emit(sigName: "notify::valign", ...args: any[]): void
  • emit(sigName: "notify::vexpand", ...args: any[]): void
  • emit(sigName: "notify::vexpand-set", ...args: any[]): void
  • emit(sigName: "notify::visible", ...args: any[]): void
  • emit(sigName: "notify::width-request", ...args: any[]): void
  • emit(sigName: "notify::accessible-role", ...args: any[]): void
  • emit(sigName: "notify::orientation", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • error_bell(): void
  • Notifies the user about an input-related error on this widget.

    If the [propertyGtk.Settings:gtk-error-bell] setting is %TRUE, it calls [methodGdk.Surface.beep], otherwise it does nothing.

    Note that the effect of [methodGdk.Surface.beep] can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.

    Returns 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_allocated_baseline(): number
  • Returns the baseline that has currently been allocated to widget.

    This function is intended to be used when implementing handlers for the GtkWidgetClass.snapshot() function, and when allocating child widgets in GtkWidgetClass.size_allocate().

    Returns number

  • get_allocated_height(): number
  • get_allocated_width(): number
  • Retrieves the widget’s allocation.

    Note, when implementing a layout container: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent typically calls [methodGtk.Widget.size_allocate] with an allocation, and that allocation is then adjusted (to handle margin and alignment for example) before assignment to the widget. [methodGtk.Widget.get_allocation] returns the adjusted allocation that was actually assigned to the widget. The adjusted allocation is guaranteed to be completely contained within the [methodGtk.Widget.size_allocate] allocation, however.

    So a layout container is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned.

    Returns Gdk.Rectangle

  • Gets the first ancestor of widget with type widget_type.

    For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first GtkBox that’s an ancestor of widget. No reference will be added to the returned widget; it should not be unreferenced.

    Note that unlike [methodGtk.Widget.is_ancestor], this function considers widget to be an ancestor of itself.

    Parameters

    • widget_type: GType<unknown>

      ancestor type

    Returns Gtk.Widget

  • get_buildable_id(): string
  • Gets the ID of the buildable object.

    GtkBuilder sets the name based on the ID attribute of the tag used to construct the buildable.

    Returns string

    • get_can_focus(): boolean
    • get_can_target(): boolean
    • get_child_visible(): boolean
    • Gets the value set with gtk_widget_set_child_visible().

      If you feel a need to use this function, your code probably needs reorganization.

      This function is only useful for container implementations and should never be called by an application.

      Returns boolean

    • Gets the clipboard object for widget.

      This is a utility function to get the clipboard object for the GdkDisplay that widget is using.

      Note that this function always works, even when widget is not realized yet.

      Returns Gdk.Clipboard

    • get_css_classes(): string[]
    • get_css_name(): string
    • 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 the GdkDisplay for the toplevel window associated with this widget.

      This function can only be called after the widget has been added to a widget hierarchy with a GtkWindow at the top.

      In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

      Returns Gdk.Display

    • get_focus_on_click(): boolean
    • get_focusable(): boolean
    • Obtains the frame clock for a widget.

      The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call [methodGdk.FrameClock.get_frame_time], in order to get a time to use for animating. For example you might record the start of the animation with an initial value from [methodGdk.FrameClock.get_frame_time], and then update the animation by calling [methodGdk.FrameClock.get_frame_time] again during each repaint.

      [methodGdk.FrameClock.request_phase] will result in a new frame on the clock, but won’t necessarily repaint any widgets. To repaint a widget, you have to use [methodGtk.Widget.queue_draw] which invalidates the widget (thus scheduling it to receive a draw on the next frame). gtk_widget_queue_draw() will also end up requesting a frame on the appropriate frame clock.

      A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock.

      Unrealized widgets do not have a frame clock.

      Returns Gdk.FrameClock

    • Gets the horizontal alignment of widget.

      For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to %GTK_ALIGN_FILL. Baselines are not supported for horizontal alignment.

      Returns Gtk.Align

    • get_has_tooltip(): boolean
    • get_height(): number
    • Returns the content height of the widget.

      This function returns the height passed to its size-allocate implementation, which is the height you should be using in [vfuncGtk.Widget.snapshot].

      For pointer events, see [methodGtk.Widget.contains].

      Returns number

    • get_hexpand(): boolean
    • Gets whether the widget would like any available extra horizontal space.

      When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.

      Containers should use [methodGtk.Widget.compute_expand] rather than this function, to see whether a widget, or any of its children, has the expand flag set. If any child of a widget wants to expand, the parent may ask to expand also.

      This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand.

      Returns boolean

    • get_hexpand_set(): boolean
    • Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

      If [propertyGtk.Widget:hexpand] property is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

      There are few reasons to use this function, but it’s here for completeness and consistency.

      Returns boolean

    • get_homogeneous(): boolean
    • get_mapped(): boolean
    • get_margin_bottom(): number
    • get_margin_end(): number
    • get_margin_start(): number
    • get_margin_top(): number
    • get_name(): string
    • Returns the nearest GtkNative ancestor of widget.

      This function will return %NULL if the widget is not contained inside a widget tree with a native ancestor.

      GtkNative widgets will return themselves here.

      Returns Gtk.Native

    • get_opacity(): number
    • Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.

      Unlike the context returned by [methodGtk.Widget.create_pango_context], this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by listening to changes of the [propertyGtk.Widget:root] property on the widget.

      Returns Pango.Context

    • Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

      This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used to deduce toplevel window and menu sizes as well as child widgets in free-form containers such as GtkFixed.

      Handle with care. Note that the natural height of a height-for-width widget will generally be a smaller size than the minimum height, since the required height for the natural width is generally smaller than the required height for the minimum width.

      Use [idgtk_widget_measure] if you want to support baseline alignment.

      Returns [Gtk.Requisition, Gtk.Requisition]

    • 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
    • This function gets back user data pointers stored via g_object_set_qdata().

      Parameters

      • quark: number

        A #GQuark, naming the user data pointer

      Returns object

    • get_realized(): boolean
    • get_receives_default(): boolean
    • Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

      See [methodGtk.Widget.set_receives_default].

      Returns boolean

    • Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

      Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.

      Returns Gtk.SizeRequestMode

    • Returns the GtkRoot widget of widget.

      This function will return %NULL if the widget is not contained inside a widget tree with a root widget.

      GtkRoot widgets will return themselves here.

      Returns Gtk.Root

    • get_scale_factor(): number
    • Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

      On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).

      See [methodGdk.Surface.get_scale_factor].

      Returns number

    • get_sensitive(): boolean
    • Returns the widget’s sensitivity.

      This function returns the value that has been set using [methodGtk.Widget.set_sensitive]).

      The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See [methodGtk.Widget.is_sensitive].

      Returns boolean

    • Gets the settings object holding the settings used for this widget.

      Note that this function can only be called when the GtkWidget is attached to a toplevel, since the settings object is specific to a particular GdkDisplay. If you want to monitor the widget for changes in its settings, connect to the notify::display signal.

      Returns Gtk.Settings

    • Returns the content width or height of the widget.

      Which dimension is returned depends on orientation.

      This is equivalent to calling [methodGtk.Widget.get_width] for %GTK_ORIENTATION_HORIZONTAL or [methodGtk.Widget.get_height] for %GTK_ORIENTATION_VERTICAL, but can be used when writing orientation-independent code, such as when implementing [ifaceGtk.Orientable] widgets.

      Parameters

      Returns number

    • get_size_request(): [number, number]
    • Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request().

      A value of -1 stored in width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See [methodGtk.Widget.set_size_request]. To get the size a widget will actually request, call [methodGtk.Widget.measure] instead of this function.

      Returns [number, number]

    • get_spacing(): number
    • Returns the widget state as a flag set.

      It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE state will be returned, that is, also based on parent insensitivity, even if widget itself is sensitive.

      Also note that if you are looking for a way to obtain the [flagsGtk.StateFlags] to pass to a [classGtk.StyleContext] method, you should look at [methodGtk.StyleContext.get_state].

      Returns Gtk.StateFlags

    • Fetch an object build from the template XML for widget_type in this widget instance.

      This will only report children which were previously declared with [methodGtk.WidgetClass.bind_template_child_full] or one of its variants.

      This function is only meant to be called for code which is private to the widget_type which declared the child and is meant for language bindings which cannot easily make use of the GObject structure offsets.

      Parameters

      • widget_type: GType<unknown>

        The GType to get a template child for

      • name: string

        The “id” of the child defined in the template XML

      Returns GObject.Object

    • get_tooltip_markup(): string
    • get_tooltip_text(): string
    • Gets the contents of the tooltip for widget.

      If the widget's tooltip was set using [methodGtk.Widget.set_tooltip_markup], this function will return the escaped text.

      Returns string

    • get_vexpand(): boolean
    • get_vexpand_set(): boolean
    • Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

      See [methodGtk.Widget.get_hexpand_set] for more detail.

      Returns boolean

    • get_visible(): boolean
    • Determines whether the widget is visible.

      If you want to take into account whether the widget’s parent is also marked as visible, use [methodGtk.Widget.is_visible] instead.

      This function does not check if the widget is obscured in any way.

      See [methodGtk.Widget.set_visible].

      Returns boolean

    • get_width(): number
    • Returns the content width of the widget.

      This function returns the width passed to its size-allocate implementation, which is the width you should be using in [vfuncGtk.Widget.snapshot].

      For pointer events, see [methodGtk.Widget.contains].

      Returns number

    • 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

    • grab_focus(): boolean
    • Causes widget to have the keyboard focus for the GtkWindow it's inside.

      If widget is not focusable, or its [vfuncGtk.Widget.grab_focus] implementation cannot transfer the focus to a descendant of widget that is focusable, it will not take focus and %FALSE will be returned.

      Calling [methodGtk.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return %TRUE.

      Returns boolean

    • has_css_class(css_class: string): boolean
    • Returns whether css_class is currently applied to widget.

      Parameters

      • css_class: string

        A style class, without the leading '.' used for notation of style classes

      Returns boolean

    • has_visible_focus(): boolean
    • Determines if the widget should show a visible indication that it has the global input focus.

      This is a convenience function that takes into account whether focus indication should currently be shown in the toplevel window of widget. See [methodGtk.Window.get_focus_visible] for more information about focus indication.

      To find out if the widget has the global input focus, use [methodGtk.Widget.has_focus].

      Returns boolean

    • hide(): void
    • Reverses the effects of gtk_widget_show().

      This is causing the widget to be hidden (invisible to the user).

      Returns void

    • in_destruction(): boolean
    • init_template(): void
    • Creates and initializes child widgets defined in templates.

      This function must be called in the instance initializer for any class which assigned itself a template using [methodGtk.WidgetClass.set_template].

      It is important to call this function in the instance initializer of a GtkWidget subclass and not in GObject.constructed() or GObject.constructor() for two reasons:

      • derived widgets will assume that the composite widgets defined by its parent classes have been created in their relative instance initializers
      • when calling g_object_new() on a widget with composite templates, it’s important to build the composite widgets before the construct properties are set. Properties passed to g_object_new() should take precedence over properties set in the private template XML

      A good rule of thumb is to call this function as the first thing in an instance initialization function.

      Returns void

    • Inserts group into widget.

      Children of widget that implement [ifaceGtk.Actionable] can then be associated with actions in group by setting their “action-name” to prefix.action-name.

      Note that inheritance is defined for individual actions. I.e. even if you insert a group with prefix prefix, actions with the same prefix will still be inherited from the parent, unless the group contains an action with the same name.

      If group is %NULL, a previously inserted group for name is removed from widget.

      Parameters

      • name: string

        the prefix for actions in group

      • group: Gio.ActionGroup

        a GActionGroup, or %NULL to remove the previously inserted group for name

      Returns void

    • Inserts widget into the child widget list of parent.

      It will be placed after previous_sibling, or at the beginning if previous_sibling is %NULL.

      After calling this function, gtk_widget_get_prev_sibling(widget) will return previous_sibling.

      If parent is already set as the parent widget of widget, this function can also be used to reorder widget in the child widget list of parent.

      This API is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.

      Parameters

      • parent: Gtk.Widget

        the parent GtkWidget to insert widget into

      • Optional previous_sibling: Gtk.Widget

        the new previous sibling of widget

      Returns void

    • Inserts widget into the child widget list of parent.

      It will be placed before next_sibling, or at the end if next_sibling is %NULL.

      After calling this function, gtk_widget_get_next_sibling(widget) will return next_sibling.

      If parent is already set as the parent widget of widget, this function can also be used to reorder widget in the child widget list of parent.

      This API is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.

      Parameters

      • parent: Gtk.Widget

        the parent GtkWidget to insert widget into

      • next_sibling: Gtk.Widget

        the new next sibling of widget

      Returns void

    • is_drawable(): boolean
    • is_floating(): boolean
    • is_focus(): boolean
    • Determines if the widget is the focus widget within its toplevel.

      This does not mean that the [propertyGtk.Widget:has-focus] property is necessarily set; [propertyGtk.Widget:has-focus] will only be set if the toplevel widget additionally has the global input focus.

      Returns boolean

    • is_sensitive(): boolean
    • is_visible(): boolean
    • Determines whether the widget and all its parents are marked as visible.

      This function does not check if the widget is obscured in any way.

      See also [methodGtk.Widget.get_visible] and [methodGtk.Widget.set_visible].

      Returns boolean

    • Emits the ::keynav-failed signal on the widget.

      This function should be called whenever keyboard navigation within a single widget hits a boundary.

      The return value of this function should be interpreted in a way similar to the return value of [methodGtk.Widget.child_focus]. When %TRUE is returned, stay in the widget, the failed keyboard navigation is OK and/or there is nowhere we can/should move the focus to. When %FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling [methodGtk.Widget.child_focus] on the widget’s toplevel.

      The default [signalGtk.Widget::keynav-failed] handler returns %FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other values of GtkDirectionType it returns %TRUE.

      Whenever the default handler returns %TRUE, it also calls [methodGtk.Widget.error_bell] to notify the user of the failed keyboard navigation.

      A use case for providing an own implementation of ::keynav-failed (either by connecting to it or by overriding it) would be a row of [classGtk.Entry] widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.

      Parameters

      Returns boolean

    • Returns the widgets for which this widget is the target of a mnemonic.

      Typically, these widgets will be labels. See, for example, [methodGtk.Label.set_mnemonic_widget].

      The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.

      Returns Gtk.Widget[]

    • map(): void
    • Causes a widget to be mapped if it isn’t already.

      This function is only for use in widget implementations.

      Returns void

    • measure(orientation: Gtk.Orientation, for_size?: number): [number, number, number, number]
    • Measures widget in the orientation orientation and for the given for_size.

      As an example, if orientation is %GTK_ORIENTATION_HORIZONTAL and for_size is 300, this functions will compute the minimum and natural width of widget if it is allocated at a height of 300 pixels.

      See GtkWidget’s geometry management section for a more details on implementing GtkWidgetClass.measure().

      Parameters

      • orientation: Gtk.Orientation

        the orientation to measure

      • Optional for_size: number

        Size for the opposite of orientation, i.e. if orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.

      Returns [number, number, number, number]

    • mnemonic_activate(group_cycling: boolean): boolean
    • Emits the ::mnemonic-activate signal.

      See [signalGtk.Widget::mnemonic-activate].

      Parameters

      • group_cycling: boolean

        %TRUE if there are other widgets with the same mnemonic

      Returns 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

    • Returns a GListModel to track the children of widget.

      Calling this function will enable extra internal bookkeeping to track children and emit signals on the returned listmodel. It may slow down operations a lot.

      Applications should try hard to avoid calling this function because of the slowdowns.

      Returns Gio.ListModel

    • Returns a GListModel to track the [classGtk.EventController]s of widget.

      Calling this function will enable extra internal bookkeeping to track controllers and emit signals on the returned listmodel. It may slow down operations a lot.

      Applications should try hard to avoid calling this function because of the slowdowns.

      Returns Gio.ListModel

    • Finds the descendant of widget closest to the point (x, y).

      The point must be given in widget coordinates, so (0, 0) is assumed to be the top left of widget's content area.

      Usually widgets will return %NULL if the given coordinate is not contained in widget checked via [methodGtk.Widget.contains]. Otherwise they will recursively try to find a child that does not return %NULL. Widgets are however free to customize their picking algorithm.

      This function is used on the toplevel to determine the widget below the mouse cursor for purposes of hover highlighting and delivering events.

      Parameters

      • x: number

        X coordinate to test, relative to widget's origin

      • y: number

        Y coordinate to test, relative to widget's origin

      • flags: PickFlags

        Flags to influence what is picked

      Returns Gtk.Widget

    • queue_allocate(): void
    • Flags the widget for a rerun of the [vfuncGtk.Widget.size_allocate] function.

      Use this function instead of [methodGtk.Widget.queue_resize] when the widget's size request didn't change but it wants to reposition its contents.

      An example user of this function is [methodGtk.Widget.set_halign].

      This function is only for use in widget implementations.

      Returns void

    • queue_draw(): void
    • Schedules this widget to be redrawn in the paint phase of the current or the next frame.

      This means widget's [vfuncGtk.Widget.snapshot] implementation will be called.

      Returns void

    • queue_resize(): void
    • Flags a widget to have its size renegotiated.

      This should be called when a widget for some reason has a new size request. For example, when you change the text in a [classGtk.Label], the label queues a resize to ensure there’s enough space for the new text.

      Note that you cannot call gtk_widget_queue_resize() on a widget from inside its implementation of the [vfuncGtk.Widget.size_allocate] virtual method. Calls to gtk_widget_queue_resize() from inside [vfuncGtk.Widget.size_allocate] will be silently ignored.

      This function is only for use in widget implementations.

      Returns void

    • realize(): void
    • Creates the GDK resources associated with a widget.

      Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.

      Realizing a widget requires all the widget’s parent widgets to be realized; calling this function realizes the widget’s parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.

      This function is primarily used in widget implementations, and isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as [signalGtk.Widget::realize].

      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

    • Removes a child widget from box.

      The child must have been added before with [methodGtk.Box.append], [methodGtk.Box.prepend], or [methodGtk.Box.insert_child_after].

      Parameters

      Returns void

    • Removes controller from widget, so that it doesn't process events anymore.

      It should not be used again.

      Widgets will remove all event controllers automatically when they are destroyed, there is normally no need to call this function.

      Parameters

      Returns void

    • remove_css_class(css_class: string): void
    • Removes a style from widget.

      After this, the style of widget will stop matching for css_class.

      Parameters

      • css_class: string

        The style class to remove from widget, without the leading '.' used for notation of style classes

      Returns void

    • remove_mnemonic_label(label: Gtk.Widget): void
    • Removes a widget from the list of mnemonic labels for this widget.

      See [methodGtk.Widget.list_mnemonic_labels]. The widget must have previously been added to the list with [methodGtk.Widget.add_mnemonic_label].

      Parameters

      • label: Gtk.Widget

        a GtkWidget that was previously set as a mnemonic label for widget with [methodGtk.Widget.add_mnemonic_label]

      Returns void

    • remove_tick_callback(id: number): void
    • 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

    • Sets the baseline position of a box.

      This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then position is used to allocate the baseline with respect to the extra space available.

      Parameters

      Returns void

    • set_can_focus(can_focus: boolean): void
    • Specifies whether the input focus can enter the widget or any of its children.

      Applications should set can_focus to %FALSE to mark a widget as for pointer/touch use only.

      Note that having can_focus be %TRUE is only one of the necessary conditions for being focusable. A widget must also be sensitive and focusable and not have an ancestor that is marked as not can-focus in order to receive input focus.

      See [methodGtk.Widget.grab_focus] for actually setting the input focus on a widget.

      Parameters

      • can_focus: boolean

        whether or not the input focus can enter the widget or any of its children

      Returns void

    • set_can_target(can_target: boolean): void
    • Sets whether widget can be the target of pointer events.

      Parameters

      • can_target: boolean

        whether this widget should be able to receive pointer events

      Returns void

    • set_child_visible(child_visible: boolean): void
    • Sets whether widget should be mapped along with its parent.

      The child visibility can be set for widget before it is added to a container with [methodGtk.Widget.set_parent], to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of %TRUE when the widget is removed from a container.

      Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.

      This function is only useful for container implementations and should never be called by an application.

      Parameters

      • child_visible: boolean

        if %TRUE, widget should be mapped along with its parent.

      Returns void

    • set_css_classes(classes: string[]): void
    • Clear all style classes applied to widget and replace them with classes.

      Parameters

      • classes: string[]

        %NULL-terminated list of style classes to apply to widget.

      Returns void

    • Sets the cursor to be shown when pointer devices point towards widget.

      If the cursor is NULL, widget will use the cursor inherited from the parent widget.

      Parameters

      Returns void

    • set_cursor_from_name(name: string): void
    • Sets a named cursor to be shown when pointer devices point towards widget.

      This is a utility function that creates a cursor via [ctorGdk.Cursor.new_from_name] and then sets it on widget with [methodGtk.Widget.set_cursor]. See those functions for details.

      On top of that, this function allows name to be %NULL, which will do the same as calling [methodGtk.Widget.set_cursor] with a %NULL cursor.

      Parameters

      • name: string

        The name of the cursor

      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

    • Sets the reading direction on a particular widget.

      This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).

      If the direction is set to %GTK_TEXT_DIR_NONE, then the value set by [funcGtk.Widget.set_default_direction] will be used.

      Parameters

      Returns void

    • Set child as the current focus child of widget.

      This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [methodGtk.Widget.grab_focus] on it.

      Parameters

      • child: Gtk.Widget

        a direct child widget of widget or %NULL to unset the focus child of widget

      Returns void

    • set_focus_on_click(focus_on_click: boolean): void
    • Sets whether the widget should grab focus when it is clicked with the mouse.

      Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

      Parameters

      • focus_on_click: boolean

        whether the widget should grab focus when clicked with the mouse

      Returns void

    • set_focusable(focusable: boolean): void
    • Specifies whether widget can own the input focus.

      Widget implementations should set focusable to %TRUE in their init() function if they want to receive keyboard input.

      Note that having focusable be %TRUE is only one of the necessary conditions for being focusable. A widget must also be sensitive and can-focus and not have an ancestor that is marked as not can-focus in order to receive input focus.

      See [methodGtk.Widget.grab_focus] for actually setting the input focus on a widget.

      Parameters

      • focusable: boolean

        whether or not widget can own the input focus

      Returns void

    • Sets the font map to use for Pango rendering.

      The font map is the object that is used to look up fonts. Setting a custom font map can be useful in special situations, e.g. when you need to add application-specific fonts to the set of available fonts.

      When not set, the widget will inherit the font map from its parent.

      Parameters

      • font_map: Pango.FontMap

        a PangoFontMap, or %NULL to unset any previously set font map

      Returns void

    • Sets the cairo_font_options_t used for Pango rendering in this widget.

      When not set, the default font options for the GdkDisplay will be used.

      Parameters

      • options: FontOptions

        a cairo_font_options_t to unset any previously set default font options

      Returns void

    • set_has_tooltip(has_tooltip: boolean): void
    • set_hexpand(expand: boolean): void
    • Sets whether the widget would like any available extra horizontal space.

      When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.

      Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.

      By default, widgets automatically expand if any of their children want to expand. (To see if a widget will automatically expand given its current children and state, call [methodGtk.Widget.compute_expand]. A container can decide how the expandability of children affects the expansion of the container by overriding the compute_expand virtual method on GtkWidget.).

      Setting hexpand explicitly with this function will override the automatic expand behavior.

      This function forces the widget to expand or not to expand, regardless of children. The override occurs because [methodGtk.Widget.set_hexpand] sets the hexpand-set property (see [methodGtk.Widget.set_hexpand_set]) which causes the widget’s hexpand value to be used, rather than looking at children and widget state.

      Parameters

      • expand: boolean

        whether to expand

      Returns void

    • set_hexpand_set(set: boolean): void
    • Sets whether the hexpand flag will be used.

      The [propertyGtk.Widget:hexpand-set] property will be set automatically when you call [methodGtk.Widget.set_hexpand] to set hexpand, so the most likely reason to use this function would be to unset an explicit expand flag.

      If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

      There are few reasons to use this function, but it’s here for completeness and consistency.

      Parameters

      • set: boolean

        value for hexpand-set property

      Returns void

    • set_homogeneous(homogeneous: boolean): void
    • Sets whether or not all children of box are given equal space in the box.

      Parameters

      • homogeneous: boolean

        a boolean value, %TRUE to create equal allotments, %FALSE for variable allotments

      Returns void

    • set_margin_bottom(margin: number): void
    • set_margin_end(margin: number): void
    • set_margin_start(margin: number): void
    • set_margin_top(margin: number): void
    • set_name(name: string): void
    • Sets a widgets name.

      Setting a name allows you to refer to the widget from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for [classGtk.StyleContext].

      Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice.

      Parameters

      • name: string

        name for the widget

      Returns void

    • set_opacity(opacity: number): void
    • Request the widget to be rendered partially transparent.

      An opacity of 0 is fully transparent and an opacity of 1 is fully opaque.

      Opacity works on both toplevel widgets and child widgets, although there are some limitations: For toplevel widgets, applying opacity depends on the capabilities of the windowing system. On X11, this has any effect only on X displays with a compositing manager, see gdk_display_is_composited(). On Windows and Wayland it should always work, although setting a window’s opacity after the window has been shown may cause some flicker.

      Note that the opacity is inherited through inclusion — if you set a toplevel to be partially translucent, all of its content will appear translucent, since it is ultimatively rendered on that toplevel. The opacity value itself is not inherited by child widgets (since that would make widgets deeper in the hierarchy progressively more translucent). As a consequence, [classGtk.Popover]s and other [ifaceGtk.Native] widgets with their own surface will use their own opacity value, and thus by default appear non-translucent, even if they are attached to a toplevel that is translucent.

      Parameters

      • opacity: number

        desired opacity, between 0 and 1

      Returns void

    • Sets how widget treats content that is drawn outside the widget's content area.

      See the definition of [enumGtk.Overflow] for details.

      This setting is provided for widget implementations and should not be used by application code.

      The default value is %GTK_OVERFLOW_VISIBLE.

      Parameters

      Returns void

    • Sets parent as the parent widget of widget.

      This takes care of details such as updating the state and style of the child to reflect its new location and resizing the parent. The opposite function is [methodGtk.Widget.unparent].

      This function is useful only when implementing subclasses of GtkWidget.

      Parameters

      Returns void

    • set_property(property_name: string, value?: any): void
    • set_receives_default(receives_default: boolean): void
    • Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

      Parameters

      • receives_default: boolean

        whether or not widget can be a default widget.

      Returns void

    • set_sensitive(sensitive: boolean): void
    • Sets the sensitivity of a widget.

      A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.

      Parameters

      • sensitive: boolean

        %TRUE to make the widget sensitive

      Returns void

    • set_size_request(width: number, height: number): void
    • Sets the minimum size of a widget.

      That is, the widget’s size request will be at least width by height. You can use this function to force a widget to be larger than it normally would be.

      In most cases, [methodGtk.Window.set_default_size] is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request.

      Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.

      The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.

      If the size request in a given direction is -1 (unset), then the “natural” size request of the widget will be used instead.

      The size request set here does not include any margin from the properties [propertyGtk.Widget:margin-start], [propertyGtk.Widget:margin-end], [propertyGtk.Widget:margin-top], and [propertyGtk.Widget:margin-bottom], but it does include pretty much all other padding or border properties set by any subclass of GtkWidget.

      Parameters

      • width: number

        width widget should request, or -1 to unset

      • height: number

        height widget should request, or -1 to unset

      Returns void

    • set_spacing(spacing: number): void
    • Turns on flag values in the current widget state.

      Typical widget states are insensitive, prelighted, etc.

      This function accepts the values %GTK_STATE_FLAG_DIR_LTR and %GTK_STATE_FLAG_DIR_RTL but ignores them. If you want to set the widget's direction, use [methodGtk.Widget.set_direction].

      This function is for use in widget implementations.

      Parameters

      • flags: Gtk.StateFlags

        State flags to turn on

      • clear: boolean

        Whether to clear state before turning on flags

      Returns void

    • set_tooltip_markup(markup: string): void
    • Sets markup as the contents of the tooltip, which is marked up with Pango markup.

      This function will take care of setting the [propertyGtk.Widget:has-tooltip] as a side effect, and of the default handler for the [signalGtk.Widget::query-tooltip] signal.

      See also [methodGtk.Tooltip.set_markup].

      Parameters

      • markup: string

        the contents of the tooltip for widget

      Returns void

    • set_tooltip_text(text: string): void
    • Sets text as the contents of the tooltip.

      If text contains any markup, it will be escaped.

      This function will take care of setting [propertyGtk.Widget:has-tooltip] as a side effect, and of the default handler for the [signalGtk.Widget::query-tooltip] signal.

      See also [methodGtk.Tooltip.set_text].

      Parameters

      • text: string

        the contents of the tooltip for widget

      Returns void

    • set_vexpand(expand: boolean): void
    • Sets whether the widget would like any available extra vertical space.

      See [methodGtk.Widget.set_hexpand] for more detail.

      Parameters

      • expand: boolean

        whether to expand

      Returns void

    • set_vexpand_set(set: boolean): void
    • Sets whether the vexpand flag will be used.

      See [methodGtk.Widget.set_hexpand_set] for more detail.

      Parameters

      • set: boolean

        value for vexpand-set property

      Returns void

    • set_visible(visible: boolean): void
    • Sets the visibility state of widget.

      Note that setting this to %TRUE doesn’t mean the widget is actually viewable, see [methodGtk.Widget.get_visible].

      This function simply calls [methodGtk.Widget.show] or [methodGtk.Widget.hide] but is nicer to use when the visibility of the widget depends on some condition.

      Parameters

      • visible: boolean

        whether the widget should be shown or not

      Returns void

    • should_layout(): boolean
    • Returns whether widget should contribute to the measuring and allocation of its parent.

      This is %FALSE for invisible children, but also for children that have their own surface.

      Returns boolean

    • show(): void
    • Flags a widget to be displayed.

      Any widget that isn’t shown will not appear on the screen.

      Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.

      When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

      Returns void

    • size_allocate(allocation: Gdk.Rectangle, baseline: number): void
    • Allocates widget with a transformation that translates the origin to the position in allocation.

      This is a simple form of [methodGtk.Widget.allocate].

      Parameters

      • allocation: Gdk.Rectangle

        position and size to be allocated to widget

      • baseline: number

        The baseline of the child, or -1

      Returns void

    • Snapshot the a child of widget.

      When a widget receives a call to the snapshot function, it must send synthetic [vfuncGtk.Widget.snapshot] calls to all children. This function provides a convenient way of doing this. A widget, when it receives a call to its [vfuncGtk.Widget.snapshot] function, calls gtk_widget_snapshot_child() once for each child, passing in the snapshot the widget received.

      gtk_widget_snapshot_child() takes care of translating the origin of snapshot, and deciding whether the child needs to be snapshot.

      This function does nothing for children that implement GtkNative.

      Parameters

      • child: Gtk.Widget

        a child of widget

      • snapshot: Gtk.Snapshot

        GtkSnapshot as passed to the widget. In particular, no calls to gtk_snapshot_translate() or other transform calls should have been made.

      Returns 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

    • translate_coordinates(dest_widget: Gtk.Widget, src_x: number, src_y: number): [boolean, number, number]
    • Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations.

      In order to perform this operation, both widget must share a common ancestor.

      Parameters

      • dest_widget: Gtk.Widget

        a GtkWidget

      • src_x: number

        X position relative to src_widget

      • src_y: number

        Y position relative to src_widget

      Returns [boolean, number, number]

    • trigger_tooltip_query(): void
    • unmap(): void
    • Causes a widget to be unmapped if it’s currently mapped.

      This function is only for use in widget implementations.

      Returns void

    • unparent(): void
    • unrealize(): void
    • Causes a widget to be unrealized (frees all GDK resources associated with the widget).

      This function is only useful in widget implementations.

      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

    • Updates an array of accessible properties.

      This function should be called by GtkWidget types whenever an accessible property change must be communicated to assistive technologies.

      This function is meant to be used by language bindings.

      Parameters

      • properties: AccessibleProperty[]

        an array of GtkAccessibleProperty

      • values: any[]

        an array of GValues, one for each property

      Returns void

    • Updates an array of accessible relations.

      This function should be called by GtkWidget types whenever an accessible relation change must be communicated to assistive technologies.

      This function is meant to be used by language bindings.

      Parameters

      • relations: AccessibleRelation[]

        an array of GtkAccessibleRelation

      • values: any[]

        an array of GValues, one for each relation

      Returns void

    • Updates an array of accessible states.

      This function should be called by GtkWidget types whenever an accessible state change must be communicated to assistive technologies.

      This function is meant to be used by language bindings.

      Parameters

      • states: AccessibleState[]

        an array of GtkAccessibleState

      • values: any[]

        an array of GValues, one for each state

      Returns void

    • vfunc_compute_expand(hexpand_p: boolean, vexpand_p: boolean): void
    • vfunc_constructed(): void
    • vfunc_contains(x: number, y: number): boolean
    • Tests if the point at (x, y) is contained in widget.

      The coordinates for (x, y) must be in widget coordinates, so (0, 0) is assumed to be the top left of widget's content area.

      virtual

      Parameters

      • x: number

        X coordinate to test, relative to widget's origin

      • y: number

        Y coordinate to test, relative to widget's origin

      Returns boolean

    • Similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

      virtual

      Parameters

      • builder: Gtk.Builder

        a GtkBuilder

      • child: GObject.Object

        child object or %NULL for non-child tags

      • tagname: string

        the name of the tag

      • data: object

        user data created in custom_tag_start

      Returns void

    • Called at the end of each custom element handled by the buildable.

      virtual

      Parameters

      • builder: Gtk.Builder

        GtkBuilder used to construct this object

      • child: GObject.Object

        child object or %NULL for non-child tags

      • tagname: string

        name of tag

      • data: object

        user data that will be passed in to parser functions

      Returns void

    • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
    • vfunc_dispose(): void
    • vfunc_finalize(): void
    • vfunc_get_id(): string
    • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
    • Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

      Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.

      virtual

      Returns Gtk.SizeRequestMode

    • vfunc_grab_focus(): boolean
    • Causes widget to have the keyboard focus for the GtkWindow it's inside.

      If widget is not focusable, or its [vfuncGtk.Widget.grab_focus] implementation cannot transfer the focus to a descendant of widget that is focusable, it will not take focus and %FALSE will be returned.

      Calling [methodGtk.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return %TRUE.

      virtual

      Returns boolean

    • vfunc_hide(): void
    • Emits the ::keynav-failed signal on the widget.

      This function should be called whenever keyboard navigation within a single widget hits a boundary.

      The return value of this function should be interpreted in a way similar to the return value of [methodGtk.Widget.child_focus]. When %TRUE is returned, stay in the widget, the failed keyboard navigation is OK and/or there is nowhere we can/should move the focus to. When %FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling [methodGtk.Widget.child_focus] on the widget’s toplevel.

      The default [signalGtk.Widget::keynav-failed] handler returns %FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other values of GtkDirectionType it returns %TRUE.

      Whenever the default handler returns %TRUE, it also calls [methodGtk.Widget.error_bell] to notify the user of the failed keyboard navigation.

      A use case for providing an own implementation of ::keynav-failed (either by connecting to it or by overriding it) would be a row of [classGtk.Entry] widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.

      virtual

      Parameters

      Returns boolean

    • vfunc_map(): void
    • vfunc_measure(orientation: Gtk.Orientation, for_size: number): [number, number, number, number]
    • Measures widget in the orientation orientation and for the given for_size.

      As an example, if orientation is %GTK_ORIENTATION_HORIZONTAL and for_size is 300, this functions will compute the minimum and natural width of widget if it is allocated at a height of 300 pixels.

      See GtkWidget’s geometry management section for a more details on implementing GtkWidgetClass.measure().

      virtual

      Parameters

      • orientation: Gtk.Orientation

        the orientation to measure

      • for_size: number

        Size for the opposite of orientation, i.e. if orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.

      Returns [number, number, number, number]

    • vfunc_mnemonic_activate(group_cycling: boolean): boolean
    • Emits the ::mnemonic-activate signal.

      See [signalGtk.Widget::mnemonic-activate].

      virtual

      Parameters

      • group_cycling: boolean

        %TRUE if there are other widgets with the same mnemonic

      Returns boolean

    • 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_query_tooltip(x: number, y: number, keyboard_tooltip: boolean, tooltip: Gtk.Tooltip): boolean
    • vfunc_realize(): void
    • Creates the GDK resources associated with a widget.

      Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.

      Realizing a widget requires all the widget’s parent widgets to be realized; calling this function realizes the widget’s parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.

      This function is primarily used in widget implementations, and isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as [signalGtk.Widget::realize].

      virtual

      Returns void

    • vfunc_root(): void
    • vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
    • vfunc_set_focus_child(child: Gtk.Widget): void
    • Set child as the current focus child of widget.

      This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [methodGtk.Widget.grab_focus] on it.

      virtual

      Parameters

      • child: Gtk.Widget

        a direct child widget of widget or %NULL to unset the focus child of widget

      Returns void

    • vfunc_set_id(id: string): void
    • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
    • vfunc_show(): void
    • Flags a widget to be displayed.

      Any widget that isn’t shown will not appear on the screen.

      Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.

      When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

      virtual

      Returns void

    • vfunc_size_allocate(width: number, height: number, baseline: number): void
    • vfunc_state_flags_changed(previous_state_flags: Gtk.StateFlags): void
    • vfunc_unmap(): void
    • vfunc_unrealize(): void
    • Causes a widget to be unrealized (frees all GDK resources associated with the widget).

      This function is only useful in widget implementations.

      virtual

      Returns void

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