ListBoxRowProtocol

public protocol ListBoxRowProtocol : ActionableProtocol, BinProtocol

The ListBoxRowProtocol protocol exposes the methods and properties of an underlying GtkListBoxRow instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ListBoxRow. Alternatively, use ListBoxRowRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkListBoxRow instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • list_box_row_ptr Default implementation

    Typed pointer to the underlying GtkListBoxRow instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkListBoxRow instance.

    Declaration

    Swift

    var list_box_row_ptr: UnsafeMutablePointer<GtkListBoxRow>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ListBoxRowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ListBoxRow Class

  • Bind a ListBoxRowPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ListBoxRowPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a ListBoxRow property

    Declaration

    Swift

    @inlinable
func get(property: ListBoxRowPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a ListBoxRow property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: ListBoxRowPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ListBoxRow signals

  • Connect a Swift signal handler to the given, typed ListBoxRowSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ListBoxRowSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed ListBoxRowSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ListBoxRowSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onActivate(flags:handler:) Extension method

    This is a keybinding signal, which will cause this row to be activated.

    If you want to be notified when the user activates a row (by key or not), use the GtkListBox::row-activated signal on the row’s parent GtkListBox.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ListBoxRowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

    Typed activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateSignal: ListBoxRowSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::activatable signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyActivatable(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ListBoxRowRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyActivatable signal is emitted
    Show on GitHub
  • notifyActivatableSignal Extension method

    Typed notify::activatable signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyActivatableSignal: ListBoxRowSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::selectable signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifySelectable(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ListBoxRowRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifySelectable signal is emitted
    Show on GitHub
  • notifySelectableSignal Extension method

    Typed notify::selectable signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifySelectableSignal: ListBoxRowSignalName { get }
    Show on GitHub

ListBoxRow Class: ListBoxRowProtocol extension (methods and fields)

  • changed() Extension method

    Marks row as changed, causing any state that depends on this to be updated. This affects sorting, filtering and headers.

    Note that calls to this method must be in sync with the data used for the row functions. For instance, if the list is mirroring some external data set, and two rows changed in the external data set then when you call gtk_list_box_row_changed() on the first row the sort function must only read the new data for the first of the two changed rows, otherwise the resorting of the rows will be wrong.

    This generally means that if you don’t fully control the data model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call gtk_list_box_invalidate_sort() on any model change, but that is more expensive.

    Declaration

    Swift

    @inlinable
func changed()
    Show on GitHub
  • getActivatable() Extension method

    Gets the value of the GtkListBoxRow:activatable property for this row.

    Declaration

    Swift

    @inlinable
func getActivatable() -> Bool
    Show on GitHub
  • getHeader() Extension method

    Returns the current header of the row. This can be used in a GtkListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it.

    Declaration

    Swift

    @inlinable
func getHeader() -> WidgetRef!
    Show on GitHub
  • getIndex() Extension method

    Gets the current index of the row in its GtkListBox container.

    Declaration

    Swift

    @inlinable
func getIndex() -> Int
    Show on GitHub
  • getSelectable() Extension method

    Gets the value of the GtkListBoxRow:selectable property for this row.

    Declaration

    Swift

    @inlinable
func getSelectable() -> Bool
    Show on GitHub
  • set(activatable:) Extension method

    Set the GtkListBoxRow:activatable property for this row.

    Declaration

    Swift

    @inlinable
func set(activatable: Bool)
    Show on GitHub
  • set(header:) Extension method

    Sets the current header of the row. This is only allowed to be called from a GtkListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox.

    Declaration

    Swift

    @inlinable
func set(header: WidgetRef? = nil)
    Show on GitHub
  • set(header:) Extension method

    Sets the current header of the row. This is only allowed to be called from a GtkListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox.

    Declaration

    Swift

    @inlinable
func set<WidgetT>(header: WidgetT?) where WidgetT : WidgetProtocol
    Show on GitHub
  • set(selectable:) Extension method

    Set the GtkListBoxRow:selectable property for this row.

    Declaration

    Swift

    @inlinable
func set(selectable: Bool)
    Show on GitHub
  • activatable Extension method

    The property determines whether the GtkListBox::row-activated signal will be emitted for this row.

    Declaration

    Swift

    @inlinable
var activatable: Bool { get nonmutating set }
    Show on GitHub
  • header Extension method

    Returns the current header of the row. This can be used in a GtkListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it.

    Declaration

    Swift

    @inlinable
var header: WidgetRef! { get nonmutating set }
    Show on GitHub
  • index Extension method

    Gets the current index of the row in its GtkListBox container.

    Declaration

    Swift

    @inlinable
var index: Int { get }
    Show on GitHub
  • isSelected Extension method

    Returns whether the child is currently selected in its GtkListBox container.

    Declaration

    Swift

    @inlinable
var isSelected: Bool { get }
    Show on GitHub
  • selectable Extension method

    The property determines whether this row can be selected.

    Declaration

    Swift

    @inlinable
var selectable: Bool { get nonmutating set }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkBin { get }
    Show on GitHub