Struct libhandy::Leaflet

source ·

pub struct Leaflet { /* private fields */ }

Expand description

An adaptive container acting like a box or a stack.

The Leaflet widget can display its children like a [gtk::Box][crate::gtk::Box] does or like a [gtk::Stack][crate::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.

The “over” and “under” transitions can draw their shadow on top of the window’s transparent areas, like the rounded corners. This is a side-effect of allowing shadows to be drawn on top of OpenGL areas. It can be mitigated by using Window or ApplicationWindow as they will crop anything drawn beyond the rounded corners.

The child property navigatable can be set on Leaflet children to determine whether they can be navigated to when folded. If FALSE, the child will be ignored by LeafletExt::adjacent_child(), LeafletExt::navigate(), and swipe gestures. This can be used used to prevent switching to widgets like separators.

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 didn’t compute its fold yet.

Properties

`can-swipe-back`

Whether swipe gestures allow switching to the previous navigatable child.

Readable | Writeable

`can-swipe-forward`

Whether swipe gestures allow switching to the next navigatable child.

Readable | Writeable

`child-transition-duration`

The child transition animation duration, in milliseconds.

Readable | Writeable

`child-transition-running`

Whether a child transition is currently running.

Readable

`folded`

Whether the leaflet is folded.

The leaflet will be folded if the size allocated to it is smaller than the sum of the natural size of its children, it will be unfolded otherwise.

Readable

`hhomogeneous-folded`

Whether to allocate the same width for all children when folded.

Readable | Writeable

`hhomogeneous-unfolded`

Whether to allocate the same width for all children when unfolded.

Readable | Writeable

`interpolate-size`

Whether the size should smoothly change when changing between children.

Readable | Writeable

`mode-transition-duration`

The mode transition animation duration, in milliseconds.

Readable | Writeable

`transition-type`

The animation type 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

`vhomogeneous-folded`

Whether to allocates the same height for all children when folded.

Readable | Writeable

`vhomogeneous-unfolded`

Whether to allocate the same height for all children when unfolded.

Readable | Writeable

`visible-child`

The widget currently visible when the leaflet is folded.

The transition is determined by transition-type and child-transition-duration. 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

Container

`border-width`

Readable | Writeable

`child`

Writeable

`resize-mode`

Readable | Writeable

Widget

`app-paintable`

Readable | Writeable

`can-default`

Readable | Writeable

`can-focus`

Readable | Writeable

`composite-child`

Readable

`double-buffered`

Whether the widget is double buffered.

Readable | Writeable

`events`

Readable | Writeable

`expand`

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

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.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

`halign`

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

`has-default`

Readable | Writeable

`has-focus`

Readable | Writeable

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

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

`height-request`

Readable | Writeable

`hexpand`

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

`hexpand-set`

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

`is-focus`

Readable | Writeable

`margin`

Sets all four sides’ margin at once. If read, returns max margin on any side.

Readable | Writeable