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
|
<!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::ToolItem Class Reference</h1>A GtkToolItem C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="toolitem_8hh-source.html">gfc/gtk/toolitem.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::ToolItem:
<p><center><img src="classGFC_1_1Gtk_1_1ToolItem.png" usemap="#GFC::Gtk::ToolItem_map" border="0" alt=""></center>
<map name="GFC::Gtk::ToolItem_map">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="90,336,260,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="90,280,260,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="90,224,260,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,170,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="180,168,350,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,170,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="180,112,350,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,170,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="180,56,350,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,170,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="180,0,350,24">
<area href="classGFC_1_1Gtk_1_1SeparatorToolItem.html" alt="GFC::Gtk::SeparatorToolItem" shape="rect" coords="0,448,170,472">
<area href="classGFC_1_1Gtk_1_1ToolButton.html" alt="GFC::Gtk::ToolButton" shape="rect" coords="180,448,350,472">
<area href="classGFC_1_1Gtk_1_1ToggleToolButton.html" alt="GFC::Gtk::ToggleToolButton" shape="rect" coords="180,504,350,528">
<area href="classGFC_1_1Gtk_1_1RadioToolButton.html" alt="GFC::Gtk::RadioToolButton" shape="rect" coords="180,560,350,584">
</map>
<a href="classGFC_1_1Gtk_1_1ToolItem-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">CreateMenuProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_6">create_menu_proxy_signal</a>
<dl class="el"><dd class="mdescRight">Create menu proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_0">sig_create_menu_proxy()</a>). <a href="#z948_6"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ToolbarReconfiguredSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_7">toolbar_reconfigured_signal</a>
<dl class="el"><dd class="mdescRight"><a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html">Toolbar</a> reconfigured signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_1">sig_toolbar_reconfigured()</a>). <a href="#z948_7"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">SetTooltipSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_8">set_tooltip_signal</a>
<dl class="el"><dd class="mdescRight">Set tooltip signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_2">sig_set_tooltip()</a>). <a href="#z948_8"></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="z949_0" doxytag="GFC::Gtk::ToolItem::ToolItem" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z949_0">ToolItem</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new tool item. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z949_1">ToolItem</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Constructs a new tool item that displays <em>widget</em>. <a href="#z949_1"></a><br></dl><li><a class="anchor" name="z949_2" doxytag="GFC::Gtk::ToolItem::~ToolItem" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z949_2">~ToolItem</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="z950_0" doxytag="GFC::Gtk::ToolItem::gtk_tool_item" ></a>
GtkToolItem * <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_0">gtk_tool_item</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkToolItem structure. <br></dl><li><a class="anchor" name="z950_1" doxytag="GFC::Gtk::ToolItem::operator GtkToolItem *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_1">operator GtkToolItem *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> to a GtkToolItem pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_2">get_homogeneous</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item is the same size as other homogeneous items (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_0">set_homogeneous()</a>). <a href="#z950_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_3">get_expand</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item is allocated extra space (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_1">set_expand()</a>). <a href="#z950_3"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_4">get_use_drag_window</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item has a drag window (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_4">set_use_drag_window()</a>). <a href="#z950_4"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_5">get_visible_horizontal</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item is visible on toolbars that are docked horizontally. <a href="#z950_5"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_6">get_visible_vertical</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item is visible when the toolbar is docked vertically (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_6">set_visible_vertical()</a>). <a href="#z950_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_7">get_is_important</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the tool item is considered important (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_7">set_is_important()</a>). <a href="#z950_7"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_8">get_icon_size</a> () const
<dl class="el"><dd class="mdescRight">Gets the icon size used for the tool item. <a href="#z950_8"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a329">Orientation</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_9">get_orientation</a> () const
<dl class="el"><dd class="mdescRight">Gets the orientation used for the tool item. <a href="#z950_9"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a342">ToolbarStyle</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_10">get_toolbar_style</a> () const
<dl class="el"><dd class="mdescRight">Gets the toolbar style used for the tool item. <a href="#z950_10"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a333">ReliefStyle</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_11">get_relief_style</a> () const
<dl class="el"><dd class="mdescRight">Gets the relief style of the tool item (see set_relief_style(). <a href="#z950_11"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_13">get_proxy_menu_item</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &menu_item_id) const
<dl class="el"><dd class="mdescRight">If <em>menu_item_id</em> matches the string passed to <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item()</a> returns the corresponding GtkMenuItem. <a href="#z950_13"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_14">retrieve_proxy_menu_item</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> that was last set by <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item()</a>, that is, the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> that is going to appear in the overflow menu. <a href="#z950_14"></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_1ToolItem.html#z951_0">set_homogeneous</a> (bool homogeneous)
<dl class="el"><dd class="mdescRight">Sets whether the tool item is to be allocated the same size as other homogeneous items. <a href="#z951_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_1">set_expand</a> (bool expand)
<dl class="el"><dd class="mdescRight">Sets whether the tool item is allocated extra space when there is more room on the toolbar than needed for the items. <a href="#z951_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_3">set_tooltip</a> (<a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> &tooltips, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &tip_text, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &tip_private=0)
<dl class="el"><dd class="mdescRight">Sets the <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> object to be used for the tool item, the text to be displayed as tooltip on the item and the private text to be used (see <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_3">Gtk::Tooltips::set_tip()</a>). <a href="#z951_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_4">set_use_drag_window</a> (bool use_drag_window)
<dl class="el"><dd class="mdescRight">Sets whether toolitem has a drag window. <a href="#z951_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_5">set_visible_horizontal</a> (bool visible_horizontal)
<dl class="el"><dd class="mdescRight">Sets whether the tool item is visible when the toolbar is docked horizontally. <a href="#z951_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_6">set_visible_vertical</a> (bool visible_vertical)
<dl class="el"><dd class="mdescRight">Sets whether the tool item is visible when the toolbar is docked vertically. <a href="#z951_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_7">set_is_important</a> (bool is_important)
<dl class="el"><dd class="mdescRight">Sets whether the tool item should be considered important. <a href="#z951_7"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &menu_item_id, <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> *menu_item)
<dl class="el"><dd class="mdescRight">Sets the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> used in the toolbar overflow menu. <a href="#z951_9"></a><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">CreateMenuProxySignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_0">sig_create_menu_proxy</a> ()
<dl class="el"><dd class="mdescRight">Connect to the create_menu_proxy_signal; emitted when the toolbar is displaying an overflow menu. <a href="#z952_0"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ToolbarReconfiguredSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_1">sig_toolbar_reconfigured</a> ()
<dl class="el"><dd class="mdescRight">Connect to the toolbar_reconfigured_signal; emitted when some property of the toolbar that the item is a child of changes. <a href="#z952_1"></a><br></dl><li><a class="anchor" name="z952_2" doxytag="GFC::Gtk::ToolItem::sig_set_tooltip" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">SetTooltipSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_2">sig_set_tooltip</a> ()
<dl class="el"><dd class="mdescRight">Connect to the set_tooltip_signal; emitted when the toolitem's tooltip changes. <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_1ToolItem.html#z947_0">ToolItem</a> (GtkToolItem *tool_item, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> from an existing GtkToolItem. <a href="#z947_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkToolItem C++ wrapper class.
<p>
ToolItems are widgets that can appear on a toolbar. To construct a toolbar item that contains something other than a button, use <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z949_0">ToolItem()</a>. Use <a class="el" href="classGFC_1_1Gtk_1_1Container.html#z461_0">Gtk::Container::add()</a> to add a child widget to the tool item.<p>
For toolbar items that contain buttons, see the <a class="el" href="classGFC_1_1Gtk_1_1ToolButton.html">Gtk::ToolButton</a>, <a class="el" href="classGFC_1_1Gtk_1_1ToggleToolButton.html">Gtk::ToggleToolButton</a> and <a class="el" href="classGFC_1_1Gtk_1_1RadioToolButton.html">Gtk::RadioToolButton</a> classes. See the <a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html">Gtk::Toolbar</a> class for a description of the toolbar widget.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z947_0" doxytag="GFC::Gtk::ToolItem::ToolItem" ></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::ToolItem::ToolItem </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkToolItem * </td>
<td class="mdname" nowrap> <em>tool_item</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>false</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_1ToolItem.html">ToolItem</a> from an existing GtkToolItem.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>tool_item</em> </td><td>A pointer to a GtkToolItem. </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>tool_item</em> can be a newly created GtkToolItem or an existing GtkToolItem (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z949_1" doxytag="GFC::Gtk::ToolItem::ToolItem" ></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::ToolItem::ToolItem </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new tool item that displays <em>widget</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The widget to set as the tool item's content. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z950_3" doxytag="GFC::Gtk::ToolItem::get_expand" ></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::ToolItem::get_expand </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 the tool item is allocated extra space (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_1">set_expand()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if then tool item is allocated extra space. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_2" doxytag="GFC::Gtk::ToolItem::get_homogeneous" ></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::ToolItem::get_homogeneous </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 the tool item is the same size as other homogeneous items (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_0">set_homogeneous()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the item is the same size as other homogeneous items. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_8" doxytag="GFC::Gtk::ToolItem::get_icon_size" ></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="namespaceGFC_1_1Gtk.html#a325">IconSize</a> GFC::Gtk::ToolItem::get_icon_size </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 icon size used for the tool item.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="namespaceGFC_1_1Gtk.html#a325">Gtk::IconSize</a> indicating the icon size used for the tool item.</dd></dl>
<br>
Custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> should call this function to find out what size icons they should use. </td>
</tr>
</table>
<a class="anchor" name="z950_7" doxytag="GFC::Gtk::ToolItem::get_is_important" ></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::ToolItem::get_is_important </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 the tool item is considered important (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_7">set_is_important()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the tool item is considered important. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_9" doxytag="GFC::Gtk::ToolItem::get_orientation" ></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="namespaceGFC_1_1Gtk.html#a329">Orientation</a> GFC::Gtk::ToolItem::get_orientation </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 orientation used for the tool item.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="namespaceGFC_1_1Gtk.html#a329">Gtk::Orientation</a> indicating the orientation used for the tool item.</dd></dl>
<br>
Custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> should call this function to find out the orientation of they should use. </td>
</tr>
</table>
<a class="anchor" name="z950_13" doxytag="GFC::Gtk::ToolItem::get_proxy_menu_item" ></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::ToolItem::get_proxy_menu_item </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>menu_item_id</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>
If <em>menu_item_id</em> matches the string passed to <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item()</a> returns the corresponding GtkMenuItem.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>menu_item_id</em> </td><td>A string used to identify the menu item. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> passed to <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item()</a>, if the menu_item_ids match.</dd></dl>
<br>
Custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> should use this function to update their menu item when the <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> changes. That the menu_item_ids must match ensures that a <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> will not inadvertently change a menu item that they did not create. </td>
</tr>
</table>
<a class="anchor" name="z950_11" doxytag="GFC::Gtk::ToolItem::get_relief_style" ></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="namespaceGFC_1_1Gtk.html#a333">ReliefStyle</a> GFC::Gtk::ToolItem::get_relief_style </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 relief style of the tool item (see set_relief_style().
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="namespaceGFC_1_1Gtk.html#a333">Gtk::ReliefStyle</a> indicating the relief style used for the tool item.</dd></dl>
<br>
Custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> should call this function in the handler of the <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> "toolbar_reconfigured" signal to find out the relief style of the buttons. </td>
</tr>
</table>
<a class="anchor" name="z950_10" doxytag="GFC::Gtk::ToolItem::get_toolbar_style" ></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="namespaceGFC_1_1Gtk.html#a342">ToolbarStyle</a> GFC::Gtk::ToolItem::get_toolbar_style </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 toolbar style used for the tool item.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="namespaceGFC_1_1Gtk.html#a342">Gtk::ToolbarStyle</a> indicating the toolbar style used for the tool item.</dd></dl>
<br>
Custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> should call this function in the handler of the <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">ToolItem</a> "toolbar_reconfigured" signal to find out in what style the toolbar is displayed and change themselves accordingly. The possibilities are: <a class="el" href="namespaceGFC_1_1Gtk.html#a342a170">Gtk::TOOLBAR_BOTH</a>, meaning the tool item should show both an icon and a label, stacked vertically, <a class="el" href="namespaceGFC_1_1Gtk.html#a342a168">Gtk::TOOLBAR_ICONS</a>, meaning the toolbar shows only icons, <a class="el" href="namespaceGFC_1_1Gtk.html#a342a169">Gtk::TOOLBAR_TEXT</a>, meaning the tool item should only show text and <a class="el" href="namespaceGFC_1_1Gtk.html#a342a171">Gtk::TOOLBAR_BOTH_HORIZ</a>, meaning the tool item should show both an icon and a label, arranged horizontally. </td>
</tr>
</table>
<a class="anchor" name="z950_4" doxytag="GFC::Gtk::ToolItem::get_use_drag_window" ></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::ToolItem::get_use_drag_window </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 the tool item has a drag window (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_4">set_use_drag_window()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the tool item uses a drag window. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_5" doxytag="GFC::Gtk::ToolItem::get_visible_horizontal" ></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::ToolItem::get_visible_horizontal </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 the tool item is visible on toolbars that are docked horizontally.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the tool item is visible on toolbars that are docked horizontally. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_6" doxytag="GFC::Gtk::ToolItem::get_visible_vertical" ></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::ToolItem::get_visible_vertical </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 the tool item is visible when the toolbar is docked vertically (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_6">set_visible_vertical()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether the tool item is visible when the toolbar is docked vertically. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z950_14" doxytag="GFC::Gtk::ToolItem::retrieve_proxy_menu_item" ></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::ToolItem::retrieve_proxy_menu_item </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>
Retrieves the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> that was last set by <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">set_proxy_menu_item()</a>, that is, the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> that is going to appear in the overflow menu.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> that is going to appear in the overflow menu for the tool item. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z951_1" doxytag="GFC::Gtk::ToolItem::set_expand" ></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::ToolItem::set_expand </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>expand</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 the tool item is allocated extra space when there is more room on the toolbar than needed for the items.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>expand</em> </td><td>Whether the tool item is allocated extra space.</td></tr>
</table>
</dl>
<br>
The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller. </td>
</tr>
</table>
<a class="anchor" name="z951_0" doxytag="GFC::Gtk::ToolItem::set_homogeneous" ></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::ToolItem::set_homogeneous </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>homogeneous</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 the tool item is to be allocated the same size as other homogeneous items.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>homogeneous</em> </td><td>Whether the tool item is the same size as other homogeneous items.</td></tr>
</table>
</dl>
<br>
The effect is that all homogeneous items will have the same width as the widest of the items. </td>
</tr>
</table>
<a class="anchor" name="z951_7" doxytag="GFC::Gtk::ToolItem::set_is_important" ></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::ToolItem::set_is_important </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>is_important</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 the tool item should be considered important.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>is_important</em> </td><td>Whether the tool item should be considered important.</td></tr>
</table>
</dl>
<br>
The <a class="el" href="classGFC_1_1Gtk_1_1ToolButton.html">ToolButton</a> class uses this property to determine whether to show or hide its label when the toolbar style is <a class="el" href="namespaceGFC_1_1Gtk.html#a342a171">Gtk::TOOLBAR_BOTH_HORIZ</a>. The result is that only tool buttons with the "is_important" property set have labels, an effect known as "priority text". </td>
</tr>
</table>
<a class="anchor" name="z951_9" doxytag="GFC::Gtk::ToolItem::set_proxy_menu_item" ></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::ToolItem::set_proxy_menu_item </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>menu_item_id</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_1Widget.html">Widget</a> * </td>
<td class="mdname" nowrap> <em>menu_item</em></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>
Sets the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> used in the toolbar overflow menu.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>menu_item_id</em> </td><td>A string used to identify <em>menu_item</em>. </td></tr>
<tr><td></td><td valign=top><em>menu_item</em> </td><td>A <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> to be used in the overflow menu.</td></tr>
</table>
</dl>
<br>
The <em>menu_item_id</em> is used to identify the caller of this function and should also be used with <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z950_13">get_proxy_menu_item()</a>. If <em>menu_item</em> is null the <a class="el" href="classGFC_1_1Gtk_1_1MenuItem.html">MenuItem</a> last set will not appear in the overflow menu (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_0">sig_create_menu_proxy()</a>). </td>
</tr>
</table>
<a class="anchor" name="z951_3" doxytag="GFC::Gtk::ToolItem::set_tooltip" ></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::ToolItem::set_tooltip </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> & </td>
<td class="mdname" nowrap> <em>tooltips</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>tip_text</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>tip_private</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>
Sets the <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> object to be used for the tool item, the text to be displayed as tooltip on the item and the private text to be used (see <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_3">Gtk::Tooltips::set_tip()</a>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>tooltips</em> </td><td>The <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> object to be used. </td></tr>
<tr><td></td><td valign=top><em>tip_text</em> </td><td>The text to be used as tooltip text for the tool item. </td></tr>
<tr><td></td><td valign=top><em>tip_private</em> </td><td>The text to be used as private tooltip text. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z951_4" doxytag="GFC::Gtk::ToolItem::set_use_drag_window" ></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::ToolItem::set_use_drag_window </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>use_drag_window</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 toolitem has a drag window.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>use_drag_window</em> </td><td>Whether the tool item has a drag window.</td></tr>
</table>
</dl>
<br>
When <em>use_drag_window</em> is <em>true</em> the tool item can be used as a drag source through <a class="el" href="classGFC_1_1Gtk_1_1Widget.html#z1057_1">Gtk::Widget::drag_source_set()</a>. When the tool item has a drag window it will intercept all events, even those that would otherwise be sent to a child of toolitem. </td>
</tr>
</table>
<a class="anchor" name="z951_5" doxytag="GFC::Gtk::ToolItem::set_visible_horizontal" ></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::ToolItem::set_visible_horizontal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>visible_horizontal</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 the tool item is visible when the toolbar is docked horizontally.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>visible_horizontal</em> </td><td>Whether the tool item is visible when in horizontal mode. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z951_6" doxytag="GFC::Gtk::ToolItem::set_visible_vertical" ></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::ToolItem::set_visible_vertical </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>visible_vertical</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 the tool item is visible when the toolbar is docked vertically.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>visible_vertical</em> </td><td>Whether the tool item is visible when the toolbar is in vertical mode.</td></tr>
</table>
</dl>
<br>
Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If <em>visible_vertical</em> is <em>false</em> the tool item will not appear on toolbars that are docked vertically. </td>
</tr>
</table>
<a class="anchor" name="z952_0" doxytag="GFC::Gtk::ToolItem::sig_create_menu_proxy" ></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">CreateMenuProxySignalProxy</a> GFC::Gtk::ToolItem::sig_create_menu_proxy </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>
Connect to the create_menu_proxy_signal; emitted when the toolbar is displaying an overflow menu.
<p>
In response the tool item should call <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z951_9">Gtk::ToolItem::set_proxy_menu_item()</a> with either with a null pointer and return true to indicate that the item should not appear in the overflow menu, or with a new menu item and return true, or return false to indicate that the signal was not handled by the item. This means that the item will not appear in the overflow menu unless a later handler installs a menu item. </td>
</tr>
</table>
<a class="anchor" name="z952_1" doxytag="GFC::Gtk::ToolItem::sig_toolbar_reconfigured" ></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">ToolbarReconfiguredSignalProxy</a> GFC::Gtk::ToolItem::sig_toolbar_reconfigured </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>
Connect to the toolbar_reconfigured_signal; emitted when some property of the toolbar that the item is a child of changes.
<p>
For custom subclasses of <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html">Gtk::ToolItem</a>, the default handler of this signal uses the functions <a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html#z934_6">Gtk::Toolbar::get_orientation()</a>, <a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html#z934_8">Gtk::Toolbar::get_style()</a>, <a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html#z934_9">Gtk::Toolbar::get_icon_size()</a> and <a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html#z934_10">Gtk::Toolbar::get_relief_style()</a> to find out what the toolbar should look like and change themselves accordingly. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z948_6" doxytag="GFC::Gtk::ToolItem::create_menu_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">CreateMenuProxySignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_6">GFC::Gtk::ToolItem::create_menu_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>
Create menu proxy signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_0">sig_create_menu_proxy()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">bool</span> function();
<span class="comment">// return: true if the signal was handled, false if not. </span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z948_8" doxytag="GFC::Gtk::ToolItem::set_tooltip_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">SetTooltipSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_8">GFC::Gtk::ToolItem::set_tooltip_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set tooltip signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_2">sig_set_tooltip()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">bool</span> function(Tooltips& tooltips, <span class="keyword">const</span> String& tip_text, <span class="keyword">const</span> String& tip_private);
<span class="comment">// tooltips: The Gtk::Tooltips. </span>
<span class="comment">// tip_text: The tooltip text. </span>
<span class="comment">// tip_private: The tooltip private text. </span>
<span class="comment">// return: true if the signal was handled, false if not.</span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z948_7" doxytag="GFC::Gtk::ToolItem::toolbar_reconfigured_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">ToolbarReconfiguredSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z948_7">GFC::Gtk::ToolItem::toolbar_reconfigured_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classGFC_1_1Gtk_1_1Toolbar.html">Toolbar</a> reconfigured signal (see <a class="el" href="classGFC_1_1Gtk_1_1ToolItem.html#z952_1">sig_toolbar_reconfigured()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="toolitem_8hh-source.html">toolitem.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:43 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>
|
