/usr/share/gtk-doc/html/evolution-shell/evolution-shell-EShellSwitcher.html is in evolution-dev 3.28.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShellSwitcher: Evolution Shell Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution Shell Reference Manual">
<link rel="up" href="ch01.html" title="The Shell">
<link rel="prev" href="evolution-shell-EShellSearchbar.html" title="EShellSearchbar">
<link rel="next" href="evolution-shell-e-shell-utils.html" title="e-shell-utils">
<meta name="generator" content="GTK-Doc V1.27 (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="#evolution-shell-EShellSwitcher.description" class="shortcut">Description</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="evolution-shell-EShellSearchbar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-shell-e-shell-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-shell-EShellSwitcher"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-shell-EShellSwitcher.top_of_page"></a>EShellSwitcher</span></h2>
<p>EShellSwitcher — buttons for switching views</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellSwitcher.html#e-shell-switcher-new" title="e_shell_switcher_new ()">e_shell_switcher_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="evolution-shell-EShellSwitcher.html#e-shell-switcher-add-action" title="e_shell_switcher_add_action ()">e_shell_switcher_add_action</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkToolbarStyle</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellSwitcher.html#e-shell-switcher-get-style" title="e_shell_switcher_get_style ()">e_shell_switcher_get_style</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="evolution-shell-EShellSwitcher.html#e-shell-switcher-set-style" title="e_shell_switcher_set_style ()">e_shell_switcher_set_style</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="evolution-shell-EShellSwitcher.html#e-shell-switcher-unset-style" title="e_shell_switcher_unset_style ()">e_shell_switcher_unset_style</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellSwitcher.html#e-shell-switcher-get-visible" title="e_shell_switcher_get_visible ()">e_shell_switcher_get_visible</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="evolution-shell-EShellSwitcher.html#e-shell-switcher-set-visible" title="e_shell_switcher_set_visible ()">e_shell_switcher_set_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-shell-EShellSwitcher.html#E-SHELL-SWITCHER-DEFAULT-TOOLBAR-STYLE:CAPS" title="E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE">E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher">EShellSwitcher</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <shell/e-shell-switcher.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-shell-switcher-new"></a><h3>e_shell_switcher_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
e_shell_switcher_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a new <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> instance.</p>
<div class="refsect3">
<a name="e-shell-switcher-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> instance</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-add-action"></a><h3>e_shell_switcher_add_action ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_shell_switcher_add_action (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
<em class="parameter"><code><span class="type">GtkAction</span> *switch_action</code></em>,
<em class="parameter"><code><span class="type">GtkAction</span> *new_window_action</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_add_action</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Adds a button to <em class="parameter"><code>switcher</code></em>
that proxies for <em class="parameter"><code>switcher_action</code></em>
.
Switcher buttons appear in the order they were added. A middle
click opens a new window of this type.</p>
<p><a class="link" href="evolution-shell-EShellWindow.html#EShellWindow" title="struct EShellWindow"><span class="type">EShellWindow</span></a> adds switcher actions in the order given by the
<em class="structfield"><code>sort_order</code></em> field in <a class="link" href="evolution-shell-EShellBackend.html#EShellBackendClass" title="struct EShellBackendClass"><span class="type">EShellBackendClass</span></a>.</p>
<div class="refsect3">
<a name="e-shell-switcher-add-action.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>switch_action</p></td>
<td class="parameter_description"><p>a <span class="type">GtkAction</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_window_action</p></td>
<td class="parameter_description"><p>a <span class="type">GtkAction</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-get-style"></a><h3>e_shell_switcher_get_style ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkToolbarStyle</span>
e_shell_switcher_get_style (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_get_style</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns whether <em class="parameter"><code>switcher</code></em>
has text, icons or both.</p>
<div class="refsect3">
<a name="e-shell-switcher-get-style.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-switcher-get-style.returns"></a><h4>Returns</h4>
<p> the current style of <em class="parameter"><code>shell</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-set-style"></a><h3>e_shell_switcher_set_style ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_shell_switcher_set_style (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
<em class="parameter"><code><span class="type">GtkToolbarStyle</span> style</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_set_style</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Alters the view of <em class="parameter"><code>switcher</code></em>
to display either icons only, text only,
or both.</p>
<div class="refsect3">
<a name="e-shell-switcher-set-style.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>style</p></td>
<td class="parameter_description"><p>the new style for <em class="parameter"><code>switcher</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-unset-style"></a><h3>e_shell_switcher_unset_style ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_shell_switcher_unset_style (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_unset_style</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Unsets a switcher style set with <a class="link" href="evolution-shell-EShellSwitcher.html#e-shell-switcher-set-style" title="e_shell_switcher_set_style ()"><code class="function">e_shell_switcher_set_style()</code></a>, so
that user preferences will be used to determine the switcher style.</p>
<div class="refsect3">
<a name="e-shell-switcher-unset-style.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-get-visible"></a><h3>e_shell_switcher_get_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
e_shell_switcher_get_visible (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_get_visible</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns <code class="literal">TRUE</code> if the switcher buttons are visible.</p>
<p>Note that switcher button visibility is different than
<em class="parameter"><code>switcher</code></em>
's GTK_VISIBLE flag, since <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a>
is actually a container widget for <a class="link" href="evolution-shell-EShellSidebar.html#EShellSidebar" title="struct EShellSidebar"><span class="type">EShellSidebar</span></a>.</p>
<div class="refsect3">
<a name="e-shell-switcher-get-visible.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-switcher-get-visible.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the switcher buttons are visible</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-switcher-set-visible"></a><h3>e_shell_switcher_set_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_shell_switcher_set_visible (<em class="parameter"><code><a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_switcher_set_visible</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets the switcher button visiblity to <em class="parameter"><code>visible</code></em>
.</p>
<p>Note that switcher button visibility is different than
<em class="parameter"><code>switcher</code></em>
's GTK_VISIBLE flag, since <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a>
is actually a container widget for <a class="link" href="evolution-shell-EShellSidebar.html#EShellSidebar" title="struct EShellSidebar"><span class="type">EShellSidebar</span></a>.</p>
<div class="refsect3">
<a name="e-shell-switcher-set-visible.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>switcher</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellSwitcher.html#EShellSwitcher" title="struct EShellSwitcher"><span class="type">EShellSwitcher</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>visible</p></td>
<td class="parameter_description"><p>whether the switcher buttons should be visible</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellSwitcher.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SHELL-SWITCHER-DEFAULT-TOOLBAR-STYLE:CAPS"></a><h3>E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE</h3>
<pre class="programlisting">#define E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE GTK_TOOLBAR_BOTH_HORIZ
</pre>
<div class="warning"><p><code class="literal">E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="EShellSwitcher"></a><h3>struct EShellSwitcher</h3>
<pre class="programlisting">struct EShellSwitcher {
GtkBin parent;
EShellSwitcherPrivate *priv;
};
</pre>
<div class="warning"><p><code class="literal">EShellSwitcher</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|