Class

Adw.Flap

Description [src]

final class Adw.Flap : Gtk.Widget {
  /* No available fields */
}

An adaptive container acting like a box or an overlay.

flap-wide flap-narrow

The AdwFlap widget can display its children like a GtkBox does or like a GtkOverlay does, according to the AdwFlap:fold-policy value.

AdwFlap has at most three children: AdwFlap:content, AdwFlap:flap and AdwFlap:separator. Content is the primary child, flap is displayed next to it when unfolded, or overlays it when folded. Flap can be shown or hidden by changing the AdwFlap:reveal-flap value, as well as via swipe gestures if AdwFlap:swipe-to-open and/or AdwFlap:swipe-to-close are set to TRUE.

Optionally, a separator can be provided, which would be displayed between the content and the flap when there’s no shadow to separate them, depending on the transition type.

AdwFlap:flap is transparent by default; add the .background style class to it if this is unwanted.

If AdwFlap:modal is set to TRUE, content becomes completely inaccessible when the flap is revealed while folded.

The position of the flap and separator children relative to the content is determined by orientation, as well as the AdwFlap:flap-position value.

Folding the flap will automatically hide the flap widget, and unfolding it will automatically reveal it. If this behavior is not desired, the AdwFlap:locked property can be used to override it.

Common use cases include sidebars, header bars that need to be able to overlap the window content (for example, in fullscreen mode) and bottom sheets.

AdwFlap as GtkBuildable

The AdwFlap implementation of the GtkBuildable interface supports setting the flap child by specifying “flap” as the “type” attribute of a element, and separator by specifying “separator”. Specifying “content” child type or omitting it results in setting the content child.

CSS nodes

AdwFlap has a single CSS node with name flap. The node will get the style classes .folded when it is folded, and .unfolded when it’s not.

Available since:1.0

Hierarchy

Ancestors

  • GtkWidget
  • GInitiallyUnowned
  • GObject

Implements

  • AdwSwipeable
  • GtkAccessible
  • GtkBuildable
  • GtkConstraintTarget
  • GtkOrientable

Constructors

adw_flap_new

Creates a new AdwFlap.

Available since: 1.0

Instance methods

adw_flap_get_content

Gets the content widget for self.

Available since: 1.0

adw_flap_get_flap

Gets the flap widget for self.

Available since: 1.0

adw_flap_get_flap_position

Gets the flap position for self.

Available since: 1.0

adw_flap_get_fold_duration

Gets the duration that fold transitions in self will take.

Available since: 1.0

adw_flap_get_fold_policy

Gets the fold policy for self.

Available since: 1.0

adw_flap_get_fold_threshold_policy

Gets the fold threshold policy for self.

Available since: 1.0

adw_flap_get_folded

Gets whether self is currently folded.

Available since: 1.0

adw_flap_get_locked

Gets whether self is locked.

Available since: 1.0

adw_flap_get_modal

Gets whether self is modal.

Available since: 1.0

adw_flap_get_reveal_flap

Gets whether the flap widget is revealed for self.

Available since: 1.0

adw_flap_get_reveal_params

Gets the reveal animation spring parameters for self.

Available since: 1.0

adw_flap_get_reveal_progress

Gets the current reveal progress for self.

Available since: 1.0

adw_flap_get_separator

Gets the separator widget for self.

Available since: 1.0

adw_flap_get_swipe_to_close

Gets whether self can be closed with a swipe gesture.

Available since: 1.0

adw_flap_get_swipe_to_open

Gets whether self can be opened with a swipe gesture.

Available since: 1.0

adw_flap_get_transition_type

Gets the type of animation used for reveal and fold transitions in self.

Available since: 1.0

adw_flap_set_content

Sets the content widget for self.

Available since: 1.0

adw_flap_set_flap

Sets the flap widget for self.

Available since: 1.0

adw_flap_set_flap_position

Sets the flap position for self.

Available since: 1.0

adw_flap_set_fold_duration

Sets the duration that fold transitions in self will take.

Available since: 1.0

adw_flap_set_fold_policy

Sets the fold policy for self.

Available since: 1.0

adw_flap_set_fold_threshold_policy

Sets the fold threshold policy for self.

Available since: 1.0

adw_flap_set_locked

Sets whether self is locked.

Available since: 1.0

adw_flap_set_modal

Sets whether self is modal.

Available since: 1.0

adw_flap_set_reveal_flap

Sets whether the flap widget is revealed for self.

Available since: 1.0

adw_flap_set_reveal_params

Sets the reveal animation spring parameters for self.

Available since: 1.0

adw_flap_set_separator

Sets the separator widget for self.

Available since: 1.0

adw_flap_set_swipe_to_close

Sets whether self can be closed with a swipe gesture.

Available since: 1.0

adw_flap_set_swipe_to_open

Sets whether self can be opened with a swipe gesture.

Available since: 1.0

adw_flap_set_transition_type

Sets the type of animation used for reveal and fold transitions in self.

Available since: 1.0

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

Properties

Adw.Flap:content

The content widget.

Available since: 1.0

Adw.Flap:flap

The flap widget.

Available since: 1.0

Adw.Flap:flap-position

The flap position.

Available since: 1.0

Adw.Flap:fold-duration

The fold transition animation duration, in milliseconds.

Available since: 1.0

Adw.Flap:fold-policy

The fold policy for the flap.

Available since: 1.0

Adw.Flap:fold-threshold-policy

Determines when the flap will fold.

Available since: 1.0

Adw.Flap:folded

Whether the flap is currently folded.

Available since: 1.0

Adw.Flap:locked

Whether the flap is locked.

Available since: 1.0

Adw.Flap:modal

Whether the flap is modal.

Available since: 1.0

Adw.Flap:reveal-flap

Whether the flap widget is revealed.

Available since: 1.0

Adw.Flap:reveal-params

The reveal animation spring parameters.

Available since: 1.0

Adw.Flap:reveal-progress

The current reveal transition progress.

Available since: 1.0

Adw.Flap:separator

The separator widget.

Available since: 1.0

Adw.Flap:swipe-to-close

Whether the flap can be closed with a swipe gesture.

Available since: 1.0

Adw.Flap:swipe-to-open

Whether the flap can be opened with a swipe gesture.

Available since: 1.0

Adw.Flap:transition-type

the type of animation used for reveal and fold transitions.

Available since: 1.0

Class structure

struct AdwFlapClass {
  GtkWidgetClass parent_class;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.