RevealerProtocol

public protocol RevealerProtocol : WidgetProtocol

A GtkRevealer animates the transition of its child from invisible to visible.

The style of transition can be controlled with [methodGtk.Revealer.set_transition_type].

These animations respect the [propertyGtk.Settings:gtk-enable-animations] setting.

CSS nodes

GtkRevealer has a single CSS node with name revealer. When styling GtkRevealer using CSS, remember that it only hides its contents, not itself. That means applied margin, padding and borders will be visible even when the [propertyGtk.Revealer:reveal-child] property is set to false.

Accessibility

GtkRevealer uses the GTK_ACCESSIBLE_ROLE_GROUP role.

The child of GtkRevealer, if set, is always available in the accessibility tree, regardless of the state of the revealer widget.

The RevealerProtocol protocol exposes the methods and properties of an underlying GtkRevealer 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 Revealer. Alternatively, use RevealerRef 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 GtkRevealer instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkRevealer instance.

    Default Implementation

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

    Declaration

    Swift

    var revealer_ptr: UnsafeMutablePointer<GtkRevealer>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to RevealerProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Revealer Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Revealer Class: RevealerProtocol extension (methods and fields)

  • getChild() Extension method

    Gets the child widget of revealer.

    Declaration

    Swift

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

    Returns whether the child is fully revealed.

    In other words, this returns whether the transition to the revealed state is completed.

    Declaration

    Swift

    @inlinable
func getChildRevealed() -> Bool
    Show on GitHub
  • getRevealChild() Extension method

    Returns whether the child is currently revealed.

    This function returns true as soon as the transition is to the revealed state is started. To learn whether the child is fully revealed (ie the transition is completed), use [methodGtk.Revealer.get_child_revealed].

    Declaration

    Swift

    @inlinable
func getRevealChild() -> Bool
    Show on GitHub
  • getTransitionDuration() Extension method

    Returns the amount of time (in milliseconds) that transitions will take.

    Declaration

    Swift

    @inlinable
func getTransitionDuration() -> Int
    Show on GitHub
  • getTransitionType() Extension method

    Gets the type of animation that will be used for transitions in revealer.

    Declaration

    Swift

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

    Sets the child widget of revealer.

    Declaration

    Swift

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

    Sets the child widget of revealer.

    Declaration

    Swift

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

    Tells the GtkRevealer to reveal or conceal its child.

    The transition will be animated with the current transition type of revealer.

    Declaration

    Swift

    @inlinable
func set(revealChild: Bool)
    Show on GitHub
  • setTransition(duration:) Extension method

    Sets the duration that transitions will take.

    Declaration

    Swift

    @inlinable
func setTransition(duration: Int)
    Show on GitHub

  • Sets the type of animation that will be used for transitions in revealer.

    Available types include various kinds of fades and slides.

    Declaration

    Swift

    @inlinable
func setTransitionType(transition: GtkRevealerTransitionType)
    Show on GitHub
  • child Extension method

    The child widget.

    Declaration

    Swift

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

    Returns whether the child is fully revealed.

    In other words, this returns whether the transition to the revealed state is completed.

    Declaration

    Swift

    @inlinable
var childRevealed: Bool { get }
    Show on GitHub
  • revealChild Extension method

    Returns whether the child is currently revealed.

    This function returns true as soon as the transition is to the revealed state is started. To learn whether the child is fully revealed (ie the transition is completed), use [methodGtk.Revealer.get_child_revealed].

    Declaration

    Swift

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

    Returns the amount of time (in milliseconds) that transitions will take.

    Declaration

    Swift

    @inlinable
var transitionDuration: Int { get nonmutating set }
    Show on GitHub
  • transitionType Extension method

    Gets the type of animation that will be used for transitions in revealer.

    Declaration

    Swift

    @inlinable
var transitionType: GtkRevealerTransitionType { get nonmutating set }
    Show on GitHub