Class
AdwCarousel
Description [src]
final class Adw.Carousel : Gtk.Widget {
/* No available fields */
}A paginated scrolling widget.
The AdwCarousel widget can be used to display a set of pages with
swipe-based navigation between them.
AdwCarouselIndicatorDots and AdwCarouselIndicatorLines can be used
to provide page indicators for AdwCarousel.
CSS nodes
AdwCarousel has a single CSS node with name carousel.
Implements
- AdwSwipeable
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable
Constructors
adw_carousel_new
Creates a new AdwCarousel.
Instance methods
adw_carousel_append
Appends child to self.
adw_carousel_get_allow_long_swipes
Gets whether to allow swiping for more than one page at a time.
adw_carousel_get_allow_mouse_drag
Sets whether self can be dragged with mouse pointer.
adw_carousel_get_allow_scroll_wheel
Gets whether self will respond to scroll wheel events.
adw_carousel_get_interactive
Gets whether self can be navigated.
adw_carousel_get_n_pages
Gets the number of pages in self.
adw_carousel_get_nth_page
Gets the page at position n.
adw_carousel_get_position
Gets current scroll position in self, unitless.
adw_carousel_get_reveal_duration
Gets the page reveal duration, in milliseconds.
adw_carousel_get_scroll_params
Gets the scroll animation spring parameters for self.
adw_carousel_get_spacing
Gets spacing between pages in pixels.
adw_carousel_insert
Inserts child into self at position position.
adw_carousel_prepend
Prepends child to self.
adw_carousel_remove
Removes child from self.
adw_carousel_reorder
Moves child into position position.
adw_carousel_scroll_to
Scrolls to widget.
adw_carousel_set_allow_long_swipes
Sets whether to allow swiping for more than one page at a time.
adw_carousel_set_allow_mouse_drag
Sets whether self can be dragged with mouse pointer.
adw_carousel_set_allow_scroll_wheel
Sets whether self will respond to scroll wheel events.
adw_carousel_set_interactive
Sets whether self can be navigated.
adw_carousel_set_reveal_duration
Sets the page reveal duration, in milliseconds.
adw_carousel_set_scroll_params
Sets the scroll animation spring parameters for self.
adw_carousel_set_spacing
Sets spacing between pages in pixels.
Methods inherited from AdwSwipeable (5)
adw_swipeable_get_cancel_progress
Gets the progress self will snap back to after the gesture is canceled.
adw_swipeable_get_distance
Gets the swipe distance of self.
adw_swipeable_get_progress
Gets the current progress of self.
adw_swipeable_get_snap_points
Gets the snap points of self.
adw_swipeable_get_swipe_area
Gets the area self can start a swipe from for the given direction and
gesture type.
Properties
Adw.Carousel:allow-long-swipes
Whether to allow swiping for more than one page at a time.
Adw.Carousel:allow-mouse-drag
Sets whether the AdwCarousel can be dragged with mouse pointer.
Adw.Carousel:allow-scroll-wheel
Whether the widget will respond to scroll wheel events.
Adw.Carousel:interactive
Whether the carousel can be navigated.
Adw.Carousel:n-pages
The number of pages in a AdwCarousel.
Adw.Carousel:position
Current scrolling position, unitless.
Adw.Carousel:reveal-duration
Page reveal duration, in milliseconds.
Adw.Carousel:scroll-params
Scroll animation spring parameters.
Adw.Carousel:spacing
Spacing between pages in pixels.
Signals
Adw.Carousel::page-changed
This signal is emitted after a page has been changed.