]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkwindow.sgml
Merge branch 'gtk-2-90'
[~andy/gtk] / docs / reference / gtk / tmpl / gtkwindow.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkWindow
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Toplevel which can contain other widgets
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11 <refsect2 id="GtkWindow-BUILDER-UI">
12 <title>GtkWindow as GtkBuildable</title>
13 <para>
14 The GtkWindow implementation of the GtkBuildable interface supports a 
15 custom &lt;accel-groups&gt; element, which supports any number of &lt;group&gt;
16 elements representing the GtkAccelGroup objects you want to add to your
17 window (synonymous with gtk_window_add_accel_group().
18 </para>
19 <example>
20 <title>A UI definition fragment with accel groups</title>
21 <programlisting><![CDATA[
22 <object class="GtkWindow">
23   <accel-groups>
24     <group name="accelgroup1"/>
25   </accel-groups>
26 </object>
27
28 ...
29
30 <object class="GtkAccelGroup" id="accelgroup1"/>
31 ]]></programlisting>
32 </example>
33 </refsect2>
34
35 <!-- ##### SECTION See_Also ##### -->
36 <para>
37
38 </para>
39
40 <!-- ##### SECTION Stability_Level ##### -->
41
42
43 <!-- ##### STRUCT GtkWindow ##### -->
44 <para>
45
46 </para>
47
48
49 <!-- ##### SIGNAL GtkWindow::activate-default ##### -->
50 <para>
51
52 </para>
53
54 @window: the object which received the signal.
55
56 <!-- ##### SIGNAL GtkWindow::activate-focus ##### -->
57 <para>
58
59 </para>
60
61 @window: the object which received the signal.
62
63 <!-- ##### SIGNAL GtkWindow::frame-event ##### -->
64 <para>
65
66 </para>
67
68 @window: the object which received the signal.
69 @event: 
70 @Returns: 
71
72 <!-- ##### SIGNAL GtkWindow::keys-changed ##### -->
73 <para>
74
75 </para>
76
77 @window: the object which received the signal.
78
79 <!-- ##### SIGNAL GtkWindow::set-focus ##### -->
80 <para>
81
82 </para>
83
84 @window: the object which received the signal.
85 @widget: 
86
87 <!-- ##### ARG GtkWindow:accept-focus ##### -->
88 <para>
89
90 </para>
91
92 <!-- ##### ARG GtkWindow:allow-grow ##### -->
93 <para>
94
95 </para>
96
97 <!-- ##### ARG GtkWindow:allow-shrink ##### -->
98 <para>
99
100 </para>
101
102 <!-- ##### ARG GtkWindow:decorated ##### -->
103 <para>
104
105 </para>
106
107 <!-- ##### ARG GtkWindow:default-height ##### -->
108 <para>
109
110 </para>
111
112 <!-- ##### ARG GtkWindow:default-width ##### -->
113 <para>
114
115 </para>
116
117 <!-- ##### ARG GtkWindow:deletable ##### -->
118 <para>
119
120 </para>
121
122 <!-- ##### ARG GtkWindow:destroy-with-parent ##### -->
123 <para>
124
125 </para>
126
127 <!-- ##### ARG GtkWindow:focus-on-map ##### -->
128 <para>
129
130 </para>
131
132 <!-- ##### ARG GtkWindow:gravity ##### -->
133 <para>
134
135 </para>
136
137 <!-- ##### ARG GtkWindow:has-toplevel-focus ##### -->
138 <para>
139
140 </para>
141
142 <!-- ##### ARG GtkWindow:icon ##### -->
143 <para>
144
145 </para>
146
147 <!-- ##### ARG GtkWindow:icon-name ##### -->
148 <para>
149
150 </para>
151
152 <!-- ##### ARG GtkWindow:is-active ##### -->
153 <para>
154
155 </para>
156
157 <!-- ##### ARG GtkWindow:mnemonics-visible ##### -->
158 <para>
159
160 </para>
161
162 <!-- ##### ARG GtkWindow:modal ##### -->
163 <para>
164
165 </para>
166
167 <!-- ##### ARG GtkWindow:opacity ##### -->
168 <para>
169
170 </para>
171
172 <!-- ##### ARG GtkWindow:resizable ##### -->
173 <para>
174
175 </para>
176
177 <!-- ##### ARG GtkWindow:role ##### -->
178 <para>
179
180 </para>
181
182 <!-- ##### ARG GtkWindow:screen ##### -->
183 <para>
184
185 </para>
186
187 <!-- ##### ARG GtkWindow:skip-pager-hint ##### -->
188 <para>
189
190 </para>
191
192 <!-- ##### ARG GtkWindow:skip-taskbar-hint ##### -->
193 <para>
194
195 </para>
196
197 <!-- ##### ARG GtkWindow:startup-id ##### -->
198 <para>
199
200 </para>
201
202 <!-- ##### ARG GtkWindow:title ##### -->
203 <para>
204
205 </para>
206
207 <!-- ##### ARG GtkWindow:transient-for ##### -->
208 <para>
209
210 </para>
211
212 <!-- ##### ARG GtkWindow:type ##### -->
213 <para>
214
215 </para>
216
217 <!-- ##### ARG GtkWindow:type-hint ##### -->
218 <para>
219
220 </para>
221
222 <!-- ##### ARG GtkWindow:urgency-hint ##### -->
223 <para>
224
225 </para>
226
227 <!-- ##### ARG GtkWindow:window-position ##### -->
228 <para>
229
230 </para>
231
232 <!-- ##### FUNCTION gtk_window_new ##### -->
233 <para>
234
235 </para>
236
237 @type: 
238 @Returns: 
239
240
241 <!-- ##### FUNCTION gtk_window_set_title ##### -->
242 <para>
243
244 </para>
245
246 @window: 
247 @title: 
248
249
250 <!-- ##### FUNCTION gtk_window_set_wmclass ##### -->
251 <para>
252
253 </para>
254
255 @window: 
256 @wmclass_name: 
257 @wmclass_class: 
258
259
260 <!-- ##### FUNCTION gtk_window_set_resizable ##### -->
261 <para>
262
263 </para>
264
265 @window: 
266 @resizable: 
267
268
269 <!-- ##### FUNCTION gtk_window_get_resizable ##### -->
270 <para>
271
272 </para>
273
274 @window: 
275 @Returns: 
276
277
278 <!-- ##### FUNCTION gtk_window_add_accel_group ##### -->
279 <para>
280
281 </para>
282
283 @window: 
284 @accel_group: 
285
286
287 <!-- ##### FUNCTION gtk_window_remove_accel_group ##### -->
288 <para>
289
290 </para>
291
292 @window: 
293 @accel_group: 
294
295
296 <!-- ##### FUNCTION gtk_window_activate_focus ##### -->
297 <para>
298
299 </para>
300
301 @window: 
302 @Returns: 
303
304
305 <!-- ##### FUNCTION gtk_window_activate_default ##### -->
306 <para>
307
308 </para>
309
310 @window: 
311 @Returns: 
312
313
314 <!-- ##### FUNCTION gtk_window_set_modal ##### -->
315 <para>
316
317 </para>
318
319 @window: 
320 @modal: 
321
322
323 <!-- ##### FUNCTION gtk_window_set_default_size ##### -->
324 <para>
325
326 </para>
327
328 @window: 
329 @width: 
330 @height: 
331
332
333 <!-- ##### FUNCTION gtk_window_set_geometry_hints ##### -->
334 <para>
335
336 </para>
337
338 @window: 
339 @geometry_widget: 
340 @geometry: 
341 @geom_mask: 
342
343
344 <!-- ##### FUNCTION gtk_window_set_gravity ##### -->
345 <para>
346
347 </para>
348
349 @window: 
350 @gravity: 
351
352
353 <!-- ##### FUNCTION gtk_window_get_gravity ##### -->
354 <para>
355
356 </para>
357
358 @window: 
359 @Returns: 
360
361
362 <!-- ##### FUNCTION gtk_window_set_position ##### -->
363 <para>
364
365 </para>
366
367 @window: 
368 @position: 
369
370
371 <!-- ##### FUNCTION gtk_window_set_transient_for ##### -->
372 <para>
373
374 </para>
375
376 @window: 
377 @parent: 
378
379
380 <!-- ##### FUNCTION gtk_window_set_destroy_with_parent ##### -->
381 <para>
382
383 </para>
384
385 @window: 
386 @setting: 
387
388
389 <!-- ##### FUNCTION gtk_window_set_screen ##### -->
390 <para>
391
392 </para>
393
394 @window: 
395 @screen: 
396
397
398 <!-- ##### FUNCTION gtk_window_get_screen ##### -->
399 <para>
400
401 </para>
402
403 @window: 
404 @Returns: 
405
406
407 <!-- ##### FUNCTION gtk_window_is_active ##### -->
408 <para>
409
410 </para>
411
412 @window: 
413 @Returns: 
414
415
416 <!-- ##### FUNCTION gtk_window_has_toplevel_focus ##### -->
417 <para>
418
419 </para>
420
421 @window: 
422 @Returns: 
423
424
425 <!-- ##### FUNCTION gtk_window_list_toplevels ##### -->
426 <para>
427
428 </para>
429
430 @Returns: 
431
432
433 <!-- ##### FUNCTION gtk_window_add_mnemonic ##### -->
434 <para>
435
436 </para>
437
438 @window: 
439 @keyval: 
440 @target: 
441
442
443 <!-- ##### FUNCTION gtk_window_remove_mnemonic ##### -->
444 <para>
445
446 </para>
447
448 @window: 
449 @keyval: 
450 @target: 
451
452
453 <!-- ##### FUNCTION gtk_window_mnemonic_activate ##### -->
454 <para>
455
456 </para>
457
458 @window: 
459 @keyval: 
460 @modifier: 
461 @Returns: 
462
463
464 <!-- ##### FUNCTION gtk_window_activate_key ##### -->
465 <para>
466
467 </para>
468
469 @window: 
470 @event: 
471 @Returns: 
472
473
474 <!-- ##### FUNCTION gtk_window_propagate_key_event ##### -->
475 <para>
476
477 </para>
478
479 @window: 
480 @event: 
481 @Returns: 
482
483
484 <!-- ##### FUNCTION gtk_window_get_focus ##### -->
485 <para>
486
487 </para>
488
489 @window: 
490 @Returns: 
491
492
493 <!-- ##### FUNCTION gtk_window_set_focus ##### -->
494 <para>
495
496 </para>
497
498 @window: 
499 @focus: 
500
501
502 <!-- ##### FUNCTION gtk_window_get_default_widget ##### -->
503 <para>
504
505 </para>
506
507 @window: 
508 @Returns: 
509
510
511 <!-- ##### FUNCTION gtk_window_set_default ##### -->
512 <para>
513
514 </para>
515
516 @window: 
517 @default_widget: 
518
519
520 <!-- ##### FUNCTION gtk_window_present ##### -->
521 <para>
522
523 </para>
524
525 @window: 
526
527
528 <!-- ##### FUNCTION gtk_window_present_with_time ##### -->
529 <para>
530
531 </para>
532
533 @window: 
534 @timestamp: 
535
536
537 <!-- ##### FUNCTION gtk_window_iconify ##### -->
538 <para>
539
540 </para>
541
542 @window: 
543
544
545 <!-- ##### FUNCTION gtk_window_deiconify ##### -->
546 <para>
547
548 </para>
549
550 @window: 
551
552
553 <!-- ##### FUNCTION gtk_window_stick ##### -->
554 <para>
555
556 </para>
557
558 @window: 
559
560
561 <!-- ##### FUNCTION gtk_window_unstick ##### -->
562 <para>
563
564 </para>
565
566 @window: 
567
568
569 <!-- ##### FUNCTION gtk_window_maximize ##### -->
570 <para>
571
572 </para>
573
574 @window: 
575
576
577 <!-- ##### FUNCTION gtk_window_unmaximize ##### -->
578 <para>
579
580 </para>
581
582 @window: 
583
584
585 <!-- ##### FUNCTION gtk_window_fullscreen ##### -->
586 <para>
587
588 </para>
589
590 @window: 
591
592
593 <!-- ##### FUNCTION gtk_window_unfullscreen ##### -->
594 <para>
595
596 </para>
597
598 @window: 
599
600
601 <!-- ##### FUNCTION gtk_window_set_keep_above ##### -->
602 <para>
603
604 </para>
605
606 @window: 
607 @setting: 
608
609
610 <!-- ##### FUNCTION gtk_window_set_keep_below ##### -->
611 <para>
612
613 </para>
614
615 @window: 
616 @setting: 
617
618
619 <!-- ##### FUNCTION gtk_window_begin_resize_drag ##### -->
620 <para>
621
622 </para>
623
624 @window: 
625 @edge: 
626 @button: 
627 @root_x: 
628 @root_y: 
629 @timestamp: 
630
631
632 <!-- ##### FUNCTION gtk_window_begin_move_drag ##### -->
633 <para>
634
635 </para>
636
637 @window: 
638 @button: 
639 @root_x: 
640 @root_y: 
641 @timestamp: 
642
643
644 <!-- ##### FUNCTION gtk_window_set_decorated ##### -->
645 <para>
646
647 </para>
648
649 @window: 
650 @setting: 
651
652
653 <!-- ##### FUNCTION gtk_window_set_deletable ##### -->
654 <para>
655
656 </para>
657
658 @window: 
659 @setting: 
660
661
662 <!-- ##### FUNCTION gtk_window_set_frame_dimensions ##### -->
663 <para>
664
665 </para>
666
667 @window: 
668 @left: 
669 @top: 
670 @right: 
671 @bottom: 
672
673
674 <!-- ##### FUNCTION gtk_window_set_has_frame ##### -->
675 <para>
676
677 </para>
678
679 @window: 
680 @setting: 
681
682
683 <!-- ##### FUNCTION gtk_window_set_mnemonic_modifier ##### -->
684 <para>
685
686 </para>
687
688 @window: 
689 @modifier: 
690
691
692 <!-- ##### FUNCTION gtk_window_set_type_hint ##### -->
693 <para>
694
695 </para>
696
697 @window: 
698 @hint: 
699
700
701 <!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### -->
702 <para>
703
704 </para>
705
706 @window: 
707 @setting: 
708
709
710 <!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### -->
711 <para>
712
713 </para>
714
715 @window: 
716 @setting: 
717
718
719 <!-- ##### FUNCTION gtk_window_set_urgency_hint ##### -->
720 <para>
721
722 </para>
723
724 @window: 
725 @setting: 
726
727
728 <!-- ##### FUNCTION gtk_window_set_accept_focus ##### -->
729 <para>
730
731 </para>
732
733 @window: 
734 @setting: 
735
736
737 <!-- ##### FUNCTION gtk_window_set_focus_on_map ##### -->
738 <para>
739
740 </para>
741
742 @window: 
743 @setting: 
744
745
746 <!-- ##### FUNCTION gtk_window_set_startup_id ##### -->
747 <para>
748
749 </para>
750
751 @window: 
752 @startup_id: 
753
754
755 <!-- ##### FUNCTION gtk_window_set_role ##### -->
756 <para>
757
758 </para>
759
760 @window: 
761 @role: 
762
763
764 <!-- ##### FUNCTION gtk_window_get_decorated ##### -->
765 <para>
766
767 </para>
768
769 @window: 
770 @Returns: 
771
772
773 <!-- ##### FUNCTION gtk_window_get_deletable ##### -->
774 <para>
775
776 </para>
777
778 @window: 
779 @Returns: 
780
781
782 <!-- ##### FUNCTION gtk_window_get_default_icon_list ##### -->
783 <para>
784
785 </para>
786
787 @Returns: 
788
789
790 <!-- ##### FUNCTION gtk_window_get_default_icon_name ##### -->
791 <para>
792
793 </para>
794
795 @Returns: 
796
797
798 <!-- ##### FUNCTION gtk_window_get_default_size ##### -->
799 <para>
800
801 </para>
802
803 @window: 
804 @width: 
805 @height: 
806
807
808 <!-- ##### FUNCTION gtk_window_get_destroy_with_parent ##### -->
809 <para>
810
811 </para>
812
813 @window: 
814 @Returns: 
815
816
817 <!-- ##### FUNCTION gtk_window_get_frame_dimensions ##### -->
818 <para>
819
820 </para>
821
822 @window: 
823 @left: 
824 @top: 
825 @right: 
826 @bottom: 
827
828
829 <!-- ##### FUNCTION gtk_window_get_has_frame ##### -->
830 <para>
831
832 </para>
833
834 @window: 
835 @Returns: 
836
837
838 <!-- ##### FUNCTION gtk_window_get_icon ##### -->
839 <para>
840
841 </para>
842
843 @window: 
844 @Returns: 
845
846
847 <!-- ##### FUNCTION gtk_window_get_icon_list ##### -->
848 <para>
849
850 </para>
851
852 @window: 
853 @Returns: 
854
855
856 <!-- ##### FUNCTION gtk_window_get_icon_name ##### -->
857 <para>
858
859 </para>
860
861 @window: 
862 @Returns: 
863
864
865 <!-- ##### FUNCTION gtk_window_get_mnemonic_modifier ##### -->
866 <para>
867
868 </para>
869
870 @window: 
871 @Returns: 
872
873
874 <!-- ##### FUNCTION gtk_window_get_modal ##### -->
875 <para>
876
877 </para>
878
879 @window: 
880 @Returns: 
881
882
883 <!-- ##### FUNCTION gtk_window_get_position ##### -->
884 <para>
885
886 </para>
887
888 @window: 
889 @root_x: 
890 @root_y: 
891
892
893 <!-- ##### FUNCTION gtk_window_get_role ##### -->
894 <para>
895
896 </para>
897
898 @window: 
899 @Returns: 
900
901
902 <!-- ##### FUNCTION gtk_window_get_size ##### -->
903 <para>
904
905 </para>
906
907 @window: 
908 @width: 
909 @height: 
910
911
912 <!-- ##### FUNCTION gtk_window_get_title ##### -->
913 <para>
914
915 </para>
916
917 @window: 
918 @Returns: 
919
920
921 <!-- ##### FUNCTION gtk_window_get_transient_for ##### -->
922 <para>
923
924 </para>
925
926 @window: 
927 @Returns: 
928
929
930 <!-- ##### FUNCTION gtk_window_get_type_hint ##### -->
931 <para>
932
933 </para>
934
935 @window: 
936 @Returns: 
937
938
939 <!-- ##### FUNCTION gtk_window_get_skip_taskbar_hint ##### -->
940 <para>
941
942 </para>
943
944 @window: 
945 @Returns: 
946
947
948 <!-- ##### FUNCTION gtk_window_get_skip_pager_hint ##### -->
949 <para>
950
951 </para>
952
953 @window: 
954 @Returns: 
955
956
957 <!-- ##### FUNCTION gtk_window_get_urgency_hint ##### -->
958 <para>
959
960 </para>
961
962 @window: 
963 @Returns: 
964
965
966 <!-- ##### FUNCTION gtk_window_get_accept_focus ##### -->
967 <para>
968
969 </para>
970
971 @window: 
972 @Returns: 
973
974
975 <!-- ##### FUNCTION gtk_window_get_focus_on_map ##### -->
976 <para>
977
978 </para>
979
980 @window: 
981 @Returns: 
982
983
984 <!-- ##### FUNCTION gtk_window_get_group ##### -->
985 <para>
986
987 </para>
988
989 @window: 
990 @Returns: 
991
992
993 <!-- ##### FUNCTION gtk_window_get_window_type ##### -->
994 <para>
995
996 </para>
997
998 @window: 
999 @Returns: 
1000
1001
1002 <!-- ##### FUNCTION gtk_window_move ##### -->
1003 <para>
1004
1005 </para>
1006
1007 @window: 
1008 @x: 
1009 @y: 
1010
1011
1012 <!-- ##### FUNCTION gtk_window_parse_geometry ##### -->
1013 <para>
1014
1015 </para>
1016
1017 @window: 
1018 @geometry: 
1019 @Returns: 
1020
1021
1022 <!-- ##### FUNCTION gtk_window_reshow_with_initial_size ##### -->
1023 <para>
1024
1025 </para>
1026
1027 @window: 
1028
1029
1030 <!-- ##### FUNCTION gtk_window_resize ##### -->
1031 <para>
1032
1033 </para>
1034
1035 @window: 
1036 @width: 
1037 @height: 
1038
1039
1040 <!-- ##### FUNCTION gtk_window_set_default_icon_list ##### -->
1041 <para>
1042
1043 </para>
1044
1045 @list: 
1046
1047
1048 <!-- ##### FUNCTION gtk_window_set_default_icon ##### -->
1049 <para>
1050
1051 </para>
1052
1053 @icon: 
1054
1055
1056 <!-- ##### FUNCTION gtk_window_set_default_icon_from_file ##### -->
1057 <para>
1058
1059 </para>
1060
1061 @filename: 
1062 @err: 
1063 @Returns: 
1064
1065
1066 <!-- ##### FUNCTION gtk_window_set_default_icon_name ##### -->
1067 <para>
1068
1069 </para>
1070
1071 @name: 
1072
1073
1074 <!-- ##### FUNCTION gtk_window_set_icon ##### -->
1075 <para>
1076
1077 </para>
1078
1079 @window: 
1080 @icon: 
1081
1082
1083 <!-- ##### FUNCTION gtk_window_set_icon_list ##### -->
1084 <para>
1085
1086 </para>
1087
1088 @window: 
1089 @list: 
1090
1091
1092 <!-- ##### FUNCTION gtk_window_set_icon_from_file ##### -->
1093 <para>
1094
1095 </para>
1096
1097 @window: 
1098 @filename: 
1099 @err: 
1100 @Returns: 
1101
1102
1103 <!-- ##### FUNCTION gtk_window_set_icon_name ##### -->
1104 <para>
1105
1106 </para>
1107
1108 @window: 
1109 @name: 
1110
1111
1112 <!-- ##### FUNCTION gtk_window_set_auto_startup_notification ##### -->
1113 <para>
1114
1115 </para>
1116
1117 @setting: 
1118
1119
1120 <!-- ##### FUNCTION gtk_window_get_opacity ##### -->
1121 <para>
1122
1123 </para>
1124
1125 @window: 
1126 @Returns: 
1127
1128
1129 <!-- ##### FUNCTION gtk_window_set_opacity ##### -->
1130 <para>
1131
1132 </para>
1133
1134 @window: 
1135 @opacity: 
1136
1137
1138 <!-- ##### FUNCTION gtk_window_get_mnemonics_visible ##### -->
1139 <para>
1140
1141 </para>
1142
1143 @window: 
1144 @Returns: 
1145
1146
1147 <!-- ##### FUNCTION gtk_window_set_mnemonics_visible ##### -->
1148 <para>
1149
1150 </para>
1151
1152 @window: 
1153 @setting: 
1154
1155