/usr/share/gtk-doc/html/libxfce4panel-1.0/libxfce4panel-Standard-Enumerations.html is in xfce4-panel-dev 4.10.1-1.
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 365 366 367 368 369 370 371 372 373 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Standard Enumerations</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
<link rel="up" href="libxfce4panel-fundamentals.html" title="Part I. Fundamentals">
<link rel="prev" href="libxfce4panel-Version-Information.html" title="Version Information">
<link rel="next" href="libxfce4panel-Commonly-used-plugin-macros.html" title="Commonly used plugin macros">
<meta name="generator" content="GTK-Doc V1.18 (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="libxfce4panel-Version-Information.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4panel-fundamentals.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><a accesskey="n" href="libxfce4panel-Commonly-used-plugin-macros.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfce4panel-Standard-Enumerations.synopsis" class="shortcut">Top</a>
|
<a href="#libxfce4panel-Standard-Enumerations.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<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="libxfce4panel-Standard-Enumerations.top_of_page"></a>Standard Enumerations</span></h2>
<p>Standard Enumerations — Standard enumerations used by the Xfce Panel.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxfce4panel-Standard-Enumerations.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libxfce4panel/libxfce4panel.h>
enum <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition">XfceScreenPosition</a>;
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-get-orientation" title="xfce_screen_position_get_orientation()">xfce_screen_position_get_orientation</a>(position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-bottom" title="xfce_screen_position_is_bottom()">xfce_screen_position_is_bottom</a> (position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-floating" title="xfce_screen_position_is_floating()">xfce_screen_position_is_floating</a> (position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-horizontal" title="xfce_screen_position_is_horizontal()">xfce_screen_position_is_horizontal</a> (position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-left" title="xfce_screen_position_is_left()">xfce_screen_position_is_left</a> (position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-right" title="xfce_screen_position_is_right()">xfce_screen_position_is_right</a> (position)
#define <a class="link" href="libxfce4panel-Standard-Enumerations.html#xfce-screen-position-is-top" title="xfce_screen_position_is_top()">xfce_screen_position_is_top</a> (position)
</pre>
</div>
<div class="refsect1">
<a name="libxfce4panel-Standard-Enumerations.description"></a><h2>Description</h2>
<p>
Currently only contains the definition of <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>.
</p>
</div>
<div class="refsect1">
<a name="libxfce4panel-Standard-Enumerations.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XfceScreenPosition"></a><h3>enum XfceScreenPosition</h3>
<pre class="programlisting">typedef enum {
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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-NONE:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_NONE</code></span></p></td>
<td>No position has been set.
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-NW-H:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_NW_H</code></span></p></td>
<td>North West Horizontal
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-N:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_N</code></span></p></td>
<td>North
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-NE-H:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_NE_H</code></span></p></td>
<td>North East Horizontal
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-NW-V:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_NW_V</code></span></p></td>
<td>North West Vertical
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-W:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_W</code></span></p></td>
<td>West
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-SW-V:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_SW_V</code></span></p></td>
<td>South West Vertical
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-NE-V:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_NE_V</code></span></p></td>
<td>North East Vertical
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-E:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_E</code></span></p></td>
<td>East
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-SE-V:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_SE_V</code></span></p></td>
<td>South East Vertical
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-SW-H:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_SW_H</code></span></p></td>
<td>South West Horizontal
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-S:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_S</code></span></p></td>
<td>South
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-SE-H:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_SE_H</code></span></p></td>
<td>South East Horizontal
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-FLOATING-H:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_FLOATING_H</code></span></p></td>
<td>Floating Horizontal
</td>
</tr>
<tr>
<td><p><a name="XFCE-SCREEN-POSITION-FLOATING-V:CAPS"></a><span class="term"><code class="literal">XFCE_SCREEN_POSITION_FLOATING_V</code></span></p></td>
<td>Floating Vertical
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-get-orientation"></a><h3>xfce_screen_position_get_orientation()</h3>
<pre class="programlisting">#define xfce_screen_position_get_orientation(position)</pre>
<p>
Converts the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> into a <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> corresponding to <em class="parameter"><code>position</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-bottom"></a><h3>xfce_screen_position_is_bottom()</h3>
<pre class="programlisting">#define xfce_screen_position_is_bottom(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is below of the center of
the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if on the bottom of the screen, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-floating"></a><h3>xfce_screen_position_is_floating()</h3>
<pre class="programlisting">#define xfce_screen_position_is_floating(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is floating on the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if floating, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-horizontal"></a><h3>xfce_screen_position_is_horizontal()</h3>
<pre class="programlisting">#define xfce_screen_position_is_horizontal(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is horizontal.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if horizontal, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-left"></a><h3>xfce_screen_position_is_left()</h3>
<pre class="programlisting">#define xfce_screen_position_is_left(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is left of the center of
the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if on the left of the screen, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-right"></a><h3>xfce_screen_position_is_right()</h3>
<pre class="programlisting">#define xfce_screen_position_is_right(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is right of the center of
the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if on the right of the screen, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screen-position-is-top"></a><h3>xfce_screen_position_is_top()</h3>
<pre class="programlisting">#define xfce_screen_position_is_top(position)</pre>
<p>
Whether the current <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> is above of the center of
the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if on the top of the screen, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|