/usr/share/gtk-doc/html/unique-3.0/unique-Message-Data.html is in libunique-3.0-doc 3.0.2-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 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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Message Data</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Unique 3.0.2 Reference Manual">
<link rel="up" href="unique-overview.html" title="Unique Overview">
<link rel="prev" href="UniqueApp.html" title="UniqueApp">
<link rel="next" href="UniqueBackend.html" title="UniqueBackend">
<meta name="generator" content="GTK-Doc V1.16.1 (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="UniqueApp.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 3.0.2
Reference Manual</th>
<td><a accesskey="n" href="UniqueBackend.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#unique-Message-Data.synopsis" class="shortcut">Top</a>
|
<a href="#unique-Message-Data.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="unique-Message-Data"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="unique-Message-Data.top_of_page"></a>Message Data</span></h2>
<p>Message Data — Message container for UniqueApp</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="unique-Message-Data.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData">UniqueMessageData</a>;
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="returnvalue">UniqueMessageData</span></a> * <a class="link" href="unique-Message-Data.html#unique-message-data-new" title="unique_message_data_new ()">unique_message_data_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="returnvalue">UniqueMessageData</span></a> * <a class="link" href="unique-Message-Data.html#unique-message-data-copy" title="unique_message_data_copy ()">unique_message_data_copy</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="unique-Message-Data.html#unique-message-data-free" title="unique_message_data_free ()">unique_message_data_free</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="unique-Message-Data.html#unique-message-data-set" title="unique_message_data_set ()">unique_message_data_set</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>);
const <span class="returnvalue">guchar</span> * <a class="link" href="unique-Message-Data.html#unique-message-data-get" title="unique_message_data_get ()">unique_message_data_get</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="unique-Message-Data.html#unique-message-data-set-text" title="unique_message_data_set_text ()">unique_message_data_set_text</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="unique-Message-Data.html#unique-message-data-get-text" title="unique_message_data_get_text ()">unique_message_data_get_text</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="unique-Message-Data.html#unique-message-data-set-uris" title="unique_message_data_set_uris ()">unique_message_data_set_uris</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **uris</code></em>);
<span class="returnvalue">gchar</span> ** <a class="link" href="unique-Message-Data.html#unique-message-data-get-uris" title="unique_message_data_get_uris ()">unique_message_data_get_uris</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="unique-Message-Data.html#unique-message-data-set-filename" title="unique_message_data_set_filename ()">unique_message_data_set_filename</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="unique-Message-Data.html#unique-message-data-get-filename" title="unique_message_data_get_filename ()">unique_message_data_get_filename</a>
(<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">GdkScreen</span> * <a class="link" href="unique-Message-Data.html#unique-message-data-get-screen" title="unique_message_data_get_screen ()">unique_message_data_get_screen</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="unique-Message-Data.html#unique-message-data-get-startup-id" title="unique_message_data_get_startup_id ()">unique_message_data_get_startup_id</a>
(<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="unique-Message-Data.html#unique-message-data-get-workspace" title="unique_message_data_get_workspace ()">unique_message_data_get_workspace</a> (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="unique-Message-Data.description"></a><h2>Description</h2>
<p>
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> contains the data sent from a <a class="link" href="UniqueApp.html" title="UniqueApp"><span class="type">UniqueApp</span></a> to a
running instance of the same application. It can contain arbitrary
binary data, and provides convenience functions to set plain text
or URI list.
</p>
<p>
You should create a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> structure using
<a class="link" href="unique-Message-Data.html#unique-message-data-new" title="unique_message_data_new ()"><code class="function">unique_message_data_new()</code></a>, you can copy it using the
<a class="link" href="unique-Message-Data.html#unique-message-data-copy" title="unique_message_data_copy ()"><code class="function">unique_message_data_copy()</code></a> and you should free it using
<a class="link" href="unique-Message-Data.html#unique-message-data-free" title="unique_message_data_free ()"><code class="function">unique_message_data_free()</code></a>.
</p>
<p>
You can set data using <a class="link" href="unique-Message-Data.html#unique-message-data-set" title="unique_message_data_set ()"><code class="function">unique_message_data_set()</code></a>,
<a class="link" href="unique-Message-Data.html#unique-message-data-set-text" title="unique_message_data_set_text ()"><code class="function">unique_message_data_set_text()</code></a>, <a class="link" href="unique-Message-Data.html#unique-message-data-set-filename" title="unique_message_data_set_filename ()"><code class="function">unique_message_data_set_filename()</code></a>
or <a class="link" href="unique-Message-Data.html#unique-message-data-set-uris" title="unique_message_data_set_uris ()"><code class="function">unique_message_data_set_uris()</code></a>.
</p>
<p>
You can retrieve the data set using <a class="link" href="unique-Message-Data.html#unique-message-data-get" title="unique_message_data_get ()"><code class="function">unique_message_data_get()</code></a>,
<a class="link" href="unique-Message-Data.html#unique-message-data-get-text" title="unique_message_data_get_text ()"><code class="function">unique_message_data_get_text()</code></a>, <a class="link" href="unique-Message-Data.html#unique-message-data-get-filename" title="unique_message_data_get_filename ()"><code class="function">unique_message_data_get_filename()</code></a>
or <a class="link" href="unique-Message-Data.html#unique-message-data-get-uris" title="unique_message_data_get_uris ()"><code class="function">unique_message_data_get_uris()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="unique-Message-Data.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="UniqueMessageData"></a><h3>UniqueMessageData</h3>
<pre class="programlisting">typedef struct _UniqueMessageData UniqueMessageData;</pre>
<p>
<a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> contains the data passed between instances of
a <a class="link" href="UniqueApp.html" title="UniqueApp"><span class="type">UniqueApp</span></a>. The <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> structure received inside
the signal handlers for UniqueApp::message-received is guaranteed
to contain the <span class="type">GdkScreen</span>, the workspace and the startup notification
id of the instance sending the message.
</p>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-new"></a><h3>unique_message_data_new ()</h3>
<pre class="programlisting"><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="returnvalue">UniqueMessageData</span></a> * unique_message_data_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> structure. This structure holds the
message data passed between running instances with
<a class="link" href="UniqueApp.html#unique-app-send-message" title="unique_app_send_message ()"><code class="function">unique_app_send_message()</code></a>.
</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="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-copy"></a><h3>unique_message_data_copy ()</h3>
<pre class="programlisting"><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="returnvalue">UniqueMessageData</span></a> * unique_message_data_copy (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Copies <em class="parameter"><code>message_data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a copy of the passed <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-free"></a><h3>unique_message_data_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> unique_message_data_free (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Frees all the resources allocated by <em class="parameter"><code>message_data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-set"></a><h3>unique_message_data_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> unique_message_data_set (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>);</pre>
<p>
Sets <em class="parameter"><code>data</code></em> as the payload of <em class="parameter"><code>message_data</code></em>. Any other data is removed
from the message data. If <em class="parameter"><code>data</code></em> is <code class="literal">NULL</code>, a <em class="parameter"><code>length</code></em> of -1 will unset
the payload, while a <em class="parameter"><code>length</code></em> of 0 will set the payload to an empty
string.
</p>
<p>
You can use <a class="link" href="unique-Message-Data.html#unique-message-data-get" title="unique_message_data_get ()"><code class="function">unique_message_data_get()</code></a> to retrieve the data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>binary blob to set, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>length of <em class="parameter"><code>data</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get"></a><h3>unique_message_data_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">guchar</span> * unique_message_data_get (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);</pre>
<p>
Retrieves the raw contents of <em class="parameter"><code>message_data</code></em> set using
<code class="function">unique_messaget_data_set()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>return location for the length of the contents. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the contents of the message data or <code class="literal">NULL</code>. The
returned string is owned by the <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> and should
never be modified or freed</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-set-text"></a><h3>unique_message_data_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> unique_message_data_set_text (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>);</pre>
<p>
Sets <em class="parameter"><code>str</code></em> as the plain text payload of <em class="parameter"><code>message_data</code></em>, converting it
to UTF-8 if needed. If <em class="parameter"><code>length</code></em> is -1, the length of the string will
be used. Use <a class="link" href="unique-Message-Data.html#unique-message-data-get-text" title="unique_message_data_get_text ()"><code class="function">unique_message_data_get_text()</code></a> to retrieve the text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>plain text to be set as payload</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>length of the text, or -1</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 text was successfully converted to UTF-8</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-text"></a><h3>unique_message_data_get_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * unique_message_data_get_text (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Retrieves the text set using <a class="link" href="unique-Message-Data.html#unique-message-data-set-text" title="unique_message_data_set_text ()"><code class="function">unique_message_data_set_text()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-set-uris"></a><h3>unique_message_data_set_uris ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> unique_message_data_set_uris (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **uris</code></em>);</pre>
<p>
Converts <em class="parameter"><code>uris</code></em> to a valid URI list and sets it as payload of
<em class="parameter"><code>message_data</code></em>. You can use <a class="link" href="unique-Message-Data.html#unique-message-data-get-uris" title="unique_message_data_get_uris ()"><code class="function">unique_message_data_get_uris()</code></a> to
retrieve the list from a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</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>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uris</code></em> :</span></p></td>
<td>a list of URIs
in a <code class="literal">NULL</code>-terminated string vector. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</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 URIs were successfully converted</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-uris"></a><h3>unique_message_data_get_uris ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> ** unique_message_data_get_uris (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Retrieves a <code class="literal">NULL</code>-terminated string vector containing the URIs set with
<a class="link" href="unique-Message-Data.html#unique-message-data-set-uris" title="unique_message_data_set_uris ()"><code class="function">unique_message_data_set_uris()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated,
<code class="literal">NULL</code>-terminated list of URIs. Use <code class="function">g_strfreev()</code> to free it. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-set-filename"></a><h3>unique_message_data_set_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> unique_message_data_set_filename (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Sets <em class="parameter"><code>filename</code></em> as the contents of <em class="parameter"><code>message_data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a filename</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-filename"></a><h3>unique_message_data_get_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * unique_message_data_get_filename
(<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Retrieves the filename set with <a class="link" href="unique-Message-Data.html#unique-message-data-set-filename" title="unique_message_data_set_filename ()"><code class="function">unique_message_data_set_filename()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated string containing the
filename. Use <code class="function">g_free()</code> to free the resources used by the returned
value. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-screen"></a><h3>unique_message_data_get_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkScreen</span> * unique_message_data_get_screen (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Returns a pointer to the screen from where the message came. You
can use <code class="function">gtk_window_set_screen()</code> to move windows or dialogs to the
right screen. This field is always set by the Unique library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">GdkScreen</span>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-startup-id"></a><h3>unique_message_data_get_startup_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * unique_message_data_get_startup_id
(<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Retrieves the startup notification id set inside <em class="parameter"><code>message_data</code></em>. This
field is always set by the Unique library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the startup notification id. The returned string is
owned by the <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> structure and should not be
modified or freed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unique-message-data-get-workspace"></a><h3>unique_message_data_get_workspace ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> unique_message_data_get_workspace (<em class="parameter"><code><a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a> *message_data</code></em>);</pre>
<p>
Retrieves the workspace number from where the message came. This
field is always set by the Unique library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_data</code></em> :</span></p></td>
<td>a <a class="link" href="unique-Message-Data.html#UniqueMessageData" title="UniqueMessageData"><span class="type">UniqueMessageData</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the workspace number</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16.1</div>
</body>
</html>
|