Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

allocation: Gdk.Rectangle
app_paintable: boolean
border_width: number
can_default: boolean
can_focus: boolean
child: Gtk.Widget
composite_child: boolean
double_buffered: boolean

Whether or not the widget is double buffered.

enable_grid_lines: Gtk.TreeViewGridLines
enable_search: boolean
enable_tree_lines: boolean
events: Gdk.EventMask
expander_column: Gtk.TreeViewColumn
extension_events: ExtensionMode
fixed_height_mode: boolean

Setting the ::fixed-height-mode property to %TRUE speeds up #GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more information on this option.

flags: number
focus_child: Gtk.Widget
g_type_instance: TypeInstance
hadjustment: Gtk.Adjustment
has_default: boolean
has_focus: boolean
has_tooltip: boolean

Enables or disables the emission of #GtkWidget::query-tooltip on widget. A value of %TRUE indicates that widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to %TRUE for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to %FALSE again.

headers_clickable: boolean
headers_visible: boolean
height_request: number
hover_expand: boolean

Enables of disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

This mode is primarily intended for treeviews in popups, e.g. in #GtkComboBox or #GtkEntryCompletion.

hover_selection: boolean

Enables of disables the hover selection mode of tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.

This mode is primarily intended for treeviews in popups, e.g. in #GtkComboBox or #GtkEntryCompletion.

is_focus: boolean
level_indentation: number

Extra indentation for each level.

model: Gtk.TreeModel
name: string
no_show_all: boolean
object: Gtk.Object
parent: Gtk.Container
parent_instance: InitiallyUnowned
private_flags: number
receives_default: boolean
reorderable: boolean
requisition: Gtk.Requisition
resize_mode: Gtk.ResizeMode
rubber_banding: boolean
rules_hint: boolean
saved_state: number
search_column: number
sensitive: boolean
show_expanders: boolean

%TRUE if the view has expanders.

state: number
style: Gtk.Style
tooltip_column: number
tooltip_markup: string

Sets the text of tooltip to be the given string, which is marked up with the Pango text markup language. Also see gtk_tooltip_set_markup().

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

tooltip_text: string

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

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

user_data: object
vadjustment: Gtk.Adjustment
visible: boolean
widget: Gtk.Widget
width_request: number
window: Gdk.Window
$gtype: GType<Gtk.TreeView>
name: string

