adwaita/org.gtkkn.bindings.adw/Flap

Flap

class Flap(pointer: <Error class: unknown class><<Error class: unknown class>>) : Swipeable

An adaptive container acting like a box or an overlay.

flap-wide

flap-narrow

The AdwFlap widget can display its children like a class@Gtk.Box does or like a class@Gtk.Overlay does, according to the property@Flap:fold-policy value.

AdwFlap has at most three children: property@Flap:content, property@Flap:flap and property@Flap:separator. Content is the primary child, flap is displayed next to it when unfolded, or overlays it when folded. Flap can be shown or hidden by changing the property@Flap:reveal-flap value, as well as via swipe gestures if property@Flap:swipe-to-open and/or property@Flap:swipe-to-close are set to TRUE.

Optionally, a separator can be provided, which would be displayed between the content and the flap when there's no shadow to separate them, depending on the transition type.

property@Flap:flap is transparent by default; add the style-classes.html#background style class to it if this is unwanted.

If property@Flap:modal is set to TRUE, content becomes completely inaccessible when the flap is revealed while folded.

The position of the flap and separator children relative to the content is determined by orientation, as well as the property@Flap:flap-position value.

Folding the flap will automatically hide the flap widget, and unfolding it will automatically reveal it. If this behavior is not desired, the property@Flap:locked property can be used to override it.

Common use cases include sidebars, header bars that need to be able to overlap the window content (for example, in fullscreen mode) and bottom sheets.

AdwFlap as GtkBuildable

The AdwFlap implementation of the iface@Gtk.Buildable interface supports setting the flap child by specifying “flap” as the “type” attribute of a <child> element, and separator by specifying “separator”. Specifying “content” child type or omitting it results in setting the content child.

CSS nodes

AdwFlap has a single CSS node with name flap. The node will get the style classes .folded when it is folded, and .unfolded when it's not.

Constructors

constructor()

Creates a new AdwFlap.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

val adwFlapPointer: <Error class: unknown class><<Error class: unknown class>>

adwSwipeablePointer

open override val adwSwipeablePointer: <Error class: unknown class><<Error class: unknown class>>

var content: <Error class: unknown class>?

The content widget.

var flap: <Error class: unknown class>?

The flap widget.

var flapPosition: <Error class: unknown class>

The flap position.

var foldDuration: <Error class: unknown class>

The fold transition animation duration, in milliseconds.

val folded: Boolean

Whether the flap is currently folded.

var foldPolicy: FlapFoldPolicy

The fold policy for the flap.

foldThresholdPolicy

var foldThresholdPolicy: FoldThresholdPolicy

Determines when the flap will fold.

gtkAccessiblePointer

open val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

gtkOrientablePointer

open val gtkOrientablePointer: <Error class: unknown class><<Error class: unknown class>>

var locked: Boolean

Whether the flap is locked.

var modal: Boolean

Whether the flap is modal.

var revealFlap: Boolean

Whether the flap widget is revealed.

var revealParams: SpringParams

The reveal animation spring parameters.

val revealProgress: <Error class: unknown class>

The current reveal transition progress.

var separator: <Error class: unknown class>?

The separator widget.

var swipeToClose: Boolean

Whether the flap can be closed with a swipe gesture.

var swipeToOpen: Boolean

Whether the flap can be opened with a swipe gesture.

var transitionType: FlapTransitionType

the type of animation used for reveal and fold transitions.

Functions

getCancelProgress

open fun getCancelProgress(): <Error class: unknown class>

Gets the progress @self will snap back to after the gesture is canceled.

open fun getDistance(): <Error class: unknown class>

Gets the swipe distance of @self.

open fun getProgress(): <Error class: unknown class>

Gets the current progress of @self.

open fun getSwipeArea(navigationDirection: NavigationDirection, isDrag: Boolean, rect: <Error class: unknown class>)

Gets the area @self can start a swipe from for the given direction and gesture type.