Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ListBaseMeta

[189:14] static extends: object

Generated metadata helpers for ListBase class surfaces.

Methods

  • properties ()

    Returns property metadata for ListBase.

    • @r A list.

class: ListBase

[36:7] extends: object

The abstract base class for GTK's list widgets. # Shortcuts and Gestures GtkListBase supports the following keyboard shortcuts: - Ctrl+A or Ctrl+/ selects all items. - Ctrl+Shift+A or Ctrl+\ unselects all items. The focused item is controlled by the navigation keys below, combined with the Ctrl modifier to prevent moving the selection, and the Shift modifier to extend the current selection. - , , , move the focus on the next item in the designed direction. - Home and End focus the first or last item. - PgUp and PgDn move the focus one page up or down. List item widgets support the following keyboard shortcuts: - Enter activates the item. - selects the item, with the same Ctrl and Shift modifiers combinations as the navigation keys. # Actions GtkListBase defines a set of built-in actions: - list.scroll-to-item moves the visible area to the item at given position with the minimum amount of scrolling required. If the item is already visible, nothing happens. - list.select-item changes the selection. - list.select-all selects all items in the model, if the selection model supports it. - list.unselect-all unselects all items in the model, if the selection model supports it. List item widgets install the following actions:

  • listitem.select changes selection if the item is selectable. - listitem.scroll-to moves the visible area of the list to this item with the minimum amount of scrolling required.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ListBase (Handle = null)

    Creates a new ListBase by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • 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.
  • 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.
  • asScrollable ()

    Wraps this handle as Scrollable.

    • @r A Scrollable object.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setOrientation (string Value)

    The orientation of the list. See GtkOrientable:orientation for details.

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