evolution-dev 3.10.4-0ubuntu1 / usr / share / gtk-doc / html / evolution-shell / EShellSwitcher.html

This file is indexed.

/usr/share/gtk-doc/html/evolution-shell/EShellSwitcher.html is in evolution-dev 3.10.4-0ubuntu1.

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
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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="EShellSearchbar.html" title="EShellSearchbar">
<link rel="next" href="evolution-shell-Shell-Utilities.html" title="Shell Utilities">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="EShellSearchbar.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Shell Reference Manual</th>
<td><a accesskey="n" href="evolution-shell-Shell-Utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShellSwitcher.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EShellSwitcher.description" class="shortcut">Description</a>
                   | 
                  <a href="#EShellSwitcher.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EShellSwitcher.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#EShellSwitcher.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#EShellSwitcher.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShellSwitcher"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShellSwitcher.top_of_page"></a>EShellSwitcher</span></h2>
<p>EShellSwitcher — buttons for switching views</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShellSwitcher.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;shell/e-shell-switcher.h&gt;

struct              <a class="link" href="EShellSwitcher.html#EShellSwitcher-struct" title="struct EShellSwitcher">EShellSwitcher</a>;
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="EShellSwitcher.html#e-shell-switcher-new" title="e_shell_switcher_new ()">e_shell_switcher_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EShellSwitcher.html#e-shell-switcher-add-action" title="e_shell_switcher_add_action ()">e_shell_switcher_add_action</a>         (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="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>);
<span class="returnvalue">GtkToolbarStyle</span>     <a class="link" href="EShellSwitcher.html#e-shell-switcher-get-style" title="e_shell_switcher_get_style ()">e_shell_switcher_get_style</a>          (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EShellSwitcher.html#e-shell-switcher-set-style" title="e_shell_switcher_set_style ()">e_shell_switcher_set_style</a>          (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkToolbarStyle</span> style</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EShellSwitcher.html#e-shell-switcher-unset-style" title="e_shell_switcher_unset_style ()">e_shell_switcher_unset_style</a>        (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EShellSwitcher.html#e-shell-switcher-get-visible" title="e_shell_switcher_get_visible ()">e_shell_switcher_get_visible</a>        (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EShellSwitcher.html#e-shell-switcher-set-visible" title="e_shell_switcher_set_visible ()">e_shell_switcher_set_visible</a>        (<em class="parameter"><code><a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShellSwitcher.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----EShellSwitcher
</pre>
</div>
<div class="refsect1">
<a name="EShellSwitcher.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EShellSwitcher implements
 AtkImplementorIface,  GtkBuildable,  <a href="../libebackend/EExtensible.html">EExtensible</a> and  GtkToolShell.</p>
</div>
<div class="refsect1">
<a name="EShellSwitcher.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="EShellSwitcher.html#EShellSwitcher--toolbar-style" title='The "toolbar-style" property'>toolbar-style</a>"            <span class="type">GtkToolbarStyle</span>       : Read / Write / Construct
  "<a class="link" href="EShellSwitcher.html#EShellSwitcher--toolbar-visible" title='The "toolbar-visible" property'>toolbar-visible</a>"          <span class="type">gboolean</span>              : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="EShellSwitcher.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="EShellSwitcher.html#EShellSwitcher-style-changed" title='The "style-changed" signal'>style-changed</a>"                                  : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="EShellSwitcher.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShellSwitcher.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShellSwitcher-struct"></a><h3>struct EShellSwitcher</h3>
<pre class="programlisting">struct EShellSwitcher;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
</div>
<hr>
<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>
<p>
Creates a new <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> instance</td>
</tr></tbody>
</table></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="EShellSwitcher.html" title="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>
<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="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> adds switcher actions in the order given by the
&lt;structfield&gt;sort_order&lt;/structfield&gt; field in <span class="type">EShellBackendClass</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>switch_action</code></em> :</span></p></td>
<td>a <span class="type">GtkAction</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_window_action</code></em> :</span></p></td>
<td>a <span class="type">GtkAction</span>
</td>
</tr>
</tbody>
</table></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="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>switcher</code></em> has text, icons or both.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the current style of <em class="parameter"><code>shell</code></em>
</td>
</tr>
</tbody>
</table></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="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkToolbarStyle</span> style</code></em>);</pre>
<p>
Alters the view of <em class="parameter"><code>switcher</code></em> to display either icons only, text only,
or both.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>the new style for <em class="parameter"><code>switcher</code></em>
</td>
</tr>
</tbody>
</table></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="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<p>
Unsets a switcher style set with <a class="link" href="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr></tbody>
</table></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="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>);</pre>
<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>&lt;!-- --&gt;'s GTK_VISIBLE flag, since <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
is actually a container widget for <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the switcher buttons are visible</td>
</tr>
</tbody>
</table></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="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre>
<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>&lt;!-- --&gt;'s GTK_VISIBLE flag, since <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
is actually a container widget for <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>visible</code></em> :</span></p></td>
<td>whether the switcher buttons should be visible</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EShellSwitcher.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShellSwitcher--toolbar-style"></a><h3>The <code class="literal">"toolbar-style"</code> property</h3>
<pre class="programlisting">  "toolbar-style"            <span class="type">GtkToolbarStyle</span>       : Read / Write / Construct</pre>
<p>
The switcher's toolbar style.
</p>
<p>Default value: GTK_TOOLBAR_BOTH_HORIZ</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellSwitcher--toolbar-visible"></a><h3>The <code class="literal">"toolbar-visible"</code> property</h3>
<pre class="programlisting">  "toolbar-visible"          <span class="type">gboolean</span>              : Read / Write / Construct</pre>
<p>
Whether the switcher is visible.
</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="EShellSwitcher.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EShellSwitcher-style-changed"></a><h3>The <code class="literal">"style-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> *switcher,
                                                        <span class="type">GtkToolbarStyle</span> style,
                                                        <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
<p>
Emitted when the style of the switcher changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher</code></em> :</span></p></td>
<td>the <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>the new <span class="type">GtkToolbarStyle</span> of the switcher</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.