Struct libhandy::ViewSwitcherTitle

pub struct ViewSwitcherTitle { /* private fields */ }

A view switcher title.

A widget letting you switch between multiple views contained by a gtk::Stack, 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.

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="GtkWindow"/>
  <child type="titlebar">
    <object class="HdyHeaderBar">
      <property name="centering-policy">strict</property>
      <child type="title">
        <object class="HdyViewSwitcherTitle"
                id="view_switcher_title">
          <property name="stack">stack</property>
        </object>
      </child>
    </object>
  </child>
  <child>
    <object class="GtkBox">
      <child>
        <object class="GtkStack" id="stack"/>
      </child>
      <child>
        <object class="HdyViewSwitcherBar">
          <property name="stack">stack</property>
          <property name="reveal"
                    bind-source="view_switcher_title"
                    bind-property="title-visible"
                    bind-flags="sync-create"/>
        </object>
      </child>
    </object>
  </child>
</object>

CSS nodes

ViewSwitcherTitle has a single CSS node with name viewswitchertitle.

Properties

policy

The policy used to determine which mode to use.

Readable | Writeable

stack

The gtk::Stack the ViewSwitcher controls.

Readable | Writeable

subtitle

The subtitle of the ViewSwitcher.

The subtitle should give a user additional details.

Readable | Writeable

title

The title of the ViewSwitcher.

The title should give a user additional details. A good title should not include the application name.

Readable | Writeable

title-visible

Whether the bar should be revealed or hidden.

Readable

view-switcher-enabled

Whether the bar should be revealed or hidden.

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

Container

border-width

Readable | Writeable

child

Writeable

resize-mode

Readable | Writeable

Widget

app-paintable

Readable | Writeable

can-default

Readable | Writeable

can-focus

Readable | Writeable

composite-child

Readable

double-buffered

Whether the widget is double buffered.

Readable | Writeable

events

Readable | Writeable

expand

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

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.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

has-default

Readable | Writeable

has-focus

Readable | Writeable

has-tooltip

Enables or disables the emission of #GtkWidget::query-tooltip on @widget. A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

height-request

Readable | Writeable

hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

hexpand-set

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

is-focus

Readable | Writeable

margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

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 gtk_widget_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 gtk_widget_set_size_request() for example.

Readable | Writeable

margin-left

Margin on left 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 gtk_widget_set_size_request() for example.

Readable | Writeable

margin-right

Margin on right 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 gtk_widget_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 gtk_widget_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 gtk_widget_set_size_request() for example.

Readable | Writeable

name

Readable | Writeable

no-show-all

Readable | Writeable

opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable

parent

Readable | Writeable

receives-default

Readable | Writeable

scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Readable

sensitive

Readable | Writeable

style

The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. 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: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget: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: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space, see #GtkAlign

Readable | Writeable

vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Readable | Writeable

vexpand-set

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Readable | Writeable

visible

Readable | Writeable

width-request

Readable | Writeable

window

The widget’s window if it is realized, None otherwise.

Readable

Implements

gtk::prelude::BinExt, gtk::prelude::ContainerExt, gtk::prelude::WidgetExt, glib::ObjectExt, gtk::prelude::BuildableExt

Implementations

impl ViewSwitcherTitle

pub fn new() -> ViewSwitcherTitle

Creates a new ViewSwitcherTitle.

Returns

the newly created ViewSwitcherTitle

pub fn builder() -> ViewSwitcherTitleBuilder

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 policy(&self) -> ViewSwitcherPolicy

Gets the policy of @self.

Returns

the policy of @self

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

Gets the stack controlled by @self.

Returns

the stack

pub fn subtitle(&self) -> Option<GString>

Gets the subtitle of @self.

Returns

the subtitle of @self

pub fn title(&self) -> Option<GString>

Gets the title of @self.

Returns

the title of @self

pub fn is_title_visible(&self) -> bool

Gets whether the title of @self is currently visible.

Returns

whether the title of @self is currently visible

pub fn is_view_switcher_enabled(&self) -> bool

Gets whether @self’s view switcher is enabled.

Returns

whether the view switcher is enabled

pub fn set_policy(&self, policy: ViewSwitcherPolicy)

Sets the policy of @self.

policy

the new policy

pub fn set_stack(&self, stack: Option<&impl IsA<Stack>>)

Sets the gtk::Stack to control.

stack

a stack

pub fn set_subtitle(&self, subtitle: Option<&str>)

Sets the subtitle of @self.

subtitle

a subtitle

pub fn set_title(&self, title: Option<&str>)

Sets the title of @self.

title

a title

pub fn set_view_switcher_enabled(&self, enabled: bool)

Sets whether @self’s view switcher is enabled.

enabled

TRUE to enable the view switcher, FALSE to disable it

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

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

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

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

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

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

Trait Implementations

impl Clone for ViewSwitcherTitle

fn clone(&self) -> Self

Returns a copy of the value.

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 Display for ViewSwitcherTitle

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

Formats the value using the given formatter.

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,

Feeds this value into the given Hasher.

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ViewSwitcherTitle

type Parent = Bin

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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<Bin> for ViewSwitcherTitle

impl IsA<Buildable> for ViewSwitcherTitle

impl IsA<Container> for ViewSwitcherTitle

impl IsA<Widget> for ViewSwitcherTitle