Adw.Flap
Description: Reference for Adw.Flap

### Class

# AdwFlap

deprecated: 1.4

#### 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.

Deprecated since: 1.4

See the migration guide.

#### Hierarchy

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- AdwSwipeable
- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable

#### Constructors

###### adw_flap_new

Creates a new `AdwFlap`.

deprecated: 1.4

#### Instance methods

###### adw_flap_get_content

Gets the content widget for `self`.

deprecated: 1.4

###### adw_flap_get_flap

Gets the flap widget for `self`.

deprecated: 1.4

###### adw_flap_get_flap_position

Gets the flap position for `self`.

deprecated: 1.4

###### adw_flap_get_fold_duration

Gets the fold transition animation duration for `self`, in milliseconds.

deprecated: 1.4

###### adw_flap_get_fold_policy

Gets the fold policy for `self`.

deprecated: 1.4

###### adw_flap_get_fold_threshold_policy

Gets the fold threshold policy for `self`.

deprecated: 1.4

###### adw_flap_get_folded

Gets whether `self` is currently folded.

deprecated: 1.4

###### adw_flap_get_locked

Gets whether `self` is locked.

deprecated: 1.4

###### adw_flap_get_modal

Gets whether `self` is modal.

deprecated: 1.4

###### adw_flap_get_reveal_flap

Gets whether the flap widget is revealed for `self`.

deprecated: 1.4

###### adw_flap_get_reveal_params

Gets the reveal animation spring parameters for `self`.

deprecated: 1.4

###### adw_flap_get_reveal_progress

Gets the current reveal progress for `self`.

deprecated: 1.4

###### adw_flap_get_separator

Gets the separator widget for `self`.

deprecated: 1.4

###### adw_flap_get_swipe_to_close

Gets whether `self` can be closed with a swipe gesture.

deprecated: 1.4

###### adw_flap_get_swipe_to_open

Gets whether `self` can be opened with a swipe gesture.

deprecated: 1.4

###### adw_flap_get_transition_type

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

deprecated: 1.4

###### adw_flap_set_content

Sets the content widget for `self`.

deprecated: 1.4

###### adw_flap_set_flap

Sets the flap widget for `self`.

deprecated: 1.4

###### adw_flap_set_flap_position

Sets the flap position for `self`.

deprecated: 1.4

###### adw_flap_set_fold_duration

Sets the fold transition animation duration for `self`, in milliseconds.

deprecated: 1.4

###### adw_flap_set_fold_policy

Sets the fold policy for `self`.

deprecated: 1.4

###### adw_flap_set_fold_threshold_policy

Sets the fold threshold policy for `self`.

deprecated: 1.4

###### adw_flap_set_locked

Sets whether `self` is locked.

deprecated: 1.4

###### adw_flap_set_modal

Sets whether `self` is modal.

deprecated: 1.4

###### adw_flap_set_reveal_flap

Sets whether the flap widget is revealed for `self`.

deprecated: 1.4

###### adw_flap_set_reveal_params

Sets the reveal animation spring parameters for `self`.

deprecated: 1.4

###### adw_flap_set_separator

Sets the separator widget for `self`.

deprecated: 1.4

###### adw_flap_set_swipe_to_close

Sets whether `self` can be closed with a swipe gesture.

deprecated: 1.4

###### adw_flap_set_swipe_to_open

Sets whether `self` can be opened with a swipe gesture.

deprecated: 1.4

###### adw_flap_set_transition_type

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

deprecated: 1.4

##### Methods inherited from GtkWidget (162)

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.

###### 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.

##### Methods inherited from GtkAccessible (19)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the accessible implementation for the given `GtkAccessible`.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

###### 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.

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`.

###### 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.Flap:content

The content widget.

deprecated: 1.4

###### Adw.Flap:flap

The flap widget.

deprecated: 1.4

###### Adw.Flap:flap-position

The flap position.

deprecated: 1.4

###### Adw.Flap:fold-duration

The fold transition animation duration, in milliseconds.

deprecated: 1.4

###### Adw.Flap:fold-policy

The fold policy for the flap.

deprecated: 1.4

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

Determines when the flap will fold.

deprecated: 1.4

###### Adw.Flap:folded

Whether the flap is currently folded.

deprecated: 1.4

###### Adw.Flap:locked

Whether the flap is locked.

deprecated: 1.4

###### Adw.Flap:modal

Whether the flap is modal.

deprecated: 1.4

###### Adw.Flap:reveal-flap

Whether the flap widget is revealed.

deprecated: 1.4

###### Adw.Flap:reveal-params

The reveal animation spring parameters.

deprecated: 1.4

###### Adw.Flap:reveal-progress

The current reveal transition progress.

deprecated: 1.4

###### Adw.Flap:separator

The separator widget.

deprecated: 1.4

###### Adw.Flap:swipe-to-close

Whether the flap can be closed with a swipe gesture.

deprecated: 1.4

###### Adw.Flap:swipe-to-open

Whether the flap can be opened with a swipe gesture.

deprecated: 1.4

###### Adw.Flap:transition-type

The type of animation used for reveal and fold transitions.

deprecated: 1.4

##### 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 widget’s 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 AdwFlapClass {
      GtkWidgetClass parent_class;

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`

  No description available.