File: class-gdkwindow.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (775 lines) | stat: -rw-r--r-- 192,623 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.gdk.Window</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="previous" href="class-gdkvisual.html" title="gtk.gdk.Visual"><link rel="next" href="gdk-functions.html" title="gtk.gdk Functions"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Window</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkvisual.html">Prev</a></td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="gdk-functions.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkwindow"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.gdk.Window</h2><p>gtk.gdk.Window &#8212; on-screen display areas in the target window
system</p></div><div class="refsect1" lang="en"><a name="id3330650"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Window</span></span>(<span class="ooclass"><span class="classname"><a href="class-gdkdrawable.html" title="gtk.gdk.Drawable">gtk.gdk.Drawable</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a href="class-gdkwindow.html#constructor-gdkwindow" title="Constructor">gtk.gdk.Window</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>window_type</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>event_mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wclass</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>visual</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>colormap</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>cursor</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wmclass_name</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wmclass_class</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>override_redirect</tt></b></span><span class="initializer">=-1</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--drag-begin" title="gtk.gdk.Window.drag_begin">drag_begin</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>targets</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--input-set-extension-events" title="gtk.gdk.Window.input_set_extension_events">input_set_extension_events</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mode</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--property-get" title="gtk.gdk.Window.property_get">property_get</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>pdelete</tt></b></span><span class="initializer">=FALSE</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--property-change" title="gtk.gdk.Window.property_change">property_change</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>format</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mode</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--property-delete" title="gtk.gdk.Window.property_delete">property_delete</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--selection-convert" title="gtk.gdk.Window.selection_convert">selection_convert</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>selection</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>target</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>time</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-keep-above" title="gtk.gdk.Window.set_keep_above">set_keep_above</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-keep-below" title="gtk.gdk.Window.set_keep_below">set_keep_below</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--destroy" title="gtk.gdk.Window.destroy">destroy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-window-type" title="gtk.gdk.Window.get_window_type">get_window_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--show" title="gtk.gdk.Window.show">show</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--hide" title="gtk.gdk.Window.hide">hide</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--withdraw" title="gtk.gdk.Window.withdraw">withdraw</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--move" title="gtk.gdk.Window.move">move</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--resize" title="gtk.gdk.Window.resize">resize</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--move-resize" title="gtk.gdk.Window.move_resize">move_resize</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--reparent" title="gtk.gdk.Window.reparent">reparent</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>new_parent</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--clear" title="gtk.gdk.Window.clear">clear</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--clear-area" title="gtk.gdk.Window.clear_area">clear_area</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--clear-area-e" title="gtk.gdk.Window.clear_area_e">clear_area_e</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--raise_" title="gtk.gdk.Window.raise_">raise_</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--lower" title="gtk.gdk.Window.lower">lower</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--focus" title="gtk.gdk.Window.focus">focus</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span><span class="initializer">=0L</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-user-data" title="gtk.gdk.Window.set_user_data">set_user_data</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>user_data</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-user-data" title="gtk.gdk.Window.get_user_data">get_user_data</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-override-redirect" title="gtk.gdk.Window.set_override_redirect">set_override_redirect</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>override_redirect</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--add-filter" title="gtk.gdk.Window.add_filter">add_filter</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>function</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--scroll" title="gtk.gdk.Window.scroll">scroll</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>dx</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>dy</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--shape-combine-mask" title="gtk.gdk.Window.shape_combine_mask">shape_combine_mask</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>shape_mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>offset_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>offset_y</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-child-shapes" title="gtk.gdk.Window.set_child_shapes">set_child_shapes</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--merge-child-shapes" title="gtk.gdk.Window.merge_child_shapes">merge_child_shapes</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--is-visible" title="gtk.gdk.Window.is_visible">is_visible</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--is-viewable" title="gtk.gdk.Window.is_viewable">is_viewable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-state" title="gtk.gdk.Window.get_state">get_state</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-static-gravities" title="gtk.gdk.Window.set_static_gravities">set_static_gravities</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_static</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-type-hint" title="gtk.gdk.Window.set_type_hint">set_type_hint</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>hint</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-modal-hint" title="gtk.gdk.Window.set_modal_hint">set_modal_hint</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>modal</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-skip-taskbar-hint" title="gtk.gdk.Window.set_skip_taskbar_hint">set_skip_taskbar_hint</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>skips_taskbar</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-skip-pager-hint" title="gtk.gdk.Window.set_skip_pager_hint">set_skip_pager_hint</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>skips_pager</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-geometry-hints" title="gtk.gdk.Window.set_geometry_hints">set_geometry_hints</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>base_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>base_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width_inc</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height_inc</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_aspect</tt></b></span><span class="initializer">=-1.0</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_aspect</tt></b></span><span class="initializer">=-1.0</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--begin-paint-rect" title="gtk.gdk.Window.begin_paint_rect">begin_paint_rect</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>rectangle</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--end-paint" title="gtk.gdk.Window.end_paint">end_paint</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-title" title="gtk.gdk.Window.set_title">set_title</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-role" title="gtk.gdk.Window.set_role">set_role</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>role</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-transient-for" title="gtk.gdk.Window.set_transient_for">set_transient_for</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>leader</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-background" title="gtk.gdk.Window.set_background">set_background</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>color</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-back-pixmap" title="gtk.gdk.Window.set_back_pixmap">set_back_pixmap</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixmap</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent_relative</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-cursor" title="gtk.gdk.Window.set_cursor">set_cursor</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>cursor</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-geometry" title="gtk.gdk.Window.get_geometry">get_geometry</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-position" title="gtk.gdk.Window.get_position">get_position</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-origin" title="gtk.gdk.Window.get_origin">get_origin</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-root-origin" title="gtk.gdk.Window.get_root_origin">get_root_origin</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-frame-extents" title="gtk.gdk.Window.get_frame_extents">get_frame_extents</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-pointer" title="gtk.gdk.Window.get_pointer">get_pointer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-parent" title="gtk.gdk.Window.get_parent">get_parent</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-toplevel" title="gtk.gdk.Window.get_toplevel">get_toplevel</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-children" title="gtk.gdk.Window.get_children">get_children</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-events" title="gtk.gdk.Window.get_events">get_events</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-events" title="gtk.gdk.Window.set_events">set_events</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>event_mask</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-icon-list" title="gtk.gdk.Window.set_icon_list">set_icon_list</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixbufs</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-icon" title="gtk.gdk.Window.set_icon">set_icon</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_window</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixmap</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mask</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-icon-name" title="gtk.gdk.Window.set_icon_name">set_icon_name</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-group" title="gtk.gdk.Window.set_group">set_group</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>leader</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-group" title="gtk.gdk.Window.get_group">get_group</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-decorations" title="gtk.gdk.Window.set_decorations">set_decorations</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>decorations</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--get-decorations" title="gtk.gdk.Window.get_decorations">get_decorations</a></span>()</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-functions" title="gtk.gdk.Window.set_functions">set_functions</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>functions</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--iconify" title="gtk.gdk.Window.iconify">iconify</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--deiconify" title="gtk.gdk.Window.deiconify">deiconify</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--stick" title="gtk.gdk.Window.stick">stick</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--unstick" title="gtk.gdk.Window.unstick">unstick</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--maximize" title="gtk.gdk.Window.maximize">maximize</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--unmaximize" title="gtk.gdk.Window.unmaximize">unmaximize</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--fullscreen" title="gtk.gdk.Window.fullscreen">fullscreen</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--unfullscreen" title="gtk.gdk.Window.unfullscreen">unfullscreen</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--register-dnd" title="gtk.gdk.Window.register_dnd">register_dnd</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--begin-resize-drag" title="gtk.gdk.Window.begin_resize_drag">begin_resize_drag</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>edge</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>button</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--begin-move-drag" title="gtk.gdk.Window.begin_move_drag">begin_move_drag</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>button</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--invalidate-rect" title="gtk.gdk.Window.invalidate_rect">invalidate_rect</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>rect</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>invalidate_children</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--freeze-updates" title="gtk.gdk.Window.freeze_updates">freeze_updates</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--thaw-updates" title="gtk.gdk.Window.thaw_updates">thaw_updates</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--process-updates" title="gtk.gdk.Window.process_updates">process_updates</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>update_children</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-accept-focus" title="gtk.gdk.Window.set_accept_focus">set_accept_focus</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accept_focus</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--enable-synchronized-configure" title="gtk.gdk.Window.enable_synchronized_configure">enable_synchronized_configure</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--configure-finished" title="gtk.gdk.Window.configure_finished">configure_finished</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#method-gdkwindow--set-focus-on-map" title="gtk.gdk.Window.set_focus_on_map">set_focus_on_map</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>focus_on_map</tt></b></span></span>)</code><br></pre></td></tr></table><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>

<code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-foreign-new" title="gtk.gdk.window_foreign_new">gtk.gdk.window_foreign_new</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-foreign-new-for-display" title="gtk.gdk.window_foreign_new_for_display">gtk.gdk.window_foreign_new_for_display</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--get-default-root-window" title="gtk.gdk.get_default_root_window">gtk.gdk.get_default_root_window</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-get-toplevels" title="gtk.gdk.window_get_toplevels">gtk.gdk.window_get_toplevels</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-lookup" title="gtk.gdk.window_lookup">gtk.gdk.window_lookup</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-lookup-for-display" title="gtk.gdk.window_lookup_for_display">gtk.gdk.window_lookup_for_display</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-process-all-updates" title="gtk.gdk.window_process_all_updates">gtk.gdk.window_process_all_updates</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--gdk-window-set-debug-updates" title="gtk.gdk.gdk_window_set_debug_updates">gtk.gdk.gdk_window_set_debug_updates</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkwindow.html#function-gdk--window-at-pointer" title="gtk.gdk.window_at_pointer">gtk.gdk.window_at_pointer</a></span>()</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3148871"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-gdkdrawable.html" title="gtk.gdk.Drawable">gtk.gdk.Drawable</a>
    +-- <a href="class-gdkwindow.html" title="gtk.gdk.Window">gtk.gdk.Window</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3148899"></a><h2>Description</h2><p> <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> is a
