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.

Available since:1.0

Constructors

adw_leaflet_new

Creates a new AdwLeaflet.

Available since: 1.0

Instance methods

adw_leaflet_append

Adds a child to self.

Available since: 1.0

adw_leaflet_get_adjacent_child

Finds the previous or next navigatable child.

Available since: 1.0

adw_leaflet_get_can_swipe_back

Gets whether a swipe gesture can be used to navigate to the previous child.

Available since: 1.0

adw_leaflet_get_can_swipe_forward

Gets whether a swipe gesture can be used to navigate to the next child.

Available since: 1.0

adw_leaflet_get_can_unfold

Gets whether self can unfold.

Available since: 1.0

adw_leaflet_get_child_by_name

Finds the child of self with name.

Available since: 1.0

adw_leaflet_get_child_transition_duration

Gets the child transition animation duration for self.

Available since: 1.0

adw_leaflet_get_child_transition_running

Gets whether a child transition is currently running for self.

Available since: 1.0

adw_leaflet_get_fold_threshold_policy

Gets the fold threshold policy for self.

Available since: 1.0

adw_leaflet_get_folded

Gets whether self is folded.

Available since: 1.0

adw_leaflet_get_homogeneous

Gets whether self is homogeneous.

Available since: 1.0

adw_leaflet_get_mode_transition_duration

Gets the mode transition animation duration for self.

Available since: 1.0

adw_leaflet_get_page

Returns the AdwLeafletPage object for child.

Available since: 1.0

adw_leaflet_get_pages

Returns a GListModel that contains the pages of the leaflet.

Available since: 1.0

adw_leaflet_get_transition_type

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

Available since: 1.0

adw_leaflet_get_visible_child

Gets the widget currently visible when the leaflet is folded.

Available since: 1.0

adw_leaflet_get_visible_child_name

Gets the name of the currently visible child widget.

Available since: 1.0

adw_leaflet_insert_child_after

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

Available since: 1.0

adw_leaflet_navigate

Navigates to the previous or next child.

Available since: 1.0

adw_leaflet_prepend

Inserts child at the first position in self.

Available since: 1.0

adw_leaflet_remove

Removes a child widget from self.

Available since: 1.0

adw_leaflet_reorder_child_after

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

Available since: 1.0

adw_leaflet_set_can_swipe_back

Sets whether a swipe gesture can be used to navigate to the previous child.

Available since: 1.0

adw_leaflet_set_can_swipe_forward

Sets whether a swipe gesture can be used to navigate to the next child.

Available since: 1.0

adw_leaflet_set_can_unfold

Sets whether self can unfold.

Available since: 1.0

adw_leaflet_set_child_transition_duration

Sets the child transition animation duration for self.

Available since: 1.0

adw_leaflet_set_fold_threshold_policy

Sets the fold threshold policy for self.

Available since: 1.0

adw_leaflet_set_homogeneous

Sets self to be homogeneous or not.

Available since: 1.0

adw_leaflet_set_mode_transition_duration

Sets the mode transition animation duration for self.

Available since: 1.0

adw_leaflet_set_transition_type

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

Available since: 1.0

adw_leaflet_set_visible_child

Sets the widget currently visible when the leaflet is folded.

Available since: 1.0

adw_leaflet_set_visible_child_name

Makes the child with the name name visible.

Available since: 1.0

Methods inherited from GtkWidget (159)
Methods inherited from GObject (42)
Methods inherited from AdwSwipeable (5)
adw_swipeable_get_cancel_progress

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

Available since: 1.0

adw_swipeable_get_distance

Gets the swipe distance of self.

Available since: 1.0

adw_swipeable_get_progress

Gets the current progress of self.

Available since: 1.0

adw_swipeable_get_snap_points

Gets the snap points of self.

Available since: 1.0

adw_swipeable_get_swipe_area

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

Available since: 1.0

Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

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_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-swipe-back

Whether a swipe gesture can be used to navigate to the previous child.

Available since: 1.0

Adw.Leaflet:can-swipe-forward

Whether a swipe gesture can be used to navigate to the next child.

Available since: 1.0

Adw.Leaflet:can-unfold

Whether or not the leaflet can unfold.

Available since: 1.0

Adw.Leaflet:child-transition-duration

The child transition animation duration, in milliseconds.

Available since: 1.0

Adw.Leaflet:child-transition-running

Whether a child transition is currently running.

Available since: 1.0

Adw.Leaflet:fold-threshold-policy

Determines when the leaflet will fold.

Available since: 1.0

Adw.Leaflet:folded

Whether the leaflet is folded.

Available since: 1.0

Adw.Leaflet:homogeneous

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

Available since: 1.0

Adw.Leaflet:mode-transition-duration

The mode transition animation duration, in milliseconds.

Available since: 1.0

Adw.Leaflet:pages

A selection model with the leaflet’s pages.

Available since: 1.0

Adw.Leaflet:transition-type

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

Available since: 1.0

Adw.Leaflet:visible-child

The widget currently visible when the leaflet is folded.

Available since: 1.0

Adw.Leaflet:visible-child-name

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

Available 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)
Gtk.Widget::destroy

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

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject.Object::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;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.