Carousel
Object Hierarchy:
Description:
[ CCode ( type_id = "adw_carousel_get_type ()" ) ]
public sealed class Carousel : Widget, Swipeable, Accessible, Buildable, ConstraintTarget, Orientable
public sealed class Carousel : Widget, Swipeable, Accessible, Buildable, ConstraintTarget, Orientable
A paginated scrolling widget.
<picture> <source srcset="carousel-dark.png" media="(prefers-color-scheme: dark)"> <img src="carousel.png" alt="carousel"> </picture>
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`.
Namespace: Adw
Package: libadwaita-1
Content:
Properties:
- public bool allow_long_swipes { get; set; }
Whether to allow swiping for more than one page at a time.
- public bool allow_mouse_drag { get; set; }
Sets whether the `AdwCarousel` can be dragged with mouse pointer.
- public bool allow_scroll_wheel { get; set; }
Whether the widget will respond to scroll wheel events.
- public bool interactive { get; set; }
Whether the carousel can be navigated.
- public uint n_pages { get; }
The number of pages in a `AdwCarousel`.
- public double position { get; }
Current scrolling position, unitless.
- public uint reveal_duration { get; set; }
Page reveal duration, in milliseconds.
- public SpringParams scroll_params { owned get; set; }
Scroll animation spring parameters.
- public uint spacing { get; set; }
Spacing between pages in pixels.
Creation methods:
- public Carousel ()
Creates a new `AdwCarousel`.
Methods:
- public void append (Widget child)
Appends
child
to this. - public bool get_allow_long_swipes ()
Gets whether to allow swiping for more than one page at a time.
- public bool get_allow_mouse_drag ()
Sets whether this can be dragged with mouse pointer.
- public bool get_allow_scroll_wheel ()
Gets whether this will respond to scroll wheel events.
- public bool get_interactive ()
Gets whether this can be navigated.
- public uint get_n_pages ()
Gets the number of pages in this.
- public unowned Widget get_nth_page (uint n)
Gets the page at position
n
. - public double get_position ()
Gets current scroll position in this, unitless.
- public uint get_reveal_duration ()
Gets the page reveal duration, in milliseconds.
- public SpringParams get_scroll_params ()
Gets the scroll animation spring parameters for this.
- public uint get_spacing ()
Gets spacing between pages in pixels.
- public void insert (Widget child, int position)
Inserts
child
into this at positionposition
. - public void prepend (Widget child)
Prepends
child
to this. - public void remove (Widget child)
Removes
child
from this. - public void reorder (Widget child, int position)
Moves
child
into positionposition
. - public void scroll_to (Widget widget, bool animate)
Scrolls to
widget
. - public void set_allow_long_swipes (bool allow_long_swipes)
Sets whether to allow swiping for more than one page at a time.
- public void set_allow_mouse_drag (bool allow_mouse_drag)
Sets whether this can be dragged with mouse pointer.
- public void set_allow_scroll_wheel (bool allow_scroll_wheel)
Sets whether this will respond to scroll wheel events.
- public void set_interactive (bool interactive)
Sets whether this can be navigated.
- public void set_reveal_duration (uint reveal_duration)
Sets the page reveal duration, in milliseconds.
- public void set_scroll_params (SpringParams @params)
Sets the scroll animation spring parameters for this.
- public void set_spacing (uint spacing)
Sets spacing between pages in pixels.
Signals:
- public signal void page_changed (uint index)
This signal is emitted after a page has been changed.
Inherited Members:
All known members inherited from class Gtk.Widget
- action_set_enabled
- activate
- activate_action
- activate_action_variant
- activate_default
- add_binding
- add_binding_action
- add_binding_signal
- add_controller
- add_css_class
- add_mnemonic_label
- add_shortcut
- add_tick_callback
- allocate
- allocate_size
- bind_template_callback_full
- bind_template_child_full
- can_focus
- can_target
- child_focus
- compute_bounds
- compute_expand
- compute_expand_internal
- compute_point
- compute_transform
- contains
- create_pango_context
- create_pango_layout
- css_changed
- css_classes
- css_name
- cursor
- destroy
- direction_changed
- dispose_template
- error_bell
- focus
- focus_on_click
- focusable
- get_accessible_role
- get_activate_signal
- get_allocated_baseline
- get_allocated_height
- get_allocated_width
- get_allocation
- get_ancestor
- get_baseline
- get_can_focus
- get_can_target
- get_child_visible
- get_clipboard
- get_color
- get_css_classes
- get_css_name
- get_cursor
- get_default_direction
- get_direction
- get_display
- get_first_child
- get_focus_child
- get_focus_on_click
- get_focusable
- get_font_map
- get_font_options
- get_frame_clock
- get_halign
- get_has_tooltip
- get_height
- get_hexpand
- get_hexpand_set
- get_last_child
- get_layout_manager
- get_layout_manager_type
- get_mapped
- get_margin_bottom
- get_margin_end
- get_margin_start
- get_margin_top
- get_name
- get_native
- get_next_sibling
- get_opacity
- get_overflow
- get_pango_context
- get_parent
- get_preferred_size
- get_prev_sibling
- get_primary_clipboard
- get_realized
- get_receives_default
- get_request_mode
- get_root
- get_scale_factor
- get_sensitive
- get_settings
- get_size
- get_size_request
- get_state_flags
- get_style_context
- get_template_child
- get_tooltip_markup
- get_tooltip_text
- get_valign
- get_vexpand
- get_vexpand_set
- get_visible
- get_width
- grab_focus
- halign
- has_css_class
- has_default
- has_focus
- has_tooltip
- has_visible_focus
- height_request
- hexpand
- hexpand_set
- hide
- in_destruction
- init_template
- insert_action_group
- insert_after
- insert_before
- install_action
- install_property_action
- is_ancestor
- is_drawable
- is_focus
- is_sensitive
- is_visible
- keynav_failed
- layout_manager
- list_mnemonic_labels
- map
- margin_bottom
- margin_end
- margin_start
- margin_top
- measure
- mnemonic_activate
- move_focus
- name
- observe_children
- observe_controllers
- opacity
- overflow
- parent
- pick
- query_action
- query_tooltip
- queue_allocate
- queue_draw
- queue_resize
- realize
- receives_default
- remove_controller
- remove_css_class
- remove_mnemonic_label
- remove_tick_callback
- root
- scale_factor
- sensitive
- set_accessible_role
- set_activate_signal
- set_activate_signal_from_name
- set_can_focus
- set_can_target
- set_child_visible
- set_css_classes
- set_css_name
- set_cursor
- set_cursor_from_name
- set_default_direction
- set_direction
- set_focus_child
- set_focus_on_click
- set_focusable
- set_font_map
- set_font_options
- set_halign
- set_has_tooltip
- set_hexpand
- set_hexpand_set
- set_layout_manager
- set_layout_manager_type
- set_margin_bottom
- set_margin_end
- set_margin_start
- set_margin_top
- set_name
- set_opacity
- set_overflow
- set_parent
- set_receives_default
- set_sensitive
- set_size_request
- set_state_flags
- set_template
- set_template_from_resource
- set_template_scope
- set_tooltip_markup
- set_tooltip_text
- set_valign
- set_vexpand
- set_vexpand_set
- set_visible
- should_layout
- show
- size_allocate
- snapshot
- snapshot_child
- state_flags_changed
- system_setting_changed
- tooltip_markup
- tooltip_text
- translate_coordinates
- trigger_tooltip_query
- unmap
- unparent
- unrealize
- unroot
- unset_state_flags
- valign
- vexpand
- vexpand_set
- visible
- width_request
All known members inherited from class GLib.Object
All known members inherited from interface Adw.Swipeable
All known members inherited from interface Gtk.Accessible
All known members inherited from interface Gtk.Buildable
All known members inherited from interface Gtk.Orientable