File: libxfce4panel-Standard-Enumerations.html

package info (click to toggle)
xfce4-panel 4.3.99.2-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 6,000 kB
  • ctags: 2,052
  • sloc: ansic: 17,370; sh: 8,587; xml: 2,908; makefile: 804
file content (399 lines) | stat: -rw-r--r-- 14,002 bytes parent folder | download
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Standard Enumerations</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="libxfce4panel Reference Manual">
<link rel="up" href="ch01.html" title="API Reference">
<link rel="prev" href="XfceHVBox.html" title="XfceHVBox">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="API Reference">
</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="XfceHVBox.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">libxfce4panel Reference Manual</th>
<td>&#160;</td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libxfce4panel-Standard-Enumerations"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>Standard Enumerations</span></h2>
<p>Standard Enumerations &#8212; <p>
Standard enumerations used by the Xfce Panel.
</p></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">



enum        <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition">XfceScreenPosition</a>;
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-horizontal">xfce_screen_position_is_horizontal</a>(position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-get-orientation">xfce_screen_position_get_orientation</a>(position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-floating">xfce_screen_position_is_floating</a>(position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-top">xfce_screen_position_is_top</a>     (position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-left">xfce_screen_position_is_left</a>    (position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-right">xfce_screen_position_is_right</a>   (position)
#define     <a href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-bottom">xfce_screen_position_is_bottom</a>  (position)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
Currently only contains the definition of <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2545982"></a><h3>
<a name="XfceScreenPosition"></a>enum XfceScreenPosition</h3>
<a class="indexterm" name="id2545994"></a><pre class="programlisting">typedef enum /*&lt;enum,prefix=XFCE_SCREEN_POSITION &gt;*/
{
    XFCE_SCREEN_POSITION_NONE,
    
    /* top */
    XFCE_SCREEN_POSITION_NW_H,          /* North West Horizontal */
    XFCE_SCREEN_POSITION_N,             /* North                 */
    XFCE_SCREEN_POSITION_NE_H,          /* North East Horizontal */

    /* left */
    XFCE_SCREEN_POSITION_NW_V,          /* North West Vertical   */
    XFCE_SCREEN_POSITION_W,             /* West                  */
    XFCE_SCREEN_POSITION_SW_V,          /* South West Vertical   */
    
    /* right */
    XFCE_SCREEN_POSITION_NE_V,          /* North East Vertical   */
    XFCE_SCREEN_POSITION_E,             /* East                  */
    XFCE_SCREEN_POSITION_SE_V,          /* South East Vertical   */

    /* bottom */
    XFCE_SCREEN_POSITION_SW_H,          /* South West Horizontal */
    XFCE_SCREEN_POSITION_S,             /* South                 */
    XFCE_SCREEN_POSITION_SE_H,          /* South East Horizontal */

    /* floating */
    XFCE_SCREEN_POSITION_FLOATING_H,    /* Floating Horizontal */
    XFCE_SCREEN_POSITION_FLOATING_V,    /* Floating Vertical */
}
XfceScreenPosition;
</pre>
<p>
There are three screen positions for each side of the screen:
LEFT/TOP, CENTER and RIGHT/BOTTOM. The XfceScreenPosition is expressed
as navigational direction, with possible addition of H or V to denote
horizontal and vertical orientation. Additionally there are two floating 
positions, horizontal and vertical.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-NONE:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_NONE</code></span></td>
<td> No position has been set.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-NW-H:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_NW_H</code></span></td>
<td> North West Horizontal
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-N:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_N</code></span></td>
<td> North
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-NE-H:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_NE_H</code></span></td>
<td> North East Horizontal
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-NW-V:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_NW_V</code></span></td>
<td> North West Vertical
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-W:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_W</code></span></td>
<td> West
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-SW-V:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_SW_V</code></span></td>
<td> South West Vertical
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-NE-V:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_NE_V</code></span></td>
<td> North East Vertical
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-E:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_E</code></span></td>
<td> East
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-SE-V:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_SE_V</code></span></td>
<td> South East Vertical
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-SW-H:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_SW_H</code></span></td>
<td> South West Horizontal
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-S:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_S</code></span></td>
<td> South
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-SE-H:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_SE_H</code></span></td>
<td> South East Horizontal
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-FLOATING-H:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_FLOATING_H</code></span></td>
<td> Floating Horizontal
</td>
</tr>
<tr>
<td>
<span class="term"><a name="XFCE-SCREEN-POSITION-FLOATING-V:CAPS"></a><code class="literal">XFCE_SCREEN_POSITION_FLOATING_V</code></span></td>
<td> Floating Vertical
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573088"></a><h3>
<a name="xfce-screen-position-is-horizontal"></a>xfce_screen_position_is_horizontal()</h3>
<a class="indexterm" name="id2573101"></a><pre class="programlisting">#define     xfce_screen_position_is_horizontal(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if horizontal, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573177"></a><h3>
<a name="xfce-screen-position-get-orientation"></a>xfce_screen_position_get_orientation()</h3>
<a class="indexterm" name="id2573190"></a><pre class="programlisting">#define     xfce_screen_position_get_orientation(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the <span class="type">GtkOrientation</span> corresponding to <em class="parameter"><code>position</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573422"></a><h3>
<a name="xfce-screen-position-is-floating"></a>xfce_screen_position_is_floating()</h3>
<a class="indexterm" name="id2573435"></a><pre class="programlisting">#define     xfce_screen_position_is_floating(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if floating, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573512"></a><h3>
<a name="xfce-screen-position-is-top"></a>xfce_screen_position_is_top()</h3>
<a class="indexterm" name="id2573523"></a><pre class="programlisting">#define     xfce_screen_position_is_top(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if on the top of the screen, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573599"></a><h3>
<a name="xfce-screen-position-is-left"></a>xfce_screen_position_is_left()</h3>
<a class="indexterm" name="id2573612"></a><pre class="programlisting">#define     xfce_screen_position_is_left(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if on the left of the screen, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583268"></a><h3>
<a name="xfce-screen-position-is-right"></a>xfce_screen_position_is_right()</h3>
<a class="indexterm" name="id2583281"></a><pre class="programlisting">#define     xfce_screen_position_is_right(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if on the right of the screen, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583357"></a><h3>
<a name="xfce-screen-position-is-bottom"></a>xfce_screen_position_is_bottom()</h3>
<a class="indexterm" name="id2583371"></a><pre class="programlisting">#define     xfce_screen_position_is_bottom(position)</pre>
<p>
</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td> the <a href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if on the bottom of the screen, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>