AspectFrameProtocol

public protocol AspectFrameProtocol : WidgetProtocol

GtkAspectFrame preserves the aspect ratio of its child.

The frame can respect the aspect ratio of the child widget, or use its own aspect ratio.

CSS nodes

GtkAspectFrame uses a CSS node with name frame.

The AspectFrameProtocol protocol exposes the methods and properties of an underlying GtkAspectFrame 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 AspectFrame. Alternatively, use AspectFrameRef 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 GtkAspectFrame instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkAspectFrame instance.

    Default Implementation

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

    Declaration

    Swift

    var aspect_frame_ptr: UnsafeMutablePointer<GtkAspectFrame>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to AspectFrameProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

AspectFrame Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

AspectFrame Class: AspectFrameProtocol extension (methods and fields)

  • getChild() Extension method

    Gets the child widget of self.

    Declaration

    Swift

    @inlinable
func getChild() -> WidgetRef!
    Show on GitHub
  • getObeyChild() Extension method

    Returns whether the child’s size request should override the set aspect ratio of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func getObeyChild() -> Bool
    Show on GitHub
  • getRatio() Extension method

    Returns the desired aspect ratio of the child.

    Declaration

    Swift

    @inlinable
func getRatio() -> CFloat
    Show on GitHub
  • getXalign() Extension method

    Returns the horizontal alignment of the child within the allocation of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func getXalign() -> CFloat
    Show on GitHub
  • getYalign() Extension method

    Returns the vertical alignment of the child within the allocation of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func getYalign() -> CFloat
    Show on GitHub
  • set(child:) Extension method

    Sets the child widget of self.

    Declaration

    Swift

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

    Sets the child widget of self.

    Declaration

    Swift

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

    Sets whether the aspect ratio of the child’s size request should override the set aspect ratio of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func set(obeyChild: Bool)
    Show on GitHub
  • set(ratio:) Extension method

    Sets the desired aspect ratio of the child.

    Declaration

    Swift

    @inlinable
func set(ratio: CFloat)
    Show on GitHub
  • set(xalign:) Extension method

    Sets the horizontal alignment of the child within the allocation of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func set(xalign: CFloat)
    Show on GitHub
  • set(yalign:) Extension method

    Sets the vertical alignment of the child within the allocation of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
func set(yalign: CFloat)
    Show on GitHub
  • child Extension method

    The child widget.

    Declaration

    Swift

    @inlinable
var child: WidgetRef! { get nonmutating set }
    Show on GitHub
  • obeyChild Extension method

    Returns whether the child’s size request should override the set aspect ratio of the GtkAspectFrame.

    Declaration

    Swift

    @inlinable
var obeyChild: Bool { get nonmutating set }
    Show on GitHub
  • ratio Extension method

    The aspect ratio to be used by the GtkAspectFrame.

    This property is only used if [propertyGtk.AspectFrame:obey-child] is set to false.

    Declaration

    Swift

    @inlinable
var ratio: CFloat { get nonmutating set }
    Show on GitHub
  • xalign Extension method

    The horizontal alignment of the child.

    Declaration

    Swift

    @inlinable
var xalign: CFloat { get nonmutating set }
    Show on GitHub
  • yalign Extension method

    The vertical alignment of the child.

    Declaration

    Swift

    @inlinable
var yalign: CFloat { get nonmutating set }
    Show on GitHub