Struct libadwaita::builders::LeafletBuilder

source Β·
pub struct LeafletBuilder { /* private fields */ }
πŸ‘ŽDeprecated: Since 1.4
Expand description

A builder-pattern type to construct Leaflet objects.

Implementations§

source§

impl LeafletBuilder

source

pub fn can_navigate_back(self, can_navigate_back: bool) -> Self

πŸ‘Ž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

source

pub fn can_navigate_forward(self, can_navigate_forward: bool) -> Self

πŸ‘Ž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

source

pub fn can_unfold(self, can_unfold: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether or not the leaflet can unfold. See the migration guide

source

pub fn child_transition_params( self, child_transition_params: &SpringParams, ) -> Self

πŸ‘ŽDeprecated: Since 1.4

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)

See the migration guide

source

pub fn fold_threshold_policy( self, fold_threshold_policy: FoldThresholdPolicy, ) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

source

pub fn homogeneous(self, homogeneous: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

source

pub fn mode_transition_duration(self, mode_transition_duration: u32) -> Self

πŸ‘ŽDeprecated: Since 1.4

The mode transition animation duration, in milliseconds. See the migration guide

source

pub fn transition_type(self, transition_type: LeafletTransitionType) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

source

pub fn visible_child(self, visible_child: &impl IsA<Widget>) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

source

pub fn visible_child_name(self, visible_child_name: impl Into<GString>) -> Self

πŸ‘ŽDeprecated: Since 1.4

The name of the widget currently visible when the leaflet is folded.

See visible-child. See the migration guide

source

pub fn can_focus(self, can_focus: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn can_target(self, can_target: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether the widget can receive pointer events.

source

pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self

πŸ‘ŽDeprecated: Since 1.4

A list of css classes applied to this widget.

source

pub fn css_name(self, css_name: impl Into<GString>) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn cursor(self, cursor: &Cursor) -> Self

πŸ‘ŽDeprecated: Since 1.4

The cursor used by @widget.

source

pub fn focus_on_click(self, focus_on_click: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

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

source

pub fn focusable(self, focusable: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether this widget itself will accept the input focus.

source

pub fn halign(self, halign: Align) -> Self

πŸ‘ŽDeprecated: Since 1.4

How to distribute horizontal space if widget gets extra space.

source

pub fn has_tooltip(self, has_tooltip: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn height_request(self, height_request: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

Override for height request of the widget.

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

source

pub fn hexpand(self, hexpand: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether to expand horizontally.

source

pub fn hexpand_set(self, hexpand_set: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether to use the hexpand property.

source

pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn margin_bottom(self, margin_bottom: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn margin_end(self, margin_end: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn margin_start(self, margin_start: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn margin_top(self, margin_top: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn name(self, name: impl Into<GString>) -> Self

πŸ‘ŽDeprecated: Since 1.4

The name of the widget.

source

pub fn opacity(self, opacity: f64) -> Self

πŸ‘ŽDeprecated: Since 1.4

The requested opacity of the widget.

source

pub fn overflow(self, overflow: Overflow) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn receives_default(self, receives_default: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

source

pub fn sensitive(self, sensitive: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether the widget responds to input.

source

pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self

πŸ‘ŽDeprecated: Since 1.4

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.

source

pub fn valign(self, valign: Align) -> Self

πŸ‘ŽDeprecated: Since 1.4

How to distribute vertical space if widget gets extra space.

source

pub fn vexpand(self, vexpand: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether to expand vertically.

source

pub fn vexpand_set(self, vexpand_set: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether to use the vexpand property.

source

pub fn visible(self, visible: bool) -> Self

πŸ‘ŽDeprecated: Since 1.4

Whether the widget is visible.

source

pub fn width_request(self, width_request: i32) -> Self

πŸ‘ŽDeprecated: Since 1.4

Override for width request of the widget.

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

source

pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self

πŸ‘ŽDeprecated: Since 1.4

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

The accessible role cannot be changed once set.

source

pub fn orientation(self, orientation: Orientation) -> Self

πŸ‘ŽDeprecated: Since 1.4

The orientation of the orientable.

source

pub fn build(self) -> Leaflet

πŸ‘ŽDeprecated: Since 1.4

Build the Leaflet.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Β§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Β§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.