1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XAppStackSidebar: XApp Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="XApp Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="XAppPreferencesWindow.html" title="XAppPreferencesWindow">
<link rel="next" href="XAppStatusIcon.html" title="XAppStatusIcon">
<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="#XAppStackSidebar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#XAppStackSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#XAppStackSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#XAppStackSidebar.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XAppPreferencesWindow.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="XAppStatusIcon.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XAppStackSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XAppStackSidebar.top_of_page"></a>XAppStackSidebar</span></h2>
<p>XAppStackSidebar — An automatic sidebar widget</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XAppStackSidebar.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="XAppStackSidebar.html" title="XAppStackSidebar"><span class="returnvalue">XAppStackSidebar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppStackSidebar.html#xapp-stack-sidebar-new" title="xapp_stack_sidebar_new ()">xapp_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="XAppStackSidebar.html#xapp-stack-sidebar-set-stack" title="xapp_stack_sidebar_set_stack ()">xapp_stack_sidebar_set_stack</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="returnvalue">GtkStack</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppStackSidebar.html#xapp-stack-sidebar-get-stack" title="xapp_stack_sidebar_get_stack ()">xapp_stack_sidebar_get_stack</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.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 href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a> *</td>
<td class="property_name"><a class="link" href="XAppStackSidebar.html#XAppStackSidebar--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="XAppStackSidebar.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="XAppStackSidebar.html#XAPP-TYPE-STACK-SIDEBAR:CAPS" title="XAPP_TYPE_STACK_SIDEBAR">XAPP_TYPE_STACK_SIDEBAR</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="XAppStackSidebar.html#XAppStackSidebar-struct" title="XAppStackSidebar">XAppStackSidebar</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
<span class="lineart">╰──</span> XAppStackSidebar
</pre>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XAppStackSidebar implements
AtkImplementorIface and <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.description"></a><h2>Description</h2>
<p>A XAppStackSidebar allows you to quickly and easily provide a
consistent "sidebar" object for your user interface</p>
<p>In order to use a XAppStackSidebar, 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="XAppStackSidebar.html#xapp-stack-sidebar-set-stack" title="xapp_stack_sidebar_set_stack ()"><code class="function">xapp_stack_sidebar_set_stack()</code></a> to connect the <a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a>
to the <a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a>. The <a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a> is an extended version of the
the <a href="../gtk3/GtkStackSidebar.html#GtkStackSidebar-struct"><span class="type">GtkStackSidebar</span></a> that allows showing an icon in addition to the text.</p>
<div class="refsect2">
<a name="id-1.2.11.8.4"></a><h3>CSS nodes</h3>
<p>XAppStackSidebar has a single CSS node with the name stacksidebar and
style class .sidebar</p>
<p>When circumstances require it, XAppStackSidebar adds the
.needs-attention style class to the widgets representing the stack
pages.</p>
</div>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xapp-stack-sidebar-new"></a><h3>xapp_stack_sidebar_new ()</h3>
<pre class="programlisting"><a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="returnvalue">XAppStackSidebar</span></a> *
xapp_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="xapp-stack-sidebar-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-stack-sidebar-set-stack"></a><h3>xapp_stack_sidebar_set_stack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_stack_sidebar_set_stack (<em class="parameter"><code><a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a> *stack</code></em>);</pre>
<p>Set the <a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a> associated with this <a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a>.</p>
<p>The sidebar widget will automatically update according to the order
(packing) and items within the given <a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a>.</p>
<div class="refsect3">
<a name="xapp-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="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</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 href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-stack-sidebar-get-stack"></a><h3>xapp_stack_sidebar_get_stack ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="returnvalue">GtkStack</span></a> *
xapp_stack_sidebar_get_stack (<em class="parameter"><code><a class="link" href="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a> *sidebar</code></em>);</pre>
<p>Retrieves the stack.
See <a class="link" href="XAppStackSidebar.html#xapp-stack-sidebar-set-stack" title="xapp_stack_sidebar_set_stack ()"><code class="function">xapp_stack_sidebar_set_stack()</code></a>.</p>
<div class="refsect3">
<a name="xapp-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="XAppStackSidebar.html" title="XAppStackSidebar"><span class="type">XAppStackSidebar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-stack-sidebar-get-stack.returns"></a><h4>Returns</h4>
<p>the associated <a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a> or
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>
</div>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XAPP-TYPE-STACK-SIDEBAR:CAPS"></a><h3>XAPP_TYPE_STACK_SIDEBAR</h3>
<pre class="programlisting">#define XAPP_TYPE_STACK_SIDEBAR (xapp_stack_sidebar_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="XAppStackSidebar-struct"></a><h3>XAppStackSidebar</h3>
<pre class="programlisting">typedef struct _XAppStackSidebar XAppStackSidebar;</pre>
</div>
</div>
<div class="refsect1">
<a name="XAppStackSidebar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XAppStackSidebar--stack"></a><h3>The <code class="literal">“stack”</code> property</h3>
<pre class="programlisting"> “stack” <a href="../gtk3/GtkStack.html#GtkStack-struct"><span class="type">GtkStack</span></a> *</pre>
<p>Associated stack for this XAppStackSidebar.</p>
<p>Owner: XAppStackSidebar</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
