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.

Available since:1.0

Constructors

adw_carousel_new

Creates a new AdwCarousel.

Available since: 1.0

Instance methods

adw_carousel_append

Appends child to self.

Available since: 1.0

adw_carousel_get_allow_long_swipes

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

Available since: 1.0

adw_carousel_get_allow_mouse_drag

Sets whether self can be dragged with mouse pointer.

Available since: 1.0

adw_carousel_get_allow_scroll_wheel

Gets whether self will respond to scroll wheel events.

Available since: 1.0

adw_carousel_get_animation_duration

Gets the animation duration used by adw_carousel_scroll_to()().

Available since: 1.0

adw_carousel_get_interactive

Gets whether self can be navigated.

Available since: 1.0

adw_carousel_get_n_pages

Gets the number of pages in self.

Available since: 1.0

adw_carousel_get_nth_page

Gets the page at position n.

Available since: 1.0

adw_carousel_get_position

Gets current scroll position in self.

Available since: 1.0

adw_carousel_get_reveal_duration

Gets duration of the animation used when adding or removing pages.

Available since: 1.0

adw_carousel_get_spacing

Gets spacing between pages in pixels.

Available since: 1.0

adw_carousel_insert

Inserts child into self at position position.

Available since: 1.0

adw_carousel_prepend

Prepends child to self.

Available since: 1.0

adw_carousel_remove

Removes child from self.

Available since: 1.0

adw_carousel_reorder

Moves child into position position.

Available since: 1.0

adw_carousel_scroll_to

Scrolls to widget with an animation.

Available since: 1.0

adw_carousel_scroll_to_full

Scrolls to widget with an animation.

Available since: 1.0

adw_carousel_set_allow_long_swipes

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

Available since: 1.0

adw_carousel_set_allow_mouse_drag

Sets whether self can be dragged with mouse pointer.

Available since: 1.0

adw_carousel_set_allow_scroll_wheel

Sets whether self will respond to scroll wheel events.

Available since: 1.0

adw_carousel_set_animation_duration

Sets the animation duration used by adw_carousel_scroll_to()().

Available since: 1.0

adw_carousel_set_interactive

Sets whether self can be navigated.

Available since: 1.0

adw_carousel_set_reveal_duration

Sets duration of the animation used when adding or removing pages.

Available since: 1.0

adw_carousel_set_spacing

Sets spacing between pages in pixels.

Available since: 1.0

Methods inherited from GtkWidget (159)
Methods inherited from GObject (42)
Methods inherited from AdwSwipeable (5)
adw_swipeable_get_cancel_progress

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

Available since: 1.0

adw_swipeable_get_distance

Gets the swipe distance of self.

Available since: 1.0

adw_swipeable_get_progress

Gets the current progress of self.

Available since: 1.0

adw_swipeable_get_snap_points

Gets the snap points of self.

Available since: 1.0

adw_swipeable_get_swipe_area

Gets the area self can start a swipe from for the given direction and gesture type.

Available since: 1.0

Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties

Adw.Carousel:allow-long-swipes

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

Available since: 1.0

Adw.Carousel:allow-mouse-drag

Sets whether the AdwCarousel can be dragged with mouse pointer.

Available since: 1.0

Adw.Carousel:allow-scroll-wheel

Whether the widget will respond to scroll wheel events.

Available since: 1.0

Adw.Carousel:animation-duration

Animation duration in milliseconds, used by adw_carousel_scroll_to()().

Available since: 1.0

Adw.Carousel:interactive

Whether the carousel can be navigated.

Available since: 1.0

Adw.Carousel:n-pages

The number of pages in a AdwCarousel.

Available since: 1.0

Adw.Carousel:position

Current scrolling position, unitless.

Available since: 1.0

Adw.Carousel:reveal-duration

Page reveal duration in milliseconds.

Available since: 1.0

Adw.Carousel:spacing

Spacing between pages in pixels.

Available since: 1.0

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkOrientable (1)
Gtk.Orientable:orientation

The orientation of the orientable.

Signals

Adw.Carousel::page-changed

This signal is emitted after a page has been changed.

Available since: 1.0

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct AdwCarouselClass {
  GtkWidgetClass parent_class;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.