ViewportProtocol

public protocol ViewportProtocol : BinProtocol, ScrollableProtocol

The GtkViewport widget acts as an adaptor class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use GtkViewport to scroll child widgets such as GtkGrid, GtkBox, and so on.

If a widget has native scrolling abilities, such as GtkTextView, GtkTreeView or GtkIconView, it can be added to a GtkScrolledWindow with gtk_container_add(). If a widget does not, you must first add the widget to a GtkViewport, then add the viewport to the scrolled window. gtk_container_add() does this automatically if a child that does not implement GtkScrollable is added to a GtkScrolledWindow, so you can ignore the presence of the viewport.

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.

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)

  • getBinWindow() Extension method

    Gets the bin window of the GtkViewport.

    Declaration

    Swift

    @inlinable
func getBinWindow() -> Gdk.WindowRef!
    Show on GitHub
  • getHadjustment() Extension method

    Returns the horizontal adjustment of the viewport.

    get_hadjustment is deprecated: Use gtk_scrollable_get_hadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getHadjustment() -> AdjustmentRef!
    Show on GitHub
  • getShadowType() Extension method

    Gets the shadow type of the GtkViewport. See gtk_viewport_set_shadow_type().

    Declaration

    Swift

    @inlinable
func getShadowType() -> GtkShadowType
    Show on GitHub
  • getVadjustment() Extension method

    Returns the vertical adjustment of the viewport.

    get_vadjustment is deprecated: Use gtk_scrollable_get_vadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getVadjustment() -> AdjustmentRef!
    Show on GitHub
  • getViewWindow() Extension method

    Gets the view window of the GtkViewport.

    Declaration

    Swift

    @inlinable
func getViewWindow() -> Gdk.WindowRef!
    Show on GitHub
  • setHadjustment(adjustment:) Extension method

    Sets the horizontal adjustment of the viewport.

    set_hadjustment is deprecated: Use gtk_scrollable_set_hadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setHadjustment(adjustment: AdjustmentRef? = nil)
    Show on GitHub
  • setHadjustment(adjustment:) Extension method

    Sets the horizontal adjustment of the viewport.

    set_hadjustment is deprecated: Use gtk_scrollable_set_hadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setHadjustment<AdjustmentT>(adjustment: AdjustmentT?) where AdjustmentT : AdjustmentProtocol
    Show on GitHub
  • setShadow(type:) Extension method

    Sets the shadow type of the viewport.

    Declaration

    Swift

    @inlinable
func setShadow(type: GtkShadowType)
    Show on GitHub
  • setVadjustment(adjustment:) Extension method

    Sets the vertical adjustment of the viewport.

    set_vadjustment is deprecated: Use gtk_scrollable_set_vadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setVadjustment(adjustment: AdjustmentRef? = nil)
    Show on GitHub
  • setVadjustment(adjustment:) Extension method

    Sets the vertical adjustment of the viewport.

    set_vadjustment is deprecated: Use gtk_scrollable_set_vadjustment()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setVadjustment<AdjustmentT>(adjustment: AdjustmentT?) where AdjustmentT : AdjustmentProtocol
    Show on GitHub
  • binWindow Extension method

    Gets the bin window of the GtkViewport.

    Declaration

    Swift

    @inlinable
var binWindow: Gdk.WindowRef! { get }
    Show on GitHub
  • hadjustment Extension method

    Returns the horizontal adjustment of the viewport.

    get_hadjustment is deprecated: Use gtk_scrollable_get_hadjustment()

    Declaration

    Swift

    @inlinable
var hadjustment: AdjustmentRef! { get nonmutating set }
    Show on GitHub
  • shadowType Extension method

    Gets the shadow type of the GtkViewport. See gtk_viewport_set_shadow_type().

    Declaration

    Swift

    @inlinable
var shadowType: GtkShadowType { get nonmutating set }
    Show on GitHub
  • vadjustment Extension method

    Returns the vertical adjustment of the viewport.

    get_vadjustment is deprecated: Use gtk_scrollable_get_vadjustment()

    Declaration

    Swift

    @inlinable
var vadjustment: AdjustmentRef! { get nonmutating set }
    Show on GitHub
  • viewWindow Extension method

    Gets the view window of the GtkViewport.

    Declaration

    Swift

    @inlinable
var viewWindow: Gdk.WindowRef! { get }
    Show on GitHub
  • bin Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var bin: GtkBin { get }
    Show on GitHub