Struct libadwaita::Flap

source ·

pub struct Flap { /* private fields */ }

👎Deprecated: Since 1.4

Expand description

See the migration guide An adaptive container acting like a box or an overlay.

The Flap widget can display its children like a Gtk::Box does or like a Gtk::Overlay does, according to the fold-policy value.

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

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

If 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 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 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 Flap implementation of the 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

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

§Properties

§`content`

The content widget.

It’s always displayed when unfolded, and partially visible when folded.

Readable | Writeable

§`flap`

The flap widget.

It’s only visible when reveal-progress is greater than 0.

Readable | Writeable

§`flap-position`

The flap position.

If it’s set to GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it’s displayed after the content.

Readable | Writeable

§`fold-duration`

The fold transition animation duration, in milliseconds.

Readable | Writeable

§`fold-policy`

The fold policy for the flap.

Readable | Writeable

§`fold-threshold-policy`

Determines when the flap will fold.

If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, flap will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don’t get their natural size.

This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.

Readable | Writeable

§`folded`

Whether the flap is currently folded.

See fold-policy.

Readable

§`locked`

Whether the flap is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, reveal-flap value never changes on its own.

Readable | Writeable

§`modal`

Whether the flap is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the Esc key, will close the flap. If FALSE, clicks are passed through to the content widget.

Readable | Writeable

§`reveal-flap`

Whether the flap widget is revealed.

Readable | Writeable

§`reveal-params`

The reveal animation spring parameters.

The default value is equivalent to:

⚠️ The following code is in c ⚠️

adw_spring_params_new (1, 0.5, 500)

Readable | Writeable

§`reveal-progress`

The current reveal transition progress.

0 means fully hidden, 1 means fully revealed.

See reveal-flap.

Readable

§`separator`

The separator widget.

It’s displayed between content and flap when there’s no shadow to display. When exactly it’s visible depends on the transition-type value.

Readable | Writeable

§`swipe-to-close`

Whether the flap can be closed with a swipe gesture.

The area that can be swiped depends on the transition-type value.

Readable | Writeable

§`swipe-to-open`

Whether the flap can be opened with a swipe gesture.

The area that can be swiped depends on the transition-type value.

Readable | Writeable

§`transition-type`

the type of animation used for reveal and fold transitions.

flap is transparent by default, which means the content will be seen through it with ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.

Readable | Writeable

Widget

§`can-focus`

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

§`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

§`css-name`

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

§`cursor`

The cursor used by @widget.

Readable | Writeable

§`focus-on-click`

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

§`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

§`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

§`has-default`

Whether the widget is the default widget.

Readable

§`has-focus`

Whether the widget has the input focus.

Readable

§`has-tooltip`

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

§`height-request`

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

§`hexpand`

Whether to expand horizontally.

Readable | Writeable

§`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

§`layout-manager`

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`margin-bottom`

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

§`margin-end`

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

Readable | Writeable

§`margin-start`

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

Readable | Writeable

§`margin-top`

Margin on top side of widget.

Readable | Writeable

§`name`

The name of the widget.

Readable | Writeable

§`opacity`

The requested opacity of the widget.

Readable | Writeable

§`overflow`

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`parent`

The parent widget of this widget.

Readable

§`receives-default`

Whether the widget will receive the default action when it is focused.

Readable | Writeable

§`root`

The gtk::Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

§`scale-factor`

The scale factor of the widget.

Readable

§`sensitive`

Whether the widget responds to input.

Readable | Writeable

§`tooltip-markup`

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`tooltip-text`

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

§`vexpand`

Whether to expand vertically.

Readable | Writeable

§`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

§`visible`

Whether the widget is visible.

Readable | Writeable

§`width-request`

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

§`accessible-role`

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

§`orientation`

The orientation of the orientable.

Readable | Writeable

§Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, SwipeableExt, gtk::prelude::OrientableExt

Struct libadwaita::Flap

§AdwFlap as GtkBuildable

§CSS nodes

§Properties

§content

§flap

§flap-position

§fold-duration

§fold-policy

§fold-threshold-policy

§folded

§locked

§modal

§reveal-flap

§reveal-params

§reveal-progress

§separator

§swipe-to-close

§swipe-to-open

§transition-type

Widget

§can-focus

§can-target

§css-classes

§css-name

§cursor

§focus-on-click

§focusable

§halign

§has-default

§has-focus

§has-tooltip

§height-request

§hexpand

§hexpand-set

§layout-manager

§margin-bottom

§margin-end

§margin-start

§margin-top

§name

§opacity

§overflow

§parent

§receives-default

§root

§scale-factor

§sensitive

§tooltip-markup

§tooltip-text

§valign

§vexpand

§vexpand-set

§visible

§width-request

Accessible

§accessible-role

Orientable

§orientation

§Implements

Implementations§

impl Flap

pub fn new() -> Flap

§Deprecated since 1.4

§Returns

pub fn builder() -> FlapBuilder

pub fn content(&self) -> Option<Widget>

§Deprecated since 1.4

§Returns

pub fn flap(&self) -> Option<Widget>

§Deprecated since 1.4

§Returns

pub fn flap_position(&self) -> PackType

§Deprecated since 1.4

§Returns

pub fn fold_duration(&self) -> u32

§Deprecated since 1.4

§Returns

pub fn fold_policy(&self) -> FlapFoldPolicy

§Deprecated since 1.4

§`content`

§`flap`

§`flap-position`

§`fold-duration`

§`fold-policy`

§`fold-threshold-policy`

§`folded`

§`locked`

§`modal`

§`reveal-flap`

§`reveal-params`

§`reveal-progress`

§`separator`

§`swipe-to-close`

§`swipe-to-open`

§`transition-type`

§`can-focus`

§`can-target`

§`css-classes`

§`css-name`

§`cursor`

§`focus-on-click`

§`focusable`

§`halign`

§`has-default`

§`has-focus`

§`has-tooltip`

§`height-request`

§`hexpand`

§`hexpand-set`

§`layout-manager`

§`margin-bottom`

§`margin-end`

§`margin-start`

§`margin-top`

§`name`

§`opacity`

§`overflow`

§`parent`

§`receives-default`

§`root`

§`scale-factor`

§`sensitive`

§`tooltip-markup`

§`tooltip-text`

§`valign`

§`vexpand`

§`vexpand-set`

§`visible`

§`width-request`

§`accessible-role`

§`orientation`

§`content`

§`flap`

§`position`

§`duration`

§`policy`

§`policy`

§`locked`

§`modal`

§`reveal_flap`

§`params`