Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: PanedAcceptpositionCallback

[655:7] extends: object

Generated low-level callback wrapper for GIR callback accept-position.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedAcceptpositionCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PanedCyclechildfocusCallback

[795:7] extends: object

Generated low-level callback wrapper for GIR callback cycle-child-focus.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedCyclechildfocusCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, reversed, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PanedMeta

[1078:14] static extends: object

Generated metadata helpers for Paned class surfaces.

Methods

  • properties ()

    Returns property metadata for Paned.

    • @r A list.
  • signals ()

    Returns signal metadata for Paned.

    • @r A list.

class: PanedCyclehandlefocusCallback

[866:7] extends: object

Generated low-level callback wrapper for GIR callback cycle-handle-focus.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedCyclehandlefocusCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, reversed, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PanedMovehandleCallback

[937:7] extends: object

Generated low-level callback wrapper for GIR callback move-handle.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedMovehandleCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, scroll_type, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: Paned

[54:7] extends: object

Arranges its children in two panes, horizontally or vertically. An example GtkPaned The division between the two panes is adjustable by the user by dragging a handle. Child widgets are added to the panes of the widget with [method@Gtk.Paned.set_start_child] and [method@Gtk.Paned.set_end_child]. The division between the two children is set by default from the size requests of the children, but it can be adjusted by the user. A paned widget draws a separator between the two child widgets and a small handle that the user can drag to adjust the division. It does not draw any relief around the children or around the separator. (The space in which the separator is called the gutter.) Often, it is useful to put each child inside a [class@Gtk.Frame] so that the gutter appears as a ridge. No separator is drawn if one of the children is missing. Each child has two options that can be set, "resize" and "shrink". If "resize" is true then, when the GtkPaned is resized, that child will expand or shrink along with the paned widget. If "shrink" is true, then that child can be made smaller than its requisition by the user. Setting "shrink" to false allows the application to set a minimum size. If "resize" is false for both children, then this is treated as if "resize" is true for both children. The application can set the position of the slider as if it were set by the user, by calling [method@Gtk.Paned.set_position]. # Shortcuts and Gestures The following signals have default keybindings: - [signal@Gtk.Paned::accept-position] - [signal@Gtk.Paned::cancel-position] - [signal@Gtk.Paned::cycle-child-focus] - [signal@Gtk.Paned::cycle-handle-focus] - [signal@Gtk.Paned::move-handle] - [signal@Gtk.Paned::toggle-handle-focus] # CSS nodes paned ├── <child> ├── separator[.wide] ╰── <child> GtkPaned has a main CSS node with name paned, and a subnode for the separator with name separator. The subnode gets a .wide style class when the paned is supposed to be wide. In horizontal orientation, the nodes are arranged based on the text direction, so in left-to-right mode, :first-child will select the leftmost child, while it will select the rightmost child in RTL layouts. ## Creating a paned widget with minimum sizes. c GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL); GtkWidget *frame1 = gtk_frame_new (NULL); GtkWidget *frame2 = gtk_frame_new (NULL); gtk_widget_set_size_request (hpaned, 200, -1); gtk_paned_set_start_child (GTK_PANED (hpaned), frame1); gtk_paned_set_resize_start_child (GTK_PANED (hpaned), TRUE); gtk_paned_set_shrink_start_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame1, 50, -1); gtk_paned_set_end_child (GTK_PANED (hpaned), frame2); gtk_paned_set_resize_end_child (GTK_PANED (hpaned), FALSE); gtk_paned_set_shrink_end_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame2, 50, -1);

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • Paned (orientation = null)

    Creates a new GtkPaned widget.

    • @p orientation is the paned’s orientation..
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asWidget ()

    Wraps this handle as Widget.

    • @r A Widget object.
  • asAccessible ()

    Wraps this handle as Accessible.

    • @r A Accessible object.
  • asAccessibleRange ()

    Wraps this handle as AccessibleRange.

    • @r A AccessibleRange object.
  • asBuildable ()

    Wraps this handle as Buildable.

    • @r A Buildable object.
  • asConstraintTarget ()

    Wraps this handle as ConstraintTarget.

    • @r A ConstraintTarget object.
  • asOrientable ()

    Wraps this handle as Orientable.

    • @r A Orientable object.
  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.
  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.
  • setOnAcceptposition (callback Fn, UserData = null)

    Emitted to accept the current position of the handle when moving it using key bindings. This is a keybinding signal. The default binding for this signal is Return or Space.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnCancelposition (callback Fn, UserData = null)

    Emitted to cancel moving the position of the handle using key bindings. The position of the handle will be reset to the value prior to moving it. This is a keybinding signal. The default binding for this signal is Escape.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnCyclechildfocus (callback Fn, UserData = null)

    Emitted to cycle the focus between the children of the paned. This is a keybinding signal. The default binding is F6.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self, bool Reversed).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnCyclehandlefocus (callback Fn, UserData = null)

    Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings. This is a keybinding signal. The default binding for this signal is F8.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self, bool Reversed).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnMovehandle (callback Fn, UserData = null)

    Emitted to move the handle with key bindings. This is a keybinding signal. The default bindings for this signal are Ctrl+, , Ctrl+, , Ctrl+, , Ctrl+, , PgUp, PgDn, Home, End.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self, string Scroll_type).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnTogglehandlefocus (callback Fn, UserData = null)

    Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain. This is a keybinding signal. The default binding is Tab.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Paned Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setEndchild (object Value)

    The second child.

    • @p Value is the new property value.
    • @r None.
  • setPosition (int Value)

    Position of the separator in pixels, from the left/top.

    • @p Value is the new property value.
    • @r None.
  • setPositionset (bool Value)

    Whether the [property@Gtk.Paned:position] property has been set.

    • @p Value is the new property value.
    • @r None.
  • setResizeendchild (bool Value)

    Determines whether the second child expands and shrinks along with the paned widget.

    • @p Value is the new property value.
    • @r None.
  • setResizestartchild (bool Value)

    Determines whether the first child expands and shrinks along with the paned widget.

    • @p Value is the new property value.
    • @r None.
  • setShrinkendchild (bool Value)

    Determines whether the second child can be made smaller than its requisition.

    • @p Value is the new property value.
    • @r None.
  • setShrinkstartchild (bool Value)

    Determines whether the first child can be made smaller than its requisition.

    • @p Value is the new property value.
    • @r None.
  • setStartchild (object Value)

    The first child.

    • @p Value is the new property value.
    • @r None.
  • setWidehandle (bool Value)

    Whether the GtkPaned should provide a stronger visual separation. For example, this could be set when a paned contains two [class@Gtk.Notebook]s, whose tab rows would otherwise merge visually.

    • @p Value is the new property value.
    • @r None.
  • get_end_child ()

    Retrieves the end child of the given GtkPaned.

  • get_position ()

    Obtains the position of the divider between the two panes.

  • get_resize_end_child ()

    Returns whether the [property@Gtk.Paned:end-child] can be resized.

  • get_resize_start_child ()

    Returns whether the [property@Gtk.Paned:start-child] can be resized.

  • get_shrink_end_child ()

    Returns whether the [property@Gtk.Paned:end-child] can shrink.

  • get_shrink_start_child ()

    Returns whether the [property@Gtk.Paned:start-child] can shrink.

  • get_start_child ()

    Retrieves the start child of the given GtkPaned.

  • get_wide_handle ()

    Gets whether the separator should be wide.

  • set_end_child (object child)

    Sets the end child of @paned to @child. If @child is NULL, the existing child will be removed.

    • @p child is the widget to add.
    • @r None.
  • set_position (int position)

    Sets the position of the divider between the two panes.

    • @p position is pixel position of divider, a negative value means that the position is unset.
    • @r None.
  • set_resize_end_child (bool resize)

    Sets whether the [property@Gtk.Paned:end-child] can be resized.

    • @p resize is true to let the end child be resized.
    • @r None.
  • set_resize_start_child (bool resize)

    Sets whether the [property@Gtk.Paned:start-child] can be resized.

    • @p resize is true to let the start child be resized.
    • @r None.
  • set_shrink_end_child (bool resize)

    Sets whether the [property@Gtk.Paned:end-child] can shrink.

    • @p resize is true to let the end child be shrunk.
    • @r None.
  • set_shrink_start_child (bool resize)

    Sets whether the [property@Gtk.Paned:start-child] can shrink.

    • @p resize is true to let the start child be shrunk.
    • @r None.
  • set_start_child (object child)

    Sets the start child of @paned to @child. If @child is NULL, the existing child will be removed.

    • @p child is the widget to add.
    • @r None.
  • set_wide_handle (bool wide)

    Sets whether the separator should be wide.

    • @p wide is the new value for the [property@Gtk.Paned:wide-handle] property.
    • @r None.

class: PanedTogglehandlefocusCallback

[1008:7] extends: object

Generated low-level callback wrapper for GIR callback toggle-handle-focus.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedTogglehandlefocusCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PanedCancelpositionCallback

[725:7] extends: object

Generated low-level callback wrapper for GIR callback cancel-position.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PanedCancelpositionCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.