Struct CarouselState 

pub struct CarouselState { /* private fields */ }

Shared behavior state for every part of a super::Carousel.

CarouselState intentionally owns behavior only. The content and its items provide presentation and layout, while this state owns selection, orientation, looping, the shared scroll handle, and the input snapshots used to settle gestures. Programmatic setters are silent; user-facing selection methods emit one CarouselEvent::Change for a successful selection.

Implementations

impl CarouselState

pub fn new(item_count: usize) -> Self

Creates state for item_count items, initially selecting the first item when at least one item exists.

pub fn with_selected_index(self, index: usize) -> Self

Sets the initially selected item.

pub fn with_axis(self, axis: Axis) -> Self

Sets the carousel orientation.

pub fn with_looping(self, looping: bool) -> Self

Enables or disables wrapping at the first and last items.

pub fn item_count(&self) -> usize

Returns the number of logical items.

pub fn selected_index(&self) -> Option<usize>

Returns the selected logical item, or None when the carousel is empty.

pub fn axis(&self) -> Axis

Returns the configured orientation.

pub fn is_looping(&self) -> bool

Returns whether navigation wraps at the carousel edges.

pub fn has_previous(&self) -> bool

Returns whether a previous item can be selected.

pub fn has_next(&self) -> bool

Returns whether a next item can be selected.

pub fn set_selected_index(&mut self, index: usize, cx: &mut Context<'_, Self>)

Silently changes the selected item for controlled/programmatic use.

The value is clamped to the available item range. This method does not emit CarouselEvent::Change.

pub fn set_item_count(&mut self, item_count: usize, cx: &mut Context<'_, Self>)

Silently changes the number of logical items and clamps the selection.

pub fn set_axis(&mut self, axis: Axis, cx: &mut Context<'_, Self>)

Silently changes the carousel orientation.

pub fn set_looping(&mut self, looping: bool, cx: &mut Context<'_, Self>)

Silently changes whether edge navigation wraps.

pub fn select_index(&mut self, index: usize, cx: &mut Context<'_, Self>) -> bool

Selects an item through a user-facing path and emits one change event when the index is valid and differs from the current selection.

pub fn select_previous(&mut self, cx: &mut Context<'_, Self>) -> bool

Selects the previous item, wrapping when looping is enabled.

pub fn select_next(&mut self, cx: &mut Context<'_, Self>) -> bool

Selects the next item, wrapping when looping is enabled.

pub fn select_first(&mut self, cx: &mut Context<'_, Self>) -> bool

Selects the first item through the user-facing path.

pub fn select_last(&mut self, cx: &mut Context<'_, Self>) -> bool

Selects the last item through the user-facing path.

Trait Implementations

impl EventEmitter<CarouselEvent> for CarouselState

impl Focusable for CarouselState

fn focus_handle(&self, cx: &App) -> FocusHandle

The keyboard focus shared by every part: the root tracks it, and a clicked control moves focus here so the arrow keys keep working.