adwaita/org.gtkkn.bindings.adw/Carousel

Carousel

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

A paginated scrolling widget.

The AdwCarousel widget can be used to display a set of pages with swipe-based navigation between them.

class@CarouselIndicatorDots and class@CarouselIndicatorLines can be used to provide page indicators for AdwCarousel.

CSS nodes

AdwCarousel has a single CSS node with name carousel.

Constructors

Carousel

constructor()

Creates a new AdwCarousel.

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

Types

Companion

object Companion

Properties

adwCarouselPointer

val adwCarouselPointer: <Error class: unknown class><<Error class: unknown class>>

adwSwipeablePointer

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

allowLongSwipes

var allowLongSwipes: Boolean

Whether to allow swiping for more than one page at a time.

allowMouseDrag

var allowMouseDrag: Boolean

Sets whether the AdwCarousel can be dragged with mouse pointer.

allowScrollWheel

var allowScrollWheel: Boolean

Whether the widget will respond to scroll wheel events.

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>>

interactive

var interactive: Boolean

Whether the carousel can be navigated.

nPages

val nPages: <Error class: unknown class>

The number of pages in a AdwCarousel.

position

val position: <Error class: unknown class>

Current scrolling position, unitless.

revealDuration

var revealDuration: <Error class: unknown class>

Page reveal duration, in milliseconds.

scrollParams

var scrollParams: SpringParams

Scroll animation spring parameters.

spacing

var spacing: <Error class: unknown class>

Spacing between pages in pixels.

Functions

append

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

Appends @child to @self.

connectPageChanged

fun connectPageChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

This signal is emitted after a page has been changed.

getCancelProgress

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

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

getDistance

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

Gets the swipe distance of @self.

getNthPage

fun getNthPage(n: <Error class: unknown class>): <Error class: unknown class>

Gets the page at position @n.

getProgress

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

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.

insert

fun insert(child: <Error class: unknown class>, position: <Error class: unknown class>)

Inserts @child into @self at position @position.

prepend

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

Prepends @child to @self.

remove

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

Removes @child from @self.

reorder

fun reorder(child: <Error class: unknown class>, position: <Error class: unknown class>)

Moves @child into position @position.

scrollTo

fun scrollTo(widget: <Error class: unknown class>, animate: Boolean)

Scrolls to @widget.