FlowBoxChildProtocol

public protocol FlowBoxChildProtocol : WidgetProtocol

GtkFlowBoxChild is the kind of widget that can be added to a GtkFlowBox.

The FlowBoxChildProtocol protocol exposes the methods and properties of an underlying GtkFlowBoxChild 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 FlowBoxChild. Alternatively, use FlowBoxChildRef 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 GtkFlowBoxChild instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkFlowBoxChild instance.

    Default Implementation

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

    Declaration

    Swift

    var flow_box_child_ptr: UnsafeMutablePointer<GtkFlowBoxChild>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to FlowBoxChildProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

FlowBoxChild Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

FlowBoxChild signals

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

    Declaration

    Swift

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: FlowBoxChildSignalName, 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 the user activates a child widget in a GtkFlowBox.

    This can be happen either by clicking or double-clicking, or via a keybinding.

    This is a keybinding signal, but it can be used by applications for their own purposes.

    The default bindings are <kbd>Space</kbd> and <kbd>Enter</kbd>.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FlowBoxChildRef) -> 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: FlowBoxChildSignalName { 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::child signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyChildSignal: FlowBoxChildSignalName { get }
    Show on GitHub

FlowBoxChild Class: FlowBoxChildProtocol extension (methods and fields)

  • changed() Extension method

    Marks child as changed, causing any state that depends on this to be updated.

    This affects sorting and filtering.

    Note that calls to this method must be in sync with the data used for the sorting and filtering functions. For instance, if the list is mirroring some external data set, and two children changed in the external data set when you call gtk_flow_box_child_changed() on the first child, the sort function must only read the new data for the first of the two changed children, otherwise the resorting of the children 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 sorting and filtering functions into the widgets themselves.

    Another alternative is to call [methodGtk.FlowBox.invalidate_sort] on any model change, but that is more expensive.

    Declaration

    Swift

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

    Gets the child widget of self.

    Declaration

    Swift

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

    Gets the current index of the child in its GtkFlowBox container.

    Declaration

    Swift

    @inlinable
func getIndex() -> Int
    Show on GitHub
  • set(child:) Extension method

    Sets the child widget of self.

    Declaration

    Swift

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

    Sets the child widget of self.

    Declaration

    Swift

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

    The child widget.

    Declaration

    Swift

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

    Gets the current index of the child in its GtkFlowBox container.

    Declaration

    Swift

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

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

    Declaration

    Swift

    @inlinable
var isSelected: Bool { get }
    Show on GitHub