keybinder-3.0-doc 0.3.2-1 / usr / share / gtk-doc / html / keybinder-3.0 / keybinder-keybinder.html

This file is indexed.

/usr/share/gtk-doc/html/keybinder-3.0/keybinder-keybinder.html is in keybinder-3.0-doc 0.3.2-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>keybinder: libkeybinder-3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libkeybinder-3.0 Reference Manual">
<link rel="up" href="ch01.html" title="libkeybinder">
<link rel="prev" href="ch01.html" title="libkeybinder">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#keybinder-keybinder.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="keybinder-keybinder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="keybinder-keybinder.top_of_page"></a>keybinder</span></h2>
<p>keybinder</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="keybinder-keybinder.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="keybinder-keybinder.html#KeybinderHandler" title="KeybinderHandler ()">*KeybinderHandler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-init" title="keybinder_init ()">keybinder_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-set-use-cooked-accelerators" title="keybinder_set_use_cooked_accelerators ()">keybinder_set_use_cooked_accelerators</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-bind" title="keybinder_bind ()">keybinder_bind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-bind-full" title="keybinder_bind_full ()">keybinder_bind_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-unbind" title="keybinder_unbind ()">keybinder_unbind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-unbind-all" title="keybinder_unbind_all ()">keybinder_unbind_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint32</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-get-current-event-time" title="keybinder_get_current_event_time ()">keybinder_get_current_event_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="keybinder-keybinder.html#keybinder-supported" title="keybinder_supported ()">keybinder_supported</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="keybinder-keybinder.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="keybinder-keybinder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="KeybinderHandler"></a><h3>KeybinderHandler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*KeybinderHandler<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *keystring</code></em>,
                     <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-init"></a><h3>keybinder_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
keybinder_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initialize the keybinder library.</p>
<p>This function must be called after initializing GTK, before calling any
other function in the library. Can only be called once.</p>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-set-use-cooked-accelerators"></a><h3>keybinder_set_use_cooked_accelerators ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
keybinder_set_use_cooked_accelerators (<em class="parameter"><code><span class="type">gboolean</span> use_cooked</code></em>);</pre>
<p>"Cooked" accelerators use symbols produced by using modifiers such
as shift or altgr, for example if "!" is produced by "Shift+1".</p>
<p>If cooked accelerators are enabled, use "&lt;Ctrl&gt;exclam" to bind
"Ctrl+!" If disabled, use "&lt;Ctrl&gt;&lt;Shift&gt;1" to bind
"Ctrl+Shift+1". These two examples are not equal on all keymaps.</p>
<p>The cooked accelerator keyvalue and modifiers are provided by the
function <code class="function">gdk_keymap_translate_keyboard_state()</code></p>
<p>Cooked accelerators are useful if you receive keystrokes from GTK to bind,
but raw accelerators can be useful if you or the user inputs accelerators as
text.</p>
<p>Default: Enabled. Should be set before binding anything.</p>
<div class="refsect3">
<a name="keybinder-set-use-cooked-accelerators.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>use_cooked</p></td>
<td class="parameter_description"><p>if <code class="literal">FALSE</code> disable cooked accelerators</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-bind"></a><h3>keybinder_bind ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
keybinder_bind (<em class="parameter"><code>const <span class="type">char</span> *keystring</code></em>,
                <em class="parameter"><code><a class="link" href="keybinder-keybinder.html#KeybinderHandler" title="KeybinderHandler ()"><span class="type">KeybinderHandler</span></a> handler</code></em>,
                <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>Grab a key combination globally and register a callback to be called each
time the key combination is pressed.</p>
<p>This function is excluded from introspected bindings and is replaced by
keybinder_bind_full.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="keybinder-bind.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>keystring</p></td>
<td class="parameter_description"><p>an accelerator description (<code class="function">gtk_accelerator_parse()</code> format)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler</p></td>
<td class="parameter_description"><p>callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>handler</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="keybinder-bind.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the accelerator could be grabbed</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-bind-full"></a><h3>keybinder_bind_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
keybinder_bind_full (<em class="parameter"><code>const <span class="type">char</span> *keystring</code></em>,
                     <em class="parameter"><code><a class="link" href="keybinder-keybinder.html#KeybinderHandler" title="KeybinderHandler ()"><span class="type">KeybinderHandler</span></a> handler</code></em>,
                     <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                     <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>Grab a key combination globally and register a callback to be called each
time the key combination is pressed.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> keybinder_bind]</span></p>
<div class="refsect3">
<a name="keybinder-bind-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>keystring</p></td>
<td class="parameter_description"><p>an accelerator description (<code class="function">gtk_accelerator_parse()</code> format)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler</p></td>
<td class="parameter_description"><p>        callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>  data to pass to <em class="parameter"><code>handler</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>  called when <em class="parameter"><code>handler</code></em>
is unregistered. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="keybinder-bind-full.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the accelerator could be grabbed</p>
</div>
<p class="since">Since: 0.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-unbind"></a><h3>keybinder_unbind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
keybinder_unbind (<em class="parameter"><code>const <span class="type">char</span> *keystring</code></em>,
                  <em class="parameter"><code><a class="link" href="keybinder-keybinder.html#KeybinderHandler" title="KeybinderHandler ()"><span class="type">KeybinderHandler</span></a> handler</code></em>);</pre>
<p>Unregister a previously bound callback for this keystring.</p>
<p>NOTE: multiple callbacks per keystring are not properly supported. You
might as well use <a class="link" href="keybinder-keybinder.html#keybinder-unbind-all" title="keybinder_unbind_all ()"><code class="function">keybinder_unbind_all()</code></a>.</p>
<p>This function is excluded from introspected bindings and is replaced by
<a class="link" href="keybinder-keybinder.html#keybinder-unbind-all" title="keybinder_unbind_all ()"><code class="function">keybinder_unbind_all()</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="keybinder-unbind.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>keystring</p></td>
<td class="parameter_description"><p>an accelerator description (<code class="function">gtk_accelerator_parse()</code> format)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler</p></td>
<td class="parameter_description"><p>callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-unbind-all"></a><h3>keybinder_unbind_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
keybinder_unbind_all (<em class="parameter"><code>const <span class="type">char</span> *keystring</code></em>);</pre>
<p>Unregister all previously bound callbacks for this keystring.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> keybinder_unbind]</span></p>
<div class="refsect3">
<a name="keybinder-unbind-all.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>keystring</p></td>
<td class="parameter_description"><p>an accelerator description (<code class="function">gtk_accelerator_parse()</code> format)</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 0.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-get-current-event-time"></a><h3>keybinder_get_current_event_time ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span>
keybinder_get_current_event_time (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="keybinder-get-current-event-time.returns"></a><h4>Returns</h4>
<p> the current event timestamp</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="keybinder-supported"></a><h3>keybinder_supported ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
keybinder_supported (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="keybinder-supported.returns"></a><h4>Returns</h4>
<p> TRUE if keybindings are supported</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="keybinder-keybinder.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.