Struct libadwaita::Carousel

pub struct Carousel { /* private fields */ }

A paginated scrolling widget.

The Carousel widget can be used to display a set of pages with swipe-based navigation between them.

CarouselIndicatorDots and CarouselIndicatorLines can be used to provide page indicators for Carousel.

CSS nodes

Carousel has a single CSS node with name carousel.

Properties

allow-long-swipes

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

If the value is FALSE, each swipe can only move to the adjacent pages.

Readable | Writeable

allow-mouse-drag

Sets whether the Carousel can be dragged with mouse pointer.

If the value is FALSE, dragging is only available on touch.

Readable | Writeable

allow-scroll-wheel

Whether the widget will respond to scroll wheel events.

If the value is FALSE, wheel events will be ignored.

Readable | Writeable

interactive

Whether the carousel can be navigated.

This can be used to temporarily disable the carousel to only allow navigating it in a certain state.

Readable | Writeable

n-pages

The number of pages in a Carousel.

Readable

position

Current scrolling position, unitless.

1 matches 1 page. Use Carousel::scroll_to() for changing it.

Readable

reveal-duration

Page reveal duration, in milliseconds.

Reveal duration is used when animating adding or removing pages.

Readable | Writeable

scroll-params

Scroll animation spring parameters.

The default value is equivalent to:

⚠️ The following code is in c ⚠️

adw_spring_params_new (1, 0.5, 500)

Readable | Writeable

spacing

Spacing between pages in pixels.

Readable | Writeable

Widget

can-focus

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

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

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

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

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

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

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

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

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Signals

page-changed

This signal is emitted after a page has been changed.

It can be used to implement “infinite scrolling” by amending the pages after every scroll.

::: note An empty carousel is indicated by (int)index == -1.

Widget

destroy

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

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See [WidgetExtManual::keynav_failed()][crate::gtk::prelude::WidgetExtManual::keynav_failed()] for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a GdkSurface.

This means that [WidgetExtManual::realize()][crate::gtk::prelude::WidgetExtManual::realize()] has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See [WidgetExtManual::state_flags()][crate::gtk::prelude::WidgetExtManual::state_flags()].

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the GdkSurface associated with @widget is destroyed.

This means that [WidgetExtManual::unrealize()][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, SwipeableExt, gtk::prelude::OrientableExt

Implementations

impl Carousel

pub fn new() -> Carousel

Creates a new Carousel.

Returns

the newly created Carousel

pub fn builder() -> CarouselBuilder

Creates a new builder-pattern struct instance to construct Carousel objects.

This method returns an instance of CarouselBuilder which can be used to create Carousel objects.

pub fn append(&self, child: &impl IsA<Widget>)

Appends @child to @self.

child

a widget to add

pub fn allows_long_swipes(&self) -> bool

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

Returns

TRUE if long swipes are allowed

pub fn allows_mouse_drag(&self) -> bool

Sets whether @self can be dragged with mouse pointer.

Returns

whether @self can be dragged with mouse pointer

pub fn allows_scroll_wheel(&self) -> bool

Gets whether @self will respond to scroll wheel events.

Returns

TRUE if @self will respond to scroll wheel events

pub fn is_interactive(&self) -> bool

Gets whether @self can be navigated.

Returns

whether @self can be navigated

pub fn n_pages(&self) -> u32

Gets the number of pages in @self.

Returns

the number of pages in @self

pub fn position(&self) -> f64

Gets current scroll position in @self, unitless.

1 matches 1 page. Use scroll_to() for changing it.

Returns

the scroll position

pub fn reveal_duration(&self) -> u32

Gets the page reveal duration, in milliseconds.

Returns

the duration

pub fn scroll_params(&self) -> SpringParams

Gets the scroll animation spring parameters for @self.

Returns

the animation parameters

pub fn spacing(&self) -> u32

Gets spacing between pages in pixels.

Returns

spacing between pages

pub fn insert(&self, child: &impl IsA<Widget>, position: i32)

Inserts @child into @self at position @position.

If position is -1, or larger than the number of pages, @child will be appended to the end.

child

a widget to add

position

the position to insert @child at

pub fn prepend(&self, child: &impl IsA<Widget>)

Prepends @child to @self.

child

a widget to add

pub fn remove(&self, child: &impl IsA<Widget>)

Removes @child from @self.

child

a widget to remove

pub fn reorder(&self, child: &impl IsA<Widget>, position: i32)

Moves @child into position @position.

If position is -1, or larger than the number of pages, @child will be moved at the end.

child

a widget to add

position

the position to move @child to

pub fn scroll_to(&self, widget: &impl IsA<Widget>, animate: bool)

Scrolls to @widget.

If @animate is TRUE, the transition will be animated.

widget

a child of @self

animate

whether to animate the transition

pub fn set_allow_long_swipes(&self, allow_long_swipes: bool)

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

If @allow_long_swipes is FALSE, each swipe can only move to the adjacent pages.

allow_long_swipes

whether to allow long swipes

pub fn set_allow_mouse_drag(&self, allow_mouse_drag: bool)

Sets whether @self can be dragged with mouse pointer.

If @allow_mouse_drag is FALSE, dragging is only available on touch.

allow_mouse_drag

whether @self can be dragged with mouse pointer

pub fn set_allow_scroll_wheel(&self, allow_scroll_wheel: bool)

Sets whether @self will respond to scroll wheel events.

If @allow_scroll_wheel is FALSE, wheel events will be ignored.

allow_scroll_wheel

whether @self will respond to scroll wheel events

pub fn set_interactive(&self, interactive: bool)

Sets whether @self can be navigated.

This can be used to temporarily disable the carousel to only allow navigating it in a certain state.

interactive

whether @self can be navigated

pub fn set_reveal_duration(&self, reveal_duration: u32)

Sets the page reveal duration, in milliseconds.

Reveal duration is used when animating adding or removing pages.

reveal_duration

the new reveal duration value

pub fn set_scroll_params(&self, params: &SpringParams)

Sets the scroll animation spring parameters for @self.

The default value is equivalent to:

⚠️ The following code is in c ⚠️

adw_spring_params_new (1, 0.5, 500)

params

the new parameters

pub fn set_spacing(&self, spacing: u32)

Sets spacing between pages in pixels.

spacing

the new spacing value

pub fn connect_page_changed<F: Fn(&Self, u32) + 'static>( &self, f: F ) -> SignalHandlerId

This signal is emitted after a page has been changed.

It can be used to implement “infinite scrolling” by amending the pages after every scroll.

::: note An empty carousel is indicated by (int)index == -1.

index

current page

pub fn connect_allow_long_swipes_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_allow_mouse_drag_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_allow_scroll_wheel_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_interactive_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_n_pages_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_position_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reveal_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_scroll_params_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_spacing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl Carousel

pub fn nth_page(&self, n: u32) -> Widget

Gets the page at position @n.

n

index of the page

Returns

the page

Trait Implementations

impl Clone for Carousel

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Carousel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Carousel

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Carousel

type ParamSpec = ParamSpecObject

type SetValue = Carousel

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Carousel>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Carousel

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Carousel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Carousel

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Carousel

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Carousel

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Carousel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Carousel

impl IsA<Accessible> for Carousel

impl IsA<Buildable> for Carousel

impl IsA<ConstraintTarget> for Carousel

impl IsA<Orientable> for Carousel

impl IsA<Swipeable> for Carousel

impl IsA<Widget> for Carousel