adw.view_switcher_title

Module for [ViewSwitcherTitle] class

class ViewSwitcherTitle ViewSwitcherTitleGidBuilder ViewSwitcherTitleGidBuilderImpl

Types 3

classViewSwitcherTitle : gtk.widget.Widget

A view switcher title.

view-switcher-title

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

It is designed to be used as the title widget of a adw.header_bar.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 adw.header_bar.HeaderBar.centeringPolicy set to adw.types.CenteringPolicy.Strict.

adw.view_switcher_title.ViewSwitcherTitle is intended to be used together with adw.view_switcher_bar.ViewSwitcherBar.

A common use case is to bind the adw.view_switcher_bar.ViewSwitcherBar.reveal property to adw.view_switcher_title.ViewSwitcherTitle.titleVisible 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

adw.view_switcher_title.ViewSwitcherTitle has a single CSS node with name viewswitchertitle.

Deprecated

See the migration guide

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

ViewSwitcherTitle self() nothrowReturns `this`, for use in `with` statements.

ViewSwitcherTitleGidBuilder builder() static nothrowGet builder for [adw.view_switcher_title.ViewSwitcherTitle] Returns: New builder object

adw.view_stack.ViewStack stack() @property nothrowGet `stack` property. Returns: The stack the view switcher controls.

void stack(adw.view_stack.ViewStack propval) @property nothrowSet `stack` property. Params: propval = The stack the view switcher controls.

string subtitle() @property nothrowGet `subtitle` property. Returns: The subtitle to display.

void subtitle(string propval) @property nothrowSet `subtitle` property. Params: propval = The subtitle to display.

string title() @property nothrowGet `title` property. Returns: The title to display.

void title(string propval) @property nothrowSet `title` property. Params: propval = The title to display.

bool titleVisible() @property nothrowGet `titleVisible` property. Returns: Whether the title is currently visible.

bool viewSwitcherEnabled() @property nothrowGet `viewSwitcherEnabled` property. Returns: Whether the view switcher is enabled.

void viewSwitcherEnabled(bool propval) @property nothrowSet `viewSwitcherEnabled` property. Params: propval = Whether the view switcher is enabled.

adw.view_stack.ViewStack getStack() nothrowGets the stack controlled by self. Returns: the stack

string getSubtitle() nothrowGets the subtitle of self. Returns: the subtitle

string getTitle() nothrowGets the title of self. Returns: the title

bool getTitleVisible() nothrowGets whether the title of self is currently visible.

bool getViewSwitcherEnabled() nothrowGets whether self's view switcher is enabled. Returns: whether the view switcher is enabled

void setStack(adw.view_stack.ViewStack stack = null) nothrowSets the stack controlled by self.

void setSubtitle(string subtitle) nothrowSets the subtitle of self.

void setTitle(string title) nothrowSets the title of self.

void setViewSwitcherEnabled(bool enabled) nothrowSets whether self's view switcher is enabled.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [adw.view_switcher_title.ViewSwitcherTitle]. Returns: the newly created [adw.view_switcher_title.ViewSwitcherTitle]

classViewSwitcherTitleGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Fluent builder implementation template for adw.view_switcher_title.ViewSwitcherTitle

Methods

T stack(adw.view_stack.ViewStack propval) nothrowSet `stack` property. Params: propval = The stack the view switcher controls. Returns: Builder instance for fluent chaining

T subtitle(string propval) nothrowSet `subtitle` property. Params: propval = The subtitle to display.

T title(string propval) nothrowSet `title` property. Params: propval = The title to display.

T viewSwitcherEnabled(bool propval) nothrowSet `viewSwitcherEnabled` property. Params: propval = Whether the view switcher is enabled.

classViewSwitcherTitleGidBuilder : ViewSwitcherTitleGidBuilderImpl!ViewSwitcherTitleGidBuilder

Fluent builder for adw.view_switcher_title.ViewSwitcherTitle

Methods

ViewSwitcherTitle build() nothrowCreate object from builder. Returns: New object