/usr/share/gtk-doc/html/gtkhotkey/GtkHotkeyRegistry.html is in libgtkhotkey-dev 0.2.1-5ubuntu1.
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 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkHotkeyRegistry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Gtk Hotkey Reference Manual">
<link rel="up" href="ch01.html" title="Core API">
<link rel="prev" href="GtkHotkeyListener.html" title="GtkHotkeyListener">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Core API">
</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="GtkHotkeyListener.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">Gtk Hotkey Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkHotkeyRegistry.synopsis" class="shortcut">Top</a>
|
<a href="#GtkHotkeyRegistry.description" class="shortcut">Description</a>
|
<a href="#GtkHotkeyRegistry.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkHotkeyRegistry.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkHotkeyRegistry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkHotkeyRegistry.top_of_page"></a>GtkHotkeyRegistry</span></h2>
<p>GtkHotkeyRegistry — Abstract base class for services storing and loading hotkeys</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkHotkeyRegistry.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-struct" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a>;
enum <a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistryError" title="enum GtkHotkeyRegistryError">GtkHotkeyRegistryError</a>;
#define <a class="link" href="GtkHotkeyRegistry.html#GTK-HOTKEY-REGISTRY-ERROR--CAPS" title="GTK_HOTKEY_REGISTRY_ERROR">GTK_HOTKEY_REGISTRY_ERROR</a>
<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a>* <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-get-default" title="gtk_hotkey_registry_get_default ()">gtk_hotkey_registry_get_default</a> (void);
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a>* <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-get-hotkey" title="gtk_hotkey_registry_get_hotkey ()">gtk_hotkey_registry_get_hotkey</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const char *app_id,
const char *key_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> * <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-get-application-hotkeys" title="gtk_hotkey_registry_get_application_hotkeys ()">gtk_hotkey_registry_get_application_hotkeys</a>
(<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const char *app_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-get-all-hotkeys" title="gtk_hotkey_registry_get_all_hotkeys ()">gtk_hotkey_registry_get_all_hotkeys</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-store-hotkey" title="gtk_hotkey_registry_store_hotkey ()">gtk_hotkey_registry_store_hotkey</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *info,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-delete-hotkey" title="gtk_hotkey_registry_delete_hotkey ()">gtk_hotkey_registry_delete_hotkey</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *app_id,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *key_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-has-hotkey" title="gtk_hotkey_registry_has_hotkey ()">gtk_hotkey_registry_has_hotkey</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *app_id,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *key_id);
void <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-hotkey-stored" title="gtk_hotkey_registry_hotkey_stored ()">gtk_hotkey_registry_hotkey_stored</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *hotkey);
void <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-hotkey-deleted" title="gtk_hotkey_registry_hotkey_deleted ()">gtk_hotkey_registry_hotkey_deleted</a> (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *hotkey);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.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>
+----GtkHotkeyRegistry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-deleted" title='The "hotkey-deleted" signal'>hotkey-deleted</a>" : Run Last
"<a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-stored" title='The "hotkey-stored" signal'>hotkey-stored</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.description"></a><h2>Description</h2>
<p>
<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> is an abstract base class for implementing a platform
specific service for storing and loading hotkey configurations.
</p>
<p>
The actual binding of the hotkey into the environment is done by a
<a class="link" href="GtkHotkeyListener.html" title="GtkHotkeyListener"><span class="type">GtkHotkeyListener</span></a>. This class is only meant to do the management part of the
hotkey handling.
</p>
<p>
The reasong why applications should use a <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> and not just a
flat text file with the hotkey signature is to make sure we don't overwrite
or interfere with the hotkeys of other applications. And possibly providing
a unified user interface for managing the hotkeys of all applications.
</p>
<p>
To obtain a <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> matching your desktop environment use
the factory method <a class="link" href="GtkHotkeyRegistry.html#gtk-hotkey-registry-get-default" title="gtk_hotkey_registry_get_default ()"><code class="function">gtk_hotkey_registry_get_default()</code></a>.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkHotkeyRegistry-struct"></a><h3>GtkHotkeyRegistry</h3>
<pre class="programlisting">typedef struct _GtkHotkeyRegistry GtkHotkeyRegistry;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkHotkeyRegistryError"></a><h3>enum GtkHotkeyRegistryError</h3>
<pre class="programlisting">typedef enum
{
GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN_APP,
GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN_KEY,
GTK_HOTKEY_REGISTRY_ERROR_MALFORMED_MEDIUM,
GTK_HOTKEY_REGISTRY_ERROR_IO,
GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN,
GTK_HOTKEY_REGISTRY_ERROR_BAD_SIGNATURE,
GTK_HOTKEY_REGISTRY_ERROR_MISSING_APP,
} GtkHotkeyRegistryError;
</pre>
<p>
Error codes for <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a>s related to <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a>s</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-UNKNOWN-APP--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN_APP</code></span></p></td>
<td> The application which is the involved
in the transaction has not registered
any hotkeys
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-UNKNOWN-KEY--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN_KEY</code></span></p></td>
<td> The hotkey key-id (the identifier that
identifies the hotkey among those
belonging to an application) is not
known.
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-MALFORMED-MEDIUM--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_MALFORMED_MEDIUM</code></span></p></td>
<td> The medium from which to read
or write is in an unrecoverable
state. For example a file
containing syntax errors
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-IO--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_IO</code></span></p></td>
<td> There was some problem with the actual io
operation. Missing file permissions, disk full,
etc.
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-UNKNOWN--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_UNKNOWN</code></span></p></td>
<td> Unexpected and uncharacterized error
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-BAD-SIGNATURE--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_BAD_SIGNATURE</code></span></p></td>
<td> The hotkey signature is not valid.
See <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--signature" title='The "signature" property'><span class="type">"signature"</span></a>.
</td>
</tr>
<tr>
<td><p><a name="GTK-HOTKEY-REGISTRY-ERROR-MISSING-APP--CAPS"></a><span class="term"><code class="literal">GTK_HOTKEY_REGISTRY_ERROR_MISSING_APP</code></span></p></td>
<td> A <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a> is referring an
application via its <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--app-info" title='The "app-info" property'><span class="type">"app-info"</span></a>
property, but the application can not
be found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GTK-HOTKEY-REGISTRY-ERROR--CAPS"></a><h3>GTK_HOTKEY_REGISTRY_ERROR</h3>
<pre class="programlisting">#define GTK_HOTKEY_REGISTRY_ERROR gtk_hotkey_registry_error_quark()
</pre>
<p>
Error domain for <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-get-default"></a><h3>gtk_hotkey_registry_get_default ()</h3>
<pre class="programlisting"><a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a>* gtk_hotkey_registry_get_default (void);</pre>
<p>
Currently the only implementation of this class is <span class="type">GtkHotkeyKeyFileRegistry</span>.</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> A reference to a <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> matching your platform
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-get-hotkey"></a><h3>gtk_hotkey_registry_get_hotkey ()</h3>
<pre class="programlisting"><a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a>* gtk_hotkey_registry_get_hotkey (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const char *app_id,
const char *key_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Look up a hotkey given its id and application id.</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>self</code></em> :</span></p></td>
<td> The registry to search in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td> The name under which the application has registered it self
when it created the <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a> in the first place.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_id</code></em> :</span></p></td>
<td> The id assignedd to the actual hotkey on the moment of its creation
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Place to store a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> in case of errors, or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to ignore
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a> for the requested parameters or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> is none
where found. In the case <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> is returned <em class="parameter"><code>error</code></em> will be set
accordingly. Free the hotkey with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> when you are done
using it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-get-application-hotkeys"></a><h3>gtk_hotkey_registry_get_application_hotkeys ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a> * gtk_hotkey_registry_get_application_hotkeys
(<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const char *app_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Look up all hotkeys registered by a given application.</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>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> to look hotkeys up in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td> Unique application id
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Place to return a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A list of <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a> objects. The list should be with freed with
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a> and the hotkey objects should be freed with
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-get-all-hotkeys"></a><h3>gtk_hotkey_registry_get_all_hotkeys ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* gtk_hotkey_registry_get_all_hotkeys (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self);</pre>
<p>
Look up all hotkeys registered by a given application.</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>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> to look hotkeys up in
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A list of all valid <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a>s stored in the registry.
The list should be with freed with <a
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a> and the hotkey
objects should be freed with <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-store-hotkey"></a><h3>gtk_hotkey_registry_store_hotkey ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_hotkey_registry_store_hotkey (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *info,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Store a hotkey in the registry for later usage. In case of success the
<a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-stored" title='The "hotkey-stored" signal'><span class="type">"hotkey-stored"</span></a> signal will be emitted.</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>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> in which to store the hotkey
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo"><span class="type">GtkHotkeyInfo</span></a> to store
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Place to return a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to ignore
</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> on success and <code class="literal">FALS</code> otherwise. In case of errors <em class="parameter"><code>error</code></em>
will be set accordingly.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-delete-hotkey"></a><h3>gtk_hotkey_registry_delete_hotkey ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_hotkey_registry_delete_hotkey (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *app_id,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *key_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Delete a hotkey from the registry. In case of success the
<a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-deleted" title='The "hotkey-deleted" signal'><span class="type">"hotkey-deleted"</span></a> signal will be emitted.</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>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> from which to delete the hotkey
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td> The value of the <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--application-id" title='The "application-id" property'><span class="type">"application-id"</span></a> property of the stored
hotkey
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_id</code></em> :</span></p></td>
<td> The value of the <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--key-id" title='The "key-id" property'><span class="type">"key-id"</span></a> property of the stored hotkey
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Place to return a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to ignore
</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> on success and <code class="literal">FALS</code> otherwise. In case of errors <em class="parameter"><code>error</code></em>
will be set accordingly.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-has-hotkey"></a><h3>gtk_hotkey_registry_has_hotkey ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_hotkey_registry_has_hotkey (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *app_id,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *key_id);</pre>
<p>
Look up all hotkeys registered by a given application.</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>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> to look hotkeys up in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td> The value of the <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--application-id" title='The "application-id" property'><span class="type">"application-id"</span></a> property of the stored
hotkey
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_id</code></em> :</span></p></td>
<td> The value of the <a class="link" href="GtkHotkeyInfo.html#GtkHotkeyInfo--key-id" title='The "key-id" property'><span class="type">"key-id"</span></a> property of the stored hotkey
</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 registry has stored a hotkey with with application id
<em class="parameter"><code>app_id</code></em> and hotkey id <em class="parameter"><code>key_id</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-hotkey-stored"></a><h3>gtk_hotkey_registry_hotkey_stored ()</h3>
<pre class="programlisting">void gtk_hotkey_registry_hotkey_stored (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *hotkey);</pre>
<p>
Emit the <a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-stored" title='The "hotkey-stored" signal'><span class="type">"hotkey-stored"</span></a> signal on <em class="parameter"><code>self</code></em>. This method should
only be used by child classes of <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</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="parameter"><code>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> to emit the signal on
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hotkey</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-hotkey-registry-hotkey-deleted"></a><h3>gtk_hotkey_registry_hotkey_deleted ()</h3>
<pre class="programlisting">void gtk_hotkey_registry_hotkey_deleted (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *self,
<a class="link" href="GtkHotkeyInfo.html" title="GtkHotkeyInfo">GtkHotkeyInfo</a> *hotkey);</pre>
<p>
Emit the <a class="link" href="GtkHotkeyRegistry.html#GtkHotkeyRegistry-hotkey-deleted" title='The "hotkey-deleted" signal'><span class="type">"hotkey-deleted"</span></a> signal on <em class="parameter"><code>self</code></em>. This method should
only be used by child classes of <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</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="parameter"><code>self</code></em> :</span></p></td>
<td> The <a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry"><span class="type">GtkHotkeyRegistry</span></a> to emit the signal on
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hotkey</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="GtkHotkeyRegistry-hotkey-deleted"></a><h3>The <code class="literal">"hotkey-deleted"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *hotkey,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *arg1,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
Emitted when a hotkey has been deleted from the registry</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>hotkey</code></em> :</span></p></td>
<td>The hotkey that was deleted
</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>
<hr>
<div class="refsect2" lang="en">
<a name="GtkHotkeyRegistry-hotkey-stored"></a><h3>The <code class="literal">"hotkey-stored"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="GtkHotkeyRegistry.html" title="GtkHotkeyRegistry">GtkHotkeyRegistry</a> *hotkey,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *arg1,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
Emitted when a hotkey has been stored in the registry</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>hotkey</code></em> :</span></p></td>
<td>The hotkey that was stored
</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 class="refsect1" lang="en">
<a name="GtkHotkeyRegistry.see-also"></a><h2>See Also</h2>
#GtkHotkeyKeyFileRegistry
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|