/usr/share/gtk-doc/html/unique/UniqueBackend.html is in libunique-doc 1.1.6-5.
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 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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UniqueBackend</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Unique 1.1.6 Reference Manual">
<link rel="up" href="unique-overview.html" title="Unique Overview">
<link rel="prev" href="unique-Message-Data.html" title="Message Data">
<link rel="next" href="unique-Versioning-Information.html" title="Versioning Information">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="unique-overview.html" title="Unique Overview">
<link rel="index" href="ix01.html" title="Index">
<link rel="appendix" href="license.html" title="Appendix A. License">
</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="unique-Message-Data.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="unique-overview.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">Unique 1.1.6
Reference Manual</th>
<td><a accesskey="n" href="unique-Versioning-Information.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#UniqueBackend.synopsis" class="shortcut">Top</a>
|
<a href="#UniqueBackend.description" class="shortcut">Description</a>
|
<a href="#UniqueBackend.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="UniqueBackend">
<a name="UniqueBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="UniqueBackend.top_of_page"></a>UniqueBackend</span></h2>
<p>UniqueBackend — Backend abstraction</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="UniqueBackend.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="UniqueBackend.html#UniqueBackend-struct" title="UniqueBackend">UniqueBackend</a>;
<a class="link" href="UniqueBackend.html#UniqueBackendClass" title="UniqueBackendClass">UniqueBackendClass</a>;
<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> * <a class="link" href="UniqueBackend.html#unique-backend-create" title="unique_backend_create ()">unique_backend_create</a> (void);
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="UniqueBackend.html#unique-backend-get-name" title="unique_backend_get_name ()">unique_backend_get_name</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);
void <a class="link" href="UniqueBackend.html#unique-backend-set-name" title="unique_backend_set_name ()">unique_backend_set_name</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="UniqueBackend.html#unique-backend-get-startup-id" title="unique_backend_get_startup_id ()">unique_backend_get_startup_id</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);
void <a class="link" href="UniqueBackend.html#unique-backend-set-startup-id" title="unique_backend_set_startup_id ()">unique_backend_set_startup_id</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *startup_id);
<a
href="http://library.gnome.org/devel/gdk/unstable/GdkScreen.html"
>GdkScreen</a> * <a class="link" href="UniqueBackend.html#unique-backend-get-screen" title="unique_backend_get_screen ()">unique_backend_get_screen</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);
void <a class="link" href="UniqueBackend.html#unique-backend-set-screen" title="unique_backend_set_screen ()">unique_backend_set_screen</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
<a
href="http://library.gnome.org/devel/gdk/unstable/GdkScreen.html"
>GdkScreen</a> *screen);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> <a class="link" href="UniqueBackend.html#unique-backend-get-workspace" title="unique_backend_get_workspace ()">unique_backend_get_workspace</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="UniqueBackend.html#unique-backend-request-name" title="unique_backend_request_name ()">unique_backend_request_name</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);
<a class="link" href="UniqueApp.html#UniqueResponse" title="enum UniqueResponse">UniqueResponse</a> <a class="link" href="UniqueBackend.html#unique-backend-send-message" title="unique_backend_send_message ()">unique_backend_send_message</a> (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> command_id,
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData">UniqueMessageData</a> *message_data,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> time_);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="UniqueBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----UniqueBackend
</pre>
</div>
<div class="refsect1" title="Description">
<a name="UniqueBackend.description"></a><h2>Description</h2>
<p>
<a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a> is the base, abstract class implemented by the different
IPC mechanisms used by Unique. Each <a class="link" href="UniqueApp.html" title="UniqueApp"><span class="type">UniqueApp</span></a> instance creates a
<a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a> to request the name or to send messages.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="UniqueBackend.details"></a><h2>Details</h2>
<div class="refsect2" title="UniqueBackend">
<a name="UniqueBackend-struct"></a><h3>UniqueBackend</h3>
<pre class="programlisting">typedef struct _UniqueBackend UniqueBackend;</pre>
<p>
The <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a> structure contains only private data and should only
be accessed using the provided functions.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="UniqueBackendClass">
<a name="UniqueBackendClass"></a><h3>UniqueBackendClass</h3>
<pre class="programlisting">typedef struct {
/* vtable, not signals */
gboolean (* request_name) (UniqueBackend *backend);
UniqueResponse (* send_message) (UniqueBackend *backend,
gint command_id,
UniqueMessageData *message_data,
guint time_);
} UniqueBackendClass;
</pre>
<p>
The class that should be implemented by every backend for <a class="link" href="UniqueApp.html" title="UniqueApp"><span class="type">UniqueApp</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code>request_name</code></em> ()</span></p></td>
<td> This method should be used to request the name for the
instance set using <a class="link" href="UniqueBackend.html#unique-backend-set-name" title="unique_backend_set_name ()"><code class="function">unique_backend_set_name()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>send_message</code></em> ()</span></p></td>
<td> This method should be used to send a message to a running
instance
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_create ()">
<a name="unique-backend-create"></a><h3>unique_backend_create ()</h3>
<pre class="programlisting"><a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> * unique_backend_create (void);</pre>
<p>
Creates a <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a> using the default backend defined at
compile time. You can override the default backend by setting the
<code class="literal">UNIQUE_BACKEND</code> environment variable with the
name of the desired backend.</p>
<p>
</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> the newly created <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a> instance
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_get_name ()">
<a name="unique-backend-get-name"></a><h3>unique_backend_get_name ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * unique_backend_get_name (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_set_name ()">
<a name="unique-backend-set-name"></a><h3>unique_backend_set_name ()</h3>
<pre class="programlisting">void unique_backend_set_name (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_get_startup_id ()">
<a name="unique-backend-get-startup-id"></a><h3>unique_backend_get_startup_id ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * unique_backend_get_startup_id (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_set_startup_id ()">
<a name="unique-backend-set-startup-id"></a><h3>unique_backend_set_startup_id ()</h3>
<pre class="programlisting">void unique_backend_set_startup_id (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *startup_id);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_get_screen ()">
<a name="unique-backend-get-screen"></a><h3>unique_backend_get_screen ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gdk/unstable/GdkScreen.html"
>GdkScreen</a> * unique_backend_get_screen (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_set_screen ()">
<a name="unique-backend-set-screen"></a><h3>unique_backend_set_screen ()</h3>
<pre class="programlisting">void unique_backend_set_screen (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
<a
href="http://library.gnome.org/devel/gdk/unstable/GdkScreen.html"
>GdkScreen</a> *screen);</pre>
<p>
FIXME</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td> FIXME
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_get_workspace ()">
<a name="unique-backend-get-workspace"></a><h3>unique_backend_get_workspace ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> unique_backend_get_workspace (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);</pre>
<p>
Retrieves the current workspace.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a workspace number
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_request_name ()">
<a name="unique-backend-request-name"></a><h3>unique_backend_request_name ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> unique_backend_request_name (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend);</pre>
<p>
Requests the name set using <a class="link" href="UniqueBackend.html#unique-backend-set-name" title="unique_backend_set_name ()"><code class="function">unique_backend_set_name()</code></a> using <em class="parameter"><code>backend</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</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 the name was assigned to us, <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> if there
already is a registered name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="unique_backend_send_message ()">
<a name="unique-backend-send-message"></a><h3>unique_backend_send_message ()</h3>
<pre class="programlisting"><a class="link" href="UniqueApp.html#UniqueResponse" title="enum UniqueResponse">UniqueResponse</a> unique_backend_send_message (<a class="link" href="UniqueBackend.html" title="UniqueBackend">UniqueBackend</a> *backend,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> command_id,
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData">UniqueMessageData</a> *message_data,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> time_);</pre>
<p>
Sends <em class="parameter"><code>command_id</code></em>, and optionally <em class="parameter"><code>message_data</code></em>, to a running instance
using <em class="parameter"><code>backend</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td> a <a class="link" href="UniqueBackend.html" title="UniqueBackend"><span class="type">UniqueBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>command_id</code></em> :</span></p></td>
<td> command to send
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td> message to send, or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_</code></em> :</span></p></td>
<td> time of the command emission, or 0 for the current time
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="UniqueApp.html#UniqueResponse" title="enum UniqueResponse"><span class="type">UniqueResponse</span></a> value sent by the running instance
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|