AdwViewSwitcher: Adwaita Reference Manual

AdwViewSwitcher

AdwViewSwitcher — An adaptive view switcher.

Functions

GtkWidget *	adw_view_switcher_new ()
AdwViewSwitcherPolicy	adw_view_switcher_get_policy ()
void	adw_view_switcher_set_policy ()
PangoEllipsizeMode	adw_view_switcher_get_narrow_ellipsize ()
void	adw_view_switcher_set_narrow_ellipsize ()
GtkStack *	adw_view_switcher_get_stack ()
void	adw_view_switcher_set_stack ()

Properties

PangoEllipsizeMode	narrow-ellipsize	Read / Write
AdwViewSwitcherPolicy	policy	Read / Write
GtkStack *	stack	Read / Write

Types and Values

#define	ADW_TYPE_VIEW_SWITCHER
enum	AdwViewSwitcherPolicy
	AdwViewSwitcher

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── AdwViewSwitcher

Implemented Interfaces

AdwViewSwitcher implements GtkAccessible, GtkBuildable and GtkConstraintTarget.

Description

An adaptive view switcher, designed to switch between multiple views in a similar fashion than a GtkStackSwitcher.

Depending on the available width, the view switcher can adapt from a wide mode showing the view's icon and title side by side, to a narrow mode showing the view's icon and title one on top of the other, in a more compact way. This can be controlled via the policy property.

To look good in a header bar, an AdwViewSwitcher requires to fill its full height. Contrary to GtkHeaderBar, AdwHeaderBar doesn't force a vertical alignment on its title widget, so we recommend it over GtkHeaderBar.

CSS nodes

AdwViewSwitcher has a single CSS node with name viewswitcher.

Accessibility

AdwViewSwitcher uses the GTK_ACCESSIBLE_ROLE_TAB_LIST role and uses the GTK_ACCESSIBLE_ROLE_TAB for its buttons.

Functions

adw_view_switcher_new ()

GtkWidget *
adw_view_switcher_new (void);

Creates a new AdwViewSwitcher widget.

Returns

a new AdwViewSwitcher

Since: 1.0

adw_view_switcher_get_policy ()

AdwViewSwitcherPolicy
adw_view_switcher_get_policy (AdwViewSwitcher *self);

Gets the policy of self .

Parameters

self

a AdwViewSwitcher

Returns

the policy of self

Since: 1.0

adw_view_switcher_set_policy ()

void
adw_view_switcher_set_policy (AdwViewSwitcher *self,
                              AdwViewSwitcherPolicy policy);

Sets the policy of self .

Parameters

self	a AdwViewSwitcher
policy	the new policy

Since: 1.0

adw_view_switcher_get_narrow_ellipsize ()

PangoEllipsizeMode
adw_view_switcher_get_narrow_ellipsize
                               (AdwViewSwitcher *self);

Get the ellipsizing position of the narrow mode label. See adw_view_switcher_set_narrow_ellipsize().

Parameters

self

a AdwViewSwitcher

Returns

PangoEllipsizeMode

Since: 1.0

adw_view_switcher_set_narrow_ellipsize ()

void
adw_view_switcher_set_narrow_ellipsize
                               (AdwViewSwitcher *self,
                                PangoEllipsizeMode mode);

Set the mode used to ellipsize the text in narrow mode if there is not enough space to render the entire string.

Parameters

self	a AdwViewSwitcher
mode	a PangoEllipsizeMode

Since: 1.0

adw_view_switcher_get_stack ()

GtkStack *
adw_view_switcher_get_stack (AdwViewSwitcher *self);

Get the GtkStack being controlled by the AdwViewSwitcher.

See: adw_view_switcher_set_stack()

Parameters

self

a AdwViewSwitcher

Returns

the GtkStack, or NULL if none has been set.

[nullable][transfer none]

Since: 1.0

adw_view_switcher_set_stack ()

void
adw_view_switcher_set_stack (AdwViewSwitcher *self,
                             GtkStack *stack);

Sets the GtkStack to control.

Parameters

self	a AdwViewSwitcher
stack	a GtkStack.	[nullable]

Since: 1.0

Types and Values

ADW_TYPE_VIEW_SWITCHER

#define ADW_TYPE_VIEW_SWITCHER (adw_view_switcher_get_type())

enum AdwViewSwitcherPolicy

Members

ADW_VIEW_SWITCHER_POLICY_AUTO	Automatically adapt to the best fitting mode
ADW_VIEW_SWITCHER_POLICY_NARROW	Force the narrow mode
ADW_VIEW_SWITCHER_POLICY_WIDE	Force the wide mode