ViewportProtocol

public protocol ViewportProtocol : ScrollableProtocol, WidgetProtocol

GtkViewport implements scrollability for widgets that lack their own scrolling capabilities.

Use GtkViewport to scroll child widgets such as GtkGrid, GtkBox, and so on.

The GtkViewport will start scrolling content only if allocated less than the child widget’s minimum size in a given orientation.

CSS nodes

GtkViewport has a single CSS node with name viewport.

Accessibility

GtkViewport uses the GTK_ACCESSIBLE_ROLE_GROUP role.

The ViewportProtocol protocol exposes the methods and properties of an underlying GtkViewport 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 Viewport. Alternatively, use ViewportRef 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 GtkViewport instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkViewport instance.

    Default Implementation

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

    Declaration

    Swift

    var viewport_ptr: UnsafeMutablePointer<GtkViewport>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ViewportProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Viewport Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Viewport Class: ViewportProtocol extension (methods and fields)

  • getChild() Extension method

    Gets the child widget of viewport.

    Declaration

    Swift

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

    Gets whether the viewport is scrolling to keep the focused child in view.

    Declaration

    Swift

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

    Sets the child widget of viewport.

    Declaration

    Swift

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

    Sets the child widget of viewport.

    Declaration

    Swift

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

    Sets whether the viewport should automatically scroll to keep the focused child in view.

    Declaration

    Swift

    @inlinable
func set(scrollToFocus: Bool)
    Show on GitHub
  • child Extension method

    The child widget.

    Declaration

    Swift

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

    Gets whether the viewport is scrolling to keep the focused child in view.

    Declaration

    Swift

    @inlinable
var scrollToFocus: Bool { get nonmutating set }
    Show on GitHub