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

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.

getAllowLongSwipes

fun getAllowLongSwipes(): Boolean

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

getAllowMouseDrag

fun getAllowMouseDrag(): Boolean

Sets whether @self can be dragged with mouse pointer.

getAllowScrollWheel

fun getAllowScrollWheel(): Boolean

Gets whether @self will respond to scroll wheel events.

getCancelProgress

open fun getCancelProgress(): Double

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

getDistance

open fun getDistance(): Double

Gets the swipe distance of @self.

getInteractive

fun getInteractive(): Boolean

Gets whether @self can be navigated.

getNPages

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

Gets the number of pages in @self.

getNthPage

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

Gets the page at position @n.

getPosition

fun getPosition(): Double

Gets current scroll position in @self, unitless.

getProgress

open fun getProgress(): Double

Gets the current progress of @self.

getRevealDuration

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

Gets the page reveal duration, in milliseconds.

getScrollParams

fun getScrollParams(): SpringParams

Gets the scroll animation spring parameters for @self.

getSpacing

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

Gets spacing between pages in pixels.

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: Int)

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: Int)

Moves @child into position @position.

scrollTo

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

Scrolls to @widget.

setAllowLongSwipes

fun setAllowLongSwipes(allowLongSwipes: Boolean)

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

setAllowMouseDrag

fun setAllowMouseDrag(allowMouseDrag: Boolean)

Sets whether @self can be dragged with mouse pointer.

setAllowScrollWheel

fun setAllowScrollWheel(allowScrollWheel: Boolean)

Sets whether @self will respond to scroll wheel events.

setInteractive

fun setInteractive(interactive: Boolean)

Sets whether @self can be navigated.

setRevealDuration

fun setRevealDuration(revealDuration: <Error class: unknown class>)

Sets the page reveal duration, in milliseconds.

setScrollParams

fun setScrollParams(params: SpringParams)

Sets the scroll animation spring parameters for @self.

setSpacing

fun setSpacing(spacing: <Error class: unknown class>)

Sets spacing between pages in pixels.