GNOME.org

GtkStackSidebar

GtkStackSidebar — An automatic sidebar widget

Functions

GtkWidget * gtk_stack_sidebar_new ()
void gtk_stack_sidebar_set_stack ()
GtkStack * gtk_stack_sidebar_get_stack ()

Properties

GtkStack * stack Read / Write

Types and Values

  GtkStackSidebar

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkStackSidebar

Implemented Interfaces

GtkStackSidebar implements GtkAccessible, GtkBuildable and GtkConstraintTarget.

Includes

#include <gtk/gtk.h>

Description

A GtkStackSidebar enables you to quickly and easily provide a consistent "sidebar" object for your user interface.

In order to use a GtkStackSidebar, you simply use a GtkStack to organize your UI flow, and add the sidebar to your sidebar area. You can use gtk_stack_sidebar_set_stack() to connect the GtkStackSidebar to the GtkStack.

CSS nodes

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

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

Functions

gtk_stack_sidebar_new ()

GtkWidget *
gtk_stack_sidebar_new (void);

Creates a new sidebar.

Returns

the new GtkStackSidebar

gtk_stack_sidebar_set_stack ()

void
gtk_stack_sidebar_set_stack (GtkStackSidebar *self,
                             GtkStack *stack);

Set the GtkStack associated with this GtkStackSidebar.

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

Parameters

self

a GtkStackSidebar

  

stack

a GtkStack

  

gtk_stack_sidebar_get_stack ()

GtkStack *
gtk_stack_sidebar_get_stack (GtkStackSidebar *self);

Retrieves the stack. See gtk_stack_sidebar_set_stack().

Parameters

self

a GtkStackSidebar

  

Returns

the associated GtkStack or NULL if none has been set explicitly.

[nullable][transfer none]

Types and Values

GtkStackSidebar

typedef struct _GtkStackSidebar GtkStackSidebar;

Property Details

The “stack” property

  “stack”                    GtkStack *

Associated stack for this GtkStackSidebar.

Owner: GtkStackSidebar

Flags: Read / Write

Generated by GTK-Doc V1.33.0