Struct libhandy::Flap

pub struct Flap { /* private fields */ }

Available on crate feature v1_2 only.

An adaptive container acting like a box or an overlay.

The Flap widget can display its children like a [gtk::Box][crate::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.

HdyFlap as GtkBuildable

The Flap implementation of the [gtk::Buildable][crate::gtk::Buildable] interface supports setting the flap child by specifying “flap” as the “type” attribute of a 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 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 current fold policy.

See FlapFoldPolicy for available policies.

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-duration

The reveal transition animation duration, in milliseconds.

Readable | Writeable

reveal-flap

Whether the flap widget is revealed.

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. If NULL, no separator will be used.

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 HDY_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.

Readable | Writeable

Container

border-width

Readable | Writeable

child

Writeable

resize-mode

Readable | Writeable

Widget

app-paintable

Readable | Writeable

can-default

Readable | Writeable

can-focus

Readable | Writeable

composite-child

Readable

double-buffered

Whether the widget is double buffered.

Readable | Writeable

events

Readable | Writeable

expand

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

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.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

has-default

Readable | Writeable

has-focus

Readable | Writeable

has-tooltip

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

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

height-request

Readable | Writeable

hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

hexpand-set

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

is-focus

Readable | Writeable

margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

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

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-left

Margin on left 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 gtk_widget_set_size_request() for example.

Readable | Writeable

margin-right

Margin on right 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 gtk_widget_set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-top

Margin on top 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 gtk_widget_set_size_request() for example.

Readable | Writeable

name

Readable | Writeable

no-show-all

Readable | Writeable

opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable

parent

Readable | Writeable

receives-default

Readable | Writeable

scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Readable

sensitive

Readable | Writeable

style

The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. 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: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget: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().

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

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

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space, see #GtkAlign

Readable | Writeable

vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Readable | Writeable

vexpand-set

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Readable | Writeable

visible

Readable | Writeable

width-request

Readable | Writeable

window

The widget’s window if it is realized, None otherwise.

Readable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

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

Implementations

impl Flap

pub fn new() -> Flap

Creates a new Flap.

Returns

the newly created Flap

pub fn builder() -> FlapBuilder

Creates a new builder-pattern struct instance to construct Flap objects.

This method returns an instance of FlapBuilder which can be used to create Flap objects.

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

Gets the content widget for @self

Returns

the content widget for @self

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

Gets the flap widget for @self

Returns

the flap widget for @self

pub fn flap_position(&self) -> PackType

Gets the flap position for @self.

Returns

the flap position for @self

pub fn fold_duration(&self) -> u32

Gets the amount of time that fold transitions will take.

Returns

the fold transition duration, in milliseconds

pub fn fold_policy(&self) -> FlapFoldPolicy

Gets the current fold policy of @self.

Returns

the current fold policy of @self

pub fn is_folded(&self) -> bool

Gets whether @self is currently folded.

Returns

TRUE if @self is currently folded

pub fn is_locked(&self) -> bool

Gets whether @self is locked.

Returns

whether @self is locked

pub fn is_modal(&self) -> bool

Gets whether the @self is modal.

Returns

whether @self is modal

pub fn reveal_duration(&self) -> u32

Gets the amount of time that reveal transitions will take.

Returns

the reveal transition duration, in milliseconds

pub fn reveals_flap(&self) -> bool

Gets whether the flap widget is revealed for @self.

Returns

whether flap widget is revealed

pub fn reveal_progress(&self) -> f64

Gets the current reveal transition progress for @self.

Returns

the current reveal progress for @self

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

Gets the separator widget for @self.

Returns

the separator widget for @self

pub fn is_swipe_to_close(&self) -> bool

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

Returns

TRUE if @self can be closed with a swipe gesture

pub fn is_swipe_to_open(&self) -> bool

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

Returns

TRUE if @self can be opened with a swipe gesture

pub fn transition_type(&self) -> FlapTransitionType

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

Returns

the current transition type of @self

pub fn set_content(&self, content: Option<&impl IsA<Widget>>)

Sets the content widget for @self.

It is always displayed when unfolded, and partially visible when folded.

content

the content widget

pub fn set_flap(&self, flap: Option<&impl IsA<Widget>>)

Sets the flap widget for @self.

flap

the flap widget

pub fn set_flap_position(&self, position: PackType)

Sets the flap position for @self.

position

the new value

pub fn set_fold_duration(&self, duration: u32)

Sets the duration that fold transitions will take.

duration

the new duration, in milliseconds

pub fn set_fold_policy(&self, policy: FlapFoldPolicy)

Sets the current fold policy for @self.

policy

a fold policy

pub fn set_locked(&self, locked: bool)

Sets whether @self is locked.

If FALSE, folding @self 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.

locked

the new value

pub fn set_modal(&self, modal: bool)

Sets whether the @self can be closed with a click.

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

modal

whether @self can be closed with a click

pub fn set_reveal_duration(&self, duration: u32)

Sets the duration that reveal transitions in @self will take.

duration

the new duration, in milliseconds

pub fn set_reveal_flap(&self, reveal_flap: bool)

Sets whether the flap widget is revealed for @self.

reveal_flap

TRUE to reveal the flap widget, FALSE otherwise

pub fn set_separator(&self, separator: Option<&impl IsA<Widget>>)

Sets the separator widget for @self.

separator

the separator widget

pub fn set_swipe_to_close(&self, swipe_to_close: bool)

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

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

swipe_to_close

whether @self can be closed with a swipe gesture

pub fn set_swipe_to_open(&self, swipe_to_open: bool)

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

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

swipe_to_open

whether @self can be opened with a swipe gesture

pub fn set_transition_type(&self, transition_type: FlapTransitionType)

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

transition_type

the new transition type

pub fn connect_content_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_flap_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_flap_position_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_fold_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_fold_policy_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_folded_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_locked_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_modal_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reveal_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reveal_flap_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reveal_progress_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_separator_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_swipe_to_close_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_swipe_to_open_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_transition_type_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for Flap

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Flap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Flap

fn default() -> Self

Returns the “default value” for a type.

impl Display for Flap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Flap

type ParamSpec = ParamSpecObject

type SetValue = Flap

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Flap>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Flap

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Flap

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Flap

type Parent = Container

impl<OT: ObjectType> PartialEq<OT> for Flap

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Flap

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Flap

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Flap

impl IsA<Buildable> for Flap

impl IsA<Container> for Flap

impl IsA<Orientable> for Flap

impl IsA<Swipeable> for Flap

impl IsA<Widget> for Flap