<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkStackSidebar: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="LayoutContainers.html" title="Layout Containers">
<link rel="prev" href="GtkStackSwitcher.html" title="GtkStackSwitcher">
<link rel="next" href="GtkActionBar.html" title="GtkActionBar">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkStackSidebar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkStackSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkStackSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkStackSidebar.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="LayoutContainers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkStackSwitcher.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkActionBar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkStackSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkStackSidebar.top_of_page"></a>GtkStackSidebar</span></h2>
<p>GtkStackSidebar — An automatic sidebar widget</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="sidebar.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkStackSidebar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkStackSidebar.html#gtk-stack-sidebar-new" title="gtk_stack_sidebar_new ()">gtk_stack_sidebar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkStackSidebar.html#gtk-stack-sidebar-set-stack" title="gtk_stack_sidebar_set_stack ()">gtk_stack_sidebar_set_stack</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkStack.html" title="GtkStack"><span class="returnvalue">GtkStack</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkStackSidebar.html#gtk-stack-sidebar-get-stack" title="gtk_stack_sidebar_get_stack ()">gtk_stack_sidebar_get_stack</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a> *</td>
<td class="property_name"><a class="link" href="GtkStackSidebar.html#GtkStackSidebar--stack" title="The “stack” property">stack</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkStackSidebar.html#GtkStackSidebar-struct" title="struct GtkStackSidebar">GtkStackSidebar</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkStackSidebar.html#GtkStackSidebarClass" title="struct GtkStackSidebarClass">GtkStackSidebarClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
<span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> GtkStackSidebar
</pre>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkStackSidebar implements
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.description"></a><h2>Description</h2>
<p>A GtkStackSidebar enables you to quickly and easily provide a
consistent "sidebar" object for your user interface.</p>
<p>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 <a class="link" href="GtkStackSidebar.html#gtk-stack-sidebar-set-stack" title="gtk_stack_sidebar_set_stack ()"><code class="function">gtk_stack_sidebar_set_stack()</code></a> to connect the <a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a>
to the <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a>.</p>
<div class="refsect2">
<a name="id-1.3.7.9.9.4"></a><h3>CSS nodes</h3>
<p>GtkStackSidebar has a single CSS node with name stacksidebar and
style class .sidebar.</p>
<p>When circumstances require it, GtkStackSidebar adds the
.needs-attention style class to the widgets representing the stack
pages.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-stack-sidebar-new"></a><h3>gtk_stack_sidebar_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_stack_sidebar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new sidebar.</p>
<div class="refsect3">
<a name="gtk-stack-sidebar-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-stack-sidebar-set-stack"></a><h3>gtk_stack_sidebar_set_stack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_stack_sidebar_set_stack (<em class="parameter"><code><a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a> *stack</code></em>);</pre>
<p>Set the <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a> associated with this <a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a>.</p>
<p>The sidebar widget will automatically update according to the order
(packing) and items within the given <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a>.</p>
<div class="refsect3">
<a name="gtk-stack-sidebar-set-stack.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stack</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-stack-sidebar-get-stack"></a><h3>gtk_stack_sidebar_get_stack ()</h3>
<pre class="programlisting"><a class="link" href="GtkStack.html" title="GtkStack"><span class="returnvalue">GtkStack</span></a> *
gtk_stack_sidebar_get_stack (<em class="parameter"><code><a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a> *sidebar</code></em>);</pre>
<p>Retrieves the stack.
See <a class="link" href="GtkStackSidebar.html#gtk-stack-sidebar-set-stack" title="gtk_stack_sidebar_set_stack ()"><code class="function">gtk_stack_sidebar_set_stack()</code></a>.</p>
<div class="refsect3">
<a name="gtk-stack-sidebar-get-stack.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkStackSidebar.html" title="GtkStackSidebar"><span class="type">GtkStackSidebar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-stack-sidebar-get-stack.returns"></a><h4>Returns</h4>
<p>the associated <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a> or
<code class="literal">NULL</code> if none has been set explicitly. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkStackSidebar-struct"></a><h3>struct GtkStackSidebar</h3>
<pre class="programlisting">struct GtkStackSidebar;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkStackSidebarClass"></a><h3>struct GtkStackSidebarClass</h3>
<pre class="programlisting">struct GtkStackSidebarClass {
GtkBinClass parent_class;
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkStackSidebar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkStackSidebar--stack"></a><h3>The <code class="literal">“stack”</code> property</h3>
<pre class="programlisting"> “stack” <a class="link" href="GtkStack.html" title="GtkStack"><span class="type">GtkStack</span></a> *</pre>
<p>Associated stack for this GtkStackSidebar.</p>
<p>Owner: GtkStackSidebar</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>