Class
AdwLeaflet
Description [src]
final class Adw.Leaflet : Gtk.Widget {
/* No available fields */
}An adaptive container acting like a box or a stack.
The AdwLeaflet widget can display its children like a GtkBox does
or like a GtkStack 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
AdwLeaflet 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.
Implements
- AdwSwipeable
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable
Constructors
adw_leaflet_new
Creates a new AdwLeaflet.
Instance methods
adw_leaflet_append
Adds a child to self.
adw_leaflet_get_adjacent_child
Finds the previous or next navigatable child.
adw_leaflet_get_can_navigate_back
Gets whether gestures and shortcuts for navigating backward are enabled.
adw_leaflet_get_can_navigate_forward
Gets whether gestures and shortcuts for navigating forward are enabled.
adw_leaflet_get_can_unfold
Gets whether self can unfold.
adw_leaflet_get_child_by_name
Finds the child of self with name.
adw_leaflet_get_child_transition_params
Gets the child transition spring parameters for self.
adw_leaflet_get_child_transition_running
Gets whether a child transition is currently running for self.
adw_leaflet_get_fold_threshold_policy
Gets the fold threshold policy for self.
adw_leaflet_get_folded
Gets whether self is folded.
adw_leaflet_get_homogeneous
Gets whether self is homogeneous.
adw_leaflet_get_mode_transition_duration
Gets the mode transition animation duration for self.
adw_leaflet_get_page
Returns the AdwLeafletPage object for child.
adw_leaflet_get_pages
Returns a GListModel that contains the pages of the leaflet.
adw_leaflet_get_transition_type
Gets the type of animation used for transitions between modes and children.
adw_leaflet_get_visible_child
Gets the widget currently visible when the leaflet is folded.
adw_leaflet_get_visible_child_name
Gets the name of the currently visible child widget.
adw_leaflet_insert_child_after
Inserts child in the position after sibling in the list of children.
adw_leaflet_navigate
Navigates to the previous or next child.
adw_leaflet_prepend
Inserts child at the first position in self.
adw_leaflet_remove
Removes a child widget from self.
adw_leaflet_reorder_child_after
Moves child to the position after sibling in the list of children.
adw_leaflet_set_can_navigate_back
Sets whether gestures and shortcuts for navigating backward are enabled.
adw_leaflet_set_can_navigate_forward
Sets whether gestures and shortcuts for navigating forward are enabled.
adw_leaflet_set_can_unfold
Sets whether self can unfold.
adw_leaflet_set_child_transition_params
Sets the child transition spring parameters for self.
adw_leaflet_set_fold_threshold_policy
Sets the fold threshold policy for self.
adw_leaflet_set_homogeneous
Sets self to be homogeneous or not.
adw_leaflet_set_mode_transition_duration
Sets the mode transition animation duration for self.
adw_leaflet_set_transition_type
Sets the type of animation used for transitions between modes and children.
adw_leaflet_set_visible_child
Sets the widget currently visible when the leaflet is folded.
adw_leaflet_set_visible_child_name
Makes the child with the name name visible.
Methods inherited from AdwSwipeable (5)
adw_swipeable_get_cancel_progress
Gets the progress self will snap back to after the gesture is canceled.
adw_swipeable_get_distance
Gets the swipe distance of self.
adw_swipeable_get_progress
Gets the current progress of self.
adw_swipeable_get_snap_points
Gets the snap points of self.
adw_swipeable_get_swipe_area
Gets the area self can start a swipe from for the given direction and
gesture type.
Properties
Adw.Leaflet:can-navigate-back
Whether gestures and shortcuts for navigating backward are enabled.
Adw.Leaflet:can-navigate-forward
Whether gestures and shortcuts for navigating forward are enabled.
Adw.Leaflet:can-unfold
Whether or not the leaflet can unfold.
Adw.Leaflet:child-transition-params
The child transition spring parameters.
Adw.Leaflet:child-transition-running
Whether a child transition is currently running.
Adw.Leaflet:fold-threshold-policy
Determines when the leaflet will fold.
Adw.Leaflet:folded
Whether the leaflet is folded.
Adw.Leaflet:homogeneous
Whether the leaflet allocates the same size for all children when folded.
Adw.Leaflet:mode-transition-duration
The mode transition animation duration, in milliseconds.
Adw.Leaflet:pages
A selection model with the leaflet’s pages.
Adw.Leaflet:transition-type
The type of animation used for transitions between modes and children.
Adw.Leaflet:visible-child
The widget currently visible when the leaflet is folded.
Adw.Leaflet:visible-child-name
The name of the widget currently visible when the leaflet is folded.