Class
AdwFlap
Description [src]
final class Adw.Flap : Gtk.Widget {
/* No available fields */
}An adaptive container acting like a box or an overlay.
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
<child> 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.
| Deprecated since: | 1.4 |
Implements
- AdwSwipeable
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable
Instance methods
adw_flap_get_fold_duration
Gets the fold transition animation duration for self, in milliseconds.
Deprecated since: 1.4
adw_flap_get_reveal_params
Gets the reveal animation spring parameters for self.
Deprecated since: 1.4
adw_flap_get_swipe_to_close
Gets whether self can be closed with a swipe gesture.
Deprecated since: 1.4
adw_flap_get_swipe_to_open
Gets whether self can be opened with a swipe gesture.
Deprecated since: 1.4
adw_flap_get_transition_type
Gets the type of animation used for reveal and fold transitions in self.
Deprecated since: 1.4
adw_flap_set_fold_duration
Sets the fold transition animation duration for self, in milliseconds.
Deprecated since: 1.4
adw_flap_set_reveal_params
Sets the reveal animation spring parameters for self.
Deprecated since: 1.4
adw_flap_set_swipe_to_close
Sets whether self can be closed with a swipe gesture.
Deprecated since: 1.4
adw_flap_set_swipe_to_open
Sets whether self can be opened with a swipe gesture.
Deprecated since: 1.4
adw_flap_set_transition_type
Sets the type of animation used for reveal and fold transitions in self.
Deprecated since: 1.4
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.Flap:fold-duration
The fold transition animation duration, in milliseconds.
Deprecated since: 1.4
Adw.Flap:transition-type
The type of animation used for reveal and fold transitions.
Deprecated since: 1.4