rectangular region on the screen. It's a low-level object, used to implement
high-level objects such as <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a> and <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>. A <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> is a
toplevel window, the object a user might think of as a "window" with a
titlebar and so on. A <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> may
contain several <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
objects since most widgets use a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>.</p><p>A <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
object interacts with the native window system for input and events. Some
<a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a>
objects do not have an associated <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> and
therefore cannot receive events. To receive events on behalf of these
"windowless" widgets a <a href="class-gtkeventbox.html" title="gtk.EventBox"><tt class="classname">gtk.EventBox</tt></a> must
be used.</p></div><div class="refsect1" lang="en"><a name="constructor-gdkwindow"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Window</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>window_type</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>event_mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wclass</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>visual</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>colormap</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>cursor</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wmclass_name</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>wmclass_class</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>override_redirect</tt></b></span><span class="initializer">=-1</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>parent</tt></b>:</span></td><td>a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr><tr><td><span class="term"><b class="parameter"><tt>width</tt></b>:</span></td><td>the width of the window in
pixels</td></tr><tr><td><span class="term"><b class="parameter"><tt>height</tt></b>:</span></td><td>the height of the window in
pixels</td></tr><tr><td><span class="term"><b class="parameter"><tt>window_type</tt></b>:</span></td><td>the window type</td></tr><tr><td><span class="term"><b class="parameter"><tt>event_mask</tt></b>:</span></td><td>the bitmask of events received by the
window</td></tr><tr><td><span class="term"><b class="parameter"><tt>wclass</tt></b>:</span></td><td>the class of window - either
<tt class="literal">gtk.gdk.INPUT_OUTPUT</tt> or
<tt class="literal">gtk.gdk.INPUT_ONLY</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>title</tt></b>:</span></td><td>the window title if a toplevel
window</td></tr><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the x coordinate of the window position relative
to <i class="parameter"><tt>parent</tt></i></td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the y coordinate of the window position relative
to <i class="parameter"><tt>parent</tt></i></td></tr><tr><td><span class="term"><b class="parameter"><tt>visual</tt></b>:</span></td><td>the <a href="class-gdkvisual.html" title="gtk.gdk.Visual"><tt class="classname">gtk.gdk.Visual</tt></a> for
the window</td></tr><tr><td><span class="term"><b class="parameter"><tt>colormap</tt></b>:</span></td><td>the <a href="class-gdkcolormap.html" title="gtk.gdk.Colormap"><tt class="classname">gtk.gdk.Colormap</tt></a>
for the window</td></tr><tr><td><span class="term"><b class="parameter"><tt>cursor</tt></b>:</span></td><td>the <a href="class-gdkcursor.html" title="gtk.gdk.Cursor"><tt class="classname">gtk.gdk.Cursor</tt></a> for
the window</td></tr><tr><td><span class="term"><b class="parameter"><tt>wmclass_name</tt></b>:</span></td><td>don't use this - see the <a href="class-gtkwindow.html#method-gtkwindow--set-wmclass" title="gtk.Window.set_wmclass"><tt class="methodname">gtk.Window.set_wmclass</tt>()</a> 
method for more information.</td></tr><tr><td><span class="term"><b class="parameter"><tt>wmclass_class</tt></b>:</span></td><td>don't use this - see the <a href="class-gtkwindow.html#method-gtkwindow--set-wmclass" title="gtk.Window.set_wmclass"><tt class="methodname">gtk.Window.set_wmclass</tt>()</a> 
method for more information.</td></tr><tr><td><span class="term"><b class="parameter"><tt>override_redirect</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> bypass the window
manager</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the new <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr></tbody></table><p>Creates a new <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> of
the type and class specified by <i class="parameter"><tt>window_type</tt></i> and
<i class="parameter"><tt>wclass</tt></i>. The window will be a child of the specified
<i class="parameter"><tt>parent</tt></i> and will have the specified
<i class="parameter"><tt>width</tt></i> and <i class="parameter"><tt>height</tt></i>.
<i class="parameter"><tt>event_mask</tt></i> is a bitfield specifying the events that
the window will receive - see the <a href="class-gdkwindow.html#method-gdkwindow--set-events" title="gtk.gdk.Window.set_events"><tt class="methodname">set_events</tt>()</a> 
method for more information. The value of <i class="parameter"><tt>window_type</tt></i>
must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_ROOT</tt></span></td><td>The root window; this window has no parent, covers the
entire screen, and is created by the window system.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TOPLEVEL</tt></span></td><td>A toplevel window (used to implement <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_CHILD</tt></span></td><td>A child window (used to implement widgets e.g. <a href="class-gtkentry.html" title="gtk.Entry"><tt class="classname">gtk.Entry</tt></a>).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_DIALOG</tt></span></td><td>A useless/deprecated compatibility type.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TEMP</tt></span></td><td>An override redirect temporary window (used to implement
<a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a>).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_FOREIGN</tt></span></td><td>A foreign window (see the <a href="class-gdkwindow.html#function-gdk--window-foreign-new" title="gtk.gdk.window_foreign_new"><tt class="function">gtk.gdk.window_foreign_new</tt>()</a> 
function).</td></tr></tbody></table><p>The value of <i class="parameter"><tt>wclass</tt></i> must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.INPUT_OUTPUT</tt></span></td><td>A window for graphics and events.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.INPUT_ONLY</tt></span></td><td>A window for events only.</td></tr></tbody></table><p>If the optional parameters are not specified the corresponding
attribute values will have default values:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>x</tt></i></span></td><td>0</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i></span></td><td>0</td></tr><tr><td><span class="term"><i class="parameter"><tt>visual</tt></i></span></td><td>the default system visual - see the <a href="class-gdkvisual.html#function-gdk--visual-get-system" title="gtk.gdk.visual_get_system"><tt class="function">gtk.gdk.visual_get_system</tt>()</a> 
function</td></tr><tr><td><span class="term"><i class="parameter"><tt>colormap</tt></i></span></td><td>either the system <a href="class-gdkcolormap.html" title="gtk.gdk.Colormap"><tt class="classname">gtk.gdk.Colormap</tt></a>
if using the system <a href="class-gdkvisual.html" title="gtk.gdk.Visual"><tt class="classname">gtk.gdk.Visual</tt></a> (see
the <a href="class-gdkcolormap.html#function-gdk--colormap-get-system" title="gtk.gdk.colormap_get_system"><tt class="function">gtk.gdk.colormap_get_system</tt>()</a> 
function) or a new <a href="class-gdkcolormap.html" title="gtk.gdk.Colormap"><tt class="classname">gtk.gdk.Colormap</tt></a>
using <i class="parameter"><tt>visual</tt></i></td></tr><tr><td><span class="term"><i class="parameter"><tt>cursor</tt></i></span></td><td>use the parent window's cursor</td></tr><tr><td><span class="term"><i class="parameter"><tt>override_redirect</tt></i></span></td><td>gtk.FALSE</td></tr></tbody></table><p></p></div><div class="refsect1" lang="en"><a name="id3289036"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkwindow--drag-begin"></a><h3>gtk.gdk.Window.drag_begin</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">drag_begin</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>targets</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>targets</tt></b>:</span></td><td>a list of offered targets</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"><tt class="classname">gtk.gdk.DragContext</tt></a></td></tr></tbody></table><p>The <tt class="methodname">drag_begin</tt>() method starts a drag
operation and returns the new <a href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"><tt class="classname">gtk.gdk.DragContext</tt></a> 
created for it. The list of targets (integer values) supported by the drag
source are specified by <i class="parameter"><tt>targets</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--input-set-extension-events"></a><h3>gtk.gdk.Window.input_set_extension_events</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">input_set_extension_events</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mode</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>mask</tt></b>:</span></td><td>the event mask to be used</td></tr><tr><td><span class="term"><b class="parameter"><tt>mode</tt></b>:</span></td><td>the set of extension events to
receive</td></tr></tbody></table><p>The <tt class="methodname">input_set_extension_events</tt>() method
enables or disables the extension events specified by
<i class="parameter"><tt>mode</tt></i> for the window when using the event mask
specified by <i class="parameter"><tt>mask</tt></i>. The value of
<i class="parameter"><tt>mode</tt></i> must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.EXTENSION_EVENTS_NONE</tt></span></td><td>no extension events are desired.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.EXTENSION_EVENTS_ALL</tt></span></td><td>all extension events are desired.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.EXTENSION_EVENTS_CURSOR</tt></span></td><td>extension events are desired only if a cursor will be
displayed for the device.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--property-get"></a><h3>gtk.gdk.Window.property_get</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">property_get</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>pdelete</tt></b></span><span class="initializer">=FALSE</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>property</tt></b>:</span></td><td>the property to get</td></tr><tr><td><span class="term"><b class="parameter"><tt>type</tt></b>:</span></td><td>the type of property to get or not specified if
any type of property data is acceptable.</td></tr><tr><td><span class="term"><b class="parameter"><tt>pdelete</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt>, delete the property
after retrieving the data.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a tuple containing the actual property type,
the data format and the data</td></tr></tbody></table><p>The <tt class="methodname">property_get</tt>() method returns a
tuple containing the actual property type (as a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>), the
format and the data of the specified <i class="parameter"><tt>property</tt></i> with
the specified <i class="parameter"><tt>type</tt></i>. The value of
<i class="parameter"><tt>type</tt></i> may not be be specified in which case it will be
0 to match any type of property. the returned data will be a string if the
data format is 8; a list of integers if the data format is 16; or, a list of
<a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>
objects or integers if the data format is 32. If
<i class="parameter"><tt>property</tt></i> cannot be found <tt class="literal">None</tt> is
returned. <i class="parameter"><tt>property</tt></i> and <i class="parameter"><tt>type</tt></i>
(if specified) must be a string or a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--property-change"></a><h3>gtk.gdk.Window.property_change</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">property_change</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>format</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mode</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>property</tt></b>:</span></td><td>the property to change</td></tr><tr><td><span class="term"><b class="parameter"><tt>type</tt></b>:</span></td><td>the new type of the property. If
<i class="parameter"><tt>mode</tt></i> is <tt class="literal">gtk.gdk.PROP_MODE_PREPEND</tt>
or <tt class="literal">gtk.gdk.PROP_MODE_APPEND</tt>, then this must match the
existing type or an error will occur.</td></tr><tr><td><span class="term"><b class="parameter"><tt>format</tt></b>:</span></td><td>the new format for the property. If
<i class="parameter"><tt>mode</tt></i> is <tt class="literal">gtk.gdk.PROP_MODE_PREPEND</tt>
or <tt class="literal">gtk.gdk.PROP_MODE_APPEND</tt>, then this must match the
existing format or an error will occur.</td></tr><tr><td><span class="term"><b class="parameter"><tt>mode</tt></b>:</span></td><td>a value describing how the new data is to be
combined with the current data.</td></tr><tr><td><span class="term"><b class="parameter"><tt>data</tt></b>:</span></td><td>the data for the property</td></tr></tbody></table><p>The <tt class="methodname">property_change</tt>() method changes
the contents of the specified <i class="parameter"><tt>property</tt></i> to the
specified <i class="parameter"><tt>data</tt></i> with the specified
<i class="parameter"><tt>type</tt></i> and <i class="parameter"><tt>format</tt></i>. The value of
<i class="parameter"><tt>mode</tt></i> must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.PROP_MODE_REPLACE</tt></span></td><td>The new data replaces the existing data.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.PROP_MODE_PREPEND</tt></span></td><td>The new data is prepended to the existing data.
</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.PROP_MODE_APPEND</tt></span></td><td>The new data is appended to the existing
data.</td></tr></tbody></table><p>which describes how the new data is to be combined with the
existing property data.The value of <i class="parameter"><tt>format</tt></i> must be 8,
16 or 32. <i class="parameter"><tt>property</tt></i> and <i class="parameter"><tt>type</tt></i>
must be a string or a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--property-delete"></a><h3>gtk.gdk.Window.property_delete</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">property_delete</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>property</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>property</tt></b>:</span></td><td>the property to delete</td></tr></tbody></table><p>The <tt class="methodname">property_delete</tt>() method deletes
the specified <i class="parameter"><tt>property</tt></i> from the window.
<i class="parameter"><tt>property</tt></i> must be a string or a gtk.gdk.Atom.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--selection-convert"></a><h3>gtk.gdk.Window.selection_convert</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">selection_convert</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>selection</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>target</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>time</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>selection</tt></b>:</span></td><td>the selection to retrieve</td></tr><tr><td><span class="term"><b class="parameter"><tt>target</tt></b>:</span></td><td>the target form of
<i class="parameter"><tt>selection</tt></i></td></tr><tr><td><span class="term"><b class="parameter"><tt>time</tt></b>:</span></td><td>the timestamp to use when retrieving
<i class="parameter"><tt>selection</tt></i>. The selection owner may refuse the request
if it did not own the selection at the time indicated by the
timestamp.</td></tr></tbody></table><p>The <tt class="methodname">selection_convert</tt>() method converts
the specified <i class="parameter"><tt>selection</tt></i> to the specified
<i class="parameter"><tt>form</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-keep-above"></a><h3>gtk.gdk.Window.set_keep_above</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_keep_above</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>setting</tt></b>:</span></td><td>xif <tt class="literal">TRUE</tt> keep the window
	  above other windows</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">set_keep_above</tt>() method sets the
"keep-above" setting to the value of <i class="parameter"><tt>setting</tt></i>. If
<i class="parameter"><tt>setting</tt></i> is <tt class="literal">TRUE</tt> the window must be
kept above other windows. If the window is already above, then this method
does nothing.</p><p>On X11, asks the window manager to keep the window above, if the
window manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of "keep
above", but most standard window managers do.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-keep-below"></a><h3>gtk.gdk.Window.set_keep_below</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_keep_below</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>setting</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt>, keep the window
	  below other windows</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">set_keep_below</tt>() method sets the
"keep-below" setting to the value of <i class="parameter"><tt>setting</tt></i>. If
<i class="parameter"><tt>setting</tt></i> is <tt class="literal">TRUE</tt> the window must be
kept below other windows. If the window was already below, then this
method does nothing.</p><p>On X11, asks the window manager to keep the window below, if the
window manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of "keep
below" but most standard window managers do.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--destroy"></a><h3>gtk.gdk.Window.destroy</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">destroy</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">destroy</tt>() method destroys the
window (destroys the server-side resource associated with the window). All
children of the window are also destroyed. There's normally no need to use
this method since windows are automatically destroyed when their reference
count reaches 0.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-window-type"></a><h3>gtk.gdk.Window.get_window_type</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_window_type</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the type of window</td></tr></tbody></table><p>The <tt class="methodname">get_window_type</tt>() method returns
the type of the window:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_ROOT</tt></span></td><td>the root window; this window has no parent, covers the
entire screen, and is created by the window system</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TOPLEVEL</tt></span></td><td>a toplevel window (used to implement <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>)</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_CHILD</tt></span></td><td>a child window (used to implement e.g. <a href="class-gtkbutton.html" title="gtk.Button"><tt class="classname">gtk.Button</tt></a>)</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_DIALOG</tt></span></td><td>a useless and deprecated compatibility type</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TEMP</tt></span></td><td>an override redirect temporary window (used to
implement <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a>)</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_FOREIGN</tt></span></td><td>a foreign window (see the <a href="class-gdkwindow.html#function-gdk--window-foreign-new" title="gtk.gdk.window_foreign_new"><tt class="function">gtk.gdk.window_foreign_new</tt>()</a> 
function)</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--show"></a><h3>gtk.gdk.Window.show</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">show</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">show</tt>() method maps the window so
it's visible on-screen and also raises it to the top of the window stack
(moves the window to the front of the Z-order). This method is opposite to
the <a href="class-gdkwindow.html#method-gdkwindow--hide" title="gtk.gdk.Window.hide"><tt class="methodname">hide</tt>()</a>
method. When implementing a <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a>, you
should call this method on the widget's <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> as
part of the "map" method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--hide"></a><h3>gtk.gdk.Window.hide</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">hide</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">hide</tt>() method withdraws toplevel
windows, so they will no longer be known to the window manager and for all
windows, unmaps them, so they won't be displayed. This is normally done
automatically as part of the <a href="class-gtkwidget.html#method-gtkwidget--hide" title="gtk.Widget.hide"><tt class="methodname">gtk.Widget.hide</tt>()</a> 
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--withdraw"></a><h3>gtk.gdk.Window.withdraw</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">withdraw</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">withdraw</tt>() method withdraws the
window (unmaps it and asks the window manager to forget about it). This is
normally done automatically by the <a href="class-gtkwidget.html#method-gtkwidget--hide" title="gtk.Widget.hide"><tt class="methodname">gtk.Widget.hide</tt>()</a> 
method called on a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--move"></a><h3>gtk.gdk.Window.move</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">move</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the X coordinate relative to the window's
parent</td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the Y coordinate relative to the window's
parent</td></tr></tbody></table><p>The <tt class="methodname">move</tt>() method repositions the
window to the location specified by <i class="parameter"><tt>x</tt></i> and
<i class="parameter"><tt>y</tt></i> relative to its parent window. For toplevel
windows, window managers may ignore or modify the move. You should probably
use the <a href="class-gtkwindow.html#method-gtkwindow--move" title="gtk.Window.move"><tt class="methodname">gtk.Window.move</tt>()</a> 
method on a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> widget
anyway, instead of using this method. For child windows, the move will
reliably succeed. If you're also planning to resize the window, use the
<a href="class-gdkwindow.html#method-gdkwindow--move-resize" title="gtk.gdk.Window.move_resize"><tt class="methodname">move_resize</tt>()</a> 
method to both move and resize simultaneously, for a nicer visual
effect.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--resize"></a><h3>gtk.gdk.Window.resize</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">resize</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>width</tt></b>:</span></td><td>the new width of the
window</td></tr><tr><td><span class="term"><b class="parameter"><tt>height</tt></b>:</span></td><td>the new height of the
window</td></tr></tbody></table><p>The <tt class="methodname">resize</tt>() method resizes the window
to the specified <i class="parameter"><tt>width</tt></i> and
<i class="parameter"><tt>height</tt></i>. For toplevel windows, this method asks the
window manager to resize the window. However, the window manager may not
allow the resize. You should use the <a href="class-gtkwindow.html#method-gtkwindow--resize" title="gtk.Window.resize"><tt class="methodname">gtk.Window.resize</tt>()</a> 
method instead of this low-level method. Windows may not be resized smaller
than 1x1. If you're also planning to move the window, use the <a href="class-gdkwindow.html#method-gdkwindow--move-resize" title="gtk.gdk.Window.move_resize"><tt class="methodname">move_resize</tt>()</a> 
method to both move and resize simultaneously, for a nicer visual
effect.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--move-resize"></a><h3>gtk.gdk.Window.move_resize</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">move_resize</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the new X position relative to the window's
parent</td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the new Y position relative to the window's
parent</td></tr><tr><td><span class="term"><b class="parameter"><tt>width</tt></b>:</span></td><td>the new width</td></tr><tr><td><span class="term"><b class="parameter"><tt>height</tt></b>:</span></td><td>the new height</td></tr></tbody></table><p>The <tt class="methodname">move_resize</tt>() method repositions
the window to the location specified by <i class="parameter"><tt>x</tt></i> and
<i class="parameter"><tt>y</tt></i> with the size specified by
<i class="parameter"><tt>width</tt></i> and <i class="parameter"><tt>height</tt></i>. This method
is equivalent to calling the <a href="class-gdkwindow.html#method-gdkwindow--move" title="gtk.gdk.Window.move"><tt class="methodname">move</tt>()</a> and
<a href="class-gdkwindow.html#method-gdkwindow--resize" title="gtk.gdk.Window.resize"><tt class="methodname">resize</tt>()</a>
methods, except that both operations are performed at once, avoiding strange
visual effects. (i.e. the user may be able to see the window first move,
then resize, if you don't use the <tt class="methodname">move_resize</tt>()
method.)</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--reparent"></a><h3>gtk.gdk.Window.reparent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">reparent</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>new_parent</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>new_parent</tt></b>:</span></td><td>the new parent <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> to
move the window into</td></tr><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the X location inside the new
parent</td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the Y location inside the new
parent</td></tr></tbody></table><p>The <tt class="methodname">reparent</tt>() method reparents the
window into the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
specified <i class="parameter"><tt>new_parent</tt></i>. The window being reparented
will be unmapped as a side effect.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--clear"></a><h3>gtk.gdk.Window.clear</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">clear</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">clear</tt>() method clears an entire the
window to the background color or background pixmap.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--clear-area"></a><h3>gtk.gdk.Window.clear_area</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">clear_area</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the X coordinate of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the Y coordinate of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>width</tt></b>:</span></td><td>the width of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>height</tt></b>:</span></td><td>the height of the rectangle to
clear</td></tr></tbody></table><p>The <tt class="methodname">clear_area</tt>() method clears the area
(specified by <i class="parameter"><tt>x</tt></i>, <i class="parameter"><tt>y</tt></i>,
<i class="parameter"><tt>width</tt></i> and <i class="parameter"><tt>height</tt></i>) of the
window to the background color or background pixmap.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--clear-area-e"></a><h3>gtk.gdk.Window.clear_area_e</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">clear_area_e</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>x</tt></b>:</span></td><td>the X coordinate of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>y</tt></b>:</span></td><td>the Y coordinate of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>width</tt></b>:</span></td><td>the width of the rectangle to
clear</td></tr><tr><td><span class="term"><b class="parameter"><tt>height</tt></b>:</span></td><td>the height of the rectangle to
clear</td></tr></tbody></table><p>The <tt class="methodname">clear_area_e</tt>() method is like the
<a href="class-gdkwindow.html#method-gdkwindow--clear-area" title="gtk.gdk.Window.clear_area"><tt class="methodname">clear_area</tt>()</a>, 
but also generates an expose event for the cleared area.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--raise_"></a><h3>gtk.gdk.Window.raise_</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">raise_</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">raise_</tt>() method raises the window to
the top of the Z-order (stacking order), so that other windows with the same
parent window appear below the window. If the window is a toplevel, the
window manager may choose to deny the request to move the window in the
Z-order. Therefore, the <a href="class-gdkwindow.html#method-gdkwindow--raise_" title="gtk.gdk.Window.raise_"><tt class="methodname">raise_</tt>()</a>
method only requests the restack, it does not guarantee it.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
		This method is called <tt class="methodname">raise</tt>() in
		the C API, but was renamed <tt class="methodname">raise_</tt>()
		since <tt class="literal">raise</tt> is a reserved Python keyword.
	</p></div></div><div class="refsect2" lang="en"><a name="method-gdkwindow--lower"></a><h3>gtk.gdk.Window.lower</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">lower</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The lower() method lowers the window to the bottom of the
Z-order (stacking order), so that other windows with the same parent window
appear above the window. If the window is a toplevel, the window manager may
choose to deny the request to move the window in the Z-order. Therefore, the
<a href="class-gdkwindow.html#method-gdkwindow--lower" title="gtk.gdk.Window.lower"><tt class="methodname">lower</tt>()</a>
only requests the restack, it does not guarantee it. Note that the <a href="class-gdkwindow.html#method-gdkwindow--show" title="gtk.gdk.Window.show"><tt class="methodname">show</tt>()</a>
method raises the window again, so don't call this method before calling the
<a href="class-gdkwindow.html#method-gdkwindow--show" title="gtk.gdk.Window.show"><tt class="methodname">show</tt>()</a>
method to avoid duplication.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--focus"></a><h3>gtk.gdk.Window.focus</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">focus</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span><span class="initializer">=0L</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>timestamp</tt></b>:</span></td><td>the timestamp of the event triggering the
window focus</td></tr></tbody></table><p>The <tt class="methodname">focus</tt>() method sets keyboard focus
to the window. If the window is not on-screen this will not work. In most
cases, the <a href="class-gtkwindow.html#method-gtkwindow--present" title="gtk.Window.present"><tt class="methodname">gtk.Window.present</tt>()</a> 
method should be used on a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>, rather
than calling this method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-user-data"></a><h3>gtk.gdk.Window.set_user_data</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_user_data</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>user_data</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>user_data</tt></b>:</span></td><td>a <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">set_user_data</tt>() method stores the
underlying GTK+ widget of the PyGTK widget that is specified by
<i class="parameter"><tt>user_data</tt></i> as the user data of the window. In general
GTK+ stores the widget that owns a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> as
user data on a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>. So,
custom widget implementations in <tt class="literal">PyGTK</tt> should use this
method to provide that capability. If <tt class="literal">GTK+</tt> receives an
event for a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>, and
the user data for the window is set, <tt class="literal">GTK+</tt> will assume the
user data is a <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a>, and
forward the event to that widget.</p><p>In PyGTK 2.4 and above this method will raise the TypeError
exception if <i class="parameter"><tt>user_data</tt></i> is not a <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is deprecated for any use other than the above. To
set other user data on a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> use
the <a href="class-gobject.html#method-gobject--set-data" title="gobject.GObject.set_data"><tt class="methodname">gobject.GObject.set_data</tt>()</a>
method instead.</p></div></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-user-data"></a><h3>gtk.gdk.Window.get_user_data</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_user_data</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the user data set on the
          window</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">get_user_data</tt>() method returns the
PyGTK widget that was set as the user data of the window using the <a href="class-gdkwindow.html#method-gdkwindow--set-user-data" title="gtk.gdk.Window.set_user_data"><tt class="methodname">set_user_data</tt>()</a>
method. This method raises the ValueError exception if the user data is not
set or is not a PyGTK object.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-override-redirect"></a><h3>gtk.gdk.Window.set_override_redirect</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_override_redirect</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>override_redirect</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>override_redirect</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the window should be
override redirect</td></tr></tbody></table><p>The <tt class="methodname">set_override_redirect</tt>() method sets
the "override redirect" attribute on the window to the value specified by
<i class="parameter"><tt>override_redirect</tt></i>. If
<i class="parameter"><tt>override_redirect</tt></i> is <tt class="literal">TRUE</tt> the
window is not under the control of the window manager. This means it won't
have a titlebar, won't be minimizable, etc. - it will be entirely under the
control of the application. The window manager can't see the override
redirect window at all. Override redirect should only be used for
short-lived temporary windows, such as popup menus. <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a> uses an
override redirect window in its implementation, for example. This method
does not work on MS Windows.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--add-filter"></a><h3>gtk.gdk.Window.add_filter</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">add_filter</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>function</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span><span class="initializer">=None</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>function</tt></b>:</span></td><td>a function</td></tr><tr><td><span class="term"><b class="parameter"><tt>data</tt></b>:</span></td><td>data to pass to
          <i class="parameter"><tt>function</tt></i></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">add_filter</tt>() method adds an event
filter function specified by <i class="parameter"><tt>function</tt></i> to the window,
allowing you to intercept events before they reach GDK. This is a low-level
operation and makes it easy to break GDK and/or GTK+, so you have to know
what you're doing. Once added there is no way to remove a filter
function. The function signature is:</p><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
  def function(<i class="parameter"><tt>event</tt></i>, <i class="parameter"><tt>user_data</tt></i>)
</pre></td></tr></table><p>where <i class="parameter"><tt>event</tt></i> is a <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> and
<i class="parameter"><tt>user_data</tt></i> is <i class="parameter"><tt>data</tt></i>. If
<i class="parameter"><tt>data</tt></i> is not specified then
<i class="parameter"><tt>user_data</tt></i> is not passed to
<i class="parameter"><tt>function</tt></i>.</p><p><i class="parameter"><tt>function</tt></i> should return one of the
following values:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.FILTER_CONTINUE</tt></span></td><td>the event was not handled, continue processing.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FILTER_TRANSLATE</tt></span></td><td>the native event was translated into a GDK event and
stored in the event that was passed in.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FILTER_REMOVE</tt></span></td><td>the event was handled, terminate processing.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--scroll"></a><h3>gtk.gdk.Window.scroll</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">scroll</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>dx</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>dy</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>dx</tt></b>:</span></td><td>the amount to scroll in the X
direction</td></tr><tr><td><span class="term"><b class="parameter"><tt>dy</tt></b>:</span></td><td>the amount to scroll in the Y
direction</td></tr></tbody></table><p>The <tt class="methodname">scroll</tt>() method scrolls the
contents of the window, both pixels and children, by the horizontal and
vertical amounts specified by <i class="parameter"><tt>dx</tt></i> and
<i class="parameter"><tt>dy</tt></i> respectively. The window itself does not move.
Portions of the window that the scroll operation brings in from off-screen
areas are invalidated. The invalidated region may be bigger than what would
strictly be necessary. (For X11, a minimum area will be invalidated if the
window has no subwindows, or if the edges of the window's parent do not
extend beyond the edges of the window. In other cases, a multi-step process
is used to scroll the window which may produce temporary visual artifacts
and unnecessary invalidations.)</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--shape-combine-mask"></a><h3>gtk.gdk.Window.shape_combine_mask</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">shape_combine_mask</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>shape_mask</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>offset_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>offset_y</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>shape_mask</tt></b>:</span></td><td>the shape bitmap mask</td></tr><tr><td><span class="term"><b class="parameter"><tt>offset_x</tt></b>:</span></td><td>the X position of shape mask with respect to
the window</td></tr><tr><td><span class="term"><b class="parameter"><tt>offset_y</tt></b>:</span></td><td>the Y position of shape mask with respect to
the window</td></tr></tbody></table><p>The <tt class="methodname">shape_combine_mask</tt>() method applies
the bitmap mask specified by <i class="parameter"><tt>shape_mask</tt></i> to the window
at the location specified by <i class="parameter"><tt>x</tt></i> and
<i class="parameter"><tt>y</tt></i>. Pixels in the window corresponding to set bits in
the <i class="parameter"><tt>shape_mask</tt></i> will be visible; pixels in the window
corresponding to unset bits in the <i class="parameter"><tt>shape_mask</tt></i> will be
transparent. This method provides a non-rectangular window. If
<i class="parameter"><tt>shape_mask</tt></i> is <tt class="literal">None</tt>, the shape mask
will be unset, and the <i class="parameter"><tt>x</tt></i>/<i class="parameter"><tt>y</tt></i>
parameters are not used.</p><p>On the X11 platform, this uses an X server extension which is
widely available on most common platforms, but not available on very old X
servers, and occasionally the implementation will be buggy. On servers
without the shape extension, this function will do nothing.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-child-shapes"></a><h3>gtk.gdk.Window.set_child_shapes</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_child_shapes</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">set_child_shapes</tt>() method sets the
shape mask of the window to the union of shape masks for all children of the
window, ignoring the shape mask of the window itself. Contrast this method
with the <a href="class-gdkwindow.html#method-gdkwindow--merge-child-shapes" title="gtk.gdk.Window.merge_child_shapes"><tt class="methodname">merge_child_shapes</tt>()</a> 
method that includes the shape mask of the window in the masks to be
merged.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--merge-child-shapes"></a><h3>gtk.gdk.Window.merge_child_shapes</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">merge_child_shapes</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">merge_child_shapes</tt>() method merges
the shape masks for any child windows into the shape mask for the window.
i.e. the union of all masks for the window and its children will become the
new mask for the window. See the <a href="class-gdkwindow.html#method-gdkwindow--shape-combine-mask" title="gtk.gdk.Window.shape_combine_mask"><tt class="methodname">shape_combine_mask</tt>()</a> 
method. This method is distinct from the <a href="class-gdkwindow.html#method-gdkwindow--set-child-shapes" title="gtk.gdk.Window.set_child_shapes"><tt class="methodname">set_child_shapes</tt>()</a> 
method because it includes the window's shape mask in the set of shapes to
be merged.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--is-visible"></a><h3>gtk.gdk.Window.is_visible</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">is_visible</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the window is
mapped</td></tr></tbody></table><p>The <tt class="methodname">is_visible</tt>() method returns
<tt class="literal">TRUE</tt> if the window has been mapped (with the <a href="class-gdkwindow.html#method-gdkwindow--show" title="gtk.gdk.Window.show"><tt class="methodname">show</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--is-viewable"></a><h3>gtk.gdk.Window.is_viewable</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">is_viewable</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the window is
viewable</td></tr></tbody></table><p>The <tt class="methodname">is_viewable</tt>() method returns
<tt class="literal">TRUE</tt>  if the window and all its ancestors are mapped.
(This is not necessarily "viewable" in the X sense, since we only check as
far as we have <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
parents, not to the root window.)</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-state"></a><h3>gtk.gdk.Window.get_state</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_state</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the window state bitfield</td></tr></tbody></table><p>The <tt class="methodname">get_state</tt>() method returns the
bitwise <tt class="literal">OR</tt> of the currently active window state
flags:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_STATE_WITHDRAWN</tt></span></td><td>The window is not shown.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_STATE_ICONIFIED</tt></span></td><td>The window is minimized.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_STATE_MAXIMIZED</tt></span></td><td>The window is maximized.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_STATE_STICKY</tt></span></td><td>The window is sticky.</td></tr><tr><td><span class="term"><tt class="literal">GDK_WINDOW_STATE_FULLSCREEN</tt></span></td><td>the window is maximized without decorations. Available
in PyGTK 2.2 and above.</td></tr><tr><td><span class="term"><tt class="literal">GDK_WINDOW_STATE_ABOVE</tt></span></td><td>the window is kept above other windows. Available
in PyGTK 2.4 and above.</td></tr><tr><td><span class="term"><tt class="literal">GDK_WINDOW_STATE_BELOW</tt></span></td><td>the window is kept below other windows. Available
in PyGTK 2.4 and above.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-static-gravities"></a><h3>gtk.gdk.Window.set_static_gravities</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_static_gravities</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_static</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>use_static</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> turn on static
gravity</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the server supports
static gravity</td></tr></tbody></table><p>The <tt class="methodname">set_static_gravities</tt>() method sets
the bit gravity of the given window to the value specified by
<i class="parameter"><tt>use_static</tt></i>. If <i class="parameter"><tt>use_static</tt></i> is
<tt class="literal">TRUE</tt> the window uses static gravity and all children get
static subwindow gravity as well. This method returns
<tt class="literal">TRUE</tt> if the window system server supports static
gravity.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-type-hint"></a><h3>gtk.gdk.Window.set_type_hint</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_type_hint</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>hint</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>hint</tt></b>:</span></td><td>a hint of the function this window will
have</td></tr></tbody></table><p>The <tt class="methodname">set_type_hint</tt>() method provides the
specified <i class="parameter"><tt>hint</tt></i> to the window manager about the
functionality of a window. The window manager can use this information when
determining the decoration and behavior of the window. The hint must be set
before the window is mapped. The value of hint must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TYPE_HINT_NORMAL</tt></span></td><td>A normal toplevel window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TYPE_HINT_DIALOG</tt></span></td><td>A dialog window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TYPE_HINT_MENU</tt></span></td><td>A window used to implement a menu.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_TYPE_HINT_TOOLBAR</tt></span></td><td>A window used to implement a toolbar. </td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-modal-hint"></a><h3>gtk.gdk.Window.set_modal_hint</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_modal_hint</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>modal</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>modal</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the window is
modal.</td></tr></tbody></table><p>The <tt class="methodname">set_modal_hint</tt>() method sets the
window's modal hint to the value specified by <i class="parameter"><tt>modal</tt></i>.
If <i class="parameter"><tt>modal</tt></i> is <tt class="literal">TRUE</tt> the window is
modal. The window manager can use this information to handle modal windows
in a special way which usually means that the window gets all the input for
the application effectively blocking input to other windows in the
application. . You should only use this on windows for which you have
previously called the <a href="class-gdkwindow.html#method-gdkwindow--set-transient-for" title="gtk.gdk.Window.set_transient_for"><tt class="methodname">set_transient_for</tt>()</a> 
method</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-skip-taskbar-hint"></a><h3>gtk.gdk.Window.set_skip_taskbar_hint</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_skip_taskbar_hint</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>modal</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>skip_taskbar</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> skip the
	  taskbar.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">set_skip_taskbar_hint</tt>() method sets
the "skip_taskbar" setting to the value specified by
<i class="parameter"><tt>skips_taskbar</tt></i>. If
<i class="parameter"><tt>skips_taskbar</tt></i> is <tt class="literal">TRUE</tt> the window
should <span class="bold"><b>not</b></span> appear in a task list or window
list. If the window's semantic type as specified with the <a href="class-gdkwindow.html#method-gdkwindow--set-type-hint" title="gtk.gdk.Window.set_type_hint"><tt class="methodname">set_type_hint()</tt></a>
method already fully describes the window, this method should <span class="bold"><b>not</b></span> be called in addition; instead you should allow
the window to be treated according to standard policy for its semantic
type.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-skip-pager-hint"></a><h3>gtk.gdk.Window.set_skip_pager_hint</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_skip_pager_hint</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>skips_pager</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>skips_pager</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> skip the pager</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">set_skip_pager_hint</tt>() method sets
the "skip_pager" setting to the value of skips_pager. If skips_pager is TRUE
the window should <span class="bold"><b>not</b></span> appear in a pager (a
workspace switcher, or other desktop utility program that displays a small
thumbnail representation of the windows on the desktop). If the window's
semantic type as specified with <a href="class-gdkwindow.html#method-gdkwindow--set-type-hint" title="gtk.gdk.Window.set_type_hint"><tt class="methodname">set_type_hint()</tt></a>
already fully describes the window, this method should <span class="bold"><b>not</b></span> be called in addition, instead you should allow
the window to be treated according to standard policy for its semantic
type.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-geometry-hints"></a><h3>gtk.gdk.Window.set_geometry_hints</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_geometry_hints</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>base_width</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>base_height</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>width_inc</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>height_inc</tt></b></span><span class="initializer">=-1</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>min_aspect</tt></b></span><span class="initializer">=-1.0</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>max_aspect</tt></b></span><span class="initializer">=-1.0</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>min_width</tt></b>:</span></td><td>minimum width of window or -1 to use 
requisition</td></tr><tr><td><span class="term"><b class="parameter"><tt>min_height</tt></b>:</span></td><td>minimum height of window or -1 to use
requisition</td></tr><tr><td><span class="term"><b class="parameter"><tt>max_width</tt></b>:</span></td><td>maximum width of window or -1 to use
requisition</td></tr><tr><td><span class="term"><b class="parameter"><tt>max_height</tt></b>:</span></td><td>maximum height of window or -1 to use
requisition</td></tr><tr><td><span class="term"><b class="parameter"><tt>base_width</tt></b>:</span></td><td>allowed window widths are
base_width + width_inc * N (where N is any integer) or
-1</td></tr><tr><td><span class="term"><b class="parameter"><tt>base_height</tt></b>:</span></td><td>allowed window widths are
base_height + height_inc * N (where N is any integer) or
-1</td></tr><tr><td><span class="term"><b class="parameter"><tt>width_inc</tt></b>:</span></td><td>width resize increment</td></tr><tr><td><span class="term"><b class="parameter"><tt>height_inc</tt></b>:</span></td><td>height resize increment</td></tr><tr><td><span class="term"><b class="parameter"><tt>min_aspect</tt></b>:</span></td><td>minimum width/height ratio</td></tr><tr><td><span class="term"><b class="parameter"><tt>max_aspect</tt></b>:</span></td><td>maximum width/height ratio</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">set_geometry_hints</tt>() method sets
the geometry hints for the window.</p><p>This method provides hints to the windowing system about
acceptable sizes for a toplevel window. The purpose of this is to constrain
user resizing, but the windowing system will typically (but is not required
to) also constrain the current size of the window to the provided values and
constrain programmatic resizing via gdk_window_resize() or
gdk_window_move_resize().</p><p>Note that on X11, this effect has no effect on windows of type
GDK_WINDOW_TEMP or windows where override_redirect has been turned on via
the <a href="class-gdkwindow.html#method-gdkwindow--set-override-redirect" title="gtk.gdk.Window.set_override_redirect"><tt class="methodname">set_override_redirect</tt>()</a>
method since these windows are not resizable by the user.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--begin-paint-rect"></a><h3>gtk.gdk.Window.begin_paint_rect</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">begin_paint_rect</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>rectangle</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>rectangle</tt></b>:</span></td><td>the rectangle you intend to draw
to</td></tr></tbody></table><p>The <tt class="methodname">begin_paint_rect</tt>() method indicates
that you are beginning the process of redrawing the area specified by
<i class="parameter"><tt>rectangle</tt></i>. A backing store (off-screen buffer) large
enough to contain <i class="parameter"><tt>rectangle</tt></i> will be created. The
backing store will be initialized with the background color or background
pixmap for window. Then, all drawing operations performed on the window will
be diverted to the backing store. When you call the <a href="class-gdkwindow.html#method-gdkwindow--end-paint" title="gtk.gdk.Window.end_paint"><tt class="methodname">end_paint</tt>()</a> 
method, the backing store will be copied to the window, making it visible
on-screen. Only the part of window contained in region will be modified; that
is, drawing operations are clipped to <i class="parameter"><tt>rectangle</tt></i>. The
net result of all this is to remove flicker, because the user sees the
finished product appear all at once when you call the <a href="class-gdkwindow.html#method-gdkwindow--end-paint" title="gtk.gdk.Window.end_paint"><tt class="methodname">end_paint</tt>()</a> 
method. If you draw to window directly without calling the
<tt class="methodname">begin_paint_rect</tt>() method, the user may see flicker
as individual drawing operations are performed in sequence. The clipping and
background initializing features of the
<tt class="methodname">begin_paint_rect</tt>() are conveniences for the
programmer, so you can avoid doing that work yourself.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--end-paint"></a><h3>gtk.gdk.Window.end_paint</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">end_paint</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">end_paint</tt>() method indicates that
the backing store created by the most recent call to the <a href="class-gdkwindow.html#method-gdkwindow--begin-paint-rect" title="gtk.gdk.Window.begin_paint_rect"><tt class="methodname">begin_paint_rect</tt>()</a> 
method should be copied on-screen and deleted, leaving the next-most-recent
backing store or no backing store at all as the active paint region. It is
an error to call this function without a matching call to the <a href="class-gdkwindow.html#method-gdkwindow--begin-paint-rect" title="gtk.gdk.Window.begin_paint_rect"><tt class="methodname">begin_paint_rect</tt>()</a> 
method first.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-title"></a><h3>gtk.gdk.Window.set_title</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_title</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>title</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>title</tt></b>:</span></td><td>the new title of the
window</td></tr></tbody></table><p>The <tt class="methodname">set_title</tt>() method sets the title
of a toplevel window, to the string specified by
<i class="parameter"><tt>title</tt></i>. If you haven't explicitly set the icon name
for the window (using the <a href="class-gdkwindow.html#method-gdkwindow--set-icon-name" title="gtk.gdk.Window.set_icon_name"><tt class="methodname">set_icon_name</tt>()</a> 
method), the icon name will be set to <i class="parameter"><tt>title</tt></i> as well.
<i class="parameter"><tt>title</tt></i> must be in UTF-8 encoding (as with all
user-readable strings in <tt class="literal">PyGTK</tt>).</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-role"></a><h3>gtk.gdk.Window.set_role</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_role</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>role</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>role</tt></b>:</span></td><td>a string indicating its
role</td></tr></tbody></table><p>The <tt class="methodname">set_role</tt>() method sets the string
specified by <i class="parameter"><tt>role</tt></i> as the window's role. When using
<tt class="literal">PyGTK</tt>, you should generally use the <a href="class-gtkwindow.html#method-gtkwindow--set-role" title="gtk.Window.set_role"><tt class="methodname">gtk.Window.set_role</tt>()</a> 
method instead of this low-level function. The window manager and session
manager use a window's role to distinguish it from other kinds of window in
the same application. When an application is restarted after being saved in
a previous session, all windows with the same title and role are treated as
interchangeable.  So if you have two windows with the same title that should
be distinguished for session management purposes, you should set the role on
those windows. It doesn't matter what string you use for the role, as long
as you have a different role for each non-interchangeable kind of
window.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-transient-for"></a><h3>gtk.gdk.Window.set_transient_for</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_transient_for</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>leader</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>leader</tt></b>:</span></td><td>another <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr></tbody></table><p>The <tt class="methodname">set_transient_for</tt>() method
indicates to the window manager that the window is a transient dialog
associated with the application window <i class="parameter"><tt>leader</tt></i>. This
allows the window manager to do things like center the window on
<i class="parameter"><tt>leader</tt></i> and keep the window above
<i class="parameter"><tt>leader</tt></i>. See the <a href="class-gtkwindow.html#method-gtkwindow--set-transient-for" title="gtk.Window.set_transient_for"><tt class="methodname">gtk.Window.set_transient_for</tt>()</a> 
method if you're using a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> or <a href="class-gtkdialog.html" title="gtk.Dialog"><tt class="classname">gtk.Dialog</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-background"></a><h3>gtk.gdk.Window.set_background</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_background</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>color</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>color</tt></b>:</span></td><td>an allocated <a href="class-gdkcolor.html" title="gtk.gdk.Color"><tt class="classname">gtk.gdk.Color</tt></a></td></tr></tbody></table><p>The <tt class="methodname">set_background</tt>() method sets the
background <a href="class-gdkcolor.html" title="gtk.gdk.Color"><tt class="classname">gtk.gdk.Color</tt></a> of the
window to the value specified by <i class="parameter"><tt>color</tt></i>. (However,
when using <tt class="literal">PyGTK</tt>, set the background of a widget with the
<a href="class-gtkwidget.html#method-gtkwidget--modify-bg" title="gtk.Widget.modify_bg"><tt class="methodname">gtk.Widget.modify_bg</tt>()</a> 
method from an application - or the <a href="class-gtkstyle.html#method-gtkstyle--set-background" title="gtk.Style.set_background"><tt class="methodname">gtk.Style.set_background</tt>()</a> 
method from a custom widget implementation.) The
<i class="parameter"><tt>color</tt></i> must be allocated Also see the <a href="class-gdkwindow.html#method-gdkwindow--set-back-pixmap" title="gtk.gdk.Window.set_back_pixmap"><tt class="methodname">set_back_pixmap</tt>()</a> 
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-back-pixmap"></a><h3>gtk.gdk.Window.set_back_pixmap</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_back_pixmap</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixmap</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>parent_relative</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>pixmap</tt></b>:</span></td><td>a <a href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><tt class="classname">gtk.gdk.Pixmap</tt></a>, or
<tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>parent_relative</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the tiling origin is
at the origin of the window's parent</td></tr></tbody></table><p>The <tt class="methodname">set_back_pixmap</tt>() method sets the
background pixmap of the window to the value specified by
<i class="parameter"><tt>pixmap</tt></i> A background pixmap will be tiled, positioning
the first tile at the origin of the window, or if
<i class="parameter"><tt>parent_relative</tt></i> is <tt class="literal">TRUE</tt>, the
tiling will be done based on the origin of the parent window (useful to
align tiles in a parent with tiles in a child). If
<i class="parameter"><tt>pixmap</tt></i> is <tt class="literal">None</tt> the window will
have no background which means it will never have its background filled by
the windowing system. Instead the window will contain whatever pixels were
already in the corresponding area of the display. The windowing system will
normally fill a window with its background when the window is obscured then
exposed, and when you call the <a href="class-gdkwindow.html#method-gdkwindow--clear" title="gtk.gdk.Window.clear"><tt class="methodname">clear</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-cursor"></a><h3>gtk.gdk.Window.set_cursor</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_cursor</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>cursor</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>cursor</tt></b>:</span></td><td>a <a href="class-gdkcursor.html" title="gtk.gdk.Cursor"><tt class="classname">gtk.gdk.Cursor</tt></a> or
<tt class="literal">None</tt></td></tr></tbody></table><p>The <tt class="methodname">set_cursor</tt>() method sets the mouse
pointer for a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>. Use
either the <a href="class-gdkcursor.html#constructor-gdkcursor1" title="">gtk.gdk.Cursor()</a> or
<a href="class-gdkcursor.html#constructor-gdkcursor2" title="">gtk.gdk.Cursor</a>() constructors
to create the cursor. To make the cursor invisible, use the <a href="class-gdkcursor.html#constructor-gdkcursor2" title="">gtk.gdk.Cursor</a>() constructor to
create a cursor with no pixels in it. Passing <tt class="literal">None</tt> for
the <i class="parameter"><tt>cursor</tt></i> argument to the
<tt class="methodname">set_cursor</tt>() method means that the window will use
the cursor of its parent window. Most windows should use this
default.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-geometry"></a><h3>gtk.gdk.Window.get_geometry</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_geometry</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 5-tuple containing the X and Y coordinate of
the location of the window relative to its parent and the width and height
of the window and the bit depth of the window.</td></tr></tbody></table><p>The <tt class="methodname">get_geometry</tt>() method returns a
5-tuple containing the window's location and size (x, y, width, height) and
the bit depth of the window. The X and Y coordinates returned are relative
to the parent window of the window, which for toplevels usually means
relative to the window decorations (titlebar, etc.) rather than relative to
the root window (screen-size background window).
</p><p>
On the X11 platform, the geometry is obtained from the X server, so reflects
the latest position of the window; this may be out-of-sync with the position
of the window delivered in the most-recently-processed
<tt class="literal">GdkEventConfigure</tt>. the <a href="class-gdkwindow.html#method-gdkwindow--get-position" title="gtk.gdk.Window.get_position"><tt class="methodname">get_position</tt>()</a> 
method in contrast gets the position from the most recent configure
event.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-position"></a><h3>gtk.gdk.Window.get_position</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_position</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 2-tuple containing the X and Y coordinates of
the window location.</td></tr></tbody></table><p>The <tt class="methodname">get_position</tt>() returns a 2-tuple
containing the position of the window as reported in the
most-recently-processed <tt class="literal">GdkEventConfigure</tt>. By comparison
with the <a href="class-gdkwindow.html#method-gdkwindow--get-geometry" title="gtk.gdk.Window.get_geometry"><tt class="methodname">get_geometry</tt>()</a> 
method that queries the X server for the current window position, regardless
of what events have been received or processed. The position coordinates are
relative to the window's parent window.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-origin"></a><h3>gtk.gdk.Window.get_origin</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_origin</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 2-tuple containing the X and Y coordinates of
the window</td></tr></tbody></table><p>The <tt class="methodname">get_origin</tt>() method returns a
2-tuple containing the x and y coordinates of the position of a window in
root window coordinates. (Compare this method with the <a href="class-gdkwindow.html#method-gdkwindow--get-position" title="gtk.gdk.Window.get_position"><tt class="methodname">get_position</tt>()</a> 
and <a href="class-gdkwindow.html#method-gdkwindow--get-geometry" title="gtk.gdk.Window.get_geometry"><tt class="methodname">get_geometry</tt>()</a> 
methods that return the position of a window relative to its parent
window.)</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-root-origin"></a><h3>gtk.gdk.Window.get_root_origin</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_root_origin</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 2-tuple containing the X and Y coordinates of
the window frame position</td></tr></tbody></table><p>The <tt class="methodname">get_root_origin</tt>() method returns a
2-tuple containing the top-left corner of the window manager frame in root
window coordinates.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-frame-extents"></a><h3>gtk.gdk.Window.get_frame_extents</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_frame_extents</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a <a href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><tt class="classname">gtk.gdk.Rectangle</tt></a>
specifying the bounding box of the window frame</td></tr></tbody></table><p>The <tt class="methodname">get_frame_extents</tt>() method returns
a <a href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><tt class="classname">gtk.gdk.Rectangle</tt></a>
specifying the bounding box of the window, including window manager
titlebar/borders if any. The frame position is given in root window
coordinates. To get the position of the window itself (rather than the
frame) in root window coordinates, use the <a href="class-gdkwindow.html#method-gdkwindow--get-origin" title="gtk.gdk.Window.get_origin"><tt class="methodname">get_origin</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-pointer"></a><h3>gtk.gdk.Window.get_pointer</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_pointer</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 3-tuple containing the X and Y coordinates of
the mouse pointer and the modifier mask</td></tr></tbody></table><p>The <tt class="methodname">get_pointer</tt>() method returns a
3-tuple containing the coordinates of the mouse pointer location relative to
the window and the modifier state. The modifier state is a combination of the
following:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.SHIFT_MASK</tt></span></td><td>The Shift key.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.LOCK_MASK</tt></span></td><td>A Lock key (depending on the modifier mapping of the X
server this may either be CapsLock or ShiftLock).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.CONTROL_MASK</tt></span></td><td>The Control key. </td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD1_MASK</tt></span></td><td>The fourth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier, but
normally it is the Alt key).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD2_MASK</tt></span></td><td>The fifth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD3_MASK</tt></span></td><td>The sixth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD4_MASK</tt></span></td><td>The seventh modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD5_MASK</tt></span></td><td>The eighth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON1_MASK</tt></span></td><td>The first mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON2_MASK</tt></span></td><td>The second mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON3_MASK</tt></span></td><td>The third mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON4_MASK</tt></span></td><td>The fourth mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON5_MASK</tt></span></td><td>The fifth mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.RELEASE_MASK</tt></span></td><td>Differentiates between (keyval, modifiers) pairs from
key press and release events.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MODIFIER_MASK</tt></span></td><td>all of the above</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-parent"></a><h3>gtk.gdk.Window.get_parent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_parent</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the parent <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> of
the window</td></tr></tbody></table><p>The <tt class="methodname">get_parent</tt>() method returns the
parent of the window as set when the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> was
created or when the <a href="class-gdkwindow.html#method-gdkwindow--reparent" title="gtk.gdk.Window.reparent"><tt class="methodname">reparent</tt>()</a> 
method was called.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-toplevel"></a><h3>gtk.gdk.Window.get_toplevel</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_toplevel</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the toplevel <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
containing the window</td></tr></tbody></table><p>The <tt class="methodname">get_toplevel</tt>() method returns the
toplevel <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
that's an ancestor of the window.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-children"></a><h3>gtk.gdk.Window.get_children</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_children</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the list of child windows inside the
window</td></tr></tbody></table><p>The <tt class="methodname">get_children</tt>() method returns the
list of children <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
objects of the window. This method only returns children created via
<tt class="literal">PyGTK</tt>, so for example it's useless when used with the
root window; it only returns windows an application created itself.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-events"></a><h3>gtk.gdk.Window.get_events</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_events</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the event mask for the
window</td></tr></tbody></table><p>The <tt class="methodname">get_events</tt>() method returns the
event mask for the window. See the <a href="class-gdkwindow.html#method-gdkwindow--set-events" title="gtk.gdk.Window.set_events"><tt class="methodname">set_events</tt>()</a> 
method for more detail.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-events"></a><h3>gtk.gdk.Window.set_events</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_events</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>event_mask</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>event_mask</tt></b>:</span></td><td>the event mask for the
window</td></tr></tbody></table><p>The <tt class="methodname">set_events</tt>() method sets the event
mask to the value specified by event_mask for the window. The event mask
determines which events will be reported for the window. For example, an
event mask including <tt class="literal">gtk.gdk.BUTTON_PRESS_MASK</tt> means the
window should report button press events. The event mask is the bitwise OR
of the following:</p><div class="itemizedlist"><ul type="disc"><li><tt class="literal">gtk.gdk.EXPOSURE_MASK</tt></li><li><tt class="literal">gtk.gdk.POINTER_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON1_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON2_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON3_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_PRESS_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_RELEASE_MASK</tt></li><li><tt class="literal">gtk.gdk.KEY_PRESS_MASK</tt></li><li><tt class="literal">gtk.gdk.KEY_RELEASE_MASK</tt></li><li><tt class="literal">gtk.gdk.ENTER_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.LEAVE_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.FOCUS_CHANGE_MASK</tt></li><li><tt class="literal">gtk.gdk.STRUCTURE_MASK</tt></li><li><tt class="literal">gtk.gdk.PROPERTY_CHANGE_MASK</tt></li><li><tt class="literal">gtk.gdk.VISIBILITY_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.PROXIMITY_IN_MASK</tt></li><li><tt class="literal">gtk.gdk.PROXIMITY_OUT_MASK</tt></li><li><tt class="literal">gtk.gdk.SUBSTRUCTURE_MASK</tt></li><li><tt class="literal">gtk.gdk.SCROLL_MASK</tt></li><li><tt class="literal">gtk.gdk.ALL_EVENTS_MASK</tt></li></ul></div><p><tt class="literal">gtk.gdk.ALL_EVENTS_MASK</tt> is a combination of
all the event masks.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-icon-list"></a><h3>gtk.gdk.Window.set_icon_list</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_icon_list</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixbufs</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>pixbufs</tt></b>:</span></td><td>a list (or tuple) containing pixbufs, of
	  different sizes.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">set_icon_list</tt>() method sets the
list of icons for the window. pixbufs is a list or tuple containing <a href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><tt class="classname">gtk.gdk.Pixbuf</tt></a>
objects to be used as the icon images. One of these will be used to
represent the window when it has been iconified. The icon is usually shown
in an icon box or some sort of task bar. Which icon size is shown depends on
the window manager. The window manager can scale the icon but setting
several size icons can give better image quality since the window manager
may only need to scale the icon by a small amount or not at all.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-icon"></a><h3>gtk.gdk.Window.set_icon</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_icon</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_window</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>pixmap</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>mask</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>icon_window</tt></b>:</span></td><td>a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> to
use for the icon</td></tr><tr><td><span class="term"><b class="parameter"><tt>pixmap</tt></b>:</span></td><td>a <a href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><tt class="classname">gtk.gdk.Pixmap</tt></a> to
use as the icon</td></tr><tr><td><span class="term"><b class="parameter"><tt>mask</tt></b>:</span></td><td>a 1-bit pixmap (<tt class="literal">GdkBitmap</tt>)
to use as mask for <i class="parameter"><tt>pixmap</tt></i></td></tr></tbody></table><p>The <tt class="methodname">set_icon</tt>() method sets the icon of
the window as a <a href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><tt class="classname">gtk.gdk.Pixmap</tt></a>
(specified by <i class="parameter"><tt>pixmap</tt></i>) or <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
specified by <i class="parameter"><tt>icon_window</tt></i>). Investigate the <a href="class-gtkwindow.html#function-gtk--window-set-default-icon-list" title="gtk.window_set_default_icon_list"><tt class="methodname">gtk.window_set_default_icon_list()</tt>()</a> 
function first, and then the <a href="class-gtkwindow.html#method-gtkwindow--set-icon-list" title="gtk.Window.set_icon_list"><tt class="methodname">gtk.Window.set_icon_list</tt>()</a> 
and <a href="class-gtkwindow.html#method-gtkwindow--set-icon" title="gtk.Window.set_icon"><tt class="methodname">gtk.Window.set_icon</tt>()</a> 
methods. If those don't meet your needs, look at the <a href="class-gdkwindow.html#method-gdkwindow--set-icon-list" title="gtk.gdk.Window.set_icon_list"><tt class="methodname">set_icon_list</tt>()</a> 
method. Only if all those are too high-level do you want to fall back to the
<a href="class-gdkwindow.html#method-gdkwindow--set-icon" title="gtk.gdk.Window.set_icon"><tt class="methodname">set_icon</tt>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-icon-name"></a><h3>gtk.gdk.Window.set_icon_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_icon_name</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>name</tt></b>:</span></td><td>the name of the window while iconified
(minimized)</td></tr></tbody></table><p>The <tt class="methodname">set_icon_name</tt>() method sets the
name of the window when it is iconified to the value of
<i class="parameter"><tt>name</tt></i>. Windows may have a name used while minimized,
distinct from the name they display in their titlebar. Most of the time this
is a bad idea from a user interface standpoint. But you can set such a name
with this method, if you like.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-group"></a><h3>gtk.gdk.Window.set_group</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_group</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>leader</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>leader</tt></b>:</span></td><td>the group leader <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr></tbody></table><p>The <tt class="methodname">set_group</tt>() method sets the group
leader for the window to the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
specified by <i class="parameter"><tt>leader</tt></i>. By default, the group leader
for all toplevel windows is set to a global window implicitly created by
<tt class="literal">PyGTK</tt>. With this method you can override this default.
The group leader window allows the window manager to distinguish all windows
that belong to a single application. It may for example allow users to
minimize or unminimize all windows belonging to an application at once. You
should only set a non-default group window if your application pretends to
be multiple applications. The group leader window may not be changed after a
window has been mapped (with the <a href="class-gdkwindow.html#method-gdkwindow--show" title="gtk.gdk.Window.show"><tt class="methodname">show</tt>()</a>
method for example).</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-group"></a><h3>gtk.gdk.Window.get_group</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_group</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the group leader <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
	  for the window</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">get_group</tt>() method returns the
