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 class@ViewStack via an class@ViewSwitcher.

It is designed to be used as the title widget of a class@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 property@HeaderBar:centering-policy set to [adw.types.CenteringPolicy.Strict].

[adw.view_switcher_title.ViewSwitcherTitle] is intended to be used together with class@ViewSwitcherBar.

A common use case is to bind the property@ViewSwitcherBar:reveal property to property@ViewSwitcherTitle: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

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

Deprecated

See the migration guide
Methods
GType _getGType()
GType _gType() @property
ViewSwitcherTitle self()Returns `this`, for use in `with` statements.
ViewSwitcherTitleGidBuilder builder()Get builder for [adw.viewswitchertitle.ViewSwitcherTitle] Returns: New builder object
adw.view_stack.ViewStack stack() @propertyGet `stack` property. Returns: The stack the view switcher controls.
void stack(adw.view_stack.ViewStack propval) @propertySet `stack` property. Params: propval = The stack the view switcher controls.
string subtitle() @propertyGet `subtitle` property. Returns: The subtitle to display.
void subtitle(string propval) @propertySet `subtitle` property. Params: propval = The subtitle to display.
string title() @propertyGet `title` property. Returns: The title to display.
void title(string propval) @propertySet `title` property. Params: propval = The title to display.
bool titleVisible() @propertyGet `titleVisible` property. Returns: Whether the title is currently visible.
bool viewSwitcherEnabled() @propertyGet `viewSwitcherEnabled` property. Returns: Whether the view switcher is enabled.
void viewSwitcherEnabled(bool propval) @propertySet `viewSwitcherEnabled` property. Params: propval = Whether the view switcher is enabled.
adw.view_stack.ViewStack getStack()Gets the stack controlled by self. Returns: the stack
string getSubtitle()Gets the subtitle of self. Returns: the subtitle
string getTitle()Gets the title of self. Returns: the title
bool getTitleVisible()Gets whether the title of self is currently visible.
bool getViewSwitcherEnabled()Gets whether self's view switcher is enabled. Returns: whether the view switcher is enabled
void setStack(adw.view_stack.ViewStack stack = null)Sets the stack controlled by self.
void setSubtitle(string subtitle)Sets the subtitle of self.
void setTitle(string title)Sets the title of self.
void setViewSwitcherEnabled(bool enabled)Sets whether self's view switcher is enabled.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new [adw.viewswitchertitle.ViewSwitcherTitle]. Returns: the newly created [adw.viewswitchertitle.ViewSwitcherTitle]
classViewSwitcherTitleGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T
Methods
T stack(adw.view_stack.ViewStack propval)Set `stack` property. Params: propval = The stack the view switcher controls. Returns: Builder instance for fluent chaining
T subtitle(string propval)Set `subtitle` property. Params: propval = The subtitle to display.
T title(string propval)Set `title` property. Params: propval = The title to display.
T viewSwitcherEnabled(bool propval)Set `viewSwitcherEnabled` property. Params: propval = Whether the view switcher is enabled.
classViewSwitcherTitleGidBuilder : ViewSwitcherTitleGidBuilderImpl!ViewSwitcherTitleGidBuilder

Fluent builder for [adw.view_switcher_title.ViewSwitcherTitle]

Methods
ViewSwitcherTitle build()