Flap


Object Hierarchy:

Hdy.Flap Hdy.Flap Hdy.Flap Gtk.Container Gtk.Container Gtk.Container->Hdy.Flap Gtk.Widget Gtk.Widget Gtk.Widget->Gtk.Container GLib.InitiallyUnowned GLib.InitiallyUnowned GLib.InitiallyUnowned->Gtk.Widget GLib.Object GLib.Object GLib.Object->GLib.InitiallyUnowned Atk.Implementor Atk.Implementor Atk.Implementor->Hdy.Flap Atk.Implementor->Gtk.Container Atk.Implementor->Gtk.Widget Gtk.Buildable Gtk.Buildable Gtk.Buildable->Hdy.Flap Gtk.Buildable->Gtk.Container Gtk.Buildable->Gtk.Widget Gtk.Orientable Gtk.Orientable Gtk.Orientable->Hdy.Flap Hdy.Swipeable Hdy.Swipeable Hdy.Swipeable->Hdy.Flap

Description:

[ CCode ( type_id = "hdy_flap_get_type ()" ) ]
[ Version ( since = "1.2" ) ]
public sealed class Flap : Container, Implementor, Buildable, Orientable, Swipeable

An adaptive container acting like a box or an overlay.

The `HdyFlap` widget can display its children like a [class@Gtk.Box] does or like a [class@Gtk.Overlay] does, according to the [ property@Flap:fold-policy] value.

`HdyFlap` has at most three children: [property@Flap:content], [property@Flap:flap] and [property@Flap: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 [ property@Flap:reveal-flap] value, as well as via swipe gestures if [property@Flap:swipe-to-open] and/or [property@Flap: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.

[property@Flap:flap] is transparent by default; add the `.background` style class to it if this is unwanted.

If [property@Flap: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 [ property@Flap: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 [ property@Flap: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.

HdyFlap as GtkBuildable

The `HdyFlap` implementation of the [iface@Gtk.Buildable] 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

`HdyFlap` 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.


Namespace: Hdy
Package: libhandy-1

Content:

Properties:

Creation methods:

Methods:

Inherited Members:

All known members inherited from class Gtk.Widget
All known members inherited from interface Atk.Implementor
All known members inherited from interface Gtk.Orientable