Struct libadwaita::builders::LeafletBuilder
source Β· pub struct LeafletBuilder { /* private fields */ }
Expand description
A builder-pattern type to construct Leaflet
objects.
Implementations§
source§impl LeafletBuilder
impl LeafletBuilder
πDeprecated: Since 1.4
Whether gestures and shortcuts for navigating backward are enabled.
The supported gestures are:
- One-finger swipe on touchscreens
- Horizontal scrolling on touchpads (usually two-finger swipe)
- Back/forward mouse buttons
The keyboard back/forward keys are also supported, as well as the Alt+β shortcut for horizontal orientation, or Alt+β for vertical orientation.
If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed.
Only children that have navigatable
set to TRUE
can be navigated to.
See the migration guide
πDeprecated: Since 1.4
Whether gestures and shortcuts for navigating forward are enabled.
The supported gestures are:
- One-finger swipe on touchscreens
- Horizontal scrolling on touchpads (usually two-finger swipe)
- Back/forward mouse buttons
The keyboard back/forward keys are also supported, as well as the Alt+β shortcut for horizontal orientation, or Alt+β for vertical orientation.
If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed.
Only children that have navigatable
set to TRUE
can be navigated to.
See the migration guide
sourcepub fn can_unfold(self, can_unfold: bool) -> Self
πDeprecated: Since 1.4
pub fn can_unfold(self, can_unfold: bool) -> Self
Whether or not the leaflet can unfold. See the migration guide
sourcepub fn child_transition_params(
self,
child_transition_params: &SpringParams,
) -> Self
πDeprecated: Since 1.4
pub fn child_transition_params( self, child_transition_params: &SpringParams, ) -> Self
The child transition spring parameters.
The default value is equivalent to:
β οΈ The following code is in c β οΈ
adw_spring_params_new (1, 0.5, 500)
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 leaflet will fold.
If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM
, it 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 homogeneous(self, homogeneous: bool) -> Self
πDeprecated: Since 1.4
pub fn homogeneous(self, homogeneous: bool) -> Self
Whether the leaflet allocates the same size for all children when folded.
If set to FALSE
, different children can have different size along the
opposite orientation.
See the migration guide
sourcepub fn mode_transition_duration(self, mode_transition_duration: u32) -> Self
πDeprecated: Since 1.4
pub fn mode_transition_duration(self, mode_transition_duration: u32) -> Self
The mode transition animation duration, in milliseconds. See the migration guide
sourcepub fn transition_type(self, transition_type: LeafletTransitionType) -> Self
πDeprecated: Since 1.4
pub fn transition_type(self, transition_type: LeafletTransitionType) -> Self
The type of animation used for transitions between modes and children.
The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to become current. See the migration guide
sourcepub fn visible_child(self, visible_child: &impl IsA<Widget>) -> Self
πDeprecated: Since 1.4
pub fn visible_child(self, visible_child: &impl IsA<Widget>) -> Self
The widget currently visible when the leaflet is folded.
The transition is determined by transition-type
and
child-transition-params
. The transition can be cancelled
by the user, in which case visible child will change back to the previously
visible child.
See the migration guide
sourcepub fn visible_child_name(self, visible_child_name: impl Into<GString>) -> Self
πDeprecated: Since 1.4
pub fn visible_child_name(self, visible_child_name: impl Into<GString>) -> Self
The name of the widget currently visible when the leaflet is folded.
See visible-child
.
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.