Class
AdwFlap
deprecated: 1.4 since: 1
Description [src]
final class Adw.Flap : Gtk.Widget
implements Adw.Swipeable, Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
/* 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.
Available since: 1
Deprecated since: 1.4
Instance methods
adw_flap_get_fold_duration
Gets the fold transition animation duration for self
, in milliseconds.
deprecated: 1.4 since: 1
adw_flap_get_fold_threshold_policy
Gets the fold threshold policy for self
.
deprecated: 1.4 since: 1
adw_flap_get_reveal_flap
Gets whether the flap widget is revealed for self
.
deprecated: 1.4 since: 1
adw_flap_get_reveal_params
Gets the reveal animation spring parameters for self
.
deprecated: 1.4 since: 1
adw_flap_get_swipe_to_close
Gets whether self
can be closed with a swipe gesture.
deprecated: 1.4 since: 1
adw_flap_get_swipe_to_open
Gets whether self
can be opened with a swipe gesture.
deprecated: 1.4 since: 1
adw_flap_get_transition_type
Gets the type of animation used for reveal and fold transitions in self
.
deprecated: 1.4 since: 1
adw_flap_set_fold_duration
Sets the fold transition animation duration for self
, in milliseconds.
deprecated: 1.4 since: 1
adw_flap_set_fold_threshold_policy
Sets the fold threshold policy for self
.
deprecated: 1.4 since: 1
adw_flap_set_reveal_flap
Sets whether the flap widget is revealed for self
.
deprecated: 1.4 since: 1
adw_flap_set_reveal_params
Sets the reveal animation spring parameters for self
.
deprecated: 1.4 since: 1
adw_flap_set_swipe_to_close
Sets whether self
can be closed with a swipe gesture.
deprecated: 1.4 since: 1
adw_flap_set_swipe_to_open
Sets whether self
can be opened with a swipe gesture.
deprecated: 1.4 since: 1
adw_flap_set_transition_type
Sets the type of animation used for reveal and fold transitions in self
.
deprecated: 1.4 since: 1
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
adw_swipeable_get_distance
Gets the swipe distance of self
.
since: 1
adw_swipeable_get_progress
Gets the current progress of self
.
since: 1
adw_swipeable_get_snap_points
Gets the snap points of self
.
since: 1
adw_swipeable_get_swipe_area
Gets the area self
can start a swipe from for the given direction and
gesture type.
since: 1
Methods inherited from GtkAccessible (19)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
unstable since: 4.14
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
unstable since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
unstable since: 4.0
gtk_accessible_get_at_context
Retrieves the accessible implementation 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.
unstable since: 4.0
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
unstable since: 4.0
gtk_accessible_reset_state
Resets the accessible state
to its default value.
unstable since: 4.0
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
.
unstable since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
unstable since: 4.0
gtk_accessible_update_property_value
Updates an array of accessible properties.
unstable since: 4.0
gtk_accessible_update_relation
Updates a list of accessible relations.
unstable since: 4.0
gtk_accessible_update_relation_value
Updates an array of accessible relations.
unstable since: 4.0
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
unstable since: 4.0
gtk_accessible_update_state_value
Updates an array of accessible states.
unstable since: 4.0
Methods inherited from GtkBuildable (1)
Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation
Retrieves the orientation of the orientable
.
unstable since: 4.0
gtk_orientable_set_orientation
Sets the orientation of the orientable
.
unstable since: 4.0
Properties
Adw.Flap:fold-duration
The fold transition animation duration, in milliseconds.
deprecated: 1.4 since: 1
Adw.Flap:swipe-to-close
Whether the flap can be closed with a swipe gesture.
deprecated: 1.4 since: 1
Adw.Flap:swipe-to-open
Whether the flap can be opened with a swipe gesture.
deprecated: 1.4 since: 1
Adw.Flap:transition-type
The type of animation used for reveal and fold transitions.
deprecated: 1.4 since: 1
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
unstable since: 4.0
Gtk.Widget:can-target
Whether the widget can receive pointer events.
unstable since: 4.0
Gtk.Widget:css-classes
A list of css classes applied to this widget.
unstable since: 4.0
Gtk.Widget:css-name
The name of this widget in the CSS tree.
unstable since: 4.0
Gtk.Widget:cursor
The cursor used by widget
.
unstable since: 4.0
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
unstable since: 4.0
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
unstable since: 4.0
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
unstable since: 4.0
Gtk.Widget:has-default
Whether the widget is the default widget.
unstable since: 4.0
Gtk.Widget:has-focus
Whether the widget has the input focus.
unstable since: 4.0
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
unstable since: 4.0
Gtk.Widget:height-request
Override for height request of the widget.
unstable since: 4.0
Gtk.Widget:hexpand
Whether to expand horizontally.
unstable since: 4.0
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
unstable since: 4.0
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
unstable since: 4.0
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
unstable since: 4.0
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
unstable since: 4.0
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
unstable since: 4.0
Gtk.Widget:margin-top
Margin on top side of widget.
unstable since: 4.0
Gtk.Widget:name
The name of the widget.
unstable since: 4.0
Gtk.Widget:opacity
The requested opacity of the widget.
unstable since: 4.0
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
unstable since: 4.0
Gtk.Widget:parent
The parent widget of this widget.
unstable since: 4.0
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
unstable since: 4.0
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
unstable since: 4.0
Gtk.Widget:scale-factor
The scale factor of the widget.
unstable since: 4.0
Gtk.Widget:sensitive
Whether the widget responds to input.
unstable since: 4.0
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
unstable since: 4.0
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
unstable since: 4.0
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
unstable since: 4.0
Gtk.Widget:vexpand
Whether to expand vertically.
unstable since: 4.0
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
unstable since: 4.0
Gtk.Widget:visible
Whether the widget is visible.
unstable since: 4.0
Gtk.Widget:width-request
Override for width request of the widget.
unstable since: 4.0
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
unstable since: 4.0
Properties inherited from GtkOrientable (1)
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.
unstable since: 4.0
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
unstable since: 4.0
GtkWidget::hide
Emitted when widget
is hidden.
unstable since: 4.0
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
unstable since: 4.0
GtkWidget::map
Emitted when widget
is going to be mapped.
unstable since: 4.0
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
unstable since: 4.0
GtkWidget::move-focus
Emitted when the focus is moved.
unstable since: 4.0
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
unstable since: 4.0
GtkWidget::realize
Emitted when widget
is associated with a GdkSurface
.
unstable since: 4.0
GtkWidget::show
Emitted when widget
is shown.
unstable since: 4.0
GtkWidget::state-flags-changed
Emitted when the widget state changes.
unstable since: 4.0
GtkWidget::unmap
Emitted when widget
is going to be unmapped.
unstable since: 4.0
GtkWidget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
unstable since: 4.0
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.
unstable since: 2.0