Struct libadwaita::Leaflet

source ·

pub struct Leaflet { /* private fields */ }

👎Deprecated: Since 1.4

Expand description

See the migration guide An adaptive container acting like a box or a stack.

The Leaflet widget can display its children like a Gtk::Box does or like a gtk::Stack does, adapting to size changes by switching between the two modes.

When there is enough space the children are displayed side by side, otherwise only one is displayed and the leaflet is said to be “folded”. The threshold is dictated by the preferred minimum sizes of the children. When a leaflet is folded, the children can be navigated using swipe gestures.

The “over” and “under” transition types stack the children one on top of the other, while the “slide” transition puts the children side by side. While navigating to a child on the side or below can be performed by swiping the current child away, navigating to an upper child requires dragging it from the edge where it resides. This doesn’t affect non-dragging swipes.

§CSS nodes

Leaflet has a single CSS node with name leaflet. The node will get the style classes .folded when it is folded, .unfolded when it’s not, or none if it hasn’t computed its fold yet.

§Properties

§`can-navigate-back`

Whether gestures and shortcuts for navigating backward are enabled.

The supported gestures are:

One-finger swipe on touchscreens
Horizontal scrolling on touchpads (usually two-finger swipe)
Back/forward mouse buttons

The keyboard back/forward keys are also supported, as well as the Alt+← shortcut for horizontal orientation, or Alt+↑ for vertical orientation.

If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed.

Only children that have navigatable set to TRUE can be navigated to.

Readable | Writeable

§`can-navigate-forward`

Whether gestures and shortcuts for navigating forward are enabled.

The supported gestures are:

One-finger swipe on touchscreens
Horizontal scrolling on touchpads (usually two-finger swipe)
Back/forward mouse buttons

The keyboard back/forward keys are also supported, as well as the Alt+→ shortcut for horizontal orientation, or Alt+↓ for vertical orientation.

If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed.

Only children that have navigatable set to TRUE can be navigated to.

Readable | Writeable

§`can-unfold`

Whether or not the leaflet can unfold.

Readable | Writeable

§`child-transition-params`

The child transition spring parameters.

The default value is equivalent to:

⚠️ The following code is in c ⚠️

adw_spring_params_new (1, 0.5, 500)

Readable | Writeable

§`child-transition-running`

Whether a child transition is currently running.

Readable

§`fold-threshold-policy`

Determines when the leaflet will fold.

If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, it will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don’t get their natural size.

This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.

Readable | Writeable

§`folded`

Whether the leaflet is folded.

The leaflet will be folded if the size allocated to it is smaller than the sum of the minimum or natural sizes of the children (see fold-threshold-policy), it will be unfolded otherwise.

Readable

§`homogeneous`

Whether the leaflet allocates the same size for all children when folded.

If set to FALSE, different children can have different size along the opposite orientation.

Readable | Writeable

§`mode-transition-duration`

The mode transition animation duration, in milliseconds.

Readable | Writeable

§`pages`

A selection model with the leaflet’s pages.

This can be used to keep an up-to-date view. The model also implements gtk::SelectionModel and can be used to track and change the visible page.

Readable

§`transition-type`

The type of animation used for transitions between modes and children.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to become current.

Readable | Writeable

§`visible-child`

The widget currently visible when the leaflet is folded.

The transition is determined by transition-type and child-transition-params. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Readable | Writeable

§`visible-child-name`

The name of the widget currently visible when the leaflet is folded.

See visible-child.

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.

Readable | Writeable

§`margin-start`

Margin on start of widget, horizontally.

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

Readable | Writeable

§`margin-top`

Margin on top side of widget.

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().

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

§Implements

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

Struct libadwaita::Leaflet

§CSS nodes

§Properties

§can-navigate-back

§can-navigate-forward

§can-unfold

§child-transition-params

§child-transition-running

§fold-threshold-policy

§folded

§homogeneous

§mode-transition-duration

§pages

§transition-type

§visible-child

§visible-child-name

Widget

§can-focus

§can-target

§css-classes

§css-name

§cursor

§focus-on-click

§focusable

§halign

§has-default

§has-focus

§has-tooltip

§height-request

§hexpand

§hexpand-set

§layout-manager

§margin-bottom

§margin-end

§margin-start

§margin-top

§name

§opacity

§overflow

§parent

§receives-default

§root

§scale-factor

§sensitive

§tooltip-markup

§tooltip-text

§valign

§vexpand

§vexpand-set

§visible

§width-request

Accessible

§accessible-role

Orientable

§orientation

§Implements

Implementations§

impl Leaflet

pub fn new() -> Leaflet

§Deprecated since 1.4

§Returns

pub fn builder() -> LeafletBuilder

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

§Deprecated since 1.4

§child

§Returns

pub fn adjacent_child(&self, direction: NavigationDirection) -> Option<Widget>

§Deprecated since 1.4

§direction

§Returns

pub fn can_navigate_back(&self) -> bool

§Deprecated since 1.4

§Returns

pub fn can_navigate_forward(&self) -> bool

§Deprecated since 1.4

§Returns

pub fn can_unfold(&self) -> bool

§Deprecated since 1.4

§Returns

pub fn child_by_name(&self, name: &str) -> Option<Widget>

§`can-navigate-back`

§`can-navigate-forward`

§`can-unfold`

§`child-transition-params`

§`child-transition-running`

§`fold-threshold-policy`

§`folded`

§`homogeneous`

§`mode-transition-duration`

§`pages`

§`transition-type`

§`visible-child`

§`visible-child-name`

§`can-focus`

§`can-target`

§`css-classes`

§`css-name`

§`cursor`

§`focus-on-click`

§`focusable`

§`halign`

§`has-default`

§`has-focus`

§`has-tooltip`

§`height-request`

§`hexpand`

§`hexpand-set`

§`layout-manager`

§`margin-bottom`

§`margin-end`

§`margin-start`

§`margin-top`

§`name`

§`opacity`

§`overflow`

§`parent`

§`receives-default`

§`root`

§`scale-factor`

§`sensitive`

§`tooltip-markup`

§`tooltip-text`

§`valign`

§`vexpand`

§`vexpand-set`

§`visible`

§`width-request`

§`accessible-role`

§`orientation`

§`child`

§`direction`

§`name`

§`child`

§`child`

§`sibling`

§`direction`

§`child`

§`child`

§`child`

§`sibling`

§`can_navigate_back`

§`can_navigate_forward`