ActionBarProtocol

public protocol ActionBarProtocol : WidgetProtocol

GtkActionBar is designed to present contextual actions.

An example GtkActionBar

It is expected to be displayed below the content and expand horizontally to fill the area.

It allows placing children at the start or the end. In addition, it contains an internal centered box which is centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

CSS nodes

actionbar
╰── revealer
    ╰── box
        ├── box.start
        │   ╰── [start children]
        ├── [center widget]
        ╰── box.end
            ╰── [end children]

A GtkActionBar‘s CSS node is called actionbar. It contains a revealer subnode, which contains a box subnode, which contains two box subnodes at the start and end of the action bar, with start and `end style classes respectively, as well as a center node that represents the center child.

Each of the boxes contains children packed for that side.

The ActionBarProtocol protocol exposes the methods and properties of an underlying GtkActionBar 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 ActionBar. Alternatively, use ActionBarRef 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 GtkActionBar instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkActionBar instance.

    Default Implementation

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

    Declaration

    Swift

    var action_bar_ptr: UnsafeMutablePointer<GtkActionBar>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ActionBarProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ActionBar Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ActionBar Class: ActionBarProtocol extension (methods and fields)

  • getCenterWidget() Extension method

    Retrieves the center bar widget of the bar.

    Declaration

    Swift

    @inlinable
func getCenterWidget() -> WidgetRef!
    Show on GitHub
  • getRevealed() Extension method

    Gets whether the contents of the action bar are revealed.

    Declaration

    Swift

    @inlinable
func getRevealed() -> Bool
    Show on GitHub
  • packEnd(child:) Extension method

    Adds child to action_bar, packed with reference to the end of the action_bar.

    Declaration

    Swift

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

    Adds child to action_bar, packed with reference to the start of the action_bar.

    Declaration

    Swift

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

    Removes a child from action_bar.

    Declaration

    Swift

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

    Sets the center widget for the GtkActionBar.

    Declaration

    Swift

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

    Sets the center widget for the GtkActionBar.

    Declaration

    Swift

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

    Reveals or conceals the content of the action bar.

    Note: this does not show or hide action_bar in the [propertyGtk.Widget:visible] sense, so revealing has no effect if the action bar is hidden.

    Declaration

    Swift

    @inlinable
func set(revealed: Bool)
    Show on GitHub
  • centerWidget Extension method

    Retrieves the center bar widget of the bar.

    Declaration

    Swift

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

    Controls whether the action bar shows its contents.

    Declaration

    Swift

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