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
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::AccelMap Class Reference</h1>A GtkAccelMap C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="accelmap_8hh-source.html">gfc/gtk/accelmap.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::AccelMap:
<p><center><img src="classGFC_1_1Gtk_1_1AccelMap.png" usemap="#GFC::Gtk::AccelMap_map" border="0" alt=""></center>
<map name="GFC::Gtk::AccelMap_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Gtk_1_1AccelMap-members.html">List of all members.</a><h2>Signals</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z275_2">changed_signal</a>
<dl class="el"><dd class="mdescRight">Changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z278_1">sig_changed()</a>). <a href="#z275_2"></a><br></dl></ul>
<h2>Public Types</h2>
<ul>
<li>typedef sigc::slot< void,<br>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &, const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> &,<br>
bool > <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#w0">ForeachSlot</a>
<dl class="el"><dd class="mdescRight">Signature for the callback slot to be called on each entry in the accelerator map. <a href="#w0"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z276_0" doxytag="GFC::Gtk::AccelMap::~AccelMap" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z276_0">~AccelMap</a> ()
<dl class="el"><dd class="mdescRight">Destructor,. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z277_0" doxytag="GFC::Gtk::AccelMap::gtk_accel_map" ></a>
GtkAccelMap * <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z277_0">gtk_accel_map</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the global GtkAccelMap structure. <br></dl><li><a class="anchor" name="z277_1" doxytag="GFC::Gtk::AccelMap::operator GtkAccelMap *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z277_1">operator GtkAccelMap *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> to a GtkAccelMap pointer. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ChangedSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z278_1">sig_changed</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path)
<dl class="el"><dd class="mdescRight">Connect to the changed_signal; emitted when an entry in the global accelerator map is changed. <a href="#z278_1"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> * <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e0">get</a> ()
<dl class="el"><dd class="mdescRight">Gets the singleton global <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> object. <a href="#e0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e2">lookup_entry</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path, <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> *accel_key=0)
<dl class="el"><dd class="mdescRight">Looks up the accelerator entry for accel_path and fills in accel_key. <a href="#e2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e4">add_entry</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path, const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> &accel_key)
<dl class="el"><dd class="mdescRight">Registers a new accelerator with the global accelerator map. <a href="#e4"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e6">change_entry</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path, const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> &accel_key, bool replace)
<dl class="el"><dd class="mdescRight">Changes the key value and modifiers currently associated with accel_path. <a href="#e6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &filename)
<dl class="el"><dd class="mdescRight">Parses a file previously saved with <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e12">save()</a> for accelerator specifications, and propagates them accordingly. <a href="#e8"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e9">load</a> (int file_descriptor)
<dl class="el"><dd class="mdescRight">Filedescriptor variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load()</a>. <a href="#e9"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e10">load</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Scanner.html">G::Scanner</a> &scanner)
<dl class="el"><dd class="mdescRight"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Scanner.html">G::Scanner</a> variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load()</a>. <a href="#e10"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e12">save</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &filename)
<dl class="el"><dd class="mdescRight">Saves current accelerator specifications (accelerator path, key and modifiers) to file_name. <a href="#e12"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e13">save</a> (int file_descriptor)
<dl class="el"><dd class="mdescRight">Filedescriptor variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e12">save()</a>. <a href="#e13"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e14">foreach</a> (const <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#w0">ForeachSlot</a> &slot)
<dl class="el"><dd class="mdescRight">Loops over the entries in the accelerator map whose accel_path doesn't match any of the filters added with add_filter(), and calls <em>slot</em> on each. <a href="#e14"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e16">lock_path</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path)
<dl class="el"><dd class="mdescRight">Locks the given accelerator path. <a href="#e16"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e18">unlock_path</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &accel_path)
<dl class="el"><dd class="mdescRight">Undoes the last call to <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e16">lock_path()</a> on this <em>accel_path</em> (see <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e16">lock_path()</a>). <a href="#e18"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z274_0">AccelMap</a> (GtkAccelMap *map, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> from an existing GtkAccelMap. <a href="#z274_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkAccelMap C++ wrapper class.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="GFC::Gtk::AccelMap::ForeachSlot" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef sigc::slot<void, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a>&, const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a>&, bool> <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#w0">GFC::Gtk::AccelMap::ForeachSlot</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Signature for the callback slot to be called on each entry in the accelerator map.
<p>
<b>Example:</b> Method signature for ForeachSlot. <div class="fragment"><pre> <span class="keywordtype">void</span> method(<span class="keyword">const</span> <span class="keywordtype">char</span> *accel_path, <span class="keyword">const</span> AccelKey& accel_key, <span class="keywordtype">bool</span> changed);
<span class="comment">// accel_path: The accelerator path for the entry.</span>
<span class="comment">// accel_key: An AccelKey object that holds the entry's accelerator key and modifiers.</span>
<span class="comment">// changed: Whether the accelerator was changed during runtime and would need saving.</span>
</pre></div> </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z274_0" doxytag="GFC::Gtk::AccelMap::AccelMap" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::AccelMap::AccelMap </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkAccelMap * </td>
<td class="mdname" nowrap> <em>map</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> from an existing GtkAccelMap.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>map</em> </td><td>A pointer to a GtkAccelMap. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>map</em> can be a newly created GtkAccelMap or an existing GtkAccelMap. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e4" doxytag="GFC::Gtk::AccelMap::add_entry" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::add_entry </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> & </td>
<td class="mdname" nowrap> <em>accel_key</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Registers a new accelerator with the global accelerator map.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
<tr><td></td><td valign=top><em>accel_key</em> </td><td>An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers.</td></tr>
</table>
</dl>
<br>
This function should only be called once per accel_path with the canonical accelerator key value and modifiers for this path. To change the accelerator during runtime programatically, use <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e6">change_entry()</a>. The accelerator path must consist of "\<WINDOWTYPE\>/Category1/Category2/.../Action", where <WINDOWTYPE> should be a unique application-specific identifier, that corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image", "Abiword-Document" or "Gnumeric-Settings". The Category1/.../Action portion is most appropriately chosen by the action the accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator path may look like: "\<Gimp-Toolbox\>/File/Dialogs/Tool Options...". </td>
</tr>
</table>
<a class="anchor" name="e6" doxytag="GFC::Gtk::AccelMap::change_entry" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::AccelMap::change_entry </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> & </td>
<td class="mdname" nowrap> <em>accel_key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>replace</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Changes the key value and modifiers currently associated with accel_path.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
<tr><td></td><td valign=top><em>accel_key</em> </td><td>An <a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> specifying the accelerator key value and modifiers. </td></tr>
<tr><td></td><td valign=top><em>replace</em> </td><td>Set <em>true</em> if other accelerators may be deleted upon conflicts. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the accelerator could be changed, <em>false</em> otherwise.</dd></dl>
<br>
Due to conflicts with other accelerators, a change may not always be possible, replace indicates whether other accelerators may be deleted to resolve such conflicts. A change will only occur if all conflicts could be resolved (which might not be the case if conflicting accelerators are locked). Successful changes are indicated by a <em>true</em> return value. </td>
</tr>
</table>
<a class="anchor" name="e14" doxytag="GFC::Gtk::AccelMap::foreach" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::foreach </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#w0">ForeachSlot</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>slot</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Loops over the entries in the accelerator map whose accel_path doesn't match any of the filters added with add_filter(), and calls <em>slot</em> on each.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>slot</em> </td><td>Ahe ForeachSlot to be called for each map entry not filtered out.</td></tr>
</table>
</dl>
<br>
The signature for the ForeachSlot is typedef'd above, the changed parameter indicates whether this accelerator was changed during runtime (thus, would need saving during an accelerator map dump). </td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="GFC::Gtk::AccelMap::get" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a>* GFC::Gtk::AccelMap::get </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the singleton global <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The global <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">Gtk::AccelMap</a> object.</dd></dl>
<br>
The <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html">AccelMap</a> object is useful only for notification of changes to the accelerator map via the 'changed_signal'. </td>
</tr>
</table>
<a class="anchor" name="e10" doxytag="GFC::Gtk::AccelMap::load" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Scanner.html">G::Scanner</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>scanner</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Scanner.html">G::Scanner</a> variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>scanner</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Scanner.html">G::Scanner</a> which has already been provided with an input file. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e9" doxytag="GFC::Gtk::AccelMap::load" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>file_descriptor</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Filedescriptor variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>file_descriptor</em> </td><td>A valid readable file descriptor.</td></tr>
</table>
</dl>
<br>
Note that the file descriptor will not be closed by this function. </td>
</tr>
</table>
<a class="anchor" name="e8" doxytag="GFC::Gtk::AccelMap::load" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parses a file previously saved with <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e12">save()</a> for accelerator specifications, and propagates them accordingly.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename</em> </td><td>A file containing accelerator specifications. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e16" doxytag="GFC::Gtk::AccelMap::lock_path" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::lock_path </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Locks the given accelerator path.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>A valid accelerator path.</td></tr>
</table>
</dl>
<br>
If the accelerator map doesn't yet contain an entry for <em>accel_path</em>, a new one is created. Locking an accelerator path prevents its accelerator from being changed during runtime. A locked accelerator path can be unlocked by <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e18">unlock_path()</a>. Refer to <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e6">change_entry()</a> for information about runtime accelerator changes.<p>
If called more than once, <em>accel_path</em> remains locked until <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e18">unlock_path()</a> has been called an equivalent number of times. Note that locking of individual accelerator paths is independent from locking the <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">Gtk::AccelGroup</a> containing them. For runtime accelerator changes to be possible both the accelerator path and its <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">Gtk::AccelGroup</a> have to be unlocked. </td>
</tr>
</table>
<a class="anchor" name="e2" doxytag="GFC::Gtk::AccelMap::lookup_entry" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::AccelMap::lookup_entry </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Gtk_1_1AccelKey.html">AccelKey</a> * </td>
<td class="mdname" nowrap> <em>accel_key</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Looks up the accelerator entry for accel_path and fills in accel_key.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
<tr><td></td><td valign=top><em>accel_key</em> </td><td>The accelerator key to be filled in (optional). </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if accel_path is known, <em>false</em> otherwise. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e13" doxytag="GFC::Gtk::AccelMap::save" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::save </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>file_descriptor</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Filedescriptor variant of <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e12">save()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>file_descriptor</em> </td><td>A valid writable file descriptor. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e12" doxytag="GFC::Gtk::AccelMap::save" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::save </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Saves current accelerator specifications (accelerator path, key and modifiers) to file_name.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename</em> </td><td>A file to contain accelerator specifications.</td></tr>
</table>
</dl>
<br>
The file is written in a format suitable to be read back in by <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e8">load()</a>. </td>
</tr>
</table>
<a class="anchor" name="z278_1" doxytag="GFC::Gtk::AccelMap::sig_changed" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ChangedSignalProxy</a> GFC::Gtk::AccelMap::sig_changed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Connect to the changed_signal; emitted when an entry in the global accelerator map is changed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>The accelerator path to be notified of changes to.</td></tr>
</table>
</dl>
<br>
If <em>accel_path</em> is provided it is appended to the signal name so that the signal connected to becomes "changed::accel_path". What this does is ensure that your changed slot is only called if <em>accel_path</em> matches the accelerator path of the "changed" signal being emitted. </td>
</tr>
</table>
<a class="anchor" name="e18" doxytag="GFC::Gtk::AccelMap::unlock_path" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::AccelMap::unlock_path </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>accel_path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Undoes the last call to <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e16">lock_path()</a> on this <em>accel_path</em> (see <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#e16">lock_path()</a>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z275_2" doxytag="GFC::Gtk::AccelMap::changed_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z275_2">GFC::Gtk::AccelMap::changed_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1AccelMap.html#z278_1">sig_changed()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(<span class="keyword">const</span> String& accel_path, <span class="keyword">const</span> AccelKey& accel_key);
<span class="comment">// accel_path: The path of the accelerator that changed.</span>
<span class="comment">// accel_key: An AccelKey specifying the accelerator key value and modifiers.</span>
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="accelmap_8hh-source.html">accelmap.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:37 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
