MiscProtocol

public protocol MiscProtocol : WidgetProtocol

The GtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.

The horizontal and vertical padding attributes allows extra space to be added around the widget.

The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widget’s position.

Note that the desired effect can in most cases be achieved by using the GtkWidget:halign, GtkWidget:valign and GtkWidget:margin properties on the child widget, so GtkMisc should not be used in new code. To reflect this fact, all GtkMisc API has been deprecated.

The MiscProtocol protocol exposes the methods and properties of an underlying GtkMisc 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 Misc. Alternatively, use MiscRef as a lighweight, unowned reference if you already have an instance you just want to use.

  • ptr

    Untyped pointer to the underlying GtkMisc instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • misc_ptr Default implementation

    Typed pointer to the underlying GtkMisc instance.

    Default Implementation

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

    Declaration

    Swift

    var misc_ptr: UnsafeMutablePointer<GtkMisc>! { get }
  • Required Initialiser for types conforming to MiscProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

Misc Class

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

    Declaration

    Swift

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

  • get(property:) Extension method

    Get the value of a Misc property

    Declaration

    Swift

    @inlinable
    func get(property: MiscPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

    Set the value of a Misc property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

Misc Class: MiscProtocol extension (methods and fields)

  • getAlignment(xalign:yalign:) Extension method

    Gets the X and Y alignment of the widget within its allocation. See gtk_misc_set_alignment().

    get_alignment is deprecated: Use #GtkWidget alignment and margin properties.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func getAlignment(xalign: UnsafeMutablePointer<gfloat>! = nil, yalign: UnsafeMutablePointer<gfloat>! = nil)
  • getPadding(xpad:ypad:) Extension method

    Gets the padding in the X and Y directions of the widget. See gtk_misc_set_padding().

    get_padding is deprecated: Use #GtkWidget alignment and margin properties.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func getPadding(xpad: UnsafeMutablePointer<gint>! = nil, ypad: UnsafeMutablePointer<gint>! = nil)
  • setAlignment(xalign:yalign:) Extension method

    Sets the alignment of the widget.

    set_alignment is deprecated: Use #GtkWidget’s alignment (#GtkWidget:halign and #GtkWidget:valign) and margin properties or #GtkLabel’s #GtkLabel:xalign and #GtkLabel:yalign properties.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func setAlignment(xalign: Double, yalign: Double)
  • setPadding(xpad:ypad:) Extension method

    Sets the amount of space to add around the widget.

    set_padding is deprecated: Use #GtkWidget alignment and margin properties.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func setPadding(xpad: Int, ypad: Int)
  • widget Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var widget: GtkWidget { get }