group leader <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> for
the window. See the <a href="class-gdkwindow.html#method-gdkwindow--set-group" title="gtk.gdk.Window.set_group"><tt class="methodname">set_group()</tt></a>
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-decorations"></a><h3>gtk.gdk.Window.set_decorations</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_decorations</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>decorations</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>decorations</tt></b>:</span></td><td>the decoration hint mask</td></tr></tbody></table><p>The <tt class="methodname">set_decorations</tt>() method sets the
specified decorations for the window. "Decorations" are the features the
window manager adds to a toplevel <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>. This
method sets the traditional Motif window manager hints that tell the window
manager which decorations you would like your window to have. Usually you
should use the <a href="class-gtkwindow.html#method-gtkwindow--set-decorated" title="gtk.Window.set_decorated"><tt class="methodname">gtk.Window.set_decorated</tt>()</a> 
method on a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> instead
of using this method directly. The value of
<i class="parameter"><tt>decorations</tt></i> is the logical OR of the
following:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_ALL</tt></span></td><td>All decorations should be applied.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_BORDER</tt></span></td><td>A frame should be drawn around the window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_RESIZEH</tt></span></td><td>The frame should have resize handles.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_TITLE</tt></span></td><td>A titlebar should be placed above the window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_MENU</tt></span></td><td>A button for opening a menu should be
included.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_MINIMIZE</tt></span></td><td>A minimize button should be included.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DECOR_MAXIMIZE</tt></span></td><td>A maximize button should be included.</td></tr></tbody></table><p>If <tt class="literal">gtk.gdk.DECOR_ALL</tt> is included in the mask,
the other bits indicate which decorations should be turned off. If
<tt class="literal">gtk.gdk.DECOR_ALL</tt> is not included, then the other bits
indicate which decorations should be turned on. Most window managers honor a
decorations hint of 0 to disable all decorations, but very few honor all
possible combinations of bits.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--get-decorations"></a><h3>gtk.gdk.Window.get_decorations</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_decorations</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the window decorations</td></tr></tbody></table><p>The <tt class="methodname">get_decorations</tt>() method returns
the decorations set on the window with the <a href="class-gdkwindow.html#method-gdkwindow--set-decorations" title="gtk.gdk.Window.set_decorations"><tt class="methodname">set_decorations</tt></a> 
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-functions"></a><h3>gtk.gdk.Window.set_functions</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_functions</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>functions</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>functions</tt></b>:</span></td><td>the bitmask of operations to allow on the
window</td></tr></tbody></table><p>The set_functions() method sets the traditional Motif window
manager hint for which operations the window manager should allow on a
toplevel window. However, few window managers do anything reliable or
interesting with this hint. Many ignore it entirely. The
<i class="parameter"><tt>functions</tt></i> argument is the logical OR of the
following:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_ALL</tt></span></td><td>All functions should be offered.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_RESIZE</tt></span></td><td>The window should be resizable.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_MOVE</tt></span></td><td>The window should be movable.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_MINIMIZE</tt></span></td><td>The window should be minimizable.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_MAXIMIZE</tt></span></td><td>The window should be maximizable.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FUNC_CLOSE</tt></span></td><td>The window should be closeable.</td></tr></tbody></table><p>If the bitmask includes <tt class="literal">gtk.gdk.FUNC_ALL</tt>,
then the other bits indicate which functions to disable; if it doesn't
include <tt class="literal">gtk.gdk.FUNC_ALL</tt>, it indicates which functions to
enable.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--iconify"></a><h3>gtk.gdk.Window.iconify</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">iconify</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">iconify</tt>() method asks the window
manager to iconify (minimize) the window. The window manager may choose to
ignore the request, but normally will honor it. Using the <a href="class-gtkwindow.html#method-gtkwindow--iconify" title="gtk.Window.iconify"><tt class="methodname">gtk.Window.iconify</tt>()</a> 
method is preferred, if you have a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>
widget.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--deiconify"></a><h3>gtk.gdk.Window.deiconify</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">deiconify</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">deiconify</tt>() method asks the window
manager to deiconify (unminimize) the window. On X11 the window manager may
choose to ignore the request to deiconify. Using the <a href="class-gtkwindow.html#method-gtkwindow--deiconify" title="gtk.Window.deiconify"><tt class="methodname">gtk.Window.deiconify</tt>()</a> 
method is preferred. Or better yet, use the <a href="class-gtkwindow.html#method-gtkwindow--present" title="gtk.Window.present"><tt class="methodname">gtk.Window.present</tt>()</a>, 
which raises the window, focuses it, unminimizes it, and puts it on the
current desktop.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--stick"></a><h3>gtk.gdk.Window.stick</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">stick</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">stick</tt>() method "pins" a window such
that it's on all workspaces and does not scroll with viewports, for window
managers that have scrollable viewports. (When using a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>, the
<a href="class-gtkwindow.html#method-gtkwindow--stick" title="gtk.Window.stick"><tt class="methodname">gtk.Window.stick</tt>()</a> 
method may be more useful.) On the X11 platform, this method depends on
window manager support, so may have no effect with many window managers.
However, <tt class="literal">PyGTK</tt> will do the best it can to convince the
window manager to stick the window. For window managers that don't support
this operation, there's nothing you can do to force it to happen.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--unstick"></a><h3>gtk.gdk.Window.unstick</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">unstick</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">unstick</tt>() method reverses the
effect of the <a href="class-gdkwindow.html#method-gdkwindow--stick" title="gtk.gdk.Window.stick"><tt class="methodname">stick</tt>()</a>
method. See the <a href="class-gdkwindow.html#method-gdkwindow--stick" title="gtk.gdk.Window.stick"><tt class="methodname">stick</tt>()</a>
and <a href="class-gtkwindow.html#method-gtkwindow--unstick" title="gtk.Window.unstick"><tt class="methodname">gtk.Window.unstick</tt>()</a> 
methods for more information.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--maximize"></a><h3>gtk.gdk.Window.maximize</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">maximize</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">maximize</tt>() method asks the window
manager to maximize the window, if the window manager supports this
operation. Not all window managers support this, and some deliberately
ignore it or don't have a concept of "maximized"; so you can't rely on the
maximization actually happening. But it will happen with most standard
window managers. If the window was already maximized, then this method does
nothing.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--unmaximize"></a><h3>gtk.gdk.Window.unmaximize</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">unmaximize</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">unmaximize</tt>() method asks the window
manager to unmaximize the window, if the window manager supports this
operation. Not all window managers support this, and some deliberately
ignore it or don't have a concept of "maximized"; so you can't rely on the
unmaximization actually happening. But it will happen with most standard
window managers. If the window wasn't maximized, then this method does
nothing.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--fullscreen"></a><h3>gtk.gdk.Window.fullscreen</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">fullscreen</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">fullscreen</tt>() method moves the window
into fullscreen mode. This means the window covers the entire screen and is
above any panels or task bars.</p><p>If the window was already fullscreen, then this method does
nothing.</p><p>On X11, asks the window manager to put the window in a
fullscreen state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or don't have
a concept of "fullscreen" but most standard window managers do.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--unfullscreen"></a><h3>gtk.gdk.Window.unfullscreen</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">unfullscreen</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">unfullscreen</tt>() method moves the
window out of fullscreen mode. If the window was not fullscreen, does
nothing.</p><p>On X11, asks the window manager to move the window out of the
fullscreen state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or don't have
a concept of "fullscreen" but most standard window managers do.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--register-dnd"></a><h3>gtk.gdk.Window.register_dnd</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">register_dnd</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">register_dnd</tt>() method registers the
window as a potential drop destination.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--begin-resize-drag"></a><h3>gtk.gdk.Window.begin_resize_drag</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">begin_resize_drag</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>edge</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>button</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>edge</tt></b>:</span></td><td>the edge or corner from which the drag is
started</td></tr><tr><td><span class="term"><b class="parameter"><tt>button</tt></b>:</span></td><td>the mouse button being used to
drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>root_x</tt></b>:</span></td><td>the root window X coordinate of the mouse click
that began the drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>root_y</tt></b>:</span></td><td>the root window Y coordinate of the mouse click
that began the drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>timestamp</tt></b>:</span></td><td>the timestamp of the mouse click that began the
drag (use the <a href="class-gdkevent.html#method-gdkevent--get-time" title="gtk.gdk.Event.get_time"><tt class="methodname">gtk.gdk.Event.get_time</tt>()</a> 
method)</td></tr></tbody></table><p>The <tt class="methodname">begin_resize_drag</tt>() method begins a
window resize operation (for a toplevel <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>) from
the specified <i class="parameter"><tt>edge</tt></i> using the specified
<i class="parameter"><tt>button</tt></i> starting at the location specified by
<i class="parameter"><tt>root_x</tt></i> and <i class="parameter"><tt>root_y</tt></i>. The value
of edge must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_NORTH_WEST</tt></span></td><td>The top left corner.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_NORTH</tt></span></td><td>The top edge.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_NORTH_EAST</tt></span></td><td>The top right corner.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_WEST</tt></span></td><td>The left edge.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_EAST</tt></span></td><td>The right edge.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_SOUTH_WEST</tt></span></td><td>The lower left corner.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_SOUTH</tt></span></td><td>The lower edge.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_EDGE_SOUTH_EAST</tt></span></td><td>The lower right corner.</td></tr></tbody></table><p>You might use this method to implement a "window resize grip,"
for example; in fact the <a href="class-gtkstatusbar.html" title="gtk.Statusbar"><tt class="classname">gtk.Statusbar</tt></a>
uses it. The method works best with window managers that support the
Extended Window Manager Hints spec (see <a href="" target="_top">http://www.freedesktop.org</a>),
but has a fallback implementation for other window managers.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--begin-move-drag"></a><h3>gtk.gdk.Window.begin_move_drag</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">begin_move_drag</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>button</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_x</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>root_y</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>timestamp</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>button</tt></b>:</span></td><td>the button being used to
drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>root_x</tt></b>:</span></td><td>the root window X coordinate of the mouse click
that began the drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>root_y</tt></b>:</span></td><td>the root window Y coordinate of the mouse click
that began the drag</td></tr><tr><td><span class="term"><b class="parameter"><tt>timestamp</tt></b>:</span></td><td>the timestamp of the mouse click that began the
drag</td></tr></tbody></table><p>The <tt class="methodname">begin_move_drag</tt>() method begins a
window move operation (for a toplevel window) using the specified
<i class="parameter"><tt>button</tt></i> starting at the location specified by
<i class="parameter"><tt>root_x</tt></i> and <i class="parameter"><tt>root_y</tt></i>. You might
use this method to implement a "window move grip," for example. The method
works best with window managers that support the Extended Window Manager
Hints spec (see <a href="" target="_top">http://www.freedesktop.org</a>),
but has a fallback implementation for other window managers.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--invalidate-rect"></a><h3>gtk.gdk.Window.invalidate_rect</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">invalidate_rect</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>rect</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>invalidate_children</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>rect</tt></b>:</span></td><td>the rectangle to
invalidate</td></tr><tr><td><span class="term"><b class="parameter"><tt>invalidate_children</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> invalidate child
<a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
objects</td></tr></tbody></table><p>The <tt class="methodname">invalidate_rect</tt>() method
invalidates the rectangular region specified by rect. If
<i class="parameter"><tt>invalidate_children</tt></i> is <tt class="literal">TRUE</tt> the
child <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
object of the window are also invalidated.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--freeze-updates"></a><h3>gtk.gdk.Window.freeze_updates</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">freeze_updates</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">freeze_updates</tt>() method temporarily
freezes the window such that it won't receive expose events. The window will
begin receiving expose events again when the <a href="class-gdkwindow.html#method-gdkwindow--thaw-updates" title="gtk.gdk.Window.thaw_updates"><tt class="methodname">thaw_updates</tt>()</a> 
method is called. If the <tt class="methodname">freeze_updates</tt>() method
has been called more than once, the <a href="class-gdkwindow.html#method-gdkwindow--thaw-updates" title="gtk.gdk.Window.thaw_updates"><tt class="methodname">thaw_updates</tt>()</a> 
method must be called an equal number of times to begin processing
exposes.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--thaw-updates"></a><h3>gtk.gdk.Window.thaw_updates</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">thaw_updates</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">thaw_updates</tt>() method thaws a
window frozen with the <a href="class-gdkwindow.html#method-gdkwindow--freeze-updates" title="gtk.gdk.Window.freeze_updates"><tt class="methodname">freeze_updates</tt>()</a> 
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--process-updates"></a><h3>gtk.gdk.Window.process_updates</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">process_updates</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>update_children</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>update_children</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> process updates for
child windows</td></tr></tbody></table><p>The <tt class="methodname">process_updates</tt>() method sends one
or more expose events to the window. The areas in each expose event will
cover the entire update area for the window (see the <a href="class-gdkwindow.html#method-gdkwindow--invalidate-rect" title="gtk.gdk.Window.invalidate_rect"><tt class="methodname">invalidate_rect</tt>()</a> 
method for details). Normally <tt class="literal">PyGTK</tt> calls the <a href="class-gdkwindow.html#function-gdk--window-process-all-updates" title="gtk.gdk.window_process_all_updates"><tt class="methodname">gtk.gdk.window_process_all_updates</tt>()</a> 
function on your behalf, so there's no need to call this method unless you
want to force expose events to be delivered immediately and synchronously
(vs. the usual case, where <tt class="literal">PyGTK</tt> delivers them in an idle
handler). Occasionally this is useful to produce nicer scrolling behavior,
for example.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-accept-focus"></a><h3>gtk.gdk.Window.set_accept_focus</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_accept_focus</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accept_focus</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accept_focus</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt>, the window should
	  receive input focus</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">set_accept_focus</tt>() method sets the
"accept_focus setting to the value of
<i class="parameter"><tt>accept_focus</tt></i>. If <i class="parameter"><tt>accept_focus</tt></i>
is <tt class="literal">TRUE</tt> the window will accept focus; if
<tt class="literal">FALSE</tt> hints to the desktop environment that the window
doesn't want to receive input focus.</p><p>On X, it is the responsibility of the window manager to
interpret this hint. ICCCM-compliant window manager usually respect
it.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--enable-synchronized-configure"></a><h3>gtk.gdk.Window.enable_synchronized_configure</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">enable_synchronized_configure</span>()</code></pre></td></tr></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">enable_synchronized_configure</tt>()
method indicates that the application will cooperate with the window system
in synchronizing the window repaint with the window manager during resizing
operations. After an application calls this method, it must call the <a href="class-gdkwindow.html#method-gdkwindow--configure-finished" title="gtk.gdk.Window.configure_finished"><tt class="methodname">configure_finished</tt>()</a>
method every time it has finished all processing associated with a set of
Configure events. Toplevel GTK+ windows automatically use this
protocol.</p><p>On X, calling this function makes window participate in the
_NET_WM_SYNC_REQUEST window manager protocol.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--configure-finished"></a><h3>gtk.gdk.Window.configure_finished</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">configure_finished</span>()</code></pre></td></tr></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">configure_finished</tt>() method signals
to the window system that the application has finished handling all the
Configure events it has received. Window Managers can use this to better
synchronize the frame repaint with the application. GTK+ applications will
automatically call this function when appropriate.</p><p>This function can only be called if the <a href="class-gdkwindow.html#method-gdkwindow--enable-synchronized-configure" title="gtk.gdk.Window.enable_synchronized_configure"><tt class="methodname">enable_synchronized_configure</tt>()</a>
method was called previously.</p></div><div class="refsect2" lang="en"><a name="method-gdkwindow--set-focus-on-map"></a><h3>gtk.gdk.Window.set_focus_on_map</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_focus_on_map</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>focus_on_map</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>focus_on_map</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the window should
receive input focus when mapped.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_focus_on_map</tt>() method sets the
a hint for the desktop environment to the value specified by
<i class="parameter"><tt>focus_on_map</tt></i>. If <i class="parameter"><tt>focus_on_map</tt></i>
is <tt class="literal">TRUE</tt> the window sets a hint for the desktop
environment indicating that it would like to receive input focus when
mapped.</p><p>On X, it is the responsibility of the window manager to
interpret this hint. Window managers following the <a href="http://www.freedesktio.org" target="_top">freedesktop.org</a> window manager
extension specification should respect it.</p></div></div><div class="refsect1" lang="en"><a name="id3260142"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--window-foreign-new"></a><h3>gtk.gdk.window_foreign_new</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_foreign_new</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>anid</tt></b>:</span></td><td>a native window system ID</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the new <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
wrapper for the native window or <tt class="literal">None</tt> if the window has
been destroyed.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.window_foreign_new</tt>() function
wraps a native window specified by <i class="parameter"><tt>anid</tt></i> for the default display in a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>. This
may fail if the window has been destroyed. For example in the X Window
System backend, a native window handle is an Xlib
<tt class="literal">XID</tt>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-foreign-new-for-display"></a><h3>gtk.gdk.window_foreign_new_for_display</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_foreign_new_for_display</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>display</tt></b>:</span></td><td>a <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a></td></tr><tr><td><span class="term"><b class="parameter"><tt>anid</tt></b>:</span></td><td>a native window system ID</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the new <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
wrapper for the native window or <tt class="literal">None</tt> if the window has
been destroyed.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The
<tt class="function">gtk.gdk.window_foreign_new_for_display</tt>() function wraps
a native window specified by <i class="parameter"><tt>anid</tt></i> for the <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>
specified by <i class="parameter"><tt>display</tt></i> in a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>. This
may fail if the window has been destroyed. For example in the X Window
System backend, a native window handle is an Xlib
<tt class="literal">XID</tt>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--get-default-root-window"></a><h3>gtk.gdk.get_default_root_window</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.get_default_root_window</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> the default root <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr></tbody></table><p>The <tt class="function">gtk.gdk.get_default_root_window</tt>()
function returns the root <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> (the
parent window that all other windows are inside) for the default display and
screen.</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-get-toplevels"></a><h3>gtk.gdk.window_get_toplevels</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_get_toplevels</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list containing the toplevel <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
object</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.window_get_toplevels</tt>() function
returns a list of all toplevel windows known to <tt class="literal">PyGTK</tt> on
the default screen. A toplevel window is a child of the root window (see the
<a href="class-gdkwindow.html#function-gdk--get-default-root-window" title="gtk.gdk.get_default_root_window">gtk.gdk.get_default_root_window</a>() 
function).</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-lookup"></a><h3>gtk.gdk.window_lookup</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_lookup</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>anid</tt></b>:</span></td><td>a native window system ID</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
wrapper for the native window or <tt class="literal">None</tt> if there is
none.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.window_lookup</tt>() function looks
up the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> that
wraps the native window handle specified by <i class="parameter"><tt>anid</tt></i>. For
example in the X Window System backend, a native window handle is an Xlib
<tt class="literal">XID</tt>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-lookup-for-display"></a><h3>gtk.gdk.window_lookup_for_display</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_lookup_for_display</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>anid</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>display</tt></b>:</span></td><td>a <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a></td></tr><tr><td><span class="term"><b class="parameter"><tt>anid</tt></b>:</span></td><td>a native window system ID</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
wrapper for the native window or <tt class="literal">None</tt> if there is
none.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <tt class="function">gtk.gdk.window_lookup_for_display</tt>()
function looks up the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> that
wraps the native window handle specified by <i class="parameter"><tt>anid</tt></i> for
the <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>
specified by <i class="parameter"><tt>display</tt></i>. For example in the X Window
System backend, a native window handle is an Xlib
<tt class="literal">XID</tt>.</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-process-all-updates"></a><h3>gtk.gdk.window_process_all_updates</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_process_all_updates</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="function">gtk.gdk.process_all_updates</tt>() function
calls the <a href="class-gdkwindow.html#method-gdkwindow--process-updates" title="gtk.gdk.Window.process_updates"><tt class="methodname">process_updates</tt>()</a> 
method for each <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> in
the application.</p></div><div class="refsect2" lang="en"><a name="function-gdk--gdk-window-set-debug-updates"></a><h3>gtk.gdk.gdk_window_set_debug_updates</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.gdk_window_set_debug_updates</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>setting</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> enable update
debugging</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.gdk_set_debug_updates</tt>() function
sets the update debugging flag to the value of
<i class="parameter"><tt>setting</tt></i>. If <i class="parameter"><tt>setting</tt></i> is
<tt class="literal">TRUE</tt>, update debugging is enabled. With update debugging
enabled, calls to the <a href="class-gdkwindow.html#method-gdkwindow--invalidate-rect" title="gtk.gdk.Window.invalidate_rect"><tt class="methodname">invalidate_rect</tt>()</a> 
method clear the invalidated rectangle of the screen to a noticeable color,
and <tt class="literal">PyGTK</tt> pauses for a short time before sending exposes
to windows during the <a href="class-gdkwindow.html#method-gdkwindow--process-updates" title="gtk.gdk.Window.process_updates"><tt class="methodname">process_updates</tt>()</a> 
method. The net effect is that you can see the invalid region for each
window and watch redraws as they occur. This allows you to diagnose
inefficiencies in your application.In essence, because the
<tt class="literal">GDK</tt> rendering model prevents all flicker, if you are
redrawing the same region 400 times you may never notice, aside from
noticing a speed problem. Enabling update debugging causes
<tt class="literal">PyGTK</tt> to flicker slowly and noticeably, so you can see
exactly what's being redrawn when, in what order.</p><p>The <tt class="option">--gtk-debug=updates</tt> command line option
passed to <tt class="literal">PyGTK</tt> programs enables this debug option at
application startup time. That's usually more useful than calling
<tt class="function">gtk.gdk.gdk_set_debug_updates</tt>() yourself, though you might
want to use this function to enable updates sometime after application
startup time.</p></div><div class="refsect2" lang="en"><a name="function-gdk--window-at-pointer"></a><h3>gtk.gdk.window_at_pointer</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.window_at_pointer</span>()</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 3 tuple containing the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
	  and the pointer location in the window or
	  <tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <tt class="function">gtk.gdk.window_at_pointer</tt>() function
returns a 3-tuple containing the <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
underneath the mouse pointer, and the location of the pointer in the
window. This function returns <tt class="literal">None</tt> if the window under
the mouse pointer is not known to GDK (if the window belongs to another
application and a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
hasn't been created for it with the <a href="class-gdkwindow.html#function-gdk--window-foreign-new" title="gtk.gdk.window_foreign_new"><tt class="function">gtk.gdk.window_foreign_new</tt>()</a>
function)</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>For multi-head-aware widgets or applications use the <a href="class-gdkdisplay.html#method-gdkdisplay--get-window-at-pointer" title="gtk.gdk.Display.get_window_at_pointer"><tt class="methodname">gtk.gdk.Display.get_window_at_pointer</tt>()</a>
method instead.</p></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gdkvisual.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gdk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="gdk-functions.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.gdk.Visual</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.gdk Functions</td></tr></table></div></body></html>