]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/windows.sgml
064a73395e2af1764af6c26189b0290b43d1f384
[~andy/gtk] / docs / reference / gdk / tmpl / windows.sgml
1 <!-- ##### SECTION Title ##### -->
2 Windows
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6 onscreen display areas in the target window system
7
8 <!-- ##### SECTION Long_Description ##### -->
9 <para>
10 A #GdkWindow is a rectangular region on the screen. It's a low-level object,
11 used to implement high-level objects such as #GtkWidget and #GtkWindow on the
12 GTK+ level. A #GtkWindow is a toplevel window, the thing a user might think of 
13 as a "window" with a titlebar and so on; a #GtkWindow may contain many #GdkWindow. 
14 For example, each #GtkButton has a #GdkWindow associated with it.
15 </para>
16
17 <!-- ##### SECTION See_Also ##### -->
18 <para>
19
20 </para>
21
22 <!-- ##### STRUCT GdkWindow ##### -->
23 <para>
24 An opaque structure representing an onscreen drawable.
25 Pointers to structures of type #GdkPixmap, #GdkBitmap,
26 and #GdkWindow, can often be used interchangeably.
27 The type #GdkDrawable refers generically to any of
28 these types.
29 </para>
30
31 @user_data: used to store the #GtkWidget associated with this window
32
33 <!-- ##### ENUM GdkWindowType ##### -->
34 <para>
35 Describes the kind of window.
36 </para>
37
38 @GDK_WINDOW_ROOT: root window; this window has no parent, covers the entire screen, and is created by the window system
39 @GDK_WINDOW_TOPLEVEL: toplevel window (used to implement #GtkWindow)
40 @GDK_WINDOW_CHILD: child window (used to implement e.g. #GtkButton)
41 @GDK_WINDOW_DIALOG: useless/deprecated compatibility type
42 @GDK_WINDOW_TEMP: override redirect temporary window (used to implement #GtkMenu)
43 @GDK_WINDOW_FOREIGN: foreign window (see gdk_window_foreign_new())
44
45 <!-- ##### ENUM GdkWindowClass ##### -->
46 <para>
47 @GDK_INPUT_OUTPUT windows are the standard kind of window you might expect. 
48 @GDK_INPUT_ONLY windows are invisible; they are used to trap events, but 
49 you can't draw on them.
50 </para>
51
52 @GDK_INPUT_OUTPUT: window for graphics and events
53 @GDK_INPUT_ONLY: window for events only
54
55 <!-- ##### ENUM GdkWindowHints ##### -->
56 <para>
57 Used to indicate which fields of a #GdkGeometry struct should be paid attention
58 to. Also, the presence/absence of @GDK_HINT_POS, @GDK_HINT_USER_POS, and
59 @GDK_HINT_USER_SIZE is significant, though they don't directly refer to
60 #GdkGeometry fields.  @GDK_HINT_USER_POS will be set automatically by #GtkWindow
61 if you call gtk_window_move(). @GDK_HINT_USER_POS and @GDK_HINT_USER_SIZE 
62 should be set if the user specified a size/position using a --geometry 
63 command-line argument; gtk_window_parse_geometry() automatically sets these
64 flags.
65 </para>
66
67 @GDK_HINT_POS: indicates that the program has positioned the window
68 @GDK_HINT_MIN_SIZE: min size fields are set
69 @GDK_HINT_MAX_SIZE: max size fields are set
70 @GDK_HINT_BASE_SIZE: base size fields are set
71 @GDK_HINT_ASPECT: aspect ratio fields are set
72 @GDK_HINT_RESIZE_INC: resize increment fields are set
73 @GDK_HINT_WIN_GRAVITY: window gravity field is set
74 @GDK_HINT_USER_POS: indicates that the window's position was explicitly set by the user
75 @GDK_HINT_USER_SIZE: indicates that the window's size was explicitly set by the user
76
77 <!-- ##### STRUCT GdkGeometry ##### -->
78 <para>
79 The #GdkGeometry struct gives the window manager information about 
80 a window's geometry constraints. Normally you would set these on 
81 the GTK+ level using gtk_window_set_geometry_hints(). #GtkWindow 
82 then sets the hints on the #GdkWindow it creates.
83 </para>
84
85 <para>
86 gdk_window_set_geometry_hints() expects the hints to be fully valid already and
87 simply passes them to the window manager; in contrast,
88 gtk_window_set_geometry_hints() performs some interpretation. For example,
89 #GtkWindow will apply the hints to the geometry widget instead of the toplevel
90 window, if you set a geometry widget. Also, the
91 @min_width/@min_height/@max_width/@max_height fields may be set to -1, and
92 #GtkWindow will substitute the size request of the window or geometry widget. If
93 the minimum size hint is not provided, #GtkWindow will use its requisition as
94 the minimum size.  If the minimum size is provided and a geometry widget is set,
95 #GtkWindow will take the minimum size as the minimum size of the geometry widget
96 rather than the entire window. The base size is treated similarly.
97 </para>
98
99 <para>
100 The canonical use-case for gtk_window_set_geometry_hints() is to get a terminal
101 widget to resize properly. Here, the terminal text area should be the geometry
102 widget; #GtkWindow will then automatically set the base size to the size of
103 other widgets in the terminal window, such as the menubar and scrollbar.  Then,
104 the @width_inc and @height_inc fields should be set to the size of one character
105 in the terminal. Finally, the base size should be set to the size of one
106 character. The net effect is that the minimum size of the terminal 
107 will have a 1x1 character terminal area, and only terminal sizes on 
108 the "character grid" will be allowed.
109 </para>
110
111 <para>
112 Here's an example of how the terminal example would be implemented, assuming 
113 a terminal area widget called "terminal" and a toplevel window "toplevel":
114 <informalexample><programlisting>
115         GdkGeometry hints;
116
117         hints.base_width = terminal->char_width;
118         hints.base_height = terminal->char_height;
119         hints.min_width = terminal->char_width;
120         hints.min_height = terminal->char_height;
121         hints.width_inc = terminal->char_width;
122         hints.height_inc = terminal->char_height;
123
124         gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
125                                        GTK_WIDGET (terminal),
126                                        &amp;hints,
127                                        GDK_HINT_RESIZE_INC |
128                                        GDK_HINT_MIN_SIZE |
129                                        GDK_HINT_BASE_SIZE);
130 </programlisting></informalexample>
131 </para>
132
133 <para>
134 The other useful fields are the @min_aspect and @max_aspect fields; these
135 contain a width/height ratio as a floating point number. If a geometry widget is
136 set, the aspect applies to the geometry widget rather than the entire window.
137 The most common use of these hints is probably to set @min_aspect and
138 @max_aspect to the same value, thus forcing the window to keep a constant aspect
139 ratio.
140 </para>
141
142 @min_width: minimum width of window (or -1 to use requisition, with #GtkWindow only)
143 @min_height minimum height of window (or -1 to use requisition, with #GtkWindow only)
144 @min_height: 
145 @max_width: maximum width of window (or -1 to use requisition, with #GtkWindow only)
146 @max_height: maximum height of window (or -1 to use requisition, with #GtkWindow only)
147 @base_width: allowed window widths are @base_width + @width_inc * N where N is any integer (-1 allowed with #GtkWindow)
148 @base_height: allowed window widths are @base_height + @height_inc * N where N is any integer (-1 allowed with #GtkWindow)
149 @width_inc: width resize increment
150 @height_inc: height resize increment
151 @min_aspect: minimum width/height ratio
152 @max_aspect: maximum width/height ratio
153 @win_gravity: window gravity, see gtk_window_set_gravity()
154
155 <!-- ##### ENUM GdkGravity ##### -->
156 <para>
157 Defines the reference point of a window and the meaning of coordinates
158 passed to gtk_window_move(). See gtk_window_move() and the "implementation 
159 notes" section of the 
160 <ulink url="http://www.freedesktop.org/standards/wm-spec.html">extended 
161 window manager hints</ulink> specification for more details.
162 </para>
163
164 @GDK_GRAVITY_NORTH_WEST: the reference point is at the top left corner.
165 @GDK_GRAVITY_NORTH: the reference point is in the middle of the top edge.
166 @GDK_GRAVITY_NORTH_EAST: the reference point is at the top right corner.
167 @GDK_GRAVITY_WEST: the reference point is at the middle of the left edge.
168 @GDK_GRAVITY_CENTER: the reference point is at the center of the window.
169 @GDK_GRAVITY_EAST: the reference point is at the middle of the right edge.
170 @GDK_GRAVITY_SOUTH_WEST: the reference point is at the lower left corner.
171 @GDK_GRAVITY_SOUTH: the reference point is at the middle of the lower edge.
172 @GDK_GRAVITY_SOUTH_EAST: the reference point is at the lower right corner.
173 @GDK_GRAVITY_STATIC: the reference point is at the top left corner of the 
174    window itself, ignoring window manager decorations.
175
176 <!-- ##### ENUM GdkWindowEdge ##### -->
177 <para>
178 Determines a window edge or corner. 
179 </para>
180
181 @GDK_WINDOW_EDGE_NORTH_WEST: the top left corner.
182 @GDK_WINDOW_EDGE_NORTH: the top edge.
183 @GDK_WINDOW_EDGE_NORTH_EAST: the top right corner.
184 @GDK_WINDOW_EDGE_WEST: the left edge.
185 @GDK_WINDOW_EDGE_EAST: the right edge.
186 @GDK_WINDOW_EDGE_SOUTH_WEST: the lower left corner.
187 @GDK_WINDOW_EDGE_SOUTH: the lower edge.
188 @GDK_WINDOW_EDGE_SOUTH_EAST: the lower right corner.
189
190 <!-- ##### ENUM GdkWindowTypeHint ##### -->
191 <para>
192 These are hints for the window manager that indicate what type of function 
193 the window has. The window manager can use this when determining decoration 
194 and behaviour of the window. The hint must be set before mapping the window.
195 </para>
196
197 @GDK_WINDOW_TYPE_HINT_NORMAL: Normal toplevel window.
198 @GDK_WINDOW_TYPE_HINT_DIALOG: Dialog window.
199 @GDK_WINDOW_TYPE_HINT_MENU: Window used to implement a menu.
200 @GDK_WINDOW_TYPE_HINT_TOOLBAR: Window used to implement toolbars.
201
202 <!-- ##### STRUCT GdkWindowAttr ##### -->
203 <para>
204 Attributes to use for a newly-created window.
205 </para>
206
207 @title: title of the window (for toplevel windows)
208 @event_mask: event mask (see gdk_window_set_events())
209 @x: X coordinate relative to parent window (see gdk_window_move())
210 @y: Y coordinate relative to parent window (see gdk_window_move())
211 @width: width of window
212 @height: height of window
213 @wclass: #GDK_INPUT_OUTPUT (normal window) or #GDK_INPUT_ONLY (invisible window that receives events)
214 @visual: #GdkVisual for window
215 @colormap: #GdkColormap for window
216 @window_type: type of window
217 @cursor: cursor for the window (see gdk_window_set_cursor())
218 @wmclass_name: don't use (see gtk_window_set_wmclass())
219 @wmclass_class: don't use (see gtk_window_set_wmclass())
220 @override_redirect: %TRUE to bypass the window manager
221
222 <!-- ##### ENUM GdkWindowAttributesType ##### -->
223 <para>
224 Used to indicate which fields in the #GdkWindowAttr struct should be
225 honored. For example, if you filled in the "cursor" and "x" fields of
226 #GdkWindowAttr, pass "@GDK_WA_X | @GDK_WA_CURSOR" to gdk_window_new().  Fields
227 in #GdkWindowAttr not covered by a bit in this enum are required; for example,
228 the @width/@height, @wclass, and @window_type fields are required, they have no
229 corresponding flag in #GdkWindowAttributesType.
230 </para>
231
232 @GDK_WA_TITLE: Honor the title field
233 @GDK_WA_X: Honor the X coordinate field
234 @GDK_WA_Y: Honor the Y coordinate field
235 @GDK_WA_CURSOR: Honor the cursor field
236 @GDK_WA_COLORMAP: Honor the colormap field
237 @GDK_WA_VISUAL: Honor the visual field
238 @GDK_WA_WMCLASS: Honor the wmclass_class and wmclass_name fields
239 @GDK_WA_NOREDIR: Honor the override_redirect field
240
241 <!-- ##### STRUCT GdkScreen ##### -->
242 <para>
243
244 </para>
245
246
247 <!-- ##### FUNCTION gdk_window_new ##### -->
248 <para>
249
250 </para>
251
252 @parent: 
253 @attributes: 
254 @attributes_mask: 
255 @Returns: 
256
257
258 <!-- ##### FUNCTION gdk_window_destroy ##### -->
259 <para>
260
261 </para>
262
263 @window: 
264
265
266 <!-- ##### MACRO gdk_window_ref ##### -->
267 <para>
268 Deprecated equivalent of g_object_ref()
269 </para>
270
271 @Returns: 
272
273
274 <!-- ##### MACRO gdk_window_unref ##### -->
275 <para>
276 Deprecated equivalent of g_object_unref()
277 </para>
278
279
280
281 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
282 <para>
283
284 </para>
285
286 @window: 
287 @Returns: 
288
289
290 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
291 <para>
292
293 </para>
294
295 @win_x: 
296 @win_y: 
297 @Returns: 
298
299
300 <!-- ##### FUNCTION gdk_window_show ##### -->
301 <para>
302
303 </para>
304
305 @window: 
306
307
308 <!-- ##### FUNCTION gdk_window_show_unraised ##### -->
309 <para>
310
311 </para>
312
313 @window: 
314
315
316 <!-- ##### FUNCTION gdk_window_hide ##### -->
317 <para>
318
319 </para>
320
321 @window: 
322
323
324 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
325 <para>
326
327 </para>
328
329 @window: 
330 @Returns: 
331
332
333 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
334 <para>
335
336 </para>
337
338 @window: 
339 @Returns: 
340
341
342 <!-- ##### FUNCTION gdk_window_get_state ##### -->
343 <para>
344
345 </para>
346
347 @window: 
348 @Returns: 
349
350
351 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
352 <para>
353
354 </para>
355
356 @window: 
357
358
359 <!-- ##### FUNCTION gdk_window_iconify ##### -->
360 <para>
361
362 </para>
363
364 @window: 
365
366
367 <!-- ##### FUNCTION gdk_window_deiconify ##### -->
368 <para>
369
370 </para>
371
372 @window: 
373
374
375 <!-- ##### FUNCTION gdk_window_stick ##### -->
376 <para>
377
378 </para>
379
380 @window: 
381
382
383 <!-- ##### FUNCTION gdk_window_unstick ##### -->
384 <para>
385
386 </para>
387
388 @window: 
389
390
391 <!-- ##### FUNCTION gdk_window_maximize ##### -->
392 <para>
393
394 </para>
395
396 @window: 
397
398
399 <!-- ##### FUNCTION gdk_window_unmaximize ##### -->
400 <para>
401
402 </para>
403
404 @window: 
405
406
407 <!-- ##### FUNCTION gdk_window_move ##### -->
408 <para>
409
410 </para>
411
412 @window: 
413 @x: 
414 @y: 
415
416
417 <!-- ##### FUNCTION gdk_window_resize ##### -->
418 <para>
419
420 </para>
421
422 @window: 
423 @width: 
424 @height: 
425
426
427 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
428 <para>
429
430 </para>
431
432 @window: 
433 @x: 
434 @y: 
435 @width: 
436 @height: 
437
438
439 <!-- ##### FUNCTION gdk_window_scroll ##### -->
440 <para>
441
442 </para>
443
444 @window: 
445 @dx: 
446 @dy: 
447
448
449 <!-- ##### FUNCTION gdk_window_reparent ##### -->
450 <para>
451
452 </para>
453
454 @window: 
455 @new_parent: 
456 @x: 
457 @y: 
458
459
460 <!-- ##### FUNCTION gdk_window_clear ##### -->
461 <para>
462
463 </para>
464
465 @window: 
466
467
468 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
469 <para>
470
471 </para>
472
473 @window: 
474 @x: 
475 @y: 
476 @width: 
477 @height: 
478
479
480 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
481 <para>
482
483 </para>
484
485 @window: 
486 @x: 
487 @y: 
488 @width: 
489 @height: 
490
491
492 <!-- ##### MACRO gdk_window_copy_area ##### -->
493 <para>
494 Deprecated equivalent to gdk_draw_drawable(), see that function for docs
495 </para>
496
497 @drawable: 
498 @gc: 
499 @x: 
500 @y: 
501 @source_drawable: 
502 @source_x: 
503 @source_y: 
504 @width: 
505 @height: 
506
507
508 <!-- ##### FUNCTION gdk_window_raise ##### -->
509 <para>
510
511 </para>
512
513 @window: 
514
515
516 <!-- ##### FUNCTION gdk_window_lower ##### -->
517 <para>
518
519 </para>
520
521 @window: 
522
523
524 <!-- ##### FUNCTION gdk_window_focus ##### -->
525 <para>
526
527 </para>
528
529 @window: 
530 @timestamp: 
531
532
533 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
534 <para>
535 Registers a window as a potential drop destination.
536 </para>
537
538 @window: a #GdkWindow.
539
540
541 <!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
542 <para>
543
544 </para>
545
546 @window: 
547 @edge: 
548 @button: 
549 @root_x: 
550 @root_y: 
551 @timestamp: 
552
553
554 <!-- ##### FUNCTION gdk_window_begin_move_drag ##### -->
555 <para>
556
557 </para>
558
559 @window: 
560 @button: 
561 @root_x: 
562 @root_y: 
563 @timestamp: 
564
565
566 <!-- ##### FUNCTION gdk_window_constrain_size ##### -->
567 <para>
568
569 </para>
570
571 @geometry: 
572 @flags: 
573 @width: 
574 @height: 
575 @new_width: 
576 @new_height: 
577
578
579 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
580 <para>
581
582 </para>
583
584 @window: 
585 @rectangle: 
586
587
588 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
589 <para>
590
591 </para>
592
593 @window: 
594 @region: 
595
596
597 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
598 <para>
599
600 </para>
601
602 @window: 
603
604
605 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
606 <para>
607
608 </para>
609
610 @window: 
611 @rect: 
612 @invalidate_children: 
613
614
615 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
616 <para>
617
618 </para>
619
620 @window: 
621 @region: 
622 @invalidate_children: 
623
624
625 <!-- ##### FUNCTION gdk_window_invalidate_maybe_recurse ##### -->
626 <para>
627
628 </para>
629
630 @window: 
631 @region: 
632 @child_func: 
633 @user_data: 
634
635
636 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
637 <para>
638
639 </para>
640
641 @window: 
642 @Returns: 
643
644
645 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
646 <para>
647
648 </para>
649
650 @window: 
651
652
653 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
654 <para>
655
656 </para>
657
658 @window: 
659
660
661 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
662 <para>
663
664 </para>
665
666
667
668 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
669 <para>
670
671 </para>
672
673 @window: 
674 @update_children: 
675
676
677 <!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
678 <para>
679
680 </para>
681
682 @setting: 
683
684
685 <!-- ##### FUNCTION gdk_window_get_internal_paint_info ##### -->
686 <para>
687
688 </para>
689
690 @window: 
691 @real_drawable: 
692 @x_offset: 
693 @y_offset: 
694
695
696 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
697 <para>
698
699 </para>
700
701 @window: 
702 @user_data: 
703
704
705 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
706 <para>
707
708 </para>
709
710 @window: 
711 @override_redirect: 
712
713
714 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
715 <para>
716
717 </para>
718
719 @window: 
720 @function: 
721 @data: 
722
723
724 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
725 <para>
726
727 </para>
728
729 @window: 
730 @function: 
731 @data: 
732
733
734 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
735 <para>
736 Specifies the type of function used to filter native events before they are
737 converted to GDK events. A filter may translate the native event to a GDK
738 event or handle it without translation.
739 </para>
740
741 @xevent: the native event to filter.
742 @event: the GDK event to which the X event will be translated.
743 @data: user data set when the filter was installed.
744 @Returns: a #GdkFilterReturn value.
745
746
747 <!-- ##### ENUM GdkFilterReturn ##### -->
748 <para>
749 Specifies the result of applying a #GdkFilterFunc to a native event.
750 </para>
751
752 @GDK_FILTER_CONTINUE: event not handled, continue processing.
753 @GDK_FILTER_TRANSLATE: translated event stored.
754 @GDK_FILTER_REMOVE: event handled, terminate processing.
755
756 <!-- ##### TYPEDEF GdkXEvent ##### -->
757 <para>
758 Used to represent native events (<type>XEvent</type>s for the X11 
759 backend, <type>MSG</type>s for Win32).
760 </para>
761
762
763 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
764 <para>
765
766 </para>
767
768 @window: 
769 @mask: 
770 @x: 
771 @y: 
772
773
774 <!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
775 <para>
776
777 </para>
778
779 @window: 
780 @shape_region: 
781 @offset_x: 
782 @offset_y: 
783
784
785 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
786 <para>
787
788 </para>
789
790 @window: 
791
792
793 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
794 <para>
795
796 </para>
797
798 @window: 
799
800
801 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
802 <para>
803
804 </para>
805
806 @window: 
807 @use_static: 
808 @Returns: 
809
810
811 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
812 <para>
813
814 </para>
815
816 @window: 
817 @x: 
818 @y: 
819 @min_width: 
820 @min_height: 
821 @max_width: 
822 @max_height: 
823 @flags: 
824
825
826 <!-- ##### FUNCTION gdk_window_set_title ##### -->
827 <para>
828
829 </para>
830
831 @window: 
832 @title: 
833
834
835 <!-- ##### FUNCTION gdk_window_set_background ##### -->
836 <para>
837
838 </para>
839
840 @window: 
841 @color: 
842
843
844 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
845 <para>
846
847 </para>
848
849 @window: 
850 @pixmap: 
851 @parent_relative: 
852
853
854 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
855 <para>
856 A special value for <literal>GdkPixmap*</literal> variables, indicating
857 that the background pixmap for a window should be inherited from the parent
858 window.
859 </para>
860
861
862
863 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
864 <para>
865
866 </para>
867
868 @window: 
869 @cursor: 
870
871
872 <!-- ##### MACRO gdk_window_set_colormap ##### -->
873 <para>
874 Deprecated equivalent to gdk_drawable_set_colormap()
875 </para>
876
877
878
879 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
880 <para>
881
882 </para>
883
884 @window: 
885 @data: 
886
887
888 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
889 <para>
890
891 </para>
892
893 @window: 
894 @x: 
895 @y: 
896 @width: 
897 @height: 
898 @depth: 
899
900
901 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
902 <para>
903
904 </para>
905
906 @window: 
907 @geometry: 
908 @geom_mask: 
909
910
911 <!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
912 <para>
913
914 </para>
915
916 @window: 
917 @pixbufs: 
918
919
920 <!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
921 <para>
922
923 </para>
924
925 @window: 
926 @modal: 
927
928
929 <!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
930 <para>
931
932 </para>
933
934 @window: 
935 @hint: 
936
937
938 <!-- ##### FUNCTION gdk_window_get_position ##### -->
939 <para>
940
941 </para>
942
943 @window: 
944 @x: 
945 @y: 
946
947
948 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
949 <para>
950
951 </para>
952
953 @window: 
954 @x: 
955 @y: 
956
957
958 <!-- ##### FUNCTION gdk_window_get_frame_extents ##### -->
959 <para>
960
961 </para>
962
963 @window: 
964 @rect: 
965
966
967 <!-- ##### MACRO gdk_window_get_size ##### -->
968 <para>
969 Deprecated equivalent of gdk_drawable_get_size().
970 </para>
971
972
973
974 <!-- ##### MACRO gdk_window_get_visual ##### -->
975 <para>
976 Deprecated equivalent of gdk_drawable_get_visual().
977 </para>
978
979 @Returns: 
980
981
982 <!-- ##### MACRO gdk_window_get_colormap ##### -->
983 <para>
984 Deprecated equivalent of gdk_drawable_get_colormap().
985 </para>
986
987 @Returns: colormap for the window
988
989
990 <!-- ##### MACRO gdk_window_get_type ##### -->
991 <para>
992 Deprecated equivalent of gdk_drawable_get_type().
993 </para>
994
995 @Returns: type of drawable
996
997
998 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
999 <para>
1000
1001 </para>
1002
1003 @window: 
1004 @x: 
1005 @y: 
1006 @Returns: 
1007
1008
1009 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
1010 <para>
1011
1012 </para>
1013
1014 @window: 
1015 @x: 
1016 @y: 
1017 @Returns: 
1018
1019
1020 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
1021 <para>
1022
1023 </para>
1024
1025 @window: 
1026 @x: 
1027 @y: 
1028 @mask: 
1029 @Returns: 
1030
1031
1032 <!-- ##### ENUM GdkModifierType ##### -->
1033 <para>
1034 A set of bit-flags to indicate the state of modifier keys and mouse buttons 
1035 in various event types. Typical modifier keys are Shift, Control, Meta, Super,
1036 Hyper, Alt, Compose, Apple, CapsLock or ShiftLock. 
1037 </para>
1038 <para>
1039 Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
1040 </para>
1041
1042 @GDK_SHIFT_MASK: the Shift key.
1043 @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the 
1044   X server this may either be CapsLock or ShiftLock).
1045 @GDK_CONTROL_MASK: the Control key.
1046 @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier 
1047   mapping of the X server which key is interpreted as this modifier, but 
1048   normally it is the Alt key).
1049 @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier 
1050   mapping of the X server which key is interpreted as this modifier).
1051 @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier 
1052   mapping of the X server which key is interpreted as this modifier).
1053 @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier 
1054   mapping of the X server which key is interpreted as this modifier).
1055 @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier 
1056   mapping of the X server which key is interpreted as this modifier).
1057 @GDK_BUTTON1_MASK: the first mouse button.
1058 @GDK_BUTTON2_MASK: the second mouse button.
1059 @GDK_BUTTON3_MASK: the third mouse button.
1060 @GDK_BUTTON4_MASK: the fourth mouse button.
1061 @GDK_BUTTON5_MASK: the fifth mouse button.
1062 @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate 
1063   between (keyval, modifiers) pairs from key press and release events.
1064 @GDK_MODIFIER_MASK: 
1065
1066 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
1067 <para>
1068
1069 </para>
1070
1071 @window: 
1072 @Returns: 
1073
1074
1075 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
1076 <para>
1077
1078 </para>
1079
1080 @window: 
1081 @Returns: 
1082
1083
1084 <!-- ##### FUNCTION gdk_window_get_children ##### -->
1085 <para>
1086
1087 </para>
1088
1089 @window: 
1090 @Returns: 
1091
1092
1093 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
1094 <para>
1095
1096 </para>
1097
1098 @window: 
1099 @Returns: 
1100
1101
1102 <!-- ##### FUNCTION gdk_window_get_events ##### -->
1103 <para>
1104
1105 </para>
1106
1107 @window: 
1108 @Returns: 
1109
1110
1111 <!-- ##### FUNCTION gdk_window_set_events ##### -->
1112 <para>
1113
1114 </para>
1115
1116 @window: 
1117 @event_mask: 
1118
1119
1120 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
1121 <para>
1122
1123 </para>
1124
1125 @window: 
1126 @icon_window: 
1127 @pixmap: 
1128 @mask: 
1129
1130
1131 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
1132 <para>
1133
1134 </para>
1135
1136 @window: 
1137 @name: 
1138
1139
1140 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
1141 <para>
1142
1143 </para>
1144
1145 @window: 
1146 @parent: 
1147
1148
1149 <!-- ##### FUNCTION gdk_window_set_role ##### -->
1150 <para>
1151
1152 </para>
1153
1154 @window: 
1155 @role: 
1156
1157
1158 <!-- ##### FUNCTION gdk_window_set_group ##### -->
1159 <para>
1160
1161 </para>
1162
1163 @window: 
1164 @leader: 
1165
1166
1167 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
1168 <para>
1169
1170 </para>
1171
1172 @window: 
1173 @decorations: 
1174
1175
1176 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
1177 <para>
1178
1179 </para>
1180
1181 @window: The window to get the decorations from
1182 @decorations: The window decorations will be written here
1183 @Returns: %TRUE if the window has decorations set, %FALSE otherwise.
1184
1185
1186 <!-- ##### ENUM GdkWMDecoration ##### -->
1187 <para>
1188 These are hints originally defined by the Motif toolkit.
1189 The window manager can use them when determining how to decorate
1190 the window. The hint must be set before mapping the window.
1191 </para>
1192
1193 @GDK_DECOR_ALL: all decorations should be applied.
1194 @GDK_DECOR_BORDER: a frame should be drawn around the window.
1195 @GDK_DECOR_RESIZEH: the frame should have resize handles.
1196 @GDK_DECOR_TITLE: a titlebar should be placed above the window.
1197 @GDK_DECOR_MENU: a button for opening a menu should be included.
1198 @GDK_DECOR_MINIMIZE: a minimize button should be included.
1199 @GDK_DECOR_MAXIMIZE: a maximize button should be included.
1200
1201 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
1202 <para>
1203
1204 </para>
1205
1206 @window: 
1207 @functions: 
1208
1209
1210 <!-- ##### ENUM GdkWMFunction ##### -->
1211 <para>
1212 These are hints originally defined by the Motif toolkit.
1213 The window manager can use them when determining the functions 
1214 to offer for the window. 
1215 The hint must be set before mapping the window.
1216 </para>
1217
1218 @GDK_FUNC_ALL: all functions should be offered.
1219 @GDK_FUNC_RESIZE: the window should be resizable.
1220 @GDK_FUNC_MOVE: the window should be movable.
1221 @GDK_FUNC_MINIMIZE: the window should be minimizable.
1222 @GDK_FUNC_MAXIMIZE: the window should be maximizable.
1223 @GDK_FUNC_CLOSE: the window should be closable.
1224
1225 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
1226 <para>
1227
1228 </para>
1229
1230 @Returns: 
1231
1232
1233 <!-- ##### FUNCTION gdk_get_default_root_window ##### -->
1234 <para>
1235
1236 </para>
1237
1238 @Returns: 
1239
1240
1241 <!-- ##### STRUCT GdkPointerHooks ##### -->
1242 <para>
1243 A table of pointers to functions for getting quantities related to 
1244 the current pointer position. GDK has one global table of this type,
1245 which can be set using gdk_set_pointer_hooks().
1246 </para>
1247 <para>
1248 This is only useful for such low-level tools as an event recorder. 
1249 Applications should never have any reason to use this facility
1250 </para>
1251
1252 @get_pointer: Obtains the current pointer position and modifier state.
1253   The position is given in coordinates relative to the window containing 
1254   the pointer, which is returned in @window.
1255 @window_at_pointer: Obtains the window underneath the mouse pointer, 
1256   returning the location of that window in @win_x, @win_y. Returns %NULL 
1257   if the window under the mouse pointer is not known to GDK (for example, 
1258   belongs to another application).
1259
1260 <!-- ##### FUNCTION gdk_set_pointer_hooks ##### -->
1261 <para>
1262
1263 </para>
1264
1265 @new_hooks: 
1266 @Returns: 
1267
1268