WindowProtocol

public protocol WindowProtocol : ObjectProtocol

AtkWindow should be implemented by the UI elements that represent a top-level window, such as the main window of an application or dialog.

The WindowProtocol protocol exposes the methods and properties of an underlying AtkWindow 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 Window. Alternatively, use WindowRef 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 AtkWindow instance.

    Declaration

    Swift

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

    Typed pointer to the underlying AtkWindow instance.

    Default Implementation

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

    Declaration

    Swift

    var window_ptr: UnsafeMutablePointer<AtkWindow>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to WindowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Window Interface

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Window signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    The signal AtkWindow::activate is emitted when a window becomes the active window of the application or session.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> 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: WindowSignalName { get }
    Show on GitHub
  • onCreate(flags:handler:) Extension method

    The signal AtkWindow::create is emitted when a new window is created.

    Note

    This represents the underlying create signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onCreate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the create signal is emitted
    Show on GitHub
  • createSignal Extension method

    Typed create signal for using the connect(signal:) methods

    Declaration

    Swift

    static var createSignal: WindowSignalName { get }
    Show on GitHub
  • onDeactivate(flags:handler:) Extension method

    The signal AtkWindow::deactivate is emitted when a window is no longer the active window of the application or session.

    Note

    This represents the underlying deactivate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDeactivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the deactivate signal is emitted
    Show on GitHub
  • deactivateSignal Extension method

    Typed deactivate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var deactivateSignal: WindowSignalName { get }
    Show on GitHub
  • onDestroy(flags:handler:) Extension method

    The signal AtkWindow::destroy is emitted when a window is destroyed.

    Note

    This represents the underlying destroy signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDestroy(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the destroy signal is emitted
    Show on GitHub
  • destroySignal Extension method

    Typed destroy signal for using the connect(signal:) methods

    Declaration

    Swift

    static var destroySignal: WindowSignalName { get }
    Show on GitHub
  • onMaximize(flags:handler:) Extension method

    The signal AtkWindow::maximize is emitted when a window is maximized.

    Note

    This represents the underlying maximize signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onMaximize(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the maximize signal is emitted
    Show on GitHub
  • maximizeSignal Extension method

    Typed maximize signal for using the connect(signal:) methods

    Declaration

    Swift

    static var maximizeSignal: WindowSignalName { get }
    Show on GitHub
  • onMinimize(flags:handler:) Extension method

    The signal AtkWindow::minimize is emitted when a window is minimized.

    Note

    This represents the underlying minimize signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onMinimize(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the minimize signal is emitted
    Show on GitHub
  • minimizeSignal Extension method

    Typed minimize signal for using the connect(signal:) methods

    Declaration

    Swift

    static var minimizeSignal: WindowSignalName { get }
    Show on GitHub
  • onMove(flags:handler:) Extension method

    The signal AtkWindow::move is emitted when a window is moved.

    Note

    This represents the underlying move signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onMove(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the move signal is emitted
    Show on GitHub
  • moveSignal Extension method

    Typed move signal for using the connect(signal:) methods

    Declaration

    Swift

    static var moveSignal: WindowSignalName { get }
    Show on GitHub
  • onResize(flags:handler:) Extension method

    The signal AtkWindow::resize is emitted when a window is resized.

    Note

    This represents the underlying resize signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onResize(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the resize signal is emitted
    Show on GitHub
  • resizeSignal Extension method

    Typed resize signal for using the connect(signal:) methods

    Declaration

    Swift

    static var resizeSignal: WindowSignalName { get }
    Show on GitHub
  • onRestore(flags:handler:) Extension method

    The signal AtkWindow::restore is emitted when a window is restored.

    Note

    This represents the underlying restore signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onRestore(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: WindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the restore signal is emitted
    Show on GitHub
  • restoreSignal Extension method

    Typed restore signal for using the connect(signal:) methods

    Declaration

    Swift

    static var restoreSignal: WindowSignalName { get }
    Show on GitHub