Leaflet

Object Hierarchy:

Description:

[ CCode ( type_id = "hdy_leaflet_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public class Leaflet : Container, Implementor, Buildable, Orientable, Swipeable

An adaptive container acting like a box or a stack.

The `HdyLeaflet` widget can display its children like a [class@Gtk.Box] does or like a [class@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 [class@Window] or [class@ApplicationWindow] as they will crop anything drawn beyond the rounded corners.

The child property `navigatable` can be set on `HdyLeaflet` children to determine whether they can be navigated to when folded. If `FALSE`, the child will be ignored by [method@Leaflet.get_adjacent_child], [method@Leaflet.navigate], and swipe gestures. This can be used used to prevent switching to widgets like separators.

CSS nodes

`HdyLeaflet` 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.

Namespace: Hdy

Package: libhandy-1

Content:

Properties:

public bool can_swipe_back { get; set; }
Whether swipe gestures allow switching to the previous navigatable child.
public bool can_swipe_forward { get; set; }
Whether swipe gestures allow switching to the next navigatable child.
public uint child_transition_duration { get; set; }
The child transition animation duration, in milliseconds.
public bool child_transition_running { get; }
Whether a child transition is currently running.
public bool folded { get; }
Whether the leaflet is folded.
public bool hhomogeneous_folded { get; set; }
Whether to allocate the same width for all children when folded.
public bool hhomogeneous_unfolded { get; set; }
Whether to allocate the same width for all children when unfolded.
public bool interpolate_size { get; set; }
Whether the size should smoothly change when changing between children.
public uint mode_transition_duration { get; set; }
The mode transition animation duration, in milliseconds.
public LeafletTransitionType transition_type { get; set; }
The animation type used for transitions between modes and children.
public bool vhomogeneous_folded { get; set; }
Whether to allocates the same height for all children when folded.
public bool vhomogeneous_unfolded { get; set; }
Whether to allocate the same height for all children when unfolded.
public Widget visible_child { get; set; }
The widget currently visible when the leaflet is folded.
public string visible_child_name { get; set; }
The name of the widget currently visible when the leaflet is folded.

Creation methods:

public Leaflet ()
Creates a new `HdyLeaflet`.

Methods:

public unowned Widget? get_adjacent_child (NavigationDirection direction)
Finds the previous or next navigatable child.
public bool get_can_swipe_back ()
Gets whether swipe gestures switch to the previous navigatable child.
public bool get_can_swipe_forward ()
Gets whether swipe gestures switch to the next navigatable child.
public unowned Widget? get_child_by_name (string name)
Finds the child of this with the name given as the argument.
public uint get_child_transition_duration ()
Gets the amount of time that transitions between children will take.
public bool get_child_transition_running ()
Returns whether this is currently in a transition from one page to another.
public bool get_folded ()
Gets whether this is folded.
public bool get_homogeneous (bool folded, Orientation orientation)
Gets whether this is homogeneous for the given fold and orientation.
public bool get_interpolate_size ()
Gets whether to interpolate between the sizes of children on page switches.
public uint get_mode_transition_duration ()
Gets the amount of time that transitions between modes in this will take.
public LeafletTransitionType get_transition_type ()
Gets the animation type that will be used for transitions between modes and children.
public unowned Widget get_visible_child ()
Gets the visible child widget.
public unowned string get_visible_child_name ()
Gets the name of the currently visible child widget.
public void insert_child_after (Widget child, Widget? sibling)
Inserts child in the position after sibling in the list of children.
public bool navigate (NavigationDirection direction)
Navigates to the previous or next navigatable child.
public void prepend (Widget child)
Inserts child at the first position in this.
public void reorder_child_after (Widget child, Widget? sibling)
Moves child to the position after sibling in the list of children.
public void set_can_swipe_back (bool can_swipe_back)
Sets whether swipe gestures switch to the previous navigatable child.
public void set_can_swipe_forward (bool can_swipe_forward)
Sets whether swipe gestures switch to the next navigatable child.
public void set_child_transition_duration (uint duration)
Sets the duration that transitions between children in this will take.
public void set_homogeneous (bool folded, Orientation orientation, bool homogeneous)
Sets whether to be homogeneous for the given fold and orientation.
public void set_interpolate_size (bool interpolate_size)
Sets whether this will interpolate its size when changing the visible child.
public void set_mode_transition_duration (uint duration)
Sets the duration that transitions between modes in this will take.
public void set_transition_type (LeafletTransitionType transition)
Sets the animation type that will be used for transitions between modes and children.
public void set_visible_child (Widget visible_child)
Sets the currently visible widget when the leaflet is folded.
public void set_visible_child_name (string name)
Makes the child with the name name visible.

Inherited Members:

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation

All known members inherited from interface Hdy.Swipeable