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
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
|
<!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::UIManager Class Reference</h1>A GtkUIManager C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="uimanager_8hh-source.html">gfc/gtk/uimanager.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::UIManager:
<p><center><img src="classGFC_1_1Gtk_1_1UIManager.png" usemap="#GFC::Gtk::UIManager_map" border="0" alt=""></center>
<map name="GFC::Gtk::UIManager_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_1UIManager-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">AddWidgetSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_12">add_widget_signal</a>
<dl class="el"><dd class="mdescRight">Add widget signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_0">sig_add_widget()</a>). <a href="#z1024_12"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ActionsChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_13">actions_changed_signal</a>
<dl class="el"><dd class="mdescRight">Actions changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_1">sig_actions_changed()</a>). <a href="#z1024_13"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ConnectProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_14">connect_proxy_signal</a>
<dl class="el"><dd class="mdescRight">Connect proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_2">sig_connect_proxy()</a>). <a href="#z1024_14"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">DisconnectProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_15">disconnect_proxy_signal</a>
<dl class="el"><dd class="mdescRight">Disconnect proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_3">sig_disconnect_proxy()</a>). <a href="#z1024_15"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">PreActivateSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_16">pre_activate_signal</a>
<dl class="el"><dd class="mdescRight">Pre-activate signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_4">sig_pre_activate()</a>). <a href="#z1024_16"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">PostActivateSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_17">post_activate_signal</a>
<dl class="el"><dd class="mdescRight">Post-activate signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_5">sig_post_activate()</a>). <a href="#z1024_17"></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="z1025_0" doxytag="GFC::Gtk::UIManager::UIManager" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1025_0">UIManager</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> object. <br></dl><li><a class="anchor" name="z1025_1" doxytag="GFC::Gtk::UIManager::~UIManager" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1025_1">~UIManager</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="z1026_0" doxytag="GFC::Gtk::UIManager::gtk_ui_manager" ></a>
GtkUIManager * <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_0">gtk_ui_manager</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkUIManager structure. <br></dl><li><a class="anchor" name="z1026_1" doxytag="GFC::Gtk::UIManager::operator GtkUIManager *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_1">operator GtkUIManager *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> to a GtkUIManager pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_2">get_add_tearoffs</a> () const
<dl class="el"><dd class="mdescRight">Determines whether menus generated by this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> will have tearoff menu items. <a href="#z1026_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_3">get_action_groups</a> (std::vector< <a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> * > &action_groups) const
<dl class="el"><dd class="mdescRight">Gets the list of action groups associated with the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1026_3"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a> * <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_4">get_accel_group</a> () const
<dl class="el"><dd class="mdescRight">Gets the <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a> associated with the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1026_4"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_6">get_widget</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &path) const
<dl class="el"><dd class="mdescRight">Looks up a widget by following a path. <a href="#z1026_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_7">get_toplevels</a> (std::vector< <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * > &toplevels, <a class="el" href="namespaceGFC_1_1Gtk.html#a259">UIManagerItemTypeField</a> types) const
<dl class="el"><dd class="mdescRight">Obtains a list of all toplevel widgets of the requested types. <a href="#z1026_7"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Action.html">Action</a> * <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_8">get_action</a> (const char *path) const
<dl class="el"><dd class="mdescRight">Looks up an action by following a path (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_6">get_widget()</a> for more information about paths). <a href="#z1026_8"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_9">get_ui</a> () const
<dl class="el"><dd class="mdescRight">Creates a UI definition of the merged UI. <a href="#z1026_9"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_0">set_add_tearoffs</a> (bool add_tearoffs)
<dl class="el"><dd class="mdescRight">Sets whether menus generated by this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> will have tearoff menu items. <a href="#z1027_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_1">insert_action_group</a> (<a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> &action_group, int pos=0)
<dl class="el"><dd class="mdescRight">Inserts an action group into the list of action groups associated with this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_2">remove_action_group</a> (<a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> &action_group)
<dl class="el"><dd class="mdescRight">Removes an action group from the list of action groups associated with self. <a href="#z1027_2"></a><br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_3">add_ui_from_string</a> (const char *buffer, int length=-1, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Parses a string containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_3"></a><br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_4">add_ui_from_string</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &buffer, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Parses a string containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_4"></a><br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_6">add_ui_from_file</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &filename, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Parses a file containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_8">add_ui</a> (unsigned int merge_id, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &path, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &name, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &action, <a class="el" href="namespaceGFC_1_1Gtk.html#a365">UIManagerItemType</a> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>=UI_MANAGER_AUTO, bool top=false)
<dl class="el"><dd class="mdescRight">Adds a UI element to the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_8"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_10">add_ui_separator</a> (unsigned int merge_id, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &path, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &name, bool top=false)
<dl class="el"><dd class="mdescRight">Adds a separator UI element to the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>. <a href="#z1027_10"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_11">remove_ui</a> (unsigned int merge_id)
<dl class="el"><dd class="mdescRight">Unmerges the part of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> content identified by merge_id. <a href="#z1027_11"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_12">ensure_update</a> ()
<dl class="el"><dd class="mdescRight">Makes sure that all pending updates to the UI have been completed. <a href="#z1027_12"></a><br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_13">new_merge_id</a> ()
<dl class="el"><dd class="mdescRight">Obtains an unused merge id, suitable for use with <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_8">add_ui()</a>. <a href="#z1027_13"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z1028_0" doxytag="GFC::Gtk::UIManager::sig_add_widget" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">AddWidgetSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_0">sig_add_widget</a> ()
<dl class="el"><dd class="mdescRight">Connect to the add_widget_signal; emitted for each generated menubar and toolbar. <br></dl><li><a class="anchor" name="z1028_1" doxytag="GFC::Gtk::UIManager::sig_actions_changed" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ActionsChangedSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_1">sig_actions_changed</a> ()
<dl class="el"><dd class="mdescRight">Connect to the actions_changed_signal; emitted whenever the set of actions changes. <br></dl><li><a class="anchor" name="z1028_2" doxytag="GFC::Gtk::UIManager::sig_connect_proxy" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ConnectProxySignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_2">sig_connect_proxy</a> ()
<dl class="el"><dd class="mdescRight">Connect to the connect_proxy_signal; emitted after connecting a proxy widget to an action in the group. <br></dl><li><a class="anchor" name="z1028_3" doxytag="GFC::Gtk::UIManager::sig_disconnect_proxy" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">DisconnectProxySignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_3">sig_disconnect_proxy</a> ()
<dl class="el"><dd class="mdescRight">Connect to the disconnect_proxy_signal; emitted after disconnecting a proxy widget from an action in the group. <br></dl><li><a class="anchor" name="z1028_4" doxytag="GFC::Gtk::UIManager::sig_pre_activate" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">PreActivateSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_4">sig_pre_activate</a> ()
<dl class="el"><dd class="mdescRight">Connect to the pre_activate_signal; emitted just before an action is activated. <br></dl><li><a class="anchor" name="z1028_5" doxytag="GFC::Gtk::UIManager::sig_post_activate" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">PostActivateSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_5">sig_post_activate</a> ()
<dl class="el"><dd class="mdescRight">Connect to the post_activate_signal; emitted just after an action is activated. <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_1UIManager.html#z1023_0">UIManager</a> (GtkUIManager *ui_manager, 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_1UIManager.html">UIManager</a> from an existing GtkUIManager. <a href="#z1023_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkUIManager C++ wrapper class.
<p>
A <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> constructs a user interface (menus and toolbars) from one or more XML UI definitions, which reference actions from one or more action groups.<p>
<b>UI Definitions</b><p>
The UI definitions are specified in an XML format which can be roughly described by the following DTD.<p>
<pre>
<!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
<!ELEMENT menubar (menuitem|separator|placeholder|menu)* >
<!ELEMENT menu (menuitem|separator|placeholder|menu)* >
<!ELEMENT popup (menuitem|separator|placeholder|menu)* ></pre><p>
<pre> <!ELEMENT toolbar (toolitem|separator|placeholder)* >
<!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
<!ELEMENT menuitem EMPTY >
<!ELEMENT toolitem EMPTY >
<!ELEMENT separator EMPTY >
<!ELEMENT accelerator EMPTY >
<!ATTLIST menubar name #IMPLIED >
<!ATTLIST toolbar name #IMPLIED >
<!ATTLIST popup name #IMPLIED ></pre><p>
<pre> <!ATTLIST placeholder name #IMPLIED >
<!ATTLIST separator name #IMPLIED >
<!ATTLIST menu name #IMPLIED
action #REQUIRED
position (top|bot) #IMPLIED >
<!ATTLIST menuitem name #IMPLIED
action #REQUIRED
position (top|bot) #IMPLIED >
<!ATTLIST toolitem name #IMPLIED
action #REQUIRED
position (top|bot) #IMPLIED >
<!ATTLIST accelerator name #IMPLIED
action #REQUIRED >
</pre><p>
There are some additional restrictions beyond those specified in the DTD, e.g. every toolitem must have a toolbar in its anchestry and every menuitem must have a menubar or popup in its anchestry. Since a GMarkup parser is used to parse the UI description, it must not only be valid XML, but valid GMarkup. If a name is not specified, it defaults to the action. If an action is not specified either, the element name is used.<p>
<b>Example:</b>. A UI definition<p>
<pre>
<ui>
<menubar>
<menu name="FileMenu" action="FileMenuAction">
<menuitem name="New" action="New2Action" />
<placeholder name="FileMenuAdditions" />
</menu>
<menu name="JustifyMenu" action="JustifyMenuAction">
<menuitem name="Left" action="justify-left"/>
<menuitem name="Centre" action="justify-center"/>
<menuitem name="Right" action="justify-right"/>
<menuitem name="Fill" action="justify-fill"/>
</menu>
</menubar>
<toolbar action="toolbar1">
<placeholder name="JustifyToolItems">
<separator/>
<toolitem name="Left" action="justify-left"/>
<toolitem name="Centre" action="justify-center"/>
<toolitem name="Right" action="justify-right"/>
<toolitem name="Fill" action="justify-fill"/>
<separator/>
</placeholder>
</toolbar>
</ui>
</pre><p>
The constructed widget hierarchy is very similar to the element tree of the XML, with the exception that placeholders are merged into their parents. The correspondence of XML elements to widgets should be almost obvious:<p>
<div class="fragment"><pre> menubar - a Gtk::MenuBar
toolbar - a Gtk::Toolbar
popup - a toplevel Gtk::Menu
menu - a Gtk::Menu attached to a menuitem
menuitem - a Gtk::MenuItem subclass, the exact &<a class="codeRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a> depends on the action
toolitem - a Gtk::ToolItem subclass, the exact &<a class="codeRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a> depends on the action
separator - a Gtk::SeparatorMenuItem or Gtk::SeparatorToolItem
accelerator - a keyboard accelerator
</pre></div><p>
The "position" attribute determines where a constructed widget is positioned with respect to its siblings in the partially constructed tree. If it is "top", the widget is prepended, otherwise it is appended.<p>
<hr>
<b>UI Merging</b><p>
The most remarkable feature of <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> is that it can overlay a set of menuitems and toolitems over another one, and demerge them later.<p>
Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated by slashes. For example, the menuitem named "Left" in the example above has the path /ui/menubar/JustifyMenu/Left and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.<p>
<hr>
<b>Accelerators</b><p>
Every action has an accelerator path. Accelerators are installed together with menuitem proxies, but they can also be explicitly added with <accelerator> elements in the UI definition. This makes it possible to have accelerators for actions even if they have no visible proxies.<p>
<hr>
<b>Smart Separators</b><p>
The separators created by <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> are "smart", i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This is a useful feature, since the merging of UI elements from multiple sources can make it hard or impossible to determine in advance whether a separator will end up in such an unfortunate position.<p>
<hr>
<b>Empty Menus</b><p>
Submenus pose similar problems to separators in connection with merging. It is impossible to know in advance whether they will end up empty after merging. <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> offers two ways to treat empty submenus:<ul>
<li>make them disappear by hiding the menu item they're attached to</li><li>add an insensitive "Empty" item</li></ul>
<p>
The behaviour is chosen based on the "is_important" property of the action to which the submenu is associated.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1023_0" doxytag="GFC::Gtk::UIManager::UIManager" ></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::UIManager::UIManager </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkUIManager * </td>
<td class="mdname" nowrap> <em>ui_manager</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_1UIManager.html">UIManager</a> from an existing GtkUIManager.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ui_manager</em> </td><td>A pointer to a GtkUIManager. </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>ui_manager</em> can be a newly created GtkUIManager or an existing GtkUIManager (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="z1027_8" doxytag="GFC::Gtk::UIManager::add_ui" ></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::UIManager::add_ui </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>merge_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>action</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a365">UIManagerItemType</a> </td>
<td class="mdname" nowrap> <em>type</em> = <code>UI_MANAGER_AUTO</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>top</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds a UI element to the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>merge_id</em> </td><td>The merge id for the merged UI (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_13">new_merge_id()</a>). </td></tr>
<tr><td></td><td valign=top><em>path</em> </td><td>A path. </td></tr>
<tr><td></td><td valign=top><em>name</em> </td><td>The name for the added UI element. </td></tr>
<tr><td></td><td valign=top><em>action</em> </td><td>The name of the action to be proxied, or null to add a separator. </td></tr>
<tr><td></td><td valign=top><em>type</em> </td><td>The type of UI element to add. </td></tr>
<tr><td></td><td valign=top><em>top</em> </td><td>If <em>true</em> the UI element is added before its siblings, otherwise it's added after.</td></tr>
</table>
</dl>
<br>
If type is <a class="el" href="namespaceGFC_1_1Gtk.html#a365a260">Gtk::UI_MANAGER_AUTO</a>, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by path. Otherwise type must indicate an element that can be inserted at the place determined by path. When adding several UI elements you will want to use the same <em>merge_id</em> for each element. This will avoid unecessary multiple calls to <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_13">new_merge_id()</a> and will make it easier to unmerge several elements with one call to <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_11">remove_ui()</a>; </td>
</tr>
</table>
<a class="anchor" name="z1027_6" doxytag="GFC::Gtk::UIManager::add_ui_from_file" ></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"> unsigned int GFC::Gtk::UIManager::add_ui_from_file </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>filename</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parses a file containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<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>The name of the file to parse. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for an error. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The merge id for the merged UI.</dd></dl>
<br>
An enclosing <ui> element is added if it is missing. The merge id can be used to unmerge the UI with <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_11">remove_ui()</a>. If an error occurred, the return value is 0. </td>
</tr>
</table>
<a class="anchor" name="z1027_4" doxytag="GFC::Gtk::UIManager::add_ui_from_string" ></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"> unsigned int GFC::Gtk::UIManager::add_ui_from_string </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>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parses a string containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer</em> </td><td>The string to parse. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for an error. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The merge id for the merged UI.</dd></dl>
<br>
An enclosing <ui> element is added if it is missing. The merge id can be used to unmerge the UI with <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_11">remove_ui()</a>. If an error occurred, the return value is 0. </td>
</tr>
</table>
<a class="anchor" name="z1027_3" doxytag="GFC::Gtk::UIManager::add_ui_from_string" ></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"> unsigned int GFC::Gtk::UIManager::add_ui_from_string </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parses a string containing a UI definition and merges it with the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer</em> </td><td>The string to parse. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of buffer, or -1 if buffer is null-terminated. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for an error. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The merge id for the merged UI.</dd></dl>
<br>
An enclosing <ui> element is added if it is missing. The merge id can be used to unmerge the UI with <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_11">remove_ui()</a>. If an error occurred, the return value is 0. </td>
</tr>
</table>
<a class="anchor" name="z1027_10" doxytag="GFC::Gtk::UIManager::add_ui_separator" ></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::UIManager::add_ui_separator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname" nowrap> <em>merge_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>top</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds a separator UI element to the current contents of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>merge_id</em> </td><td>The merge id for the merged UI (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_13">new_merge_id()</a>). </td></tr>
<tr><td></td><td valign=top><em>path</em> </td><td>A path. </td></tr>
<tr><td></td><td valign=top><em>name</em> </td><td>The name for the added separator UI element. </td></tr>
<tr><td></td><td valign=top><em>top</em> </td><td>If <em>true</em> the separator is added before its siblings, otherwise it's added after. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1027_12" doxytag="GFC::Gtk::UIManager::ensure_update" ></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::UIManager::ensure_update </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Makes sure that all pending updates to the UI have been completed.
<p>
This may occasionally be necessary, since <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> updates the UI in an idle function. A typical example where this function is useful is to enforce that the menubar and toolbar have been added to the main window before showing it: <div class="fragment"><pre> window->add(*vbox);
ui_manager->sig_add_widget().connect(sigc::mem_fun(vbox, &MyVBox::on_add_widget));
ui_manager->add_ui_from_file(<span class="stringliteral">"my-menus"</span>);
ui_manager->add_ui_from_file(<span class="stringliteral">"my-toolbars"</span>);
ui_manager->ensure_update();
window->show();
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1026_4" doxytag="GFC::Gtk::UIManager::get_accel_group" ></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_1AccelGroup.html">AccelGroup</a>* GFC::Gtk::UIManager::get_accel_group </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a> associated with the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classGFC_1_1Gtk_1_1AccelGroup.html">AccelGroup</a>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_8" doxytag="GFC::Gtk::UIManager::get_action" ></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_1Action.html">Action</a>* GFC::Gtk::UIManager::get_action </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Looks up an action by following a path (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1026_6">get_widget()</a> for more information about paths).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>path</em> </td><td>A path. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The action whose proxy widget is found by following the path, or null if no widget was found. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_3" doxytag="GFC::Gtk::UIManager::get_action_groups" ></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::UIManager::get_action_groups </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> * > & </td>
<td class="mdname1" valign="top" nowrap> <em>action_groups</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the list of action groups associated with the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>action_groups</em> </td><td>A vector of ActionGroup* to hold the action groups. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if any action groups were returned, <em>false</em> if there were none. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_2" doxytag="GFC::Gtk::UIManager::get_add_tearoffs" ></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::UIManager::get_add_tearoffs </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines whether menus generated by this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> will have tearoff menu items.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether tearoff menu items are added. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_7" doxytag="GFC::Gtk::UIManager::get_toplevels" ></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::UIManager::get_toplevels </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * > & </td>
<td class="mdname" nowrap> <em>toplevels</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a259">UIManagerItemTypeField</a> </td>
<td class="mdname" nowrap> <em>types</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains a list of all toplevel widgets of the requested types.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>toplevels</em> </td><td>A vector of widget* to hold the list of all toplevel widgets of the requested types. </td></tr>
<tr><td></td><td valign=top><em>types</em> </td><td>Specifies the <a class="el" href="namespaceGFC_1_1Gtk.html#a365">Gtk::UIManagerItemType</a> of toplevel widgets to include.</td></tr>
</table>
</dl>
<br>
The allowed types are <a class="el" href="namespaceGFC_1_1Gtk.html#a365a261">Gtk::UI_MANAGER_MENUBAR</a>, <a class="el" href="namespaceGFC_1_1Gtk.html#a365a263">Gtk::UI_MANAGER_TOOLBAR</a> and <a class="el" href="namespaceGFC_1_1Gtk.html#a365a265">Gtk::UI_MANAGER_POPUP</a>. <dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if any widgets of the requested types were were returned, <em>false</em> otherwise. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_9" doxytag="GFC::Gtk::UIManager::get_ui" ></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="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> GFC::Gtk::UIManager::get_ui </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a UI definition of the merged UI.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> containing an XML representation of the merged UI. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1026_6" doxytag="GFC::Gtk::UIManager::get_widget" ></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_1Widget.html">Widget</a>* GFC::Gtk::UIManager::get_widget </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>path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Looks up a widget by following a path.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>path</em> </td><td>A path. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The widget found by following the path, or null if no widget was found.</dd></dl>
<br>
The path consists of the names specified in the XML description of the UI separated by '/'. Elements which don't have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.<p>
Note that the widget found by following a path that ends in a <menu> element is the menuitem to which the menu is attached, not the menu itself. </td>
</tr>
</table>
<a class="anchor" name="z1027_1" doxytag="GFC::Gtk::UIManager::insert_action_group" ></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::UIManager::insert_action_group </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> & </td>
<td class="mdname" nowrap> <em>action_group</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>pos</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Inserts an action group into the list of action groups associated with this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>action_group</em> </td><td>The action group to be inserted. </td></tr>
<tr><td></td><td valign=top><em>pos</em> </td><td>The position at which the group will be inserted.</td></tr>
</table>
</dl>
<br>
Note actions in earlier groups hide actions with the same name in later groups. </td>
</tr>
</table>
<a class="anchor" name="z1027_13" doxytag="GFC::Gtk::UIManager::new_merge_id" ></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"> unsigned int GFC::Gtk::UIManager::new_merge_id </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Obtains an unused merge id, suitable for use with <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_8">add_ui()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>An unused merge id. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1027_2" doxytag="GFC::Gtk::UIManager::remove_action_group" ></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::UIManager::remove_action_group </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1ActionGroup.html">ActionGroup</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>action_group</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>
Removes an action group from the list of action groups associated with self.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>action_group</em> </td><td>The action group to be removed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1027_11" doxytag="GFC::Gtk::UIManager::remove_ui" ></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::UIManager::remove_ui </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>merge_id</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>
Unmerges the part of the <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> content identified by merge_id.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>merge_id</em> </td><td>A merge id as returned by <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1027_3">add_ui_from_string()</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1027_0" doxytag="GFC::Gtk::UIManager::set_add_tearoffs" ></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::UIManager::set_add_tearoffs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>add_tearoffs</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>
Sets whether menus generated by this <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html">UIManager</a> will have tearoff menu items.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>add_tearoffs</em> </td><td>Whether tearoff menu items are added.</td></tr>
</table>
</dl>
<br>
Note that this only affects regular menus. Generated popup menus never have tearoff menu items. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z1024_13" doxytag="GFC::Gtk::UIManager::actions_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">ActionsChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_13">GFC::Gtk::UIManager::actions_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>
Actions changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_1">sig_actions_changed()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1024_12" doxytag="GFC::Gtk::UIManager::add_widget_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">AddWidgetSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_12">GFC::Gtk::UIManager::add_widget_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add widget signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_0">sig_add_widget()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(Widget& widget);
<span class="comment">// widget: The added widget.</span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1024_14" doxytag="GFC::Gtk::UIManager::connect_proxy_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">ConnectProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_14">GFC::Gtk::UIManager::connect_proxy_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Connect proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_2">sig_connect_proxy()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(Action& action, Widget& proxy);
<span class="comment">// action: The action.</span>
<span class="comment">// proxy: The proxy widget. </span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1024_15" doxytag="GFC::Gtk::UIManager::disconnect_proxy_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">DisconnectProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_15">GFC::Gtk::UIManager::disconnect_proxy_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Disconnect proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_3">sig_disconnect_proxy()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(Action& action, Widget& proxy);
<span class="comment">// action: The action.</span>
<span class="comment">// proxy: The proxy widget. </span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1024_17" doxytag="GFC::Gtk::UIManager::post_activate_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">PostActivateSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_17">GFC::Gtk::UIManager::post_activate_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Post-activate signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_5">sig_post_activate()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(Action& action);
<span class="comment">// action: The action.</span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1024_16" doxytag="GFC::Gtk::UIManager::pre_activate_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">PreActivateSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1024_16">GFC::Gtk::UIManager::pre_activate_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Pre-activate signal (see <a class="el" href="classGFC_1_1Gtk_1_1UIManager.html#z1028_4">sig_pre_activate()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(Action& action);
<span class="comment">// action: The action.</span>
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="uimanager_8hh-source.html">uimanager.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:44 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>
|
