Struct ViewSwitcherTitle

pub struct ViewSwitcherTitle { /* private fields */ }

👎Deprecated: Since 1.4

See the migration guide A view switcher title.

A widget letting you switch between multiple views contained by a ViewStack via an ViewSwitcher.

It is designed to be used as the title widget of a HeaderBar, and will display the window’s title when the window is too narrow to fit the view switcher e.g. on mobile phones, or if there are less than two views.

In order to center the title in narrow windows, the header bar should have centering-policy set to ADW_CENTERING_POLICY_STRICT.

ViewSwitcherTitle is intended to be used together with ViewSwitcherBar.

A common use case is to bind the reveal property to title-visible to automatically reveal the view switcher bar when the title label is displayed in place of the view switcher, as follows:

<object class="AdwWindow">
  <property name="content">
    <object class="AdwToolbarView">
      <child type="top">
        <object class="AdwHeaderBar">
          <property name="centering-policy">strict</property>
          <property name="title-widget">
            <object class="AdwViewSwitcherTitle" id="title">
              <property name="stack">stack</property>
            </object>
          </property>
        </object>
      </child>
      <property name="content">
        <object class="AdwViewStack" id="stack"/>
      </property>
      <child type="bottom">
        <object class="AdwViewSwitcherBar">
          <property name="stack">stack</property>
          <binding name="reveal">
            <lookup name="title-visible">title</lookup>
          </binding>
        </object>
      </child>
    </object>
  </property>
</object>

CSS nodes

ViewSwitcherTitle has a single CSS node with name viewswitchertitle.

Properties

stack

The stack the view switcher controls.

Readable | Writeable

subtitle

The subtitle to display.

The subtitle should give the user additional details.

Readable | Writeable

title

The title to display.

The title typically identifies the current view or content item, and generally does not use the application name.

Readable | Writeable

title-visible

Whether the title is currently visible.

If the title is visible, it means the view switcher is hidden an it may be wanted to show an alternative switcher, e.g. a ViewSwitcherBar.

Readable

view-switcher-enabled

Whether the view switcher is enabled.

If it is disabled, the title will be displayed instead. This allows to programmatically hide the view switcher even if it fits in the available space.

This can be used e.g. to ensure the view switcher is hidden below a certain window width, or any other constraint you find suitable.

Readable | Writeable

Widget

can-focus

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.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

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.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

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.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

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.

Readable | Writeable

height-request

Override for height request of the widget.

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

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

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.

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

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.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

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

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

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.

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

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

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

Readable | Writeable

Accessible

accessible-role

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

The accessible role cannot be changed once set.

Readable | Writeable

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl ViewSwitcherTitle

pub fn new() -> ViewSwitcherTitle

👎Deprecated: Since 1.4

Creates a new ViewSwitcherTitle.

Deprecated since 1.4

See the migration guide

Returns

the newly created ViewSwitcherTitle

pub fn builder() -> ViewSwitcherTitleBuilder

👎Deprecated: Since 1.4

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

This method returns an instance of ViewSwitcherTitleBuilder which can be used to create ViewSwitcherTitle objects.

pub fn stack(&self) -> Option<ViewStack>

👎Deprecated: Since 1.4

Gets the stack controlled by @self.

Deprecated since 1.4

See the migration guide

Returns

the stack

pub fn subtitle(&self) -> GString

👎Deprecated: Since 1.4

Gets the subtitle of @self.

Deprecated since 1.4

See the migration guide

Returns

the subtitle

pub fn title(&self) -> GString

👎Deprecated: Since 1.4

Gets the title of @self.

Deprecated since 1.4

See the migration guide

Returns

the title

pub fn is_title_visible(&self) -> bool

👎Deprecated: Since 1.4

Gets whether the title of @self is currently visible.

If the title is visible, it means the view switcher is hidden an it may be wanted to show an alternative switcher, e.g. a ViewSwitcherBar.

Deprecated since 1.4

See the migration guide

Returns

whether the title of @self is currently visible

pub fn is_view_switcher_enabled(&self) -> bool

👎Deprecated: Since 1.4

Gets whether @self’s view switcher is enabled.

Deprecated since 1.4

See the migration guide

Returns

whether the view switcher is enabled

pub fn set_stack(&self, stack: Option<&ViewStack>)

👎Deprecated: Since 1.4

Sets the stack controlled by @self.

Deprecated since 1.4

See the migration guide

stack

a stack

pub fn set_subtitle(&self, subtitle: &str)

👎Deprecated: Since 1.4

Sets the subtitle of @self.

The subtitle should give the user additional details.

Deprecated since 1.4

See the migration guide

subtitle

a subtitle

pub fn set_title(&self, title: &str)

👎Deprecated: Since 1.4

Sets the title of @self.

The title typically identifies the current view or content item, and generally does not use the application name.

Deprecated since 1.4

See the migration guide

title

a title

pub fn set_view_switcher_enabled(&self, enabled: bool)

👎Deprecated: Since 1.4

Sets whether @self’s view switcher is enabled.

If it is disabled, the title will be displayed instead. This allows to programmatically hide the view switcher even if it fits in the available space.

This can be used e.g. to ensure the view switcher is hidden below a certain window width, or any other constraint you find suitable.

Deprecated since 1.4

See the migration guide

enabled

whether the view switcher is enabled

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

👎Deprecated: Since 1.4

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

👎Deprecated: Since 1.4

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

👎Deprecated: Since 1.4

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

👎Deprecated: Since 1.4

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

👎Deprecated: Since 1.4

Trait Implementations

impl Clone for ViewSwitcherTitle

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ViewSwitcherTitle

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

Formats the value using the given formatter.

impl Default for ViewSwitcherTitle

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ViewSwitcherTitle

type ParamSpec = ParamSpecObject

type SetValue = ViewSwitcherTitle

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ViewSwitcherTitle

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

where H: Hasher,

Hashes the memory address of this object.

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 ViewSwitcherTitle

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for ViewSwitcherTitle

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for ViewSwitcherTitle

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ViewSwitcherTitle

impl IsA<Accessible> for ViewSwitcherTitle

impl IsA<Buildable> for ViewSwitcherTitle

impl IsA<ConstraintTarget> for ViewSwitcherTitle

impl IsA<Widget> for ViewSwitcherTitle