Gtk.StackSidebar

Subclasses:

None

Methods

Inherited:

Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	new ()
	get_stack ()
	set_stack (stack)

Virtual Methods

Inherited:

Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties

Inherited:

Gtk.Container (3), Gtk.Widget (39)

Name	Type	Flags	Short Description
stack	Gtk.Stack	r/w/en	Associated stack for this Gtk.StackSidebar

Style Properties

Inherited:

Gtk.Widget (17)

Signals

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Fields

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent	Gtk.Bin	r

Class Details

class Gtk.StackSidebar(**kwargs)

Bases:

Gtk.Bin

Abstract:

No

Structure:

Gtk.StackSidebarClass

A Gtk.StackSidebar enables you to quickly and easily provide a consistent “sidebar” object for your user interface.

In order to use a Gtk.StackSidebar, you simply use a Gtk.Stack to organize your UI flow, and add the sidebar to your sidebar area. You can use Gtk.StackSidebar.set_stack() to connect the Gtk.StackSidebar to the Gtk.Stack.

CSS nodes

Gtk.StackSidebar has a single CSS node with name stacksidebar and style class .sidebar.

When circumstances require it, Gtk.StackSidebar adds the .needs-attention style class to the widgets representing the stack pages.

New in version 3.16.

classmethod new()

Returns:

the new Gtk.StackSidebar

Return type:

Gtk.Widget

Creates a new sidebar.

New in version 3.16.

get_stack()

Returns:

the associated Gtk.Stack or None if none has been set explicitly

Return type:

Gtk.Stack or None

Retrieves the stack. See Gtk.StackSidebar.set_stack().

New in version 3.16.

set_stack(stack)

Parameters:

stack (Gtk.Stack) – a Gtk.Stack

Set the Gtk.Stack associated with this Gtk.StackSidebar.

The sidebar widget will automatically update according to the order (packing) and items within the given Gtk.Stack.

New in version 3.16.

Property Details

Gtk.StackSidebar.props.stack

Name:

stack

Type:

Gtk.Stack

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Associated stack for this Gtk.StackSidebar