Gtk.StackSidebar

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Bin Gtk.Bin Gtk.StackSidebar Gtk.StackSidebar Gtk.Bin->Gtk.StackSidebar Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container

Subclasses:None

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)

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()[source]
Returns:the new Gtk.StackSidebar
Return type:Gtk.Widget

Creates a new sidebar.

New in version 3.16.

get_stack()[source]
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)[source]
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