WindowControls

open class WindowControls : Widget, WindowControlsProtocol

GtkWindowControls shows window frame controls.

Typical window frame controls are minimize, maximize and close buttons, and the window icon.

An example GtkWindowControls

GtkWindowControls only displays start or end side of the controls (see [propertyGtk.WindowControls:side]), so it’s intended to be always used in pair with another GtkWindowControls for the opposite side, for example:

<object class="GtkBox">
  <child>
    <object class="GtkWindowControls">
      <property name="side">start</property>
    </object>
  </child>

  ...

  <child>
    <object class="GtkWindowControls">
      <property name="side">end</property>
    </object>
  </child>
</object>

CSS nodes

windowcontrols
├── [image.icon]
├── [button.minimize]
├── [button.maximize]
╰── [button.close]

A GtkWindowControls‘ CSS node is called windowcontrols. It contains subnodes corresponding to each title button. Which of the title buttons exist and where they are placed exactly depends on the desktop environment and [propertyGtk.WindowControls:decoration-layout] value.

When [propertyGtk.WindowControls:empty] is true, it gets the .empty style class.

Accessibility

GtkWindowControls uses the GTK_ACCESSIBLE_ROLE_GROUP role.

The WindowControls type acts as a reference-counted owner of an underlying GtkWindowControls instance. It provides the methods that can operate on this data type through WindowControlsProtocol conformance. Use WindowControls as a strong reference or owner of a GtkWindowControls instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkWindowControls>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkWindowControls>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkWindowControls>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkWindowControls>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkWindowControls. i.e., ownership is transferred to the WindowControls instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkWindowControls>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements WindowControlsProtocol Will retain GtkWindowControls.

    Declaration

    Swift

    @inlinable
public init<T>(windowControls other: T) where T : WindowControlsProtocol

    Parameters

    other

    an instance of a related type that implements WindowControlsProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to WindowControlsProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a new GtkWindowControls.

    Declaration

    Swift

    @inlinable
public init(side: GtkPackType)
    Show on GitHub