GridViewProtocol

public protocol GridViewProtocol : ListBaseProtocol

GtkGridView presents a large dynamic grid of items.

GtkGridView uses its factory to generate one child widget for each visible item and shows them in a grid. The orientation of the grid view determines if the grid reflows vertically or horizontally.

GtkGridView allows the user to select items according to the selection characteristics of the model. For models that allow multiple selected items, it is possible to turn on rubberband selection, using [propertyGtk.GridView:enable-rubberband].

To learn more about the list widget framework, see the overview.

CSS nodes

gridview
├── child[.activatable]
│
├── child[.activatable]
│
┊
╰── [rubberband]

GtkGridView uses a single CSS node with name gridview. Each child uses a single CSS node with name child. If the [propertyGtk.ListItem:activatable] property is set, the corresponding row will have the .activatable style class. For rubberband selection, a subnode with name rubberband is used.

Accessibility

GtkGridView uses the GTK_ACCESSIBLE_ROLE_GRID role, and the items use the GTK_ACCESSIBLE_ROLE_GRID_CELL role.

The GridViewProtocol protocol exposes the methods and properties of an underlying GtkGridView 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 GridView. Alternatively, use GridViewRef 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 GtkGridView instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkGridView instance.

    Default Implementation

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

    Declaration

    Swift

    var grid_view_ptr: UnsafeMutablePointer<GtkGridView>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GridViewProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GridView Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: GridViewPropertyName, 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 GridView property

    Declaration

    Swift

    @inlinable
func get(property: GridViewPropertyName) -> 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 GridView property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GridView signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GridViewSignalName, 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 GridViewSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GridViewSignalName, 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

    Emitted when a cell has been activated by the user, usually via activating the GtkGridView|list.activate-item action.

    This allows for a convenient way to handle activation in a gridview. See [propertyGtk.ListItem:activatable] for details on how to use this signal.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    position

    position of item to activate
    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: GridViewSignalName { 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::enable-rubberband signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyEnableRubberband(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifyEnableRubberband signal is emitted
    Show on GitHub
  • notifyEnableRubberbandSignal Extension method

    Typed notify::enable-rubberband signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyEnableRubberbandSignal: GridViewSignalName { 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::factory signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyFactory(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifyFactory signal is emitted
    Show on GitHub
  • notifyFactorySignal Extension method

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

    Declaration

    Swift

    static var notifyFactorySignal: GridViewSignalName { 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::max-columns signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyMaxColumns(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifyMaxColumns signal is emitted
    Show on GitHub
  • notifyMaxColumnsSignal Extension method

    Typed notify::max-columns signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyMaxColumnsSignal: GridViewSignalName { 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::min-columns signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyMinColumns(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifyMinColumns signal is emitted
    Show on GitHub
  • notifyMinColumnsSignal Extension method

    Typed notify::min-columns signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyMinColumnsSignal: GridViewSignalName { 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::model signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyModel(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifyModel signal is emitted
    Show on GitHub
  • notifyModelSignal Extension method

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

    Declaration

    Swift

    static var notifyModelSignal: GridViewSignalName { 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::single-click-activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifySingleClickActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GridViewRef, _ 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 notifySingleClickActivate signal is emitted
    Show on GitHub

  • Typed notify::single-click-activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifySingleClickActivateSignal: GridViewSignalName { get }
    Show on GitHub

GridView Class: GridViewProtocol extension (methods and fields)

  • getEnableRubberband() Extension method

    Returns whether rows can be selected by dragging with the mouse.

    Declaration

    Swift

    @inlinable
func getEnableRubberband() -> Bool
    Show on GitHub
  • getFactory() Extension method

    Gets the factory that’s currently used to populate list items.

    Declaration

    Swift

    @inlinable
func getFactory() -> ListItemFactoryRef!
    Show on GitHub
  • getMaxColumns() Extension method

    Gets the maximum number of columns that the grid will use.

    Declaration

    Swift

    @inlinable
func getMaxColumns() -> Int
    Show on GitHub
  • getMinColumns() Extension method

    Gets the minimum number of columns that the grid will use.

    Declaration

    Swift

    @inlinable
func getMinColumns() -> Int
    Show on GitHub
  • getModel() Extension method

    Gets the model that’s currently used to read the items displayed.

    Declaration

    Swift

    @inlinable
func getModel() -> SelectionModelRef!
    Show on GitHub
  • getSingleClickActivate() Extension method

    Returns whether items will be activated on single click and selected on hover.

    Declaration

    Swift

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

    Sets whether selections can be changed by dragging with the mouse.

    Declaration

    Swift

    @inlinable
func set(enableRubberband: Bool)
    Show on GitHub
  • set(factory:) Extension method

    Sets the GtkListItemFactory to use for populating list items.

    Declaration

    Swift

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

    Sets the GtkListItemFactory to use for populating list items.

    Declaration

    Swift

    @inlinable
func set<ListItemFactoryT>(factory: ListItemFactoryT?) where ListItemFactoryT : ListItemFactoryProtocol
    Show on GitHub
  • set(maxColumns:) Extension method

    Sets the maximum number of columns to use.

    This number must be at least 1.

    If max_columns is smaller than the minimum set via [methodGtk.GridView.set_min_columns], that value is used instead.

    Declaration

    Swift

    @inlinable
func set(maxColumns: Int)
    Show on GitHub
  • set(minColumns:) Extension method

    Sets the minimum number of columns to use.

    This number must be at least 1.

    If min_columns is smaller than the minimum set via [methodGtk.GridView.set_max_columns], that value is ignored.

    Declaration

    Swift

    @inlinable
func set(minColumns: Int)
    Show on GitHub
  • set(model:) Extension method

    Sets the imodel to use.

    This must be a [ifaceGtk.SelectionModel].

    Declaration

    Swift

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

    Sets the imodel to use.

    This must be a [ifaceGtk.SelectionModel].

    Declaration

    Swift

    @inlinable
func set<SelectionModelT>(model: SelectionModelT?) where SelectionModelT : SelectionModelProtocol
    Show on GitHub
  • set(singleClickActivate:) Extension method

    Sets whether items should be activated on single click and selected on hover.

    Declaration

    Swift

    @inlinable
func set(singleClickActivate: Bool)
    Show on GitHub
  • enableRubberband Extension method

    Returns whether rows can be selected by dragging with the mouse.

    Declaration

    Swift

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

    Factory for populating list items.

    Declaration

    Swift

    @inlinable
var factory: ListItemFactoryRef! { get nonmutating set }
    Show on GitHub
  • maxColumns Extension method

    Gets the maximum number of columns that the grid will use.

    Declaration

    Swift

    @inlinable
var maxColumns: Int { get nonmutating set }
    Show on GitHub
  • minColumns Extension method

    Gets the minimum number of columns that the grid will use.

    Declaration

    Swift

    @inlinable
var minColumns: Int { get nonmutating set }
    Show on GitHub
  • model Extension method

    Model for the items displayed.

    Declaration

    Swift

    @inlinable
var model: SelectionModelRef! { get nonmutating set }
    Show on GitHub
  • singleClickActivate Extension method

    Returns whether items will be activated on single click and selected on hover.

    Declaration

    Swift

    @inlinable
var singleClickActivate: Bool { get nonmutating set }
    Show on GitHub