Struct libadwaita::builders::ToolbarViewBuilder

pub struct ToolbarViewBuilder { /* private fields */ }

Available on crate feature v1_4 only.

A builder-pattern type to construct ToolbarView objects.

Implementations

impl ToolbarViewBuilder

pub fn bottom_bar_style(self, bottom_bar_style: ToolbarStyle) -> Self

Appearance of the bottom bars.

If set to ADW_TOOLBAR_FLAT, bottom bars are flat and scrolling content has a subtle undershoot shadow when touching them, same as the .undershoot-bottom style class. This works well for simple content, e.g. StatusPage or PreferencesPage, where the background at the bottom of the page is uniform. Additionally, windows with sidebars should always use this style.

Undershoot shadow is only present if a bottom bar is actually present and visible. It is also never present if extend-content-to-bottom-edge is set to TRUE.

If set to ADW_TOOLBAR_RAISED, bottom bars have an opaque background and a persistent shadow, this is suitable for content such as utility panes, where some elements are directly adjacent to the bottom bars, or TabView, where each page can have a different background.

ADW_TOOLBAR_RAISED_BORDER is similar to ADW_TOOLBAR_RAISED, but the shadow is replaced with a more subtle border. This can be useful for applications like image viewers.

See also top-bar-style.

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

The content widget.

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

Whether the content widget can extend behind bottom bars.

This can be used in combination with reveal-bottom-bars to show and hide toolbars in fullscreen.

See extend-content-to-top-edge.

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

Whether the content widget can extend behind top bars.

This can be used in combination with reveal-top-bars to show and hide toolbars in fullscreen.

See extend-content-to-bottom-edge.

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

Whether bottom bars are visible.

The transition will be animated.

This can be used in combination with extend-content-to-bottom-edge to show and hide toolbars in fullscreen.

See reveal-top-bars.

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

Whether top bars are revealed.

The transition will be animated.

This can be used in combination with extend-content-to-top-edge to show and hide toolbars in fullscreen.

See reveal-bottom-bars.

pub fn top_bar_style(self, top_bar_style: ToolbarStyle) -> Self

Appearance of the top bars.

If set to ADW_TOOLBAR_FLAT, top bars are flat and scrolling content has a subtle undershoot shadow when touching them, same as the .undershoot-top style class. This works well for simple content, e.g. StatusPage or PreferencesPage, where the background at the top of the page is uniform. Additionally, windows with sidebars should always use this style.

Undershoot shadow is only present if a top bar is actually present and visible. It is also never present if extend-content-to-top-edge is set to TRUE.

If set to ADW_TOOLBAR_RAISED, top bars have an opaque background and a persistent shadow, this is suitable for content such as utility panes, where some elements are directly adjacent to the top bars, or TabView, where each page can have a different background.

ADW_TOOLBAR_RAISED_BORDER is similar to ADW_TOOLBAR_RAISED, but the shadow is replaced with a more subtle border. This can be useful for applications like image viewers.

See also bottom-bar-style.

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.

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

Whether the widget can receive pointer events.

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

A list of css classes applied to this widget.

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.

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

The cursor used by @widget.

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.

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

Whether this widget itself will accept the input focus.

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

How to distribute horizontal space if widget gets extra space.

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.

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.

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

Whether to expand horizontally.

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

Whether to use the hexpand property.

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.

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.

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.

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.

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.

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

The name of the widget.

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

The requested opacity of the widget.

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.

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

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

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

Whether the widget responds to input.

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.

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.

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

How to distribute vertical space if widget gets extra space.

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

Whether to expand vertically.

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

Whether to use the vexpand property.

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

Whether the widget is visible.

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.

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.

pub fn build(self) -> ToolbarView

Build the ToolbarView.