]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/windows.sgml
Start of integration of Erwann Chenede's multihead work from the
[~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 This is a currently just a placeholder typedef for the first argument of 
244 the @window_at_pointer function in #GdkPointerHooks. It will be used
245 when GDK gets multihead support. 
246 </para>
247
248 @parent_instance: 
249
250 <!-- ##### FUNCTION gdk_window_new ##### -->
251 <para>
252
253 </para>
254
255 @parent: 
256 @attributes: 
257 @attributes_mask: 
258 @Returns: 
259
260
261 <!-- ##### FUNCTION gdk_window_destroy ##### -->
262 <para>
263
264 </para>
265
266 @window: 
267
268
269 <!-- ##### MACRO gdk_window_ref ##### -->
270 <para>
271 Deprecated equivalent of g_object_ref()
272 </para>
273
274 @Returns: 
275
276
277 <!-- ##### MACRO gdk_window_unref ##### -->
278 <para>
279 Deprecated equivalent of g_object_unref()
280 </para>
281
282
283
284 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
285 <para>
286
287 </para>
288
289 @window: 
290 @Returns: 
291
292
293 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
294 <para>
295
296 </para>
297
298 @win_x: 
299 @win_y: 
300 @Returns: 
301
302
303 <!-- ##### FUNCTION gdk_window_show ##### -->
304 <para>
305
306 </para>
307
308 @window: 
309
310
311 <!-- ##### FUNCTION gdk_window_show_unraised ##### -->
312 <para>
313
314 </para>
315
316 @window: 
317
318
319 <!-- ##### FUNCTION gdk_window_hide ##### -->
320 <para>
321
322 </para>
323
324 @window: 
325
326
327 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
328 <para>
329
330 </para>
331
332 @window: 
333 @Returns: 
334
335
336 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
337 <para>
338
339 </para>
340
341 @window: 
342 @Returns: 
343
344
345 <!-- ##### FUNCTION gdk_window_get_state ##### -->
346 <para>
347
348 </para>
349
350 @window: 
351 @Returns: 
352
353
354 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
355 <para>
356
357 </para>
358
359 @window: 
360
361
362 <!-- ##### FUNCTION gdk_window_iconify ##### -->
363 <para>
364
365 </para>
366
367 @window: 
368
369
370 <!-- ##### FUNCTION gdk_window_deiconify ##### -->
371 <para>
372
373 </para>
374
375 @window: 
376
377
378 <!-- ##### FUNCTION gdk_window_stick ##### -->
379 <para>
380
381 </para>
382
383 @window: 
384
385
386 <!-- ##### FUNCTION gdk_window_unstick ##### -->
387 <para>
388
389 </para>
390
391 @window: 
392
393
394 <!-- ##### FUNCTION gdk_window_maximize ##### -->
395 <para>
396
397 </para>
398
399 @window: 
400
401
402 <!-- ##### FUNCTION gdk_window_unmaximize ##### -->
403 <para>
404
405 </para>
406
407 @window: 
408
409
410 <!-- ##### FUNCTION gdk_window_move ##### -->
411 <para>
412
413 </para>
414
415 @window: 
416 @x: 
417 @y: 
418
419
420 <!-- ##### FUNCTION gdk_window_resize ##### -->
421 <para>
422
423 </para>
424
425 @window: 
426 @width: 
427 @height: 
428
429
430 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
431 <para>
432
433 </para>
434
435 @window: 
436 @x: 
437 @y: 
438 @width: 
439 @height: 
440
441
442 <!-- ##### FUNCTION gdk_window_scroll ##### -->
443 <para>
444
445 </para>
446
447 @window: 
448 @dx: 
449 @dy: 
450
451
452 <!-- ##### FUNCTION gdk_window_reparent ##### -->
453 <para>
454
455 </para>
456
457 @window: 
458 @new_parent: 
459 @x: 
460 @y: 
461
462
463 <!-- ##### FUNCTION gdk_window_clear ##### -->
464 <para>
465
466 </para>
467
468 @window: 
469
470
471 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
472 <para>
473
474 </para>
475
476 @window: 
477 @x: 
478 @y: 
479 @width: 
480 @height: 
481
482
483 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
484 <para>
485
486 </para>
487
488 @window: 
489 @x: 
490 @y: 
491 @width: 
492 @height: 
493
494
495 <!-- ##### MACRO gdk_window_copy_area ##### -->
496 <para>
497 Deprecated equivalent to gdk_draw_drawable(), see that function for docs
498 </para>
499
500 @drawable: 
501 @gc: 
502 @x: 
503 @y: 
504 @source_drawable: 
505 @source_x: 
506 @source_y: 
507 @width: 
508 @height: 
509
510
511 <!-- ##### FUNCTION gdk_window_raise ##### -->
512 <para>
513
514 </para>
515
516 @window: 
517
518
519 <!-- ##### FUNCTION gdk_window_lower ##### -->
520 <para>
521
522 </para>
523
524 @window: 
525
526
527 <!-- ##### FUNCTION gdk_window_focus ##### -->
528 <para>
529
530 </para>
531
532 @window: 
533 @timestamp: 
534
535
536 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
537 <para>
538 Registers a window as a potential drop destination.
539 </para>
540
541 @window: a #GdkWindow.
542
543
544 <!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
545 <para>
546
547 </para>
548
549 @window: 
550 @edge: 
551 @button: 
552 @root_x: 
553 @root_y: 
554 @timestamp: 
555
556
557 <!-- ##### FUNCTION gdk_window_begin_move_drag ##### -->
558 <para>
559
560 </para>
561
562 @window: 
563 @button: 
564 @root_x: 
565 @root_y: 
566 @timestamp: 
567
568
569 <!-- ##### FUNCTION gdk_window_constrain_size ##### -->
570 <para>
571
572 </para>
573
574 @geometry: 
575 @flags: 
576 @width: 
577 @height: 
578 @new_width: 
579 @new_height: 
580
581
582 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
583 <para>
584
585 </para>
586
587 @window: 
588 @rectangle: 
589
590
591 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
592 <para>
593
594 </para>
595
596 @window: 
597 @region: 
598
599
600 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
601 <para>
602
603 </para>
604
605 @window: 
606
607
608 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
609 <para>
610
611 </para>
612
613 @window: 
614 @rect: 
615 @invalidate_children: 
616
617
618 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
619 <para>
620
621 </para>
622
623 @window: 
624 @region: 
625 @invalidate_children: 
626
627
628 <!-- ##### FUNCTION gdk_window_invalidate_maybe_recurse ##### -->
629 <para>
630
631 </para>
632
633 @window: 
634 @region: 
635 @child_func: 
636 @user_data: 
637
638
639 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
640 <para>
641
642 </para>
643
644 @window: 
645 @Returns: 
646
647
648 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
649 <para>
650
651 </para>
652
653 @window: 
654
655
656 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
657 <para>
658
659 </para>
660
661 @window: 
662
663
664 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
665 <para>
666
667 </para>
668
669
670
671 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
672 <para>
673
674 </para>
675
676 @window: 
677 @update_children: 
678
679
680 <!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
681 <para>
682
683 </para>
684
685 @setting: 
686
687
688 <!-- ##### FUNCTION gdk_window_get_internal_paint_info ##### -->
689 <para>
690
691 </para>
692
693 @window: 
694 @real_drawable: 
695 @x_offset: 
696 @y_offset: 
697
698
699 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
700 <para>
701
702 </para>
703
704 @window: 
705 @user_data: 
706
707
708 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
709 <para>
710
711 </para>
712
713 @window: 
714 @override_redirect: 
715
716
717 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
718 <para>
719
720 </para>
721
722 @window: 
723 @function: 
724 @data: 
725
726
727 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
728 <para>
729
730 </para>
731
732 @window: 
733 @function: 
734 @data: 
735
736
737 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
738 <para>
739 Specifies the type of function used to filter native events before they are
740 converted to GDK events. A filter may translate the native event to a GDK
741 event or handle it without translation.
742 </para>
743
744 @xevent: the native event to filter.
745 @event: the GDK event to which the X event will be translated.
746 @data: user data set when the filter was installed.
747 @Returns: a #GdkFilterReturn value.
748
749
750 <!-- ##### ENUM GdkFilterReturn ##### -->
751 <para>
752 Specifies the result of applying a #GdkFilterFunc to a native event.
753 </para>
754
755 @GDK_FILTER_CONTINUE: event not handled, continue processing.
756 @GDK_FILTER_TRANSLATE: translated event stored.
757 @GDK_FILTER_REMOVE: event handled, terminate processing.
758
759 <!-- ##### TYPEDEF GdkXEvent ##### -->
760 <para>
761 Used to represent native events (<type>XEvent</type>s for the X11 
762 backend, <type>MSG</type>s for Win32).
763 </para>
764
765
766 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
767 <para>
768
769 </para>
770
771 @window: 
772 @mask: 
773 @x: 
774 @y: 
775
776
777 <!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
778 <para>
779
780 </para>
781
782 @window: 
783 @shape_region: 
784 @offset_x: 
785 @offset_y: 
786
787
788 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
789 <para>
790
791 </para>
792
793 @window: 
794
795
796 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
797 <para>
798
799 </para>
800
801 @window: 
802
803
804 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
805 <para>
806
807 </para>
808
809 @window: 
810 @use_static: 
811 @Returns: 
812
813
814 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
815 <para>
816
817 </para>
818
819 @window: 
820 @x: 
821 @y: 
822 @min_width: 
823 @min_height: 
824 @max_width: 
825 @max_height: 
826 @flags: 
827
828
829 <!-- ##### FUNCTION gdk_window_set_title ##### -->
830 <para>
831
832 </para>
833
834 @window: 
835 @title: 
836
837
838 <!-- ##### FUNCTION gdk_window_set_background ##### -->
839 <para>
840
841 </para>
842
843 @window: 
844 @color: 
845
846
847 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
848 <para>
849
850 </para>
851
852 @window: 
853 @pixmap: 
854 @parent_relative: 
855
856
857 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
858 <para>
859 A special value for <literal>GdkPixmap*</literal> variables, indicating
860 that the background pixmap for a window should be inherited from the parent
861 window.
862 </para>
863
864
865
866 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
867 <para>
868
869 </para>
870
871 @window: 
872 @cursor: 
873
874
875 <!-- ##### MACRO gdk_window_set_colormap ##### -->
876 <para>
877 Deprecated equivalent to gdk_drawable_set_colormap()
878 </para>
879
880
881
882 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
883 <para>
884
885 </para>
886
887 @window: 
888 @data: 
889
890
891 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
892 <para>
893
894 </para>
895
896 @window: 
897 @x: 
898 @y: 
899 @width: 
900 @height: 
901 @depth: 
902
903
904 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
905 <para>
906
907 </para>
908
909 @window: 
910 @geometry: 
911 @geom_mask: 
912
913
914 <!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
915 <para>
916
917 </para>
918
919 @window: 
920 @pixbufs: 
921
922
923 <!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
924 <para>
925
926 </para>
927
928 @window: 
929 @modal: 
930
931
932 <!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
933 <para>
934
935 </para>
936
937 @window: 
938 @hint: 
939
940
941 <!-- ##### FUNCTION gdk_window_get_position ##### -->
942 <para>
943
944 </para>
945
946 @window: 
947 @x: 
948 @y: 
949
950
951 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
952 <para>
953
954 </para>
955
956 @window: 
957 @x: 
958 @y: 
959
960
961 <!-- ##### FUNCTION gdk_window_get_frame_extents ##### -->
962 <para>
963
964 </para>
965
966 @window: 
967 @rect: 
968
969
970 <!-- ##### MACRO gdk_window_get_size ##### -->
971 <para>
972 Deprecated equivalent of gdk_drawable_get_size().
973 </para>
974
975
976
977 <!-- ##### MACRO gdk_window_get_visual ##### -->
978 <para>
979 Deprecated equivalent of gdk_drawable_get_visual().
980 </para>
981
982 @Returns: 
983
984
985 <!-- ##### MACRO gdk_window_get_colormap ##### -->
986 <para>
987 Deprecated equivalent of gdk_drawable_get_colormap().
988 </para>
989
990 @Returns: colormap for the window
991
992
993 <!-- ##### MACRO gdk_window_get_type ##### -->
994 <para>
995 Deprecated equivalent of gdk_drawable_get_type().
996 </para>
997
998 @Returns: type of drawable
999
1000
1001 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
1002 <para>
1003
1004 </para>
1005
1006 @window: 
1007 @x: 
1008 @y: 
1009 @Returns: 
1010
1011
1012 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
1013 <para>
1014
1015 </para>
1016
1017 @window: 
1018 @x: 
1019 @y: 
1020 @Returns: 
1021
1022
1023 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
1024 <para>
1025
1026 </para>
1027
1028 @window: 
1029 @x: 
1030 @y: 
1031 @mask: 
1032 @Returns: 
1033
1034
1035 <!-- ##### ENUM GdkModifierType ##### -->
1036 <para>
1037 A set of bit-flags to indicate the state of modifier keys and mouse buttons 
1038 in various event types. Typical modifier keys are Shift, Control, Meta, Super,
1039 Hyper, Alt, Compose, Apple, CapsLock or ShiftLock. 
1040 </para>
1041 <para>
1042 Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
1043 </para>
1044
1045 @GDK_SHIFT_MASK: the Shift key.
1046 @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the 
1047   X server this may either be CapsLock or ShiftLock).
1048 @GDK_CONTROL_MASK: the Control key.
1049 @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier 
1050   mapping of the X server which key is interpreted as this modifier, but 
1051   normally it is the Alt key).
1052 @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier 
1053   mapping of the X server which key is interpreted as this modifier).
1054 @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier 
1055   mapping of the X server which key is interpreted as this modifier).
1056 @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier 
1057   mapping of the X server which key is interpreted as this modifier).
1058 @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier 
1059   mapping of the X server which key is interpreted as this modifier).
1060 @GDK_BUTTON1_MASK: the first mouse button.
1061 @GDK_BUTTON2_MASK: the second mouse button.
1062 @GDK_BUTTON3_MASK: the third mouse button.
1063 @GDK_BUTTON4_MASK: the fourth mouse button.
1064 @GDK_BUTTON5_MASK: the fifth mouse button.
1065 @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate 
1066   between (keyval, modifiers) pairs from key press and release events.
1067 @GDK_MODIFIER_MASK: 
1068
1069 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
1070 <para>
1071
1072 </para>
1073
1074 @window: 
1075 @Returns: 
1076
1077
1078 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
1079 <para>
1080
1081 </para>
1082
1083 @window: 
1084 @Returns: 
1085
1086
1087 <!-- ##### FUNCTION gdk_window_get_children ##### -->
1088 <para>
1089
1090 </para>
1091
1092 @window: 
1093 @Returns: 
1094
1095
1096 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
1097 <para>
1098
1099 </para>
1100
1101 @window: 
1102 @Returns: 
1103
1104
1105 <!-- ##### FUNCTION gdk_window_get_events ##### -->
1106 <para>
1107
1108 </para>
1109
1110 @window: 
1111 @Returns: 
1112
1113
1114 <!-- ##### FUNCTION gdk_window_set_events ##### -->
1115 <para>
1116
1117 </para>
1118
1119 @window: 
1120 @event_mask: 
1121
1122
1123 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
1124 <para>
1125
1126 </para>
1127
1128 @window: 
1129 @icon_window: 
1130 @pixmap: 
1131 @mask: 
1132
1133
1134 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
1135 <para>
1136
1137 </para>
1138
1139 @window: 
1140 @name: 
1141
1142
1143 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
1144 <para>
1145
1146 </para>
1147
1148 @window: 
1149 @parent: 
1150
1151
1152 <!-- ##### FUNCTION gdk_window_set_role ##### -->
1153 <para>
1154
1155 </para>
1156
1157 @window: 
1158 @role: 
1159
1160
1161 <!-- ##### FUNCTION gdk_window_set_group ##### -->
1162 <para>
1163
1164 </para>
1165
1166 @window: 
1167 @leader: 
1168
1169
1170 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
1171 <para>
1172
1173 </para>
1174
1175 @window: 
1176 @decorations: 
1177
1178
1179 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
1180 <para>
1181
1182 </para>
1183
1184 @window: The window to get the decorations from
1185 @decorations: The window decorations will be written here
1186 @Returns: %TRUE if the window has decorations set, %FALSE otherwise.
1187
1188
1189 <!-- ##### ENUM GdkWMDecoration ##### -->
1190 <para>
1191 These are hints originally defined by the Motif toolkit.
1192 The window manager can use them when determining how to decorate
1193 the window. The hint must be set before mapping the window.
1194 </para>
1195
1196 @GDK_DECOR_ALL: all decorations should be applied.
1197 @GDK_DECOR_BORDER: a frame should be drawn around the window.
1198 @GDK_DECOR_RESIZEH: the frame should have resize handles.
1199 @GDK_DECOR_TITLE: a titlebar should be placed above the window.
1200 @GDK_DECOR_MENU: a button for opening a menu should be included.
1201 @GDK_DECOR_MINIMIZE: a minimize button should be included.
1202 @GDK_DECOR_MAXIMIZE: a maximize button should be included.
1203
1204 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
1205 <para>
1206
1207 </para>
1208
1209 @window: 
1210 @functions: 
1211
1212
1213 <!-- ##### ENUM GdkWMFunction ##### -->
1214 <para>
1215 These are hints originally defined by the Motif toolkit.
1216 The window manager can use them when determining the functions 
1217 to offer for the window. 
1218 The hint must be set before mapping the window.
1219 </para>
1220
1221 @GDK_FUNC_ALL: all functions should be offered.
1222 @GDK_FUNC_RESIZE: the window should be resizable.
1223 @GDK_FUNC_MOVE: the window should be movable.
1224 @GDK_FUNC_MINIMIZE: the window should be minimizable.
1225 @GDK_FUNC_MAXIMIZE: the window should be maximizable.
1226 @GDK_FUNC_CLOSE: the window should be closable.
1227
1228 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
1229 <para>
1230
1231 </para>
1232
1233 @Returns: 
1234
1235
1236 <!-- ##### FUNCTION gdk_get_default_root_window ##### -->
1237 <para>
1238
1239 </para>
1240
1241 @Returns: 
1242
1243
1244 <!-- ##### STRUCT GdkPointerHooks ##### -->
1245 <para>
1246 A table of pointers to functions for getting quantities related to 
1247 the current pointer position. GDK has one global table of this type,
1248 which can be set using gdk_set_pointer_hooks().
1249 </para>
1250 <para>
1251 This is only useful for such low-level tools as an event recorder. 
1252 Applications should never have any reason to use this facility
1253 </para>
1254
1255 @get_pointer: Obtains the current pointer position and modifier state.
1256   The position is given in coordinates relative to the window containing 
1257   the pointer, which is returned in @window.
1258 @window_at_pointer: Obtains the window underneath the mouse pointer, 
1259   returning the location of that window in @win_x, @win_y. Returns %NULL 
1260   if the window under the mouse pointer is not known to GDK (for example, 
1261   belongs to another application).
1262
1263 <!-- ##### FUNCTION gdk_set_pointer_hooks ##### -->
1264 <para>
1265
1266 </para>
1267
1268 @new_hooks: 
1269 @Returns: 
1270
1271