adwaita/org.gtkkn.bindings.adw/Leaflet

Leaflet

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

An adaptive container acting like a box or a stack.

The AdwLeaflet widget can display its children like a class@Gtk.Box does or like a class@Gtk.Stack does, adapting to size changes by switching between the two modes.

When there is enough space the children are displayed side by side, otherwise only one is displayed and the leaflet is said to be “folded”. The threshold is dictated by the preferred minimum sizes of the children. When a leaflet is folded, the children can be navigated using swipe gestures.

The “over” and “under” transition types stack the children one on top of the other, while the “slide” transition puts the children side by side. While navigating to a child on the side or below can be performed by swiping the current child away, navigating to an upper child requires dragging it from the edge where it resides. This doesn't affect non-dragging swipes.

CSS nodes

AdwLeaflet has a single CSS node with name leaflet. The node will get the style classes .folded when it is folded, .unfolded when it's not, or none if it hasn't computed its fold yet.

Skipped during bindings generation

method visible-child: Property TypeInfo of getter and setter do not match
method visible-child-name: Property TypeInfo of getter and setter do not match

Constructors

Leaflet

constructor()

Creates a new AdwLeaflet.

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

Types

Companion

object Companion

Properties

adwLeafletPointer

val adwLeafletPointer: <Error class: unknown class><<Error class: unknown class>>

adwSwipeablePointer

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

canNavigateBack

var canNavigateBack: Boolean

Whether gestures and shortcuts for navigating backward are enabled.

canNavigateForward

var canNavigateForward: Boolean

Whether gestures and shortcuts for navigating forward are enabled.

canUnfold

var canUnfold: Boolean

Whether or not the leaflet can unfold.

childTransitionParams

var childTransitionParams: SpringParams

The child transition spring parameters.

childTransitionRunning

val childTransitionRunning: Boolean

Whether a child transition is currently running.

folded

val folded: Boolean

Whether the leaflet is folded.

foldThresholdPolicy

var foldThresholdPolicy: FoldThresholdPolicy

Determines when the leaflet 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>>

homogeneous

var homogeneous: Boolean

Whether the leaflet allocates the same size for all children when folded.

modeTransitionDuration

var modeTransitionDuration: <Error class: unknown class>

The mode transition animation duration, in milliseconds.

pages

val pages: <Error class: unknown class>

A selection model with the leaflet's pages.

transitionType

var transitionType: LeafletTransitionType

The type of animation used for transitions between modes and children.

Functions

append

fun append(child: <Error class: unknown class>): LeafletPage

Adds a child to @self.

getAdjacentChild

fun getAdjacentChild(direction: NavigationDirection): <Error class: unknown class>?

Finds the previous or next navigatable child.

getCancelProgress

open fun getCancelProgress(): Double

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

getCanNavigateBack

fun getCanNavigateBack(): Boolean

Gets whether gestures and shortcuts for navigating backward are enabled.

getCanNavigateForward

fun getCanNavigateForward(): Boolean

Gets whether gestures and shortcuts for navigating forward are enabled.

getCanUnfold

fun getCanUnfold(): Boolean

Gets whether @self can unfold.

getChildByName

fun getChildByName(name: String): <Error class: unknown class>?

Finds the child of @self with @name.

getChildTransitionParams

fun getChildTransitionParams(): SpringParams

Gets the child transition spring parameters for @self.

getChildTransitionRunning

fun getChildTransitionRunning(): Boolean

Gets whether a child transition is currently running for @self.

getDistance

open fun getDistance(): Double

Gets the swipe distance of @self.

getFolded

fun getFolded(): Boolean

Gets whether @self is folded.

getFoldThresholdPolicy

fun getFoldThresholdPolicy(): FoldThresholdPolicy

Gets the fold threshold policy for @self.

getHomogeneous

fun getHomogeneous(): Boolean

Gets whether @self is homogeneous.

getModeTransitionDuration

fun getModeTransitionDuration(): <Error class: unknown class>

Gets the mode transition animation duration for @self.

getPage

fun getPage(child: <Error class: unknown class>): LeafletPage

Returns the class@LeafletPage object for @child.

getPages

fun getPages(): <Error class: unknown class>

Returns a iface@Gio.ListModel that contains the pages of the leaflet.

getProgress

open fun getProgress(): Double

Gets the current progress of @self.

getSwipeArea

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.

getTransitionType

fun getTransitionType(): LeafletTransitionType

Gets the type of animation used for transitions between modes and children.

getVisibleChild

fun getVisibleChild(): <Error class: unknown class>?

Gets the widget currently visible when the leaflet is folded.

getVisibleChildName

fun getVisibleChildName(): String?

Gets the name of the currently visible child widget.

insertChildAfter

fun insertChildAfter(child: <Error class: unknown class>, sibling: <Error class: unknown class>? = null): LeafletPage

Inserts @child in the position after @sibling in the list of children.

navigate

fun navigate(direction: NavigationDirection): Boolean

Navigates to the previous or next child.

prepend

fun prepend(child: <Error class: unknown class>): LeafletPage

Inserts @child at the first position in @self.

remove

fun remove(child: <Error class: unknown class>)

Removes a child widget from @self.

reorderChildAfter

fun reorderChildAfter(child: <Error class: unknown class>, sibling: <Error class: unknown class>? = null)

Moves @child to the position after @sibling in the list of children.

setCanNavigateBack

fun setCanNavigateBack(canNavigateBack: Boolean)

Sets whether gestures and shortcuts for navigating backward are enabled.

setCanNavigateForward

fun setCanNavigateForward(canNavigateForward: Boolean)

Sets whether gestures and shortcuts for navigating forward are enabled.

setCanUnfold

fun setCanUnfold(canUnfold: Boolean)

Sets whether @self can unfold.

setChildTransitionParams

fun setChildTransitionParams(params: SpringParams)

Sets the child transition spring parameters for @self.

setFoldThresholdPolicy

fun setFoldThresholdPolicy(policy: FoldThresholdPolicy)

Sets the fold threshold policy for @self.

setHomogeneous

fun setHomogeneous(homogeneous: Boolean)

Sets @self to be homogeneous or not.

setModeTransitionDuration

fun setModeTransitionDuration(duration: <Error class: unknown class>)

Sets the mode transition animation duration for @self.

setTransitionType

fun setTransitionType(transition: LeafletTransitionType)

Sets the type of animation used for transitions between modes and children.

setVisibleChild

fun setVisibleChild(visibleChild: <Error class: unknown class>)

Sets the widget currently visible when the leaflet is folded.

setVisibleChildName

fun setVisibleChildName(name: String)

Makes the child with the name @name visible.