adwaita/org.gtkkn.bindings.adw/Leaflet

Leaflet

class Leaflet(val adwLeafletPointer: <Error class: unknown class><<Error class: unknown class>>) : Swipeable(source)

⚠️ Deprecated ⚠️

This is deprecated since version 1.4.

See migrating-to-breakpoints.html#replace-adwleaflet

---

An adaptive container acting like a box or a stack.

leaflet-wide

leaflet-narrow

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

constructor()

This is deprecated since version 1.4.

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

Types

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

This is deprecated since version 1.4.

canNavigateForward

var canNavigateForward: Boolean

This is deprecated since version 1.4.

var canUnfold: Boolean

This is deprecated since version 1.4.

childTransitionParams

var childTransitionParams: SpringParams

This is deprecated since version 1.4.

childTransitionRunning

val childTransitionRunning: Boolean

This is deprecated since version 1.4.

val folded: Boolean

This is deprecated since version 1.4.

foldThresholdPolicy

var foldThresholdPolicy: FoldThresholdPolicy

This is deprecated since version 1.4.

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 homogeneous: Boolean

This is deprecated since version 1.4.

modeTransitionDuration

var modeTransitionDuration: <Error class: unknown class>

This is deprecated since version 1.4.

val pages: <Error class: unknown class>

This is deprecated since version 1.4.

var transitionType: LeafletTransitionType

This is deprecated since version 1.4.

Functions

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

This is deprecated since version 1.4.

getAdjacentChild

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

This is deprecated since version 1.4.

getCancelProgress

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

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

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

This is deprecated since version 1.4.

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

Gets the swipe distance of @self.

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

This is deprecated since version 1.4.

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.

getVisibleChild

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

This is deprecated since version 1.4.

getVisibleChildName

fun getVisibleChildName(): String?

This is deprecated since version 1.4.

insertChildAfter

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

This is deprecated since version 1.4.

fun navigate(direction: NavigationDirection): Boolean

This is deprecated since version 1.4.

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

This is deprecated since version 1.4.

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

This is deprecated since version 1.4.

reorderChildAfter

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

This is deprecated since version 1.4.

setVisibleChild

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

This is deprecated since version 1.4.

setVisibleChildName

fun setVisibleChildName(name: String)

This is deprecated since version 1.4.