StackSidebarProtocol

public protocol StackSidebarProtocol : WidgetProtocol

A GtkStackSidebar uses a sidebar to switch between GtkStack pages.

In order to use a GtkStackSidebar, you simply use a GtkStack to organize your UI flow, and add the sidebar to your sidebar area. You can use [methodGtk.StackSidebar.set_stack] to connect the GtkStackSidebar to the GtkStack.

CSS nodes

GtkStackSidebar has a single CSS node with name stacksidebar and style class .sidebar.

When circumstances require it, GtkStackSidebar adds the .needs-attention style class to the widgets representing the stack pages.

The StackSidebarProtocol protocol exposes the methods and properties of an underlying GtkStackSidebar 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 StackSidebar. Alternatively, use StackSidebarRef 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 GtkStackSidebar instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkStackSidebar instance.

    Default Implementation

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

    Declaration

    Swift

    var stack_sidebar_ptr: UnsafeMutablePointer<GtkStackSidebar>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to StackSidebarProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

StackSidebar Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

StackSidebar Class: StackSidebarProtocol extension (methods and fields)

  • getStack() Extension method

    Retrieves the stack.

    Declaration

    Swift

    @inlinable
func getStack() -> StackRef!
    Show on GitHub
  • set(stack:) Extension method

    Set the GtkStack associated with this GtkStackSidebar.

    The sidebar widget will automatically update according to the order and items within the given GtkStack.

    Declaration

    Swift

    @inlinable
func set<StackT>(stack: StackT) where StackT : StackProtocol
    Show on GitHub
  • stack Extension method

    The stack.

    Declaration

    Swift

    @inlinable
var stack: StackRef! { get nonmutating set }
    Show on GitHub