Methods

  • activate(): boolean
  • For widgets that can be "activated" (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If widget isn't activatable, the function returns %FALSE.

    Returns boolean

  • Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkTable, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_table_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can't place the same widget inside two different containers.

    Parameters

    • widget: Gtk.Widget

      a widget to be placed inside container

    Returns void

  • Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. The accel_group needs to be added to the widget's toplevel via gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or gtk_menu_item_set_accel_path() instead.

    Parameters

    • accel_signal: string

      widget signal to emit on accelerator activation

    • accel_group: Gtk.AccelGroup

      accel group for this widget, added to its toplevel

    • accel_key: number

      GDK keyval of the accelerator

    • accel_mods: Gdk.ModifierType

      modifier key combination of the accelerator

    • accel_flags: Gtk.AccelFlags

      flag accelerators, e.g. %GTK_ACCEL_VISIBLE

    Returns void

  • add_events(events: number): void
  • Adds the events in the bitfield events to the event mask for widget. See gtk_widget_set_events() for details.

    Parameters

    • events: number

      an event mask, see #GdkEventMask

    Returns void

  • Adds a widget to the list of mnemonic labels for this widget. (See gtk_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, by using a connection to the #GtkWidget::destroy signal or a weak notifier.

    Parameters

    • label: Gtk.Widget

      a #GtkWidget that acts as a mnemonic label for widget

    Returns void

  • Appends column to the list of columns. If tree_view has "fixed_height" mode enabled, then column must have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    Parameters

    Returns number

  • 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

  • can_activate_accel(signal_id: number): boolean
  • Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on widget; if the signal isn't overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.

    Parameters

    • signal_id: number

      the ID of a signal installed on widget

    Returns boolean

  • check_resize(): void
  • This function is used by custom widget implementations; if you're writing an app, you'd use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those functions instead.

    gtk_widget_child_focus() is called by containers as the user moves around the window using keyboard shortcuts. direction indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). gtk_widget_child_focus() emits the #GtkWidget::focus signal; widgets override the default handler for this signal in order to implement appropriate focus behavior.

    The default ::focus handler 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. If returning %TRUE, widgets normally call gtk_widget_grab_focus() to place the focus accordingly; if returning %FALSE, they don't modify the current focus location.

    This function replaces gtk_container_focus() from GTK+ 1.2. It was necessary to check that the child was visible, sensitive, and focusable before calling gtk_container_focus(). gtk_widget_child_focus() returns %FALSE if the widget is not currently in a focusable state, so there's no need for those checks.

    Parameters

    Returns boolean

  • child_get_property(child: Gtk.Widget, property_name: string, value: any): void
  • child_notify(child_property: string): void
  • Emits a #GtkWidget::child-notify signal for the

    child property `child_property` on `widget`.

    This is the analogue of g_object_notify() for child properties.

    Parameters

    • child_property: string

      the name of a child property installed on the class of widget<!-- -->'s parent

    Returns void

  • child_set_property(child: Gtk.Widget, property_name: string, value: any): void
  • child_type(): GType<unknown>
  • Returns the type of the children supported by the container.

    Note that this may return %G_TYPE_NONE to indicate that no more children can be added, e.g. for a #GtkPaned which already has two children.

    Returns GType<unknown>

  • class_path(): [number, string, string]
  • collapse_all(): void
  • columns_autosize(): void
  • Resizes all columns to their optimal width. Only works after the treeview has been realized.

    Returns void

  • convert_bin_window_to_tree_coords(bx: number, by: number): [number, number]
  • Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

    Parameters

    • bx: number

      X coordinate relative to bin_window

    • by: number

      Y coordinate relative to bin_window

    Returns [number, number]

  • convert_bin_window_to_widget_coords(bx: number, by: number): [number, number]
  • Converts bin_window coordinates (see gtk_tree_view_get_bin_window()) to widget relative coordinates.

    Parameters

    • bx: number

      bin_window X coordinate

    • by: number

      bin_window Y coordinate

    Returns [number, number]

  • convert_tree_to_bin_window_coords(tx: number, ty: number): [number, number]
  • Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

    Parameters

    • tx: number

      tree X coordinate

    • ty: number

      tree Y coordinate

    Returns [number, number]

  • convert_tree_to_widget_coords(tx: number, ty: number): [number, number]
  • Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

    Parameters

    • tx: number

      X coordinate relative to the tree

    • ty: number

      Y coordinate relative to the tree

    Returns [number, number]

  • convert_widget_to_bin_window_coords(wx: number, wy: number): [number, number]
  • Converts widget coordinates to coordinates for the bin_window (see gtk_tree_view_get_bin_window()).

    Parameters

    • wx: number

      X coordinate relative to the widget

    • wy: number

      Y coordinate relative to the widget

    Returns [number, number]

  • convert_widget_to_tree_coords(wx: number, wy: number): [number, number]
  • Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

    Parameters

    • wx: number

      X coordinate relative to the widget

    • wy: number

      Y coordinate relative to the widget

    Returns [number, number]

  • 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, in order to notify the layout of changes to the base direction or font of this widget, you must call pango_layout_context_changed() in response to the #GtkWidget::style-set and #GtkWidget::direction-changed signals for the widget.

    Parameters

    • text: string

      text to set on the layout (can be %NULL)

    Returns Pango.Layout

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

    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

  • This is called at the end of each custom element handled by the buildable.

    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

  • destroy(): void
  • Destroys a widget. Equivalent to gtk_object_destroy(), except that you don't have to cast the widget to #GtkObject. When a widget is destroyed, it will break any references it holds to other objects. If the widget is inside a container, the widget will be removed from the container. If the widget is a toplevel (derived from #GtkWindow), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed. Removing a widget from its container or the list of toplevels results in the widget being finalized, unless you've added additional references to the widget with g_object_ref().

    In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well.

    Returns void

  • This function sets *widget_pointer to %NULL if widget_pointer != %NULL. It's intended to be used as a callback connected to the "destroy" signal of a widget. You connect gtk_widget_destroyed() as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to %NULL. Useful for example to avoid multiple copies of the same dialog.

    Parameters

    • widget_pointer: Gtk.Widget

      address of a variable that contains widget

    Returns Gtk.Widget

  • disconnect(id: number): void
  • In GTK+ 1.2, this function would immediately render the region area of a widget, by invoking the virtual draw method of a widget. In GTK+ 2.0, the draw method is gone, and instead gtk_widget_draw() simply invalidates the specified region of the widget, then updates the invalid region of the widget immediately. Usually you don't want to update the region immediately for performance reasons, so in general gtk_widget_queue_draw_area() is a better choice if you want to draw a region of a widget.

    Parameters

    Returns void

  • emit(sigName: "columns-changed", ...args: any[]): void
  • emit(sigName: "cursor-changed", ...args: any[]): void
  • emit(sigName: "expand-collapse-cursor-row", object: boolean, p0: boolean, p1: boolean, ...args: any[]): void
  • emit(sigName: "move-cursor", object: Gtk.MovementStep, p0: number, ...args: any[]): void
  • emit(sigName: "row-activated", path: Gtk.TreePath, column: Gtk.TreeViewColumn, ...args: any[]): void
  • emit(sigName: "row-collapsed", iter: Gtk.TreeIter, path: Gtk.TreePath, ...args: any[]): void
  • emit(sigName: "row-expanded", iter: Gtk.TreeIter, path: Gtk.TreePath, ...args: any[]): void
  • emit(sigName: "select-all", ...args: any[]): void
  • emit(sigName: "select-cursor-parent", ...args: any[]): void
  • emit(sigName: "select-cursor-row", object: boolean, ...args: any[]): void
  • emit(sigName: "set-scroll-adjustments", object: Gtk.Adjustment, p0: Gtk.Adjustment, ...args: any[]): void
  • emit(sigName: "start-interactive-search", ...args: any[]): void
  • emit(sigName: "test-collapse-row", iter: Gtk.TreeIter, path: Gtk.TreePath, ...args: any[]): void
  • emit(sigName: "test-expand-row", iter: Gtk.TreeIter, path: Gtk.TreePath, ...args: any[]): void
  • emit(sigName: "toggle-cursor-row", ...args: any[]): void
  • emit(sigName: "unselect-all", ...args: any[]): void
  • emit(sigName: "notify::enable-grid-lines", ...args: any[]): void
  • emit(sigName: "notify::enable-search", ...args: any[]): void
  • emit(sigName: "notify::enable-tree-lines", ...args: any[]): void
  • emit(sigName: "notify::expander-column", ...args: any[]): void
  • emit(sigName: "notify::fixed-height-mode", ...args: any[]): void
  • emit(sigName: "notify::hadjustment", ...args: any[]): void
  • emit(sigName: "notify::headers-clickable", ...args: any[]): void
  • emit(sigName: "notify::headers-visible", ...args: any[]): void
  • emit(sigName: "notify::hover-expand", ...args: any[]): void
  • emit(sigName: "notify::hover-selection", ...args: any[]): void
  • emit(sigName: "notify::level-indentation", ...args: any[]): void
  • emit(sigName: "notify::model", ...args: any[]): void
  • emit(sigName: "notify::reorderable", ...args: any[]): void
  • emit(sigName: "notify::rubber-banding", ...args: any[]): void
  • emit(sigName: "notify::rules-hint", ...args: any[]): void
  • emit(sigName: "notify::search-column", ...args: any[]): void
  • emit(sigName: "notify::show-expanders", ...args: any[]): void
  • emit(sigName: "notify::tooltip-column", ...args: any[]): void
  • emit(sigName: "notify::vadjustment", ...args: any[]): void
  • emit(sigName: "notify::child", ...args: any[]): void
  • emit(sigName: "notify::resize-mode", ...args: any[]): void
  • emit(sigName: "notify::app-paintable", ...args: any[]): void
  • emit(sigName: "notify::can-default", ...args: any[]): void
  • emit(sigName: "notify::can-focus", ...args: any[]): void
  • emit(sigName: "notify::composite-child", ...args: any[]): void
  • emit(sigName: "notify::double-buffered", ...args: any[]): void
  • emit(sigName: "notify::events", ...args: any[]): void
  • emit(sigName: "notify::extension-events", ...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::is-focus", ...args: any[]): void
  • emit(sigName: "notify::no-show-all", ...args: any[]): void
  • emit(sigName: "notify::receives-default", ...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::visible", ...args: any[]): void
  • emit(sigName: "notify::width-request", ...args: any[]): void
  • emit(sigName: "notify::user-data", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Turns tree_view into a drop destination for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE.

    Parameters

    • targets: Gtk.TargetEntry[]

      the table of targets that the drag will support

    • actions: Gdk.DragAction

      the bitmask of possible actions for a drag from this widget

    Returns void

  • Turns tree_view into a drag source for automatic DND. Calling this method sets #GtkTreeView:reorderable to %FALSE.

    Parameters

    • start_button_mask: Gdk.ModifierType

      Mask of allowed buttons to start drag

    • targets: Gtk.TargetEntry[]

      the table of targets that the drag will support

    • actions: Gdk.DragAction

      the bitmask of possible actions for a drag from this widget

    Returns void

  • ensure_style(): void
  • Ensures that widget has a style (widget->style). Not a very useful function; most of the time, if you want the style, the widget is realized, and realized widgets are guaranteed to have a style already.

    Returns void

  • error_bell(): void
  • Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls gdk_window_beep(), otherwise it does nothing.

    Note that the effect of gdk_window_beep() can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.

    Returns void

  • Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don't use this function; instead, use gtk_main_do_event() so the event will behave as if it were in the event queue. Don't synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window.

    Parameters

    Returns boolean

  • expand_all(): void
  • expand_row(path: Gtk.TreePath, open_all: boolean): boolean
  • Opens the row so its children are visible.

    Parameters

    • path: Gtk.TreePath

      path to a row

    • open_all: boolean

      whether to recursively expand, or just expand immediate children

    Returns boolean

  • 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

  • Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

    Parameters

    Returns void

  • freeze_child_notify(): void
  • Stops emission of #GtkWidget::child-notify signals on widget. The signals are queued until gtk_widget_thaw_child_notify() is called on widget.

    This is the analogue of g_object_freeze_notify() for child properties.

    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

  • Returns the accessible object that describes the widget to an assistive technology.

    If no accessibility library is loaded (i.e. no ATK implementation library is loaded via GTK_MODULES or via another application library, such as libgnome), then this #AtkObject instance may be a no-op. Likewise, if no class-specific #AtkObject implementation is available for the widget instance in question, it will inherit an #AtkObject implementation from the first ancestor class for which such an implementation is defined.

    The documentation of the ATK library contains more information about accessible objects and their uses.

    Returns Atk.Object

  • 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. See note about checking for a toplevel #GtkWindow in the docs for gtk_widget_get_toplevel().

    Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor() considers widget to be an ancestor of itself.

    Parameters

    • widget_type: GType<unknown>

      ancestor type

    Returns Gtk.Widget

  • get_app_paintable(): boolean
  • Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by path and the column specified by column. If path is %NULL, or points to a node not found in the tree, the y and height fields of the rectangle will be filled with 0. If column is %NULL, the x and width fields will be filled with 0. The returned rectangle is equivalent to the background_area passed to gtk_cell_renderer_render(). These background areas tile to cover the entire bin window. Contrast with the cell_area, returned by gtk_tree_view_get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.

    Parameters

    • path: Gtk.TreePath

      a #GtkTreePath for the row, or %NULL to get only horizontal coordinates

    • column: Gtk.TreeViewColumn

      a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes

    Returns Gdk.Rectangle

  • Returns the window that tree_view renders to. This is used primarily to compare to event->window to confirm that the event on tree_view is on the right window.

    Returns Gdk.Window

  • get_border_width(): number
  • get_can_default(): boolean
  • get_can_focus(): boolean
  • Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by path and the column specified by column. If path is %NULL, or points to a path not currently displayed, the y and height fields of the rectangle will be filled with 0. If column is %NULL, the x and width fields will be filled with 0. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the cell_area passed to gtk_cell_renderer_render(). This function is only valid if tree_view is realized.

    Parameters

    • path: Gtk.TreePath

      a #GtkTreePath for the row, or %NULL to get only horizontal coordinates

    • column: Gtk.TreeViewColumn

      a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates

    Returns Gdk.Rectangle

  • This function is only for use in widget implementations. Obtains widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk_widget_set_size_request()), in which case it returns that geometry instead of the widget's requisition.

    This function differs from gtk_widget_size_request() in that it retrieves the last size request value from widget->requisition, while gtk_widget_size_request() actually calls the "size_request" method on widget to compute the size request and fill in widget->requisition, and only then returns widget->requisition.

    Because this function does not call the "size_request" method, it can only be used when you know that widget->requisition is up-to-date, that is, gtk_widget_size_request() has been called since the last time a resize was queued. In general, only container implementations have this information; applications should use gtk_widget_size_request().

    Parameters

    Returns void

  • 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 never should be called by an application.

    Returns boolean

  • Returns the clipboard object for the given selection to be used with widget. widget must have a #GdkDisplay associated with it, so must be attached to a toplevel window.

    Parameters

    • selection: Gdk.Atom

      a #GdkAtom which identifies the clipboard to use. %GDK_SELECTION_CLIPBOARD gives the default clipboard. Another common value is %GDK_SELECTION_PRIMARY, which gives the primary X selection.

    Returns Gtk.Clipboard

  • get_composite_name(): string
  • Fills in path and focus_column with the current path and focus column. If the cursor isn't currently set, then *path will be %NULL. If no column currently has focus, then *focus_column will be %NULL.

    The returned #GtkTreePath must be freed with gtk_tree_path_free() when you are done with it.

    Returns [Gtk.TreePath, Gtk.TreeViewColumn]

  • get_data(key?: string): object
  • get_data(key?: string): object
  • get_data(...args: any[]): any
  • get_data(args_or_key?: string | any[]): any
  • get_data_by_id(data_id: number): object
  • Determines the destination row for a given position. drag_x and drag_y are expected to be in widget coordinates. This function is only meaningful if tree_view is realized. Therefore this function will always return %FALSE if tree_view is not realized or does not have a model.

    Parameters

    • drag_x: number

      the position to determine the destination row for

    • drag_y: number

      the position to determine the destination row for

    Returns [boolean, Gtk.TreePath, Gtk.TreeViewDropPosition]

  • 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_double_buffered(): boolean
  • get_enable_search(): boolean
  • Returns whether or not the tree allows to start interactive searching by typing in text.

    Returns boolean

  • get_enable_tree_lines(): boolean
  • get_events(): number
  • Returns the event mask for the widget (a bitfield containing flags from the #GdkEventMask enumeration). These are the events that the widget will receive.

    Returns number

  • get_fixed_height_mode(): boolean
  • Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores %NULL in focusable_widgets and returns %FALSE.

    Returns [boolean, Gtk.Widget[]]

  • get_has_tooltip(): boolean
  • get_has_window(): boolean
  • get_headers_clickable(): boolean
  • get_headers_visible(): boolean
  • get_hover_expand(): boolean
  • get_hover_selection(): boolean
  • get_level_indentation(): number
  • get_mapped(): boolean
  • Returns the current modifier style for the widget. (As set by gtk_widget_modify_style().) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call gtk_widget_modify_style(), passing in the returned rc style, to make sure that your changes take effect.

    Caution: passing the style back to gtk_widget_modify_style() will normally end up destroying it, because gtk_widget_modify_style() copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.

    Returns Gtk.RcStyle

  • get_name(): string
  • get_no_show_all(): boolean
  • Returns the current value of the GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect this widget.

    Returns boolean

  • Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk_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.

    If you create and keep a #PangoLayout using this context, you must deal with changes to the context by calling pango_layout_context_changed() on the layout in response to the #GtkWidget::style-set and #GtkWidget::direction-changed signals for the widget.

    Returns Pango.Context

  • Finds the path at the point (x, y), relative to bin_window coordinates (please see gtk_tree_view_get_bin_window()). That is, x and y are relative to an events coordinates. x and y must come from an event on the tree_view only where event->window == gtk_tree_view_get_bin_window (). It is primarily for things like popup menus. If path is non-%NULL, then it will be filled with the #GtkTreePath at that point. This path should be freed with gtk_tree_path_free(). If column is non-%NULL, then it will be filled with the column at that point. cell_x and cell_y return the coordinates relative to the cell background (i.e. the background_area passed to gtk_cell_renderer_render()). This function is only meaningful if tree_view is realized. Therefore this function will always return %FALSE if tree_view is not realized or does not have a model.

    For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords().

    Parameters

    • x: number

      The x position to be identified (relative to bin_window).

    • y: number

      The y position to be identified (relative to bin_window).

    Returns [boolean, Gtk.TreePath, Gtk.TreeViewColumn, number, number]

  • get_pointer(): [number, number]
  • Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as widget->window coordinates for widgets that are not #GTK_NO_WINDOW widgets, and are relative to widget->allocation.x, widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.

    Returns [number, number]

  • 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
  • get_realized(): boolean
  • get_receives_default(): boolean
  • get_reorderable(): boolean
  • Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable().

    Returns boolean

  • Retrieves the widget's requisition.

    This function should only be used by widget implementations in order to figure whether the widget's requisition has actually changed after some internal state change (so that they can call gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).

    Normally, gtk_widget_size_request() should be used.

    Returns Gtk.Requisition

  • Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with #GtkWindow at the top.

    The root window is useful for such purposes as creating a popup #GdkWindow associated with the window. 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.Window

  • get_rubber_banding(): boolean
  • Returns whether rubber banding is turned on for tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

    Returns boolean

  • get_rules_hint(): boolean
  • Get the #GdkScreen from 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 screen specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

    Returns Gdk.Screen

  • get_search_column(): number
  • Returns the #GtkEntry which is currently in use as interactive search entry for tree_view. In case the built-in entry is being used, %NULL will be returned.

    Returns Gtk.Entry

  • get_sensitive(): boolean
  • Returns the widget's sensitivity (in the sense of returning the value that has been set using gtk_widget_set_sensitive()).

    The effective sensitivity of a widget is however determined by both its own and its parent widget's sensitivity. See gtk_widget_is_sensitive().

    Returns boolean

  • Gets the settings object holding the settings (global property settings, RC file information, etc) 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 #GdkScreen.

    Returns Gtk.Settings

  • get_show_expanders(): boolean
  • 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 intead. See gtk_widget_set_size_request(). To get the size a widget will actually use, call gtk_widget_size_request() instead of this function.

    Returns [number, number]

  • get_tooltip_column(): number
  • Returns the column of tree_view's model which is being used for displaying tooltips on tree_view's rows.

    Returns number

  • This function is supposed to be used in a #GtkWidget::query-tooltip signal handler for #GtkTreeView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.

    The return value indicates whether there is a tree view row at the given coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. When %TRUE, then any of model, path and iter which have been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to tree_view's bin_window if keyboard_tooltip is %FALSE.

    Parameters

    • x: number

      the x coordinate (relative to widget coordinates)

    • y: number

      the y coordinate (relative to widget coordinates)

    • keyboard_tip: boolean

      whether this is a keyboard tooltip or not

    Returns [boolean, number, number, Gtk.TreeModel, Gtk.TreePath, Gtk.TreeIter]

  • get_tooltip_markup(): string
  • get_tooltip_text(): string
  • This function returns the topmost widget in the container hierarchy widget is a part of. If widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced.

    Note the difference in behavior vs. gtk_widget_get_ancestor(); gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) would return %NULL if widget wasn't inside a toplevel window, and if the window was inside a #GtkWindow-derived widget which was in turn inside the toplevel #GtkWindow. While the second case may seem unlikely, it actually happens when a #GtkPlug is embedded inside a #GtkSocket within the same application.

    To reliably find the toplevel #GtkWindow, use gtk_widget_get_toplevel() and check if the %TOPLEVEL flags is set on the result. |[ GtkWidget *toplevel = gtk_widget_get_toplevel (widget); if (gtk_widget_is_toplevel (toplevel)) { /* Perform action on toplevel. */ }

    
    

    Returns Gtk.Widget

  • get_user_data(): object
  • get_visible(): boolean
  • Determines whether the widget is visible. Note that this doesn't take into account whether the widget's parent is also visible or the widget is obscured in any way.

    See gtk_widget_set_visible().

    Returns boolean

  • Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.

    The paths should be freed with gtk_tree_path_free() after use.

    Returns [boolean, Gtk.TreePath, Gtk.TreePath]

  • Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

    Returns Gdk.Rectangle

  • 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_default(): void
  • Causes widget to become the default widget. widget must have the %GTK_CAN_DEFAULT flag set; typically you have to set this flag yourself by calling gtk_widget_set_can_default (widget, %TRUE). The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, gtk_widget_activate() should affect them.

    Returns void

  • grab_focus(): void
  • Causes widget to have the keyboard focus for the #GtkWindow it's inside. widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won't work.

    More precisely, it must have the %GTK_CAN_FOCUS flag set. Use gtk_widget_set_can_focus() to modify that flag.

    The widget also needs to be realized and mapped. This is indicated by the related signals. Grabbing the focus immediately after creating the widget will likely fail and cause critical warnings.

    Returns void

  • has_grab(): boolean
  • Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).

    See also gtk_grab_add().

    Returns boolean

  • has_rc_style(): boolean
  • has_screen(): boolean
  • Checks whether there is a #GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top.

    Returns boolean

  • hide(): void
  • hide_all(): void
  • hide_on_delete(): boolean
  • Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk_widget_hide() on its argument, then returns %TRUE. If connected to ::delete-event, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when ::delete-event is received.

    Returns boolean

  • input_shape_combine_mask(shape_mask: Gdk.Bitmap, offset_x: number, offset_y: number): void
  • Sets an input shape for this widget's GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk_window_input_shape_combine_mask() for more information.

    Parameters

    • shape_mask: Gdk.Bitmap

      shape to be added, or %NULL to remove an existing shape

    • offset_x: number

      X position of shape mask with respect to window

    • offset_y: number

      Y position of shape mask with respect to window

    Returns void

  • This inserts the column into the tree_view at position. If position is -1, then the column is inserted at the end. If tree_view has "fixed_height" mode enabled, then column must have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    Parameters

    • column: Gtk.TreeViewColumn

      The #GtkTreeViewColumn to be inserted.

    • position: number

      The position to insert column in.

    Returns number

  • Convenience function that inserts a new column into the #GtkTreeView with the given cell renderer and a #GtkCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). If tree_view has "fixed_height" mode enabled, then the new column will have its "sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    Parameters

    • position: number

      Position to insert, -1 for append

    • title: string

      column title

    • cell: Gtk.CellRenderer

      cell renderer for column

    • func: Gtk.TreeCellDataFunc

      function to set attributes of cell renderer

    Returns number

  • Computes the intersection of a widget's area and area, storing the intersection in intersection, and returns %TRUE if there was an intersection. intersection may be %NULL if you're only interested in whether there was an intersection.

    Parameters

    Returns boolean

  • is_composited(): boolean
  • Whether widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a compositing manager is running for widget's screen.

    Please note that the semantics of this call will change in the future if used on a widget that has a composited window in its hierarchy (as set by gdk_window_set_composited()).

    Returns boolean

  • is_drawable(): boolean
  • is_floating(): boolean
  • is_rubber_banding_active(): boolean
  • is_sensitive(): boolean
  • is_toplevel(): boolean
  • Determines whether widget is a toplevel widget. Currently only #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel widgets have no parent widget.

    Returns boolean

  • This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of gtk_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 gtk_widget_child_focus() on the widget's toplevel.

    The default ::keynav-failed handler returns %TRUE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other values of #GtkDirectionType, it looks at the #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE if the setting is %TRUE. This way the entire user interface becomes cursor-navigatable on input devices such as mobile phones which only have cursor keys but no tab key.

    Whenever the default handler returns %TRUE, it also calls gtk_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 #GtkEntry 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

  • list_accel_closures(): TClosure<any, any>[]
  • Lists the closures used by widget for accelerator group connections with gtk_accel_group_connect_by_path() or gtk_accel_group_connect(). The closures can be used to monitor accelerator changes on widget, by connecting to the GtkAccelGroup::accel-changed signal of the #GtkAccelGroup of a closure which can be found out with gtk_accel_group_from_accel_closure().

    Returns TClosure<any, any>[]

  • Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, gtk_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
  • mnemonic_activate(group_cycling: boolean): boolean
  • Emits the #GtkWidget::mnemonic-activate signal.

    The default handler for this signal activates the widget if group_cycling is %FALSE, and just grabs the focus if group_cycling is %TRUE.

    Parameters

    • group_cycling: boolean

      %TRUE if there are other widgets with the same mnemonic

    Returns boolean

  • Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk_widget_modify_text()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style().

    Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set) draw on their parent container's window and thus may not draw any background themselves. This is the case for e.g. #GtkLabel. To modify the background of such widgets, you have to set the base color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a #GtkEventBox widget and setting the base color on that.

    Parameters

    • state: Gtk.StateType

      the state for which to set the base color

    • color: Gdk.Color

      the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_base().

    Returns void

  • Sets the background color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style().

    Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set) draw on their parent container's window and thus may not draw any background themselves. This is the case for e.g. #GtkLabel. To modify the background of such widgets, you have to set the background color on their parent; if you want to set the background of a rectangular area around a label, try placing the label in a #GtkEventBox widget and setting the background color on that.

    Parameters

    • state: Gtk.StateType

      the state for which to set the background color

    • color: Gdk.Color

      the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_bg().

    Returns void

  • Sets the cursor color to use in a widget, overriding the #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color style properties. All other style values are left untouched. See also gtk_widget_modify_style().

    Parameters

    • primary: Gdk.Color

      the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor().

    • secondary: Gdk.Color

      the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor().

    Returns void

  • Sets the foreground color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style().

    Parameters

    • state: Gtk.StateType

      the state for which to set the foreground color

    • color: Gdk.Color

      the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_fg().

    Returns void

  • Sets the font to use for a widget. All other style values are left untouched. See also gtk_widget_modify_style().

    Parameters

    • font_desc: FontDescription

      the font description to use, or %NULL to undo the effect of previous calls to gtk_widget_modify_font().

    Returns void

  • Modifies style values on the widget. Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a style is explicitely set on the widget using gtk_widget_set_style(). The #GtkRcStyle structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.

    Note that modifications made with this function are not cumulative with previous calls to gtk_widget_modify_style() or with such functions as gtk_widget_modify_fg(). If you wish to retain previous values, you must first call gtk_widget_get_modifier_style(), make your modifications to the returned style, then call gtk_widget_modify_style() with that style. On the other hand, if you first call gtk_widget_modify_style(), subsequent calls to such functions gtk_widget_modify_fg() will have a cumulative effect with the initial modifications.

    Parameters

    • style: Gtk.RcStyle

      the #GtkRcStyle holding the style modifications

    Returns void

  • Sets the text color for a widget in a particular state. All other style values are left untouched. The text color is the foreground color used along with the base color (see gtk_widget_modify_base()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style().

    Parameters

    • state: Gtk.StateType

      the state for which to set the text color

    • color: Gdk.Color

      the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_text().

    Returns void

  • Moves column to be after to base_column. If base_column is %NULL, then column is placed in the first position.

    Parameters

    Returns void

  • 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

  • Called when the builder finishes the parsing of a

    GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

    Parameters

    Returns void

  • path(): [number, string, string]
  • Obtains the full path to widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk_widget_get_name(). Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. "GtkButton") or can be set to an application-specific value with gtk_widget_set_name(). By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. path_reversed_p fills in the path in reverse order, i.e. starting with widget's name instead of starting with the name of widget's outermost ancestor.

    Returns [number, string, string]

  • When a container receives an expose event, it must send synthetic expose events to all children that don't have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives an expose event, calls gtk_container_propagate_expose() once for each child, passing in the event the container received.

    gtk_container_propagate_expose() takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event.

    In most cases, a container can simply either simply inherit the #GtkWidget::expose implementation from #GtkContainer, or, do some drawing and then chain to the ::expose implementation from #GtkContainer.

    Note that the ::expose-event signal has been replaced by a ::draw signal in GTK+ 3, and consequently, gtk_container_propagate_expose() has been replaced by gtk_container_propagate_draw(). The GTK+ 3 migration guide for hints on how to port from ::expose-event to ::draw.

    Parameters

    Returns void

  • queue_clear(): void
  • queue_clear_area(x: number, y: number, width: number, height: number): void
  • This function is no longer different from gtk_widget_queue_draw_area(), though it once was. Now it just calls gtk_widget_queue_draw_area(). Originally gtk_widget_queue_clear_area() would force a redraw of the background for %GTK_NO_WINDOW widgets, and gtk_widget_queue_draw_area() would not. Now both functions ensure the background will be redrawn.

    Parameters

    • x: number

      x coordinate of upper-left corner of rectangle to redraw

    • y: number

      y coordinate of upper-left corner of rectangle to redraw

    • width: number

      width of region to draw

    • height: number

      height of region to draw

    Returns void

  • queue_draw(): void
  • queue_draw_area(x: number, y: number, width: number, height: number): void
  • Invalidates the rectangular area of widget defined by x, y, width and height by calling gdk_window_invalidate_rect() on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.

    Normally you would only use this function in widget implementations. You might also use it, or gdk_window_invalidate_rect() directly, to schedule a redraw of a #GtkDrawingArea or some portion thereof.

    Frequently you can just call gdk_window_invalidate_rect() or gdk_window_invalidate_region() instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children.

    The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time.

    Parameters

    • x: number

      x coordinate of upper-left corner of rectangle to redraw

    • y: number

      y coordinate of upper-left corner of rectangle to redraw

    • width: number

      width of region to draw

    • height: number

      height of region to draw

    Returns void

  • queue_resize(): void
  • This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a #GtkLabel, #GtkLabel queues a resize to ensure there's enough space for the new text.

    Returns void

  • queue_resize_no_redraw(): void
  • realize(): void
  • Creates the GDK (windowing system) resources associated with a widget. For example, widget->window will be created when a widget is realized. 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 gtk_widget_realize() 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 GtkWidget::expose-event. Or simply g_signal_connect () to the GtkWidget::realize signal.

    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 widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

    Parameters

    • widget: Gtk.Widget

      a current child of container

    Returns void

  • remove_data(key: string): void
  • remove_data_by_id(data_id: number): void
  • remove_mnemonic_label(label: Gtk.Widget): void
  • Removes a widget from the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). The widget must have previously been added to the list with gtk_widget_add_mnemonic_label().

    Parameters

    • label: Gtk.Widget

      a #GtkWidget that was previously set as a mnemnic label for widget with gtk_widget_add_mnemonic_label().

    Returns void

  • remove_no_notify(key: string): void
  • remove_no_notify_by_id(key_id: number): void
  • render_icon(stock_id: string, size: number, detail: string): Pixbuf
  • A convenience function that uses the theme engine and RC file settings for widget to look up stock_id and render it to a pixbuf. stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. size should be a size such as #GTK_ICON_SIZE_MENU. detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.

    The pixels in the returned #GdkPixbuf are shared with the rest of the application and should not be modified. The pixbuf should be freed after use with g_object_unref().

    Parameters

    • stock_id: string

      a stock ID

    • size: number

      a stock size. A size of (GtkIconSize)-1 means render at the size of the source and don't scale (if there are multiple source sizes, GTK+ picks one of the available sizes).

    • detail: string

      render detail to pass to theme engine

    Returns Pixbuf

  • reset_rc_styles(): void
  • Reset the styles of widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.

    This function is not useful for applications.

    Returns void

  • reset_shapes(): void
  • resize_children(): void
  • run_dispose(): void
  • Moves the alignments of tree_view to the position specified by column and path. If column is %NULL, then no horizontal scrolling occurs. Likewise, if path is %NULL no vertical scrolling occurs. At a minimum, one of column or path need to be non-%NULL. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

    If use_align is %FALSE, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to its current position. If the cell is currently visible on the screen, nothing is done.

    This function only works if the model is set, and path is a valid row on the model. If the model changes before the tree_view is realized, the centered path will be modified to reflect this change.

    Parameters

    • path: Gtk.TreePath

      The path of the row to move to, or %NULL.

    • column: Gtk.TreeViewColumn

      The #GtkTreeViewColumn to move horizontally to, or %NULL.

    • use_align: boolean

      whether to use alignment arguments, or %FALSE.

    • row_align: number

      The vertical alignment of the row specified by path.

    • col_align: number

      The horizontal alignment of the column specified by column.

    Returns void

  • scroll_to_point(tree_x: number, tree_y: number): void
  • Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates. The tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell().

    If either tree_x or tree_y are -1, then that direction isn't scrolled.

    Parameters

    • tree_x: number

      X coordinate of new top-left pixel of visible area, or -1

    • tree_y: number

      Y coordinate of new top-left pixel of visible area, or -1

    Returns void

  • Very rarely-used function. This function is used to emit an expose event signals on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a child %NO_WINDOW widget, and that is normally done using gtk_container_propagate_expose().

    If you want to force an area of a window to be redrawn, use gdk_window_invalidate_rect() or gdk_window_invalidate_region(). To cause the redraw to be done immediately, follow that call with a call to gdk_window_process_updates().

    Parameters

    Returns number

  • send_focus_change(event: Gdk.Event): boolean
  • Sends the focus change event to widget

    This function is not meant to be used by applications. The only time it should be used is when it is necessary for a #GtkWidget to assign focus to a widget that is semantically owned by the first widget even though it's not a direct child - for instance, a search entry in a floating window similar to the quick search in #GtkTreeView.

    An example of its usage is:

    |[ GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);

    fevent->focus_change.type = GDK_FOCUS_CHANGE; fevent->focus_change.in = TRUE; fevent->focus_change.window = gtk_widget_get_window (widget); if (fevent->focus_change.window != NULL) g_object_ref (fevent->focus_change.window);

    gtk_widget_send_focus_change (widget, fevent);

    gdk_event_free (event);


    @param event a #GdkEvent of type GDK_FOCUS_CHANGE

    Parameters

    Returns boolean

  • set_accel_path(accel_path: string, accel_group?: Gtk.AccelGroup): void
  • Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. This removes any accelerators (for any accelerator group) installed by previous calls to gtk_widget_set_accel_path(). Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See gtk_accel_map_save().)

    This function is a low level function that would most likely be used by a menu creation system like #GtkUIManager. If you use #GtkUIManager, setting up accelerator paths will be done automatically.

    Even when you you aren't using #GtkUIManager, if you only want to set up accelerators on menu items gtk_menu_item_set_accel_path() provides a somewhat more convenient interface.

    Note that accel_path string will be stored in a #GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string().

    Parameters

    • accel_path: string

      path used to look up the accelerator

    • Optional accel_group: Gtk.AccelGroup

      a #GtkAccelGroup.

    Returns void

  • set_app_paintable(app_paintable: boolean): void
  • Sets whether the application intends to draw on the widget in an #GtkWidget::expose-event handler.

    This is a hint to the widget and does not affect the behavior of the GTK+ core; many widgets ignore this flag entirely. For widgets that do pay attention to the flag, such as #GtkEventBox and #GtkWindow, the effect is to suppress default themed drawing of the widget's background. (Children of the widget will still be drawn.) The application is then entirely responsible for drawing the widget background.

    Note that the background is still drawn when the widget is mapped. If this is not suitable (e.g. because you want to make a transparent window using an RGBA visual), you can work around this by doing: |[ gtk_widget_realize (window); gdk_window_set_back_pixmap (window->window, NULL, FALSE); gtk_widget_show (window);


    @param app_paintable %TRUE if the application will paint on the widget

    Parameters

    • app_paintable: boolean

    Returns void

  • set_border_width(border_width: number): void
  • Sets the border width of the container.

    The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is #GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a #GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

    Parameters

    • border_width: number

      amount of blank space to leave outside the container. Valid values are in the range 0-65535 pixels.

    Returns void

  • set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
  • set_can_default(can_default: boolean): void
  • Specifies whether widget can be a default widget. See gtk_widget_grab_default() for details about the meaning of "default".

    Parameters

    • can_default: boolean

      whether or not widget can be a default widget.

    Returns void

  • set_can_focus(can_focus: boolean): void
  • Specifies whether widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget.

    Parameters

    • can_focus: boolean

      whether or not widget can own the input focus.

    Returns void

  • set_child_visible(is_visible: boolean): void
  • Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with gtk_widget_show().

    The child visibility can be set for widget before it is added to a container with gtk_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 never should be called by an application.

    Parameters

    • is_visible: boolean

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

    Returns void

  • Sets the colormap for the widget to the given value. Widget must not have been previously realized. This probably should only be used from an init() function (i.e. from the constructor for the widget).

    Parameters

    Returns void

  • Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to func are: the tree_view, the #GtkTreeViewColumn being dragged, the two #GtkTreeViewColumn s determining the drop spot, and user_data. If either of the #GtkTreeViewColumn arguments for the drop spot are %NULL, then they indicate an edge. If func is set to be %NULL, then tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.

    Parameters

    Returns void

  • set_composite_name(name: string): void
  • Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is not %NULL, then focus is given to the column specified by it. Additionally, if focus_column is specified, and start_editing is %TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

    If path is invalid for model, the current cursor (if any) will be unset and the function will return without failing.

    Parameters

    • path: Gtk.TreePath

      A #GtkTreePath

    • focus_column: Gtk.TreeViewColumn

      A #GtkTreeViewColumn, or %NULL

    • start_editing: boolean

      %TRUE if the specified cell should start being edited.

    Returns void

  • Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user's attention on a particular row. If focus_column is not %NULL, then focus is given to the column specified by it. If focus_column and focus_cell are not %NULL, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is %TRUE, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus (tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

    If path is invalid for model, the current cursor (if any) will be unset and the function will return without failing.

    Parameters

    • path: Gtk.TreePath

      A #GtkTreePath

    • focus_column: Gtk.TreeViewColumn

      A #GtkTreeViewColumn, or %NULL

    • focus_cell: Gtk.CellRenderer

      A #GtkCellRenderer, or %NULL

    • start_editing: boolean

      %TRUE if the specified cell should start being edited.

    Returns void

  • set_data(key: string, data?: object): void
  • set_data(key: string, data?: object): void
  • set_data(...args: any[]): any
  • set_data(args_or_key: string | any[], data?: object): any
  • 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
    • Optional data: object

    Returns void

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

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

    Internally, the key is converted to a #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

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    • args_or_key: string | any[]
    • Optional data: object

    Returns any

  • set_data_by_id(data_id: number, data: object): void
  • set_data_by_id_full(data_id: number, data: object, destroy: GLib.DestroyNotify): void
  • This function should almost never be used. It is meant for private use by ATK for determining the number of visible children that are removed when the user collapses a row, or a row is deleted.

    Parameters

    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 explicitely 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 gtk_widget_set_default_direction() will be used.

    Parameters

    Returns void

  • set_double_buffered(double_buffered: boolean): void
  • Widgets are double buffered by default; you can use this function to turn off the buffering. "Double buffered" simply means that gdk_window_begin_paint_region() and gdk_window_end_paint() are called automatically around expose events sent to the widget. gdk_window_begin_paint() diverts all drawing to a widget's window to an offscreen buffer, and gdk_window_end_paint() draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.

    In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.

    Note: if you turn off double-buffering, you have to handle expose events, since even the clearing to the background color or pixmap will not happen automatically (as it is done in gdk_window_begin_paint()).

    Parameters

    • double_buffered: boolean

      %TRUE to double-buffer a widget

    Returns void

  • set_enable_search(enable_search: boolean): void
  • If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").

    Note that even if this is %FALSE, the user can still initiate a search using the "start-interactive-search" key binding.

    Parameters

    • enable_search: boolean

      %TRUE, if the user can search interactively

    Returns void

  • set_enable_tree_lines(enabled: boolean): void
  • Sets whether to draw lines interconnecting the expanders in tree_view. This does not have any visible effects for lists.

    Parameters

    • enabled: boolean

      %TRUE to enable tree line drawing, %FALSE otherwise.

    Returns void

  • set_events(events: number): void
  • Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget's functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk_widget_add_events() for widgets that are already realized, or if you want to preserve the existing event mask. This function can't be used with #GTK_NO_WINDOW widgets; to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.

    Parameters

    • events: number

      event mask

    Returns void

  • Sets the column to draw the expander arrow at. It must be in tree_view. If column is %NULL, then the expander arrow is always at the first visible column.

    If you do not want expander arrow to appear in your tree, set the expander column to a hidden column.

    Parameters

    Returns void

  • set_fixed_height_mode(enable: boolean): void
  • Enables or disables the fixed height mode of tree_view. Fixed height mode speeds up #GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type %GTK_TREE_VIEW_COLUMN_FIXED.

    Parameters

    • enable: boolean

      %TRUE to enable fixed height mode

    Returns void

  • set_focus_chain(focusable_widgets: Gtk.Widget[]): void
  • Sets a focus chain, overriding the one computed automatically by GTK+.

    In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

    Parameters

    • focusable_widgets: Gtk.Widget[]

      the new focus chain

    Returns void

  • Sets, or unsets if child is %NULL, the focused child of container.

    This function emits the GtkContainer::set_focus_child signal of container. Implementations of #GtkContainer can override the default behaviour by overriding the class closure of this signal.

    This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

    Parameters

    Returns void

  • Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment.

    The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

    Parameters

    • adjustment: Gtk.Adjustment

      an adjustment which should be adjusted when the focus is moved among the descendents of container

    Returns void

  • Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment.

    The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

    Parameters

    • adjustment: Gtk.Adjustment

      an adjustment which should be adjusted when the focus is moved among the descendents of container

    Returns void

  • set_has_tooltip(has_tooltip: boolean): void
  • Sets the has-tooltip property on widget to has_tooltip. See GtkWidget:has-tooltip for more information.

    Parameters

    • has_tooltip: boolean

      whether or not widget has a tooltip.

    Returns void

  • set_has_window(has_window: boolean): void
  • Specifies whether widget has a #GdkWindow of its own. Note that all realized widgets have a non-%NULL "window" pointer (gtk_widget_get_window() never returns a %NULL window when a widget is realized), but for many of them it's actually the #GdkWindow of one of its parent widgets. Widgets that do not create a %window for themselves in GtkWidget::realize() must announce this by calling this function with has_window = %FALSE.

    This function should only be called by widget implementations, and they should call it in their init() function.

    Parameters

    • has_window: boolean

      whether or not widget has a window.

    Returns void

  • set_headers_clickable(setting: boolean): void
  • Allow the column title buttons to be clicked.

    Parameters

    • setting: boolean

      %TRUE if the columns are clickable.

    Returns void

  • set_headers_visible(headers_visible: boolean): void
  • Sets the visibility state of the headers.

    Parameters

    • headers_visible: boolean

      %TRUE if the headers are visible

    Returns void

  • set_hover_expand(expand: boolean): void
  • Enables of disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

    Parameters

    • expand: boolean

      %TRUE to enable hover selection mode

    Returns void

  • set_hover_selection(hover: boolean): void
  • Enables of disables the hover selection mode of tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.

    Parameters

    • hover: boolean

      %TRUE to enable hover selection mode

    Returns void

  • set_level_indentation(indentation: number): void
  • Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.

    Parameters

    • indentation: number

      the amount, in pixels, of extra indentation in tree_view.

    Returns void

  • set_mapped(mapped: boolean): void
  • Marks the widget as being realized.

    This function should only ever be called in a derived widget's "map" or "unmap" implementation.

    Parameters

    • mapped: boolean

      %TRUE to mark the widget as mapped

    Returns void

  • Sets the model for a #GtkTreeView. If the tree_view already has a model set, it will remove it before setting the new model. If model is %NULL, then it will unset the old model.

    Parameters

    Returns void

  • set_name(name: string): void
  • Widgets can be named, which allows you to refer to them from a gtkrc file. You can apply a style to widgets with a particular name in the gtkrc file. See the documentation for gtkrc files (on the same page as the docs for #GtkRcStyle).

    Note that widget names are separated by periods in paths (see gtk_widget_path()), so names with embedded periods may cause confusion.

    Parameters

    • name: string

      name for the widget

    Returns void

  • set_no_show_all(no_show_all: boolean): void
  • Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect this widget.

    This is mostly for use in constructing widget hierarchies with externally controlled visibility, see #GtkUIManager.

    Parameters

    • no_show_all: boolean

      the new value for the "no-show-all" property

    Returns void

  • This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of widget, and takes care of some details such as updating the state and style of the child to reflect its new location. The opposite function is gtk_widget_unparent().

    Parameters

    Returns void

  • set_parent_window(parent_window: Gdk.Window): void
  • set_property(property_name: string, value?: any): void
  • set_realized(realized: boolean): void
  • Marks the widget as being realized.

    This function should only ever be called in a derived widget's "realize" or "unrealize" implementation.

    Parameters

    • realized: boolean

      %TRUE to mark the widget as realized

    Returns void

  • set_reallocate_redraws(needs_redraws: boolean): void
  • Sets the reallocate_redraws flag of the container to the given value.

    Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

    Parameters

    • needs_redraws: boolean

      the new value for the container's reallocate_redraws flag

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

    See gtk_widget_grab_default() for details about the meaning of "default".

    Parameters

    • receives_default: boolean

      whether or not widget can be a default widget.

    Returns void

  • set_redraw_on_allocate(redraw_on_allocate: boolean): void
  • Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is %TRUE and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this setting off will improve performance.

    Note that for %NO_WINDOW widgets setting this flag to %FALSE turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a %NO_WINDOW widget that does draw on widget->window, you are responsible for invalidating both the old and new allocation of the widget when the widget is moved and responsible for invalidating regions newly when the widget increases size.

    Parameters

    • redraw_on_allocate: boolean

      if %TRUE, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn.

    Returns void

  • set_reorderable(reorderable: boolean): void
  • This function is a convenience function to allow you to reorder models that support the #GtkDragSourceIface and the #GtkDragDestIface. Both #GtkTreeStore and #GtkListStore support these. If reorderable is %TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's row_inserted and row_deleted signals. The reordering is implemented by setting up the tree view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.

    This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.

    Parameters

    • reorderable: boolean

      %TRUE, if the tree can be reordered.

    Returns void

  • Sets the resize mode for the container.

    The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

    Parameters

    Returns void

  • Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value.

    Parameters

    Returns void

  • set_rubber_banding(enable: boolean): void
  • Enables or disables rubber banding in tree_view. If the selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

    Parameters

    • enable: boolean

      %TRUE to enable rubber banding

    Returns void

  • set_rules_hint(setting: boolean): void
  • This function tells GTK+ that the user interface for your application requires users to read across tree rows and associate cells with one another. By default, GTK+ will then render the tree with alternating row colors. Do not use it just because you prefer the appearance of the ruled tree; that's a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors useful from a functional standpoint (since it has lots of columns, generally).

    Parameters

    • setting: boolean

      %TRUE if the tree requires reading across rows

    Returns void

  • For widgets that support scrolling, sets the scroll adjustments and returns %TRUE. For widgets that don't support scrolling, does nothing and returns %FALSE. Widgets that don't support scrolling can be scrolled by placing them in a #GtkViewport, which does support scrolling.

    Parameters

    • hadjustment: Gtk.Adjustment

      an adjustment for horizontal scrolling, or %NULL

    • vadjustment: Gtk.Adjustment

      an adjustment for vertical scrolling, or %NULL

    Returns boolean

  • set_search_column(column: number): void
  • Sets column as the column where the interactive search code should search in for the current model.

    If the search column is set, users can use the "start-interactive-search" key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search.

    Note that column refers to a column of the current model. The search column is reset to -1 when the model is changed.

    Parameters

    • column: number

      the column of the model to search in, or -1 to disable searching

    Returns void

  • set_search_entry(entry: Gtk.Entry): void
  • Sets the entry which the interactive search code will use for this tree_view. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing %NULL for entry will make the interactive search code use the built-in popup entry again.

    Parameters

    • entry: Gtk.Entry

      the entry the interactive search code of tree_view should use or %NULL

    Returns void

  • Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality #GtkTreeViewSearchEqualFunc returns %FALSE on matches.

    Parameters

    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_show_expanders(enabled: boolean): void
  • Sets whether to draw and enable expanders and indent child rows in tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using gtk_tree_view_set_level_indentation(). This does not have any visible effects for lists.

    Parameters

    • enabled: boolean

      %TRUE to enable expander drawing, %FALSE otherwise.

    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 width by height. You can use this function to force a widget to be either larger or smaller than it normally would be.

    In most cases, gtk_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. When dealing with window sizes, gtk_window_set_geometry_hints() can be a useful function as well.

    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.

    Widgets can't actually be allocated a size less than 1 by 1, but you can pass 0,0 to this function to mean "as small as possible."

    Parameters

    • width: number

      width widget should request, or -1 to unset

    • height: number

      height widget should request, or -1 to unset

    Returns void

  • This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk_widget_set_sensitive().

    Parameters

    Returns void

  • Sets the #GtkStyle for a widget (widget->style). You probably don't want to use this function; it interacts badly with themes, because themes work by replacing the #GtkStyle. Instead, use gtk_widget_modify_style().

    Parameters

    • style: Gtk.Style

      a #GtkStyle, or %NULL to remove the effect of a previous gtk_widget_set_style() and go back to the default style

    Returns void

  • Sets the tip area of tooltip to the area path, column and cell have in common. For example if path is %NULL and column is set, the tip area will be set to the full area covered by column. See also gtk_tooltip_set_tip_area().

    Note that if path is not specified and cell is set and part of a column containing the expander, the tooltip might not show and hide at the correct position. In such cases path must be set to the current node under the mouse cursor for this function to operate correctly.

    See also gtk_tree_view_set_tooltip_column() for a simpler alternative.

    Parameters

    Returns void

  • set_tooltip_column(column: number): void
  • If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have #GtkTreeView handle these automatically for you. column should be set to the column in tree_view's model containing the tooltip texts, or -1 to disable this feature.

    When enabled, #GtkWidget::has-tooltip will be set to %TRUE and tree_view will connect a #GtkWidget::query-tooltip signal handler.

    Note that the signal handler sets the text with gtk_tooltip_set_markup(), so &, <, etc have to be escaped in the text.

    Parameters

    • column: number

      an integer, which is a valid column number for tree_view's model

    Returns void

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

    This function will take care of setting GtkWidget:has-tooltip to %TRUE and of the default handler for the GtkWidget::query-tooltip signal.

    See also the GtkWidget:tooltip-markup property and gtk_tooltip_set_markup().

    Parameters

    • markup: string

      the contents of the tooltip for widget, or %NULL

    Returns void

  • Sets the tip area of tooltip to be the area covered by the row at path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area().

    Parameters

    Returns void

  • set_tooltip_text(text: string): void
  • Sets text as the contents of the tooltip. This function will take care of setting GtkWidget:has-tooltip to %TRUE and of the default handler for the GtkWidget::query-tooltip signal.

    See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().

    Parameters

    • text: string

      the contents of the tooltip for widget

    Returns void

  • set_tooltip_window(custom_window: Gtk.Window): void
  • Replaces the default, usually yellow, window used for displaying tooltips with custom_window. GTK+ will take care of showing and hiding custom_window at the right moment, to behave likewise as the default tooltip window. If custom_window is %NULL, the default tooltip window will be used.

    If the custom window should have the default theming it needs to have the name "gtk-tooltip", see gtk_widget_set_name().

    Parameters

    • custom_window: Gtk.Window

      a #GtkWindow, or %NULL

    Returns void

  • set_uposition(x: number, y: number): void
  • Sets the position of a widget. The funny "u" in the name comes from the "user position" hint specified by the X Window System, and exists for legacy reasons. This function doesn't work if a widget is inside a container; it's only really useful on #GtkWindow.

    Don't use this function to center dialogs over the main application window; most window managers will do the centering on your behalf if you call gtk_window_set_transient_for(), and it's really not possible to get the centering to work correctly in all cases from application code. But if you insist, use gtk_window_set_position() to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering manually.

    Note that although x and y can be individually unset, the position is not honoured unless both x and y are set.

    Parameters

    • x: number

      x position; -1 to unset x; -2 to leave x unchanged

    • y: number

      y position; -1 to unset y; -2 to leave y unchanged

    Returns void

  • set_user_data(data: object): void
  • set_usize(width: number, height: number): void
  • Sets the minimum size of a widget; that is, the widget's size request will be width by height. You can use this function to force a widget to be either larger or smaller than it is. The strange "usize" name dates from the early days of GTK+, and derives from X Window System terminology. In many cases, gtk_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 usize will force them to leave the window at least as large as the usize. When dealing with window sizes, gtk_window_set_geometry_hints() can be a useful function as well.

    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.

    Parameters

    • width: number

      minimum width, or -1 to unset

    • height: number

      minimum height, or -1 to unset

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

    This function simply calls gtk_widget_show() or gtk_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

  • Sets a widget's window. This function should only be used in a widget's GtkWidget::realize() implementation. The %window passed is usually either new window created with gdk_window_new(), or the window of its parent widget as returned by gtk_widget_get_parent_window().

    Widgets must indicate whether they will create their own #GdkWindow by calling gtk_widget_set_has_window(). This is usually done in the widget's init() function.

    Parameters

    Returns void

  • shape_combine_mask(shape_mask: Gdk.Bitmap, offset_x: number, offset_y: number): void
  • Sets a shape for this widget's GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_mask() for more information.

    Parameters

    • shape_mask: Gdk.Bitmap

      shape to be added, or %NULL to remove an existing shape

    • offset_x: number

      X position of shape mask with respect to window

    • offset_y: number

      Y position of shape mask with respect to window

    Returns void

  • show(): void
  • Flags a widget to be displayed. Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets.

    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

  • show_all(): void
  • show_now(): void
  • Shows a widget. If the widget is an unmapped toplevel widget (i.e. a #GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.

    Returns void

  • sink(): void
  • This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate().

    You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.

    Also remember that the size request is not necessarily the size a widget will actually be allocated.

    See also gtk_widget_get_child_requisition().

    Parameters

    Returns void

  • steal_data(key?: string): 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

  • style_attach(): void
  • This function attaches the widget's #GtkStyle to the widget's #GdkWindow. It is a replacement for

    widget->style = gtk_style_attach (widget->style, widget->window);

    and should only ever be called in a derived widget's "realize" implementation which does not chain up to its parent class' "realize" implementation, because one of the parent classes (finally #GtkWidget) would attach the style itself.

    Returns void

  • style_get_property(property_name: string, value: any): void
  • thaw_child_notify(): void
  • 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 widgets must be realized, and must share a common toplevel.

    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]

  • tree_to_widget_coords(tx: number, ty: number, wx: number, wy: number): void
  • Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

    Parameters

    • tx: number

      tree X coordinate

    • ty: number

      tree Y coordinate

    • wx: number

      return location for X coordinate relative to bin_window

    • wy: number

      return location for Y coordinate relative to bin_window

    Returns void

  • trigger_tooltip_query(): void
  • unmap(): void
  • unparent(): void
  • This function is only for use in widget implementations. Should be called by implementations of the remove method on #GtkContainer, to dissociate a child from the container.

    Returns void

  • unrealize(): void
  • This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as widget->window).

    Returns void

  • unref(): void
  • unset_focus_chain(): void
  • unset_rows_drag_dest(): void
  • Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets #GtkTreeView:reorderable to %FALSE.

    Returns void

  • unset_rows_drag_source(): void
  • Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets #GtkTreeView:reorderable to %FALSE.

    Returns void

  • Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkTable, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_table_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can't place the same widget inside two different containers.

    virtual

    Parameters

    • widget: Gtk.Widget

      a widget to be placed inside container

    Returns void

  • vfunc_can_activate_accel(signal_id: number): boolean
  • Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on widget; if the signal isn't overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.

    virtual

    Parameters

    • signal_id: number

      the ID of a signal installed on widget

    Returns boolean

  • vfunc_check_resize(): void
  • vfunc_child_type(): GType<unknown>
  • Returns the type of the children supported by the container.

    Note that this may return %G_TYPE_NONE to indicate that no more children can be added, e.g. for a #GtkPaned which already has two children.

    virtual

    Returns GType<unknown>

  • vfunc_columns_changed(): void
  • vfunc_composite_name(child: Gtk.Widget): string
  • vfunc_composited_changed(): void
  • vfunc_constructed(): void
  • vfunc_cursor_changed(): void
  • This is 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

  • This is 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_destroy(): void
  • vfunc_dispatch_child_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_drag_drop(context: Gdk.DragContext, x: number, y: number, time_: number): boolean
  • vfunc_drag_motion(context: Gdk.DragContext, x: number, y: number, time_: number): boolean
  • Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don't use this function; instead, use gtk_main_do_event() so the event will behave as if it were in the event queue. Don't synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window.

    virtual

    Parameters

    Returns boolean

  • vfunc_expand_collapse_cursor_row(logical: boolean, expand: boolean, open_all: boolean): boolean
  • vfunc_finalize(): void
  • Returns the accessible object that describes the widget to an assistive technology.

    If no accessibility library is loaded (i.e. no ATK implementation library is loaded via GTK_MODULES or via another application library, such as libgnome), then this #AtkObject instance may be a no-op. Likewise, if no class-specific #AtkObject implementation is available for the widget instance in question, it will inherit an #AtkObject implementation from the first ancestor class for which such an implementation is defined.

    The documentation of the ATK library contains more information about accessible objects and their uses.

    virtual

    Returns Atk.Object

  • vfunc_get_arg(arg: Arg, arg_id: number): void
  • vfunc_get_child_property(child: Gtk.Widget, property_id: number, value: any, pspec: ParamSpec): void
  • vfunc_get_name(): string
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_grab_focus(): void
  • Causes widget to have the keyboard focus for the #GtkWindow it's inside. widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won't work.

    More precisely, it must have the %GTK_CAN_FOCUS flag set. Use gtk_widget_set_can_focus() to modify that flag.

    The widget also needs to be realized and mapped. This is indicated by the related signals. Grabbing the focus immediately after creating the widget will likely fail and cause critical warnings.

    virtual

    Returns void

  • vfunc_grab_notify(was_grabbed: boolean): void
  • vfunc_hide(): void
  • vfunc_hide_all(): void
  • vfunc_hierarchy_changed(previous_toplevel: Gtk.Widget): void
  • vfunc_map(): void
  • vfunc_mnemonic_activate(group_cycling: boolean): boolean
  • Emits the #GtkWidget::mnemonic-activate signal.

    The default handler for this signal activates the widget if group_cycling is %FALSE, and just grabs the focus if group_cycling is %TRUE.

    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_parent_set(previous_parent: Gtk.Widget): void
  • Called when the builder finishes the parsing of a

    GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.
    virtual

    Parameters

    Returns void

  • vfunc_popup_menu(): boolean
  • vfunc_query_tooltip(x: number, y: number, keyboard_tooltip: boolean, tooltip: Gtk.Tooltip): boolean
  • vfunc_realize(): void
  • Creates the GDK (windowing system) resources associated with a widget. For example, widget->window will be created when a widget is realized. 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 gtk_widget_realize() 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 GtkWidget::expose-event. Or simply g_signal_connect () to the GtkWidget::realize signal.

    virtual

    Returns void

  • Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

    virtual

    Parameters

    • widget: Gtk.Widget

      a current child of container

    Returns void

  • vfunc_screen_changed(previous_screen: Gdk.Screen): void
  • vfunc_select_all(): boolean
  • vfunc_select_cursor_parent(): boolean
  • vfunc_select_cursor_row(start_editing: boolean): boolean
  • vfunc_selection_get(selection_data: Gtk.SelectionData, info: number, time_: number): void
  • vfunc_selection_received(selection_data: Gtk.SelectionData, time_: number): void
  • vfunc_set_arg(arg: Arg, arg_id: number): void
  • vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
  • vfunc_set_child_property(child: Gtk.Widget, property_id: number, value: any, pspec: ParamSpec): void
  • vfunc_set_focus_child(widget: Gtk.Widget): void
  • Sets, or unsets if child is %NULL, the focused child of container.

    This function emits the GtkContainer::set_focus_child signal of container. Implementations of #GtkContainer can override the default behaviour by overriding the class closure of this signal.

    This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

    virtual

    Parameters

    Returns void

  • vfunc_set_name(name: 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. If you want to show all the widgets in a container, it's easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets.

    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_show_all(): void
  • This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate().

    You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.

    Also remember that the size request is not necessarily the size a widget will actually be allocated.

    See also gtk_widget_get_child_requisition().

    virtual

    Parameters

    Returns void

  • vfunc_start_interactive_search(): boolean
  • vfunc_style_set(previous_style: Gtk.Style): void
  • vfunc_toggle_cursor_row(): boolean
  • vfunc_unmap(): void
  • vfunc_unrealize(): void
  • This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as widget->window).

    virtual

    Returns void

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

  • widget_to_tree_coords(wx: number, wy: number, tx: number, ty: number): void
  • Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

    Parameters

    • wx: number

      X coordinate relative to bin_window

    • wy: number

      Y coordinate relative to bin_window

    • tx: number

      return location for tree X coordinate

    • ty: number

      return location for tree Y coordinate

    Returns void

  • add_arg_type(arg_name: string, arg_type: GType<unknown>, arg_flags: number, arg_id: number): 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

  • pop_colormap(): void
  • pop_composite_child(): void
  • Pushes cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove cmap with gtk_widget_pop_colormap(). There's little reason to use this function.

    Parameters

    Returns void

  • push_composite_child(): void
  • Makes all newly-created widgets as composite children until the corresponding gtk_widget_pop_composite_child() call.

    A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI builders might want to treat them in a different way.

    Here is a simple example: |[ gtk_widget_push_composite_child (); scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment); gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar"); gtk_widget_pop_composite_child (); gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window)); g_object_ref (scrolled_window->hscrollbar);

    
    

    Returns void

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