Struct libadwaita::builders::FlapBuilder
source Β· pub struct FlapBuilder { /* private fields */ }
Expand description
A builder-pattern type to construct Flap
objects.
Implementations§
source§impl FlapBuilder
impl FlapBuilder
sourcepub fn content(self, content: &impl IsA<Widget>) -> Self
πDeprecated: Since 1.4
pub fn content(self, content: &impl IsA<Widget>) -> Self
The content widget.
Itβs always displayed when unfolded, and partially visible when folded. See the migration guide
sourcepub fn flap(self, flap: &impl IsA<Widget>) -> Self
πDeprecated: Since 1.4
pub fn flap(self, flap: &impl IsA<Widget>) -> Self
The flap widget.
Itβs only visible when reveal-progress
is greater than 0.
See the migration guide
sourcepub fn flap_position(self, flap_position: PackType) -> Self
πDeprecated: Since 1.4
pub fn flap_position(self, flap_position: PackType) -> Self
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.
See the migration guide
sourcepub fn fold_duration(self, fold_duration: u32) -> Self
πDeprecated: Since 1.4
pub fn fold_duration(self, fold_duration: u32) -> Self
The fold transition animation duration, in milliseconds. See the migration guide
sourcepub fn fold_policy(self, fold_policy: FlapFoldPolicy) -> Self
πDeprecated: Since 1.4
pub fn fold_policy(self, fold_policy: FlapFoldPolicy) -> Self
The fold policy for the flap. See the migration guide
sourcepub fn fold_threshold_policy(
self,
fold_threshold_policy: FoldThresholdPolicy,
) -> Self
πDeprecated: Since 1.4
pub fn fold_threshold_policy( self, fold_threshold_policy: FoldThresholdPolicy, ) -> Self
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. See the migration guide
sourcepub fn locked(self, locked: bool) -> Self
πDeprecated: Since 1.4
pub fn locked(self, locked: bool) -> Self
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.
See the migration guide
sourcepub fn modal(self, modal: bool) -> Self
πDeprecated: Since 1.4
pub fn modal(self, modal: bool) -> Self
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.
See the migration guide
sourcepub fn reveal_flap(self, reveal_flap: bool) -> Self
πDeprecated: Since 1.4
pub fn reveal_flap(self, reveal_flap: bool) -> Self
Whether the flap widget is revealed. See the migration guide
sourcepub fn reveal_params(self, reveal_params: &SpringParams) -> Self
πDeprecated: Since 1.4
pub fn reveal_params(self, reveal_params: &SpringParams) -> Self
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)
sourcepub fn separator(self, separator: &impl IsA<Widget>) -> Self
πDeprecated: Since 1.4
pub fn separator(self, separator: &impl IsA<Widget>) -> Self
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.
See the migration guide
sourcepub fn swipe_to_close(self, swipe_to_close: bool) -> Self
πDeprecated: Since 1.4
pub fn swipe_to_close(self, swipe_to_close: bool) -> Self
Whether the flap can be closed with a swipe gesture.
The area that can be swiped depends on the transition-type
value.
See the migration guide
sourcepub fn swipe_to_open(self, swipe_to_open: bool) -> Self
πDeprecated: Since 1.4
pub fn swipe_to_open(self, swipe_to_open: bool) -> Self
Whether the flap can be opened with a swipe gesture.
The area that can be swiped depends on the transition-type
value.
See the migration guide
sourcepub fn transition_type(self, transition_type: FlapTransitionType) -> Self
πDeprecated: Since 1.4
pub fn transition_type(self, transition_type: FlapTransitionType) -> Self
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.
See the migration guide
sourcepub fn can_focus(self, can_focus: bool) -> Self
πDeprecated: Since 1.4
pub fn can_focus(self, can_focus: bool) -> Self
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.
sourcepub fn can_target(self, can_target: bool) -> Self
πDeprecated: Since 1.4
pub fn can_target(self, can_target: bool) -> Self
Whether the widget can receive pointer events.
sourcepub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
πDeprecated: Since 1.4
pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
A list of css classes applied to this widget.
sourcepub fn css_name(self, css_name: impl Into<GString>) -> Self
πDeprecated: Since 1.4
pub fn css_name(self, css_name: impl Into<GString>) -> Self
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.
sourcepub fn cursor(self, cursor: &Cursor) -> Self
πDeprecated: Since 1.4
pub fn cursor(self, cursor: &Cursor) -> Self
The cursor used by @widget.
sourcepub fn focus_on_click(self, focus_on_click: bool) -> Self
πDeprecated: Since 1.4
pub fn focus_on_click(self, focus_on_click: bool) -> Self
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
sourcepub fn focusable(self, focusable: bool) -> Self
πDeprecated: Since 1.4
pub fn focusable(self, focusable: bool) -> Self
Whether this widget itself will accept the input focus.
sourcepub fn halign(self, halign: Align) -> Self
πDeprecated: Since 1.4
pub fn halign(self, halign: Align) -> Self
How to distribute horizontal space if widget gets extra space.
sourcepub fn has_tooltip(self, has_tooltip: bool) -> Self
πDeprecated: Since 1.4
pub fn has_tooltip(self, has_tooltip: bool) -> Self
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.
sourcepub fn height_request(self, height_request: i32) -> Self
πDeprecated: Since 1.4
pub fn height_request(self, height_request: i32) -> Self
Override for height request of the widget.
If this is -1, the natural request will be used.
sourcepub fn hexpand(self, hexpand: bool) -> Self
πDeprecated: Since 1.4
pub fn hexpand(self, hexpand: bool) -> Self
Whether to expand horizontally.
sourcepub fn hexpand_set(self, hexpand_set: bool) -> Self
πDeprecated: Since 1.4
pub fn hexpand_set(self, hexpand_set: bool) -> Self
Whether to use the hexpand
property.
sourcepub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self
πDeprecated: Since 1.4
pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self
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.
sourcepub fn margin_bottom(self, margin_bottom: i32) -> Self
πDeprecated: Since 1.4
pub fn margin_bottom(self, margin_bottom: i32) -> Self
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.
sourcepub fn margin_end(self, margin_end: i32) -> Self
πDeprecated: Since 1.4
pub fn margin_end(self, margin_end: i32) -> Self
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
[WidgetExtManual::set_size_request()
][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.
sourcepub fn margin_start(self, margin_start: i32) -> Self
πDeprecated: Since 1.4
pub fn margin_start(self, margin_start: i32) -> Self
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
[WidgetExtManual::set_size_request()
][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.
sourcepub fn margin_top(self, margin_top: i32) -> Self
πDeprecated: Since 1.4
pub fn margin_top(self, margin_top: i32) -> Self
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
[WidgetExtManual::set_size_request()
][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.
sourcepub fn name(self, name: impl Into<GString>) -> Self
πDeprecated: Since 1.4
pub fn name(self, name: impl Into<GString>) -> Self
The name of the widget.
sourcepub fn opacity(self, opacity: f64) -> Self
πDeprecated: Since 1.4
pub fn opacity(self, opacity: f64) -> Self
The requested opacity of the widget.
sourcepub fn overflow(self, overflow: Overflow) -> Self
πDeprecated: Since 1.4
pub fn overflow(self, overflow: Overflow) -> Self
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.
sourcepub fn receives_default(self, receives_default: bool) -> Self
πDeprecated: Since 1.4
pub fn receives_default(self, receives_default: bool) -> Self
Whether the widget will receive the default action when it is focused.
sourcepub fn sensitive(self, sensitive: bool) -> Self
πDeprecated: Since 1.4
pub fn sensitive(self, sensitive: bool) -> Self
Whether the widget responds to input.
sourcepub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self
πDeprecated: Since 1.4
pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self
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.
sourcepub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self
πDeprecated: Since 1.4
pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self
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
:
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.
sourcepub fn valign(self, valign: Align) -> Self
πDeprecated: Since 1.4
pub fn valign(self, valign: Align) -> Self
How to distribute vertical space if widget gets extra space.
sourcepub fn vexpand(self, vexpand: bool) -> Self
πDeprecated: Since 1.4
pub fn vexpand(self, vexpand: bool) -> Self
Whether to expand vertically.
sourcepub fn vexpand_set(self, vexpand_set: bool) -> Self
πDeprecated: Since 1.4
pub fn vexpand_set(self, vexpand_set: bool) -> Self
Whether to use the vexpand
property.
sourcepub fn visible(self, visible: bool) -> Self
πDeprecated: Since 1.4
pub fn visible(self, visible: bool) -> Self
Whether the widget is visible.
sourcepub fn width_request(self, width_request: i32) -> Self
πDeprecated: Since 1.4
pub fn width_request(self, width_request: i32) -> Self
Override for width request of the widget.
If this is -1, the natural request will be used.
sourcepub fn accessible_role(self, accessible_role: AccessibleRole) -> Self
πDeprecated: Since 1.4
pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self
The accessible role of the given gtk::Accessible
implementation.
The accessible role cannot be changed once set.
sourcepub fn orientation(self, orientation: Orientation) -> Self
πDeprecated: Since 1.4
pub fn orientation(self, orientation: Orientation) -> Self
The orientation of the orientable.