StackSidebarRef

public struct StackSidebarRef : StackSidebarProtocol, GWeakCapturing

A GtkStackSidebar enables you to quickly and easily provide a consistent “sidebar” object for your user interface.

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 gtk_stack_sidebar_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 StackSidebarRef type acts as a lightweight Swift reference to an underlying GtkStackSidebar instance. It exposes methods that can operate on this data type through StackSidebarProtocol conformance. Use StackSidebarRef only as an unowned reference to an existing GtkStackSidebar instance.

  • ptr
    Untyped pointer to the underlying `GtkStackSidebar` instance.
    

    For type-safe access, use the generated, typed pointer stack_sidebar_ptr property instead.

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!

StackSidebar Class

  • Designated initialiser from the underlying C data type

    Declaration

    Swift

    @inlinable
    init(_ p: UnsafeMutablePointer<GtkStackSidebar>)
  • Designated initialiser from a constant pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
    init(_ p: UnsafePointer<GtkStackSidebar>)
  • Conditional initialiser from an optional pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
    init!(_ maybePointer: UnsafeMutablePointer<GtkStackSidebar>?)
  • Conditional initialiser from an optional, non-mutable pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
    init!(_ maybePointer: UnsafePointer<GtkStackSidebar>?)
  • Conditional initialiser from an optional gpointer

    Declaration

    Swift

    @inlinable
    init!(gpointer g: gpointer?)
  • Conditional initialiser from an optional, non-mutable gconstpointer

    Declaration

    Swift

    @inlinable
    init!(gconstpointer g: gconstpointer?)
  • Reference intialiser for a related type that implements StackSidebarProtocol

    Declaration

    Swift

    @inlinable
    init<T>(_ other: T) where T : StackSidebarProtocol
  • This factory is syntactic sugar for setting weak pointers wrapped in GWeak<T>

    Declaration

    Swift

    @inlinable
    static func unowned<T>(_ other: T) -> StackSidebarRef where T : StackSidebarProtocol
  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to StackSidebarProtocol.

    Declaration

    Swift

    @inlinable
    init<T>(cPointer: UnsafeMutablePointer<T>)
  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to StackSidebarProtocol.

    Declaration

    Swift

    @inlinable
    init<T>(constPointer: UnsafePointer<T>)
  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to StackSidebarProtocol.

    Declaration

    Swift

    @inlinable
    init(mutating raw: UnsafeRawPointer)
  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to StackSidebarProtocol.

    Declaration

    Swift

    @inlinable
    init(raw: UnsafeMutableRawPointer)
  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to StackSidebarProtocol.

    Declaration

    Swift

    @inlinable
    init(opaquePointer: OpaquePointer)
  • Creates a new sidebar.

    Declaration

    Swift

    @inlinable
    init()