]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/windows.sgml
fix a typo.
[~andy/gtk] / docs / reference / gdk / tmpl / windows.sgml
1 <!-- ##### SECTION Title ##### -->
2 Windows
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### STRUCT GdkWindowAttr ##### -->
18 <para>
19
20 </para>
21
22 @title: 
23 @event_mask: 
24 @x: 
25 @y: 
26 @width: 
27 @height: 
28 @wclass: 
29 @visual: 
30 @colormap: 
31 @window_type: 
32 @cursor: 
33 @wmclass_name: 
34 @wmclass_class: 
35 @override_redirect: 
36
37 <!-- ##### STRUCT GdkWindow ##### -->
38 <para>
39
40 </para>
41
42 @user_data: 
43
44 <!-- ##### ENUM GdkWindowType ##### -->
45 <para>
46
47 </para>
48
49 @GDK_WINDOW_ROOT: 
50 @GDK_WINDOW_TOPLEVEL: 
51 @GDK_WINDOW_CHILD: 
52 @GDK_WINDOW_DIALOG: 
53 @GDK_WINDOW_TEMP: 
54 @GDK_WINDOW_FOREIGN: 
55
56 <!-- ##### ENUM GdkWindowClass ##### -->
57 <para>
58
59 </para>
60
61 @GDK_INPUT_OUTPUT: 
62 @GDK_INPUT_ONLY: 
63
64 <!-- ##### ENUM GdkWindowAttributesType ##### -->
65 <para>
66
67 </para>
68
69 @GDK_WA_TITLE: 
70 @GDK_WA_X: 
71 @GDK_WA_Y: 
72 @GDK_WA_CURSOR: 
73 @GDK_WA_COLORMAP: 
74 @GDK_WA_VISUAL: 
75 @GDK_WA_WMCLASS: 
76 @GDK_WA_NOREDIR: 
77
78 <!-- ##### ENUM GdkWindowHints ##### -->
79 <para>
80
81 </para>
82
83 @GDK_HINT_POS: 
84 @GDK_HINT_MIN_SIZE: 
85 @GDK_HINT_MAX_SIZE: 
86 @GDK_HINT_BASE_SIZE: 
87 @GDK_HINT_ASPECT: 
88 @GDK_HINT_RESIZE_INC: 
89 @GDK_HINT_WIN_GRAVITY: 
90 @GDK_HINT_USER_POS: 
91 @GDK_HINT_USER_SIZE: 
92
93 <!-- ##### STRUCT GdkGeometry ##### -->
94 <para>
95
96 </para>
97
98 @min_width: 
99 @min_height: 
100 @max_width: 
101 @max_height: 
102 @base_width: 
103 @base_height: 
104 @width_inc: 
105 @height_inc: 
106 @min_aspect: 
107 @max_aspect: 
108 @win_gravity: 
109
110 <!-- ##### ENUM GdkGravity ##### -->
111 <para>
112
113 </para>
114
115 @GDK_GRAVITY_NORTH_WEST: 
116 @GDK_GRAVITY_NORTH: 
117 @GDK_GRAVITY_NORTH_EAST: 
118 @GDK_GRAVITY_WEST: 
119 @GDK_GRAVITY_CENTER: 
120 @GDK_GRAVITY_EAST: 
121 @GDK_GRAVITY_SOUTH_WEST: 
122 @GDK_GRAVITY_SOUTH: 
123 @GDK_GRAVITY_SOUTH_EAST: 
124 @GDK_GRAVITY_STATIC: 
125
126 <!-- ##### ENUM GdkWindowEdge ##### -->
127 <para>
128
129 </para>
130
131 @GDK_WINDOW_EDGE_NORTH_WEST: 
132 @GDK_WINDOW_EDGE_NORTH: 
133 @GDK_WINDOW_EDGE_NORTH_EAST: 
134 @GDK_WINDOW_EDGE_WEST: 
135 @GDK_WINDOW_EDGE_EAST: 
136 @GDK_WINDOW_EDGE_SOUTH_WEST: 
137 @GDK_WINDOW_EDGE_SOUTH: 
138 @GDK_WINDOW_EDGE_SOUTH_EAST: 
139
140 <!-- ##### ENUM GdkWindowTypeHint ##### -->
141 <para>
142
143 </para>
144
145 @GDK_WINDOW_TYPE_HINT_NORMAL: 
146 @GDK_WINDOW_TYPE_HINT_DIALOG: 
147 @GDK_WINDOW_TYPE_HINT_MENU: 
148 @GDK_WINDOW_TYPE_HINT_TOOLBAR: 
149
150 <!-- ##### FUNCTION gdk_window_new ##### -->
151 <para>
152
153 </para>
154
155 @parent: 
156 @attributes: 
157 @attributes_mask: 
158 @Returns: 
159
160
161 <!-- ##### FUNCTION gdk_window_destroy ##### -->
162 <para>
163
164 </para>
165
166 @window: 
167
168
169 <!-- ##### MACRO gdk_window_ref ##### -->
170 <para>
171
172 </para>
173
174 @Returns: 
175 <!-- # Unused Parameters # -->
176 @window: 
177
178
179 <!-- ##### MACRO gdk_window_unref ##### -->
180 <para>
181
182 </para>
183
184 <!-- # Unused Parameters # -->
185 @window: 
186
187
188 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
189 <para>
190
191 </para>
192
193 @window: 
194 @Returns: 
195
196
197 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
198 <para>
199
200 </para>
201
202 @win_x: 
203 @win_y: 
204 @Returns: 
205
206
207 <!-- ##### FUNCTION gdk_window_show ##### -->
208 <para>
209
210 </para>
211
212 @window: 
213
214
215 <!-- ##### FUNCTION gdk_window_hide ##### -->
216 <para>
217
218 </para>
219
220 @window: 
221
222
223 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
224 <para>
225
226 </para>
227
228 @window: 
229 @Returns: 
230
231
232 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
233 <para>
234
235 </para>
236
237 @window: 
238 @Returns: 
239
240
241 <!-- ##### FUNCTION gdk_window_get_state ##### -->
242 <para>
243
244 </para>
245
246 @window: 
247 @Returns: 
248
249
250 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
251 <para>
252
253 </para>
254
255 @window: 
256
257
258 <!-- ##### FUNCTION gdk_window_iconify ##### -->
259 <para>
260
261 </para>
262
263 @window: 
264
265
266 <!-- ##### FUNCTION gdk_window_deiconify ##### -->
267 <para>
268
269 </para>
270
271 @window: 
272
273
274 <!-- ##### FUNCTION gdk_window_stick ##### -->
275 <para>
276
277 </para>
278
279 @window: 
280
281
282 <!-- ##### FUNCTION gdk_window_unstick ##### -->
283 <para>
284
285 </para>
286
287 @window: 
288
289
290 <!-- ##### FUNCTION gdk_window_maximize ##### -->
291 <para>
292
293 </para>
294
295 @window: 
296
297
298 <!-- ##### FUNCTION gdk_window_unmaximize ##### -->
299 <para>
300
301 </para>
302
303 @window: 
304
305
306 <!-- ##### FUNCTION gdk_window_move ##### -->
307 <para>
308
309 </para>
310
311 @window: 
312 @x: 
313 @y: 
314
315
316 <!-- ##### FUNCTION gdk_window_resize ##### -->
317 <para>
318
319 </para>
320
321 @window: 
322 @width: 
323 @height: 
324
325
326 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
327 <para>
328
329 </para>
330
331 @window: 
332 @x: 
333 @y: 
334 @width: 
335 @height: 
336
337
338 <!-- ##### FUNCTION gdk_window_scroll ##### -->
339 <para>
340
341 </para>
342
343 @window: 
344 @dx: 
345 @dy: 
346
347
348 <!-- ##### FUNCTION gdk_window_reparent ##### -->
349 <para>
350
351 </para>
352
353 @window: 
354 @new_parent: 
355 @x: 
356 @y: 
357
358
359 <!-- ##### FUNCTION gdk_window_clear ##### -->
360 <para>
361
362 </para>
363
364 @window: 
365
366
367 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
368 <para>
369
370 </para>
371
372 @window: 
373 @x: 
374 @y: 
375 @width: 
376 @height: 
377
378
379 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
380 <para>
381
382 </para>
383
384 @window: 
385 @x: 
386 @y: 
387 @width: 
388 @height: 
389
390
391 <!-- ##### MACRO gdk_window_copy_area ##### -->
392 <para>
393
394 </para>
395
396 @drawable: 
397 @gc: 
398 @x: 
399 @y: 
400 @source_drawable: 
401 @source_x: 
402 @source_y: 
403 @width: 
404 @height: 
405 <!-- # Unused Parameters # -->
406 @window: 
407 @source_window: 
408
409
410 <!-- ##### FUNCTION gdk_window_raise ##### -->
411 <para>
412
413 </para>
414
415 @window: 
416
417
418 <!-- ##### FUNCTION gdk_window_lower ##### -->
419 <para>
420
421 </para>
422
423 @window: 
424
425
426 <!-- ##### FUNCTION gdk_window_focus ##### -->
427 <para>
428
429 </para>
430
431 @window: 
432 @timestamp: 
433
434
435 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
436 <para>
437
438 </para>
439
440 @window: 
441
442
443 <!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
444 <para>
445
446 </para>
447
448 @window: 
449 @edge: 
450 @button: 
451 @root_x: 
452 @root_y: 
453 @timestamp: 
454
455
456 <!-- ##### FUNCTION gdk_window_begin_move_drag ##### -->
457 <para>
458
459 </para>
460
461 @window: 
462 @button: 
463 @root_x: 
464 @root_y: 
465 @timestamp: 
466
467
468 <!-- ##### FUNCTION gdk_window_constrain_size ##### -->
469 <para>
470
471 </para>
472
473 @geometry: 
474 @flags: 
475 @width: 
476 @height: 
477 @new_width: 
478 @new_height: 
479
480
481 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
482 <para>
483
484 </para>
485
486 @window: 
487 @rectangle: 
488
489
490 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
491 <para>
492
493 </para>
494
495 @window: 
496 @region: 
497
498
499 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
500 <para>
501
502 </para>
503
504 @window: 
505
506
507 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
508 <para>
509
510 </para>
511
512 @window: 
513 @rect: 
514 @invalidate_children: 
515
516
517 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
518 <para>
519
520 </para>
521
522 @window: 
523 @region: 
524 @invalidate_children: 
525
526
527 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
528 <para>
529
530 </para>
531
532 @window: 
533 @Returns: 
534
535
536 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
537 <para>
538
539 </para>
540
541 @window: 
542
543
544 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
545 <para>
546
547 </para>
548
549 @window: 
550
551
552 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
553 <para>
554
555 </para>
556
557
558
559 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
560 <para>
561
562 </para>
563
564 @window: 
565 @update_children: 
566
567
568 <!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
569 <para>
570
571 </para>
572
573 @setting: 
574
575
576 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
577 <para>
578
579 </para>
580
581 @window: 
582 @user_data: 
583
584
585 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
586 <para>
587
588 </para>
589
590 @window: 
591 @override_redirect: 
592
593
594 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
595 <para>
596
597 </para>
598
599 @window: 
600 @function: 
601 @data: 
602
603
604 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
605 <para>
606
607 </para>
608
609 @window: 
610 @function: 
611 @data: 
612
613
614 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
615 <para>
616
617 </para>
618
619 @xevent: 
620 @event: 
621 @data: 
622 @Returns: 
623
624
625 <!-- ##### ENUM GdkFilterReturn ##### -->
626 <para>
627
628 </para>
629
630 @GDK_FILTER_CONTINUE: 
631 @GDK_FILTER_TRANSLATE: 
632 @GDK_FILTER_REMOVE: 
633
634 <!-- ##### TYPEDEF GdkXEvent ##### -->
635 <para>
636
637 </para>
638
639
640 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
641 <para>
642
643 </para>
644
645 @window: 
646 @shape_mask: 
647 @offset_x: 
648 @offset_y: 
649
650
651 <!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
652 <para>
653
654 </para>
655
656 @window: 
657 @shape_region: 
658 @offset_x: 
659 @offset_y: 
660
661
662 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
663 <para>
664
665 </para>
666
667 @window: 
668
669
670 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
671 <para>
672
673 </para>
674
675 @window: 
676
677
678 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
679 <para>
680
681 </para>
682
683 @window: 
684 @use_static: 
685 @Returns: 
686
687
688 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
689 <para>
690
691 </para>
692
693 @window: 
694 @x: 
695 @y: 
696 @min_width: 
697 @min_height: 
698 @max_width: 
699 @max_height: 
700 @flags: 
701
702
703 <!-- ##### FUNCTION gdk_window_set_title ##### -->
704 <para>
705
706 </para>
707
708 @window: 
709 @title: 
710
711
712 <!-- ##### FUNCTION gdk_window_set_background ##### -->
713 <para>
714
715 </para>
716
717 @window: 
718 @color: 
719
720
721 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
722 <para>
723
724 </para>
725
726 @window: 
727 @pixmap: 
728 @parent_relative: 
729
730
731 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
732 <para>
733
734 </para>
735
736
737
738 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
739 <para>
740
741 </para>
742
743 @window: 
744 @cursor: 
745
746
747 <!-- ##### MACRO gdk_window_set_colormap ##### -->
748 <para>
749
750 </para>
751
752 <!-- # Unused Parameters # -->
753 @window: 
754 @colormap: 
755
756
757 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
758 <para>
759
760 </para>
761
762 @window: 
763 @data: 
764
765
766 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
767 <para>
768
769 </para>
770
771 @window: 
772 @x: 
773 @y: 
774 @width: 
775 @height: 
776 @depth: 
777
778
779 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
780 <para>
781
782 </para>
783
784 @window: 
785 @geometry: 
786 @flags: 
787
788
789 <!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
790 <para>
791
792 </para>
793
794 @window: 
795 @pixbufs: 
796 @Returns: 
797
798
799 <!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
800 <para>
801
802 </para>
803
804 @window: 
805 @modal: 
806
807
808 <!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
809 <para>
810
811 </para>
812
813 @window: 
814 @hint: 
815
816
817 <!-- ##### FUNCTION gdk_window_get_position ##### -->
818 <para>
819
820 </para>
821
822 @window: 
823 @x: 
824 @y: 
825
826
827 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
828 <para>
829
830 </para>
831
832 @window: 
833 @x: 
834 @y: 
835
836
837 <!-- ##### FUNCTION gdk_window_get_frame_extents ##### -->
838 <para>
839
840 </para>
841
842 @window: 
843 @rect: 
844
845
846 <!-- ##### MACRO gdk_window_get_size ##### -->
847 <para>
848
849 </para>
850
851 <!-- # Unused Parameters # -->
852 @window: 
853 @width: 
854 @height: 
855
856
857 <!-- ##### MACRO gdk_window_get_visual ##### -->
858 <para>
859
860 </para>
861
862 @Returns: 
863 <!-- # Unused Parameters # -->
864 @window: 
865
866
867 <!-- ##### MACRO gdk_window_get_colormap ##### -->
868 <para>
869
870 </para>
871
872 @Returns: 
873 <!-- # Unused Parameters # -->
874 @window: 
875
876
877 <!-- ##### MACRO gdk_window_get_type ##### -->
878 <para>
879
880 </para>
881
882 @Returns: 
883 <!-- # Unused Parameters # -->
884 @window: 
885
886
887 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
888 <para>
889
890 </para>
891
892 @window: 
893 @x: 
894 @y: 
895 @Returns: 
896
897
898 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
899 <para>
900
901 </para>
902
903 @window: 
904 @x: 
905 @y: 
906 @Returns: 
907
908
909 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
910 <para>
911
912 </para>
913
914 @window: 
915 @x: 
916 @y: 
917 @mask: 
918 @Returns: 
919
920
921 <!-- ##### ENUM GdkModifierType ##### -->
922 <para>
923
924 </para>
925
926 @GDK_SHIFT_MASK: 
927 @GDK_LOCK_MASK: 
928 @GDK_CONTROL_MASK: 
929 @GDK_MOD1_MASK: 
930 @GDK_MOD2_MASK: 
931 @GDK_MOD3_MASK: 
932 @GDK_MOD4_MASK: 
933 @GDK_MOD5_MASK: 
934 @GDK_BUTTON1_MASK: 
935 @GDK_BUTTON2_MASK: 
936 @GDK_BUTTON3_MASK: 
937 @GDK_BUTTON4_MASK: 
938 @GDK_BUTTON5_MASK: 
939 @GDK_RELEASE_MASK: 
940 @GDK_MODIFIER_MASK: 
941
942 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
943 <para>
944
945 </para>
946
947 @window: 
948 @Returns: 
949
950
951 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
952 <para>
953
954 </para>
955
956 @window: 
957 @Returns: 
958
959
960 <!-- ##### FUNCTION gdk_window_get_children ##### -->
961 <para>
962
963 </para>
964
965 @window: 
966 @Returns: 
967
968
969 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
970 <para>
971
972 </para>
973
974 @window: 
975 @Returns: 
976
977
978 <!-- ##### FUNCTION gdk_window_get_events ##### -->
979 <para>
980
981 </para>
982
983 @window: 
984 @Returns: 
985
986
987 <!-- ##### FUNCTION gdk_window_set_events ##### -->
988 <para>
989
990 </para>
991
992 @window: 
993 @event_mask: 
994
995
996 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
997 <para>
998
999 </para>
1000
1001 @window: 
1002 @icon_window: 
1003 @pixmap: 
1004 @mask: 
1005
1006
1007 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
1008 <para>
1009
1010 </para>
1011
1012 @window: 
1013 @name: 
1014
1015
1016 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
1017 <para>
1018
1019 </para>
1020
1021 @window: 
1022 @leader: 
1023
1024
1025 <!-- ##### FUNCTION gdk_window_set_role ##### -->
1026 <para>
1027
1028 </para>
1029
1030 @window: 
1031 @role: 
1032
1033
1034 <!-- ##### FUNCTION gdk_window_set_group ##### -->
1035 <para>
1036
1037 </para>
1038
1039 @window: 
1040 @leader: 
1041
1042
1043 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
1044 <para>
1045
1046 </para>
1047
1048 @window: 
1049 @decorations: 
1050
1051
1052 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
1053 <para>
1054
1055 </para>
1056
1057 @window: The window to get the decorations from
1058 @decorations: The window decorations will be written here
1059 @Returns: TRUE if the window has decorations set, FALSE otherwise.
1060
1061
1062 <!-- ##### ENUM GdkWMDecoration ##### -->
1063 <para>
1064
1065 </para>
1066
1067 @GDK_DECOR_ALL: 
1068 @GDK_DECOR_BORDER: 
1069 @GDK_DECOR_RESIZEH: 
1070 @GDK_DECOR_TITLE: 
1071 @GDK_DECOR_MENU: 
1072 @GDK_DECOR_MINIMIZE: 
1073 @GDK_DECOR_MAXIMIZE: 
1074
1075 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
1076 <para>
1077
1078 </para>
1079
1080 @window: 
1081 @functions: 
1082
1083
1084 <!-- ##### ENUM GdkWMFunction ##### -->
1085 <para>
1086
1087 </para>
1088
1089 @GDK_FUNC_ALL: 
1090 @GDK_FUNC_RESIZE: 
1091 @GDK_FUNC_MOVE: 
1092 @GDK_FUNC_MINIMIZE: 
1093 @GDK_FUNC_MAXIMIZE: 
1094 @GDK_FUNC_CLOSE: 
1095
1096 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
1097 <para>
1098
1099 </para>
1100
1101 @Returns: 
1102
1103