RootProtocol

public protocol RootProtocol : NativeProtocol

GtkRoot is the interface implemented by all widgets that can act as a toplevel widget.

The root widget takes care of providing the connection to the windowing system and manages layout, drawing and event delivery for its widget hierarchy.

The obvious example of a GtkRoot is GtkWindow.

To get the display to which a GtkRoot belongs, use [methodGtk.Root.get_display].

GtkRoot also maintains the location of keyboard focus inside its widget hierarchy, with [methodGtk.Root.set_focus] and [methodGtk.Root.get_focus].

The RootProtocol protocol exposes the methods and properties of an underlying GtkRoot 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 Root. Alternatively, use RootRef 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 GtkRoot instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkRoot instance.

    Default Implementation

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

    Declaration

    Swift

    var root_ptr: UnsafeMutablePointer<GtkRoot>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to RootProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Root Interface

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Root Interface: RootProtocol extension (methods and fields)

  • getDisplay() Extension method

    Returns the display that this GtkRoot is on.

    Declaration

    Swift

    @inlinable
func getDisplay() -> Gdk.DisplayRef!
    Show on GitHub
  • getFocus() Extension method

    Retrieves the current focused widget within the root.

    Note that this is the widget that would have the focus if the root is active; if the root is not focused then gtk_widget_has_focus (widget) will be false for the widget.

    Declaration

    Swift

    @inlinable
func getFocus() -> WidgetRef!
    Show on GitHub
  • set(focus:) Extension method

    If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root.

    If focus is nil, unsets the focus widget for the root.

    To set the focus to a particular widget in the root, it is usually more convenient to use [methodGtk.Widget.grab_focus] instead of this function.

    Declaration

    Swift

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

    If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root.

    If focus is nil, unsets the focus widget for the root.

    To set the focus to a particular widget in the root, it is usually more convenient to use [methodGtk.Widget.grab_focus] instead of this function.

    Declaration

    Swift

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

    Returns the display that this GtkRoot is on.

    Declaration

    Swift

    @inlinable
var display: Gdk.DisplayRef! { get }
    Show on GitHub
  • focus Extension method

    Retrieves the current focused widget within the root.

    Note that this is the widget that would have the focus if the root is active; if the root is not focused then gtk_widget_has_focus (widget) will be false for the widget.

    Declaration

    Swift

    @inlinable
var focus: WidgetRef! { get nonmutating set }
    Show on GitHub