Adw.Leaflet
Description: Reference for Adw.Leaflet

### Class

# AdwLeaflet

since: 1.0

#### Description [src]

    final class Adw.Leaflet : Gtk.Widget
      implements Adw.Swipeable, Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
      /* 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.

Available since: 1.0

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- AdwSwipeable
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable

#### Constructors

###### adw_leaflet_new

Creates a new `AdwLeaflet`.

since: 1.0

#### Instance methods

###### adw_leaflet_append

Adds a child to `self`.

since: 1.0

###### adw_leaflet_get_adjacent_child

Finds the previous or next navigatable child.

since: 1.0

###### adw_leaflet_get_can_navigate_back

Gets whether gestures and shortcuts for navigating backward are enabled.

since: 1.0

###### adw_leaflet_get_can_navigate_forward

Gets whether gestures and shortcuts for navigating forward are enabled.

since: 1.0

###### adw_leaflet_get_can_unfold

Gets whether `self` can unfold.

since: 1.0

###### adw_leaflet_get_child_by_name

Finds the child of `self` with `name`.

since: 1.0

###### adw_leaflet_get_child_transition_params

Gets the child transition spring parameters for `self`.

since: 1.0

###### adw_leaflet_get_child_transition_running

Gets whether a child transition is currently running for `self`.

since: 1.0

###### adw_leaflet_get_fold_threshold_policy

Gets the fold threshold policy for `self`.

since: 1.0

###### adw_leaflet_get_folded

Gets whether `self` is folded.

since: 1.0

###### adw_leaflet_get_homogeneous

Gets whether `self` is homogeneous.

since: 1.0

###### adw_leaflet_get_mode_transition_duration

Gets the mode transition animation duration for `self`.

since: 1.0

###### adw_leaflet_get_page

Returns the `AdwLeafletPage` object for `child`.

since: 1.0

###### adw_leaflet_get_pages

Returns a `GListModel` that contains the pages of the leaflet.

since: 1.0

###### adw_leaflet_get_transition_type

Gets the type of animation used for transitions between modes and children.

since: 1.0

###### adw_leaflet_get_visible_child

Gets the widget currently visible when the leaflet is folded.

since: 1.0

###### adw_leaflet_get_visible_child_name

Gets the name of the currently visible child widget.

since: 1.0

###### adw_leaflet_insert_child_after

Inserts `child` in the position after `sibling` in the list of children.

since: 1.0

###### adw_leaflet_navigate

Navigates to the previous or next child.

since: 1.0

###### adw_leaflet_prepend

Inserts `child` at the first position in `self`.

since: 1.0

###### adw_leaflet_remove

Removes a child widget from `self`.

since: 1.0

###### adw_leaflet_reorder_child_after

Moves `child` to the position after `sibling` in the list of children.

since: 1.0

###### adw_leaflet_set_can_navigate_back

Sets whether gestures and shortcuts for navigating backward are enabled.

since: 1.0

###### adw_leaflet_set_can_navigate_forward

Sets whether gestures and shortcuts for navigating forward are enabled.

since: 1.0

###### adw_leaflet_set_can_unfold

Sets whether `self` can unfold.

since: 1.0

###### adw_leaflet_set_child_transition_params

Sets the child transition spring parameters for `self`.

since: 1.0

###### adw_leaflet_set_fold_threshold_policy

Sets the fold threshold policy for `self`.

since: 1.0

###### adw_leaflet_set_homogeneous

Sets `self` to be homogeneous or not.

since: 1.0

###### adw_leaflet_set_mode_transition_duration

Sets the mode transition animation duration for `self`.

since: 1.0

###### adw_leaflet_set_transition_type

Sets the type of animation used for transitions between modes and children.

since: 1.0

###### adw_leaflet_set_visible_child

Sets the widget currently visible when the leaflet is folded.

since: 1.0

###### adw_leaflet_set_visible_child_name

Makes the child with the name `name` visible.

since: 1.0

##### Methods inherited from GtkWidget (161)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from AdwSwipeable (5)

###### adw_swipeable_get_cancel_progress

Gets the progress `self` will snap back to after the gesture is canceled.

since: 1.0

###### adw_swipeable_get_distance

Gets the swipe distance of `self`.

since: 1.0

###### adw_swipeable_get_progress

Gets the current progress of `self`.

since: 1.0

###### adw_swipeable_get_snap_points

Gets the snap points of `self`.

since: 1.0

###### adw_swipeable_get_swipe_area

Gets the area `self` can start a swipe from for the given direction and gesture type.

since: 1.0

##### Methods inherited from GtkAccessible (18)

###### gtk_accessible_get_accessible_parent

Retrieves the accessible accessible for an accessible object.

unstable since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the `GtkATContext` for the given `GtkAccessible`.

unstable since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

###### gtk_accessible_reset_property

Resets the accessible `property` to its default value.

###### gtk_accessible_reset_relation

Resets the accessible `relation` to its default value.

###### gtk_accessible_reset_state

Resets the accessible `state` to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

unstable since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`. That might be useful when a new child of a custom `GtkAccessible` is created, and it needs to be linked to a previous child.

unstable since: 4.10

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states. See the `GtkAccessibleState` documentation for the value types of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

##### Methods inherited from GtkOrientable (2)

###### gtk_orientable_get_orientation

Retrieves the orientation of the `orientable`.

###### gtk_orientable_set_orientation

Sets the orientation of the `orientable`.

#### Properties

###### Adw.Leaflet:can-navigate-back

Whether gestures and shortcuts for navigating backward are enabled.

since: 1.0

###### Adw.Leaflet:can-navigate-forward

Whether gestures and shortcuts for navigating forward are enabled.

since: 1.0

###### Adw.Leaflet:can-unfold

Whether or not the leaflet can unfold.

since: 1.0

###### Adw.Leaflet:child-transition-params

The child transition spring parameters.

since: 1.0

###### Adw.Leaflet:child-transition-running

Whether a child transition is currently running.

since: 1.0

###### Adw.Leaflet:fold-threshold-policy

Determines when the leaflet will fold.

since: 1.0

###### Adw.Leaflet:folded

Whether the leaflet is folded.

since: 1.0

###### Adw.Leaflet:homogeneous

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

since: 1.0

###### Adw.Leaflet:mode-transition-duration

The mode transition animation duration, in milliseconds.

since: 1.0

###### Adw.Leaflet:pages

A selection model with the leaflet’s pages.

since: 1.0

###### Adw.Leaflet:transition-type

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

since: 1.0

###### Adw.Leaflet:visible-child

The widget currently visible when the leaflet is folded.

since: 1.0

###### Adw.Leaflet:visible-child-name

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

since: 1.0

##### Properties inherited from GtkWidget (34)

###### Gtk.Widget:can-focus

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

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

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

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

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

###### Gtk.Widget:height-request

Override for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

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

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

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

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

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

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Override for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

##### Properties inherited from GtkOrientable (1)

###### Gtk.Orientable:orientation

The orientation of the orientable.

#### Signals

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

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

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AdwLeafletClass {
      GtkWidgetClass parent_class;

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`
  No description available.