-
Notifications
You must be signed in to change notification settings - Fork 1
/
python-xlib_12.html
954 lines (796 loc) · 35.4 KB
/
python-xlib_12.html
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
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created on September 16, 2020 by texi2html 5.0
texi2html was written by:
Lionel Cons <[email protected]> (original author)
Karl Berry <[email protected]>
Olaf Bachmann <[email protected]>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <[email protected]>
-->
<head>
<title>The Python X Library: 5.3 Event Types</title>
<meta name="description" content="The Python X Library: 5.3 Event Types">
<meta name="keywords" content="The Python X Library: 5.3 Event Types">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 5.0">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:pre}
span.nolinebreak {white-space:pre}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Event-Types"></a>
<table class="header" cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="python-xlib_9.html#Event-Handling" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_11.html#Selecting-Events" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_9.html#Event-Handling" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_13.html#Sending-Events" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_14.html#X-Objects" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="python-xlib.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="python-xlib_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<hr>
<a name="Event-Types-1"></a>
<h2 class="section">5.3 Event Types</h2>
<p>This section describes all event types by listing their fields and basic
information on when they are generated. All events are defined in the
module <code>Xlib.protocol.event</code>. All event types have the following
two attributes:
</p>
<dl>
<dt><a name="index-type"></a>Instance Variable of Event: <strong>type</strong></dt>
<dd>
<p>Stores the X type code of this event. Type codes are integers in the
range 2-127, and are defined with symbolic names in <code>Xlib.X</code>. The
symbolic names are the same as the event class names, except for the
special event <code>AnyEvent</code>.
</p>
</dd></dl>
<dl>
<dt><a name="index-send_005fevent"></a>Instance Variable of Event: <strong>send_event</strong></dt>
<dd>
<p>This attribute is normally 0, meaning that the event was generated by
the X server. It is set to 1 if this event was instead sent from
another client.
</p>
</dd></dl>
<p>Event object can be created by instantiating the corresponding event
class, providing all the attributes described for the event as keyword
arguments.
</p>
<dl>
<dt><a name="index-KeyPress"></a>Event: <strong>KeyPress</strong></dt>
<dt><a name="index-KeyRelease"></a>Event: <strong>KeyRelease</strong></dt>
<dt><a name="index-ButtonPress"></a>Event: <strong>ButtonPress</strong></dt>
<dt><a name="index-ButtonRelease"></a>Event: <strong>ButtonRelease</strong></dt>
<dt><a name="index-MotionNotify"></a>Event: <strong>MotionNotify</strong></dt>
<dd>
<p>These events are generated when a key or a button logically changes
state, or when the pointer logically moves. In the discussion below,
the <em>source window</em> is the window that the event occured in. The
event may be generated on some other window than the source window, see
XKeyEvent(3X11) for details. The same man page also describes
<code>MotionNotify</code>.
</p>
<dl>
<dt><a name="index-time"></a>Instance Variable of KeyButtonPointerEvent: <strong>time</strong></dt>
<dd><p>The server X time when this event was generated.
</p></dd></dl>
<dl>
<dt><a name="index-root"></a>Instance Variable of KeyButtonPointerEvent: <strong>root</strong></dt>
<dd><p>The root window which the source window is an inferior of.
</p></dd></dl>
<dl>
<dt><a name="index-window"></a>Instance Variable of KeyButtonPointerEvent: <strong>window</strong></dt>
<dd><p>The window the event is reported on.
</p></dd></dl>
<dl>
<dt><a name="index-same_005fscreen"></a>Instance Variable of KeyButtonPointerEvent: <strong>same_screen</strong></dt>
<dd><p>Set to 1 if <code>window</code> is on the same screen as <code>root</code>, 0
otherwise.
</p></dd></dl>
<dl>
<dt><a name="index-child"></a>Instance Variable of KeyButtonPointerEvent: <strong>child</strong></dt>
<dd><p>If the source window is an inferior of <code>window</code>, <code>child</code> is
set to the child of <code>window</code> that is the ancestor of (or is) the
source window. Otherwise it is set to <code>X.NONE</code>.
</p></dd></dl>
<dl>
<dt><a name="index-root_005fx"></a>Instance Variable of KeyButtonPointerEvent: <strong>root_x</strong></dt>
<dt><a name="index-root_005fy"></a>Instance Variable of KeyButtonPointerEvent: <strong>root_y</strong></dt>
<dd><p>The pointer coordinates at the time of the event, relative to the root
window.
</p></dd></dl>
<dl>
<dt><a name="index-event_005fx"></a>Instance Variable of KeyButtonPointerEvent: <strong>event_x</strong></dt>
<dt><a name="index-event_005fy"></a>Instance Variable of KeyButtonPointerEvent: <strong>event_y</strong></dt>
<dd><p>The pointer coordinates at the time of the event, relative to
<code>window</code>. If <code>window</code> is not on the same screen as
<code>root</code>, these are set to 0.
</p></dd></dl>
<dl>
<dt><a name="index-state"></a>Instance Variable of KeyButtonPointerEvent: <strong>state</strong></dt>
<dd><p>The logical state of the button and modifier keys just before the event.
</p></dd></dl>
<dl>
<dt><a name="index-detail"></a>Instance Variable of KeyButtonPointerEvent: <strong>detail</strong></dt>
<dd><p>For <code>KeyPress</code> and <code>KeyRelease</code>, this is the keycode of the
event key.
</p>
<p>For <code>ButtonPress</code> and <code>ButtonRelease</code>, this is the button of
the event.
</p>
<p>For <code>MotionNotify</code>, this is either <code>X.NotifyNormal</code> or
<code>X.NotifyHint</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-EnterNotify"></a>Event: <strong>EnterNotify</strong></dt>
<dt><a name="index-LeaveNotify"></a>Event: <strong>LeaveNotify</strong></dt>
<dd>
<p>If pointer motion or window hierarchy change causes the pointer to be in
another window than before, these events are generated instead of
a <code>MotionNotify</code> event.
</p>
<p>The semantics are quite complex, see XCrossingEvent(3X11) for details.
</p>
<dl>
<dt><a name="index-time-1"></a>Instance Variable of EnterLeaveEvent: <strong>time</strong></dt>
<dd><p>The server X time when this event was generated.
</p></dd></dl>
<dl>
<dt><a name="index-root-1"></a>Instance Variable of EnterLeaveEvent: <strong>root</strong></dt>
<dd><p>The root window of the pointer at the end of this event.
</p></dd></dl>
<dl>
<dt><a name="index-window-1"></a>Instance Variable of EnterLeaveEvent: <strong>window</strong></dt>
<dd><p>The window the event is reported for.
</p></dd></dl>
<dl>
<dt><a name="index-child-1"></a>Instance Variable of EnterLeaveEvent: <strong>child</strong></dt>
<dd><p>In a <code>LeaveNotify</code> event, if a child of <code>window</code> contains the
initial pointer position, this is set to that child window.
In a <code>EnterNotify</code> event, if a child of <code>window</code> contains the
final pointer position, this is set to that child window.
Otherwise this is set to <code>X.NONE</code>.
</p></dd></dl>
<dl>
<dt><a name="index-root_005fx-1"></a>Instance Variable of EnterLeaveEvent: <strong>root_x</strong></dt>
<dt><a name="index-root_005fy-1"></a>Instance Variable of EnterLeaveEvent: <strong>root_y</strong></dt>
<dd><p>The final pointer position relative to <code>root</code>.
</p></dd></dl>
<dl>
<dt><a name="index-event_005fx-1"></a>Instance Variable of EnterLeaveEvent: <strong>event_x</strong></dt>
<dt><a name="index-event_005fy-1"></a>Instance Variable of EnterLeaveEvent: <strong>event_y</strong></dt>
<dd><p>The final pointer position relative to <code>window</code>.
</p></dd></dl>
<dl>
<dt><a name="index-state-1"></a>Instance Variable of EnterLeaveEvent: <strong>state</strong></dt>
<dd><p>The modifier and button state at the time of the event.
</p></dd></dl>
<dl>
<dt><a name="index-mode"></a>Instance Variable of EnterLeaveEvent: <strong>mode</strong></dt>
<dd><p>One of <code>X.NotifyNormal</code>, <code>X.NotifyGrab</code> or
<code>X.NotifyUngrab</code>.
</p></dd></dl>
<dl>
<dt><a name="index-detail-1"></a>Instance Variable of EnterLeaveEvent: <strong>detail</strong></dt>
<dd><p>One of <code>X.NotifyAncestor</code>, <code>X.NotifyVirtual</code>,
<code>X.NotifyInferior</code>, <code>X.NotifyNonlinear</code>, or
<code>X.NotifyNonlinearVirtual</code>.
</p></dd></dl>
<dl>
<dt><a name="index-flags"></a>Instance Variable of EnterLeaveEvent: <strong>flags</strong></dt>
<dd><p>If bit 0 is set, <code>window</code> is the focus window or an inferior of it.
If bit 1 is set, <code>window</code> is on the same screen as <code>root</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-FocusIn"></a>Event: <strong>FocusIn</strong></dt>
<dt><a name="index-FocusOut"></a>Event: <strong>FocusOut</strong></dt>
<dd>
<p>These events are generated when the focus changes. This is also very
complex events, see XFocusChangeEvent(3X11) for details.
</p>
<dl>
<dt><a name="index-window-2"></a>Instance Variable of FocusEvent: <strong>window</strong></dt>
<dd><p>The window the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-mode-1"></a>Instance Variable of FocusEvent: <strong>mode</strong></dt>
<dd><p>One of <code>X.NotifyNormal</code>, <code>X.NotifyWhileGrabbed</code>,
<code>X.NotifyGrab</code>, or <code>X.NotifyUngrab</code>.
</p></dd></dl>
<dl>
<dt><a name="index-detail-2"></a>Instance Variable of FocusEvent: <strong>detail</strong></dt>
<dd><p>One of <code>X.NotifyAncestor</code>, <code>X.NotifyVirtual</code>,
<code>X.NotifyInferior</code>, <code>X.NotifyNonlinear</code>,
<code>X.NotifyNonlinearVirtual</code>, <code>X.NotifyPointer</code>,
<code>X.NotifyPointerRoot</code>, or <code>X.NONE</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-KeymapNotify"></a>Event: <strong>KeymapNotify</strong></dt>
<dd>
<p>This event is generated immediately after every <code>EnterNotify</code> and
<code>FocusIn</code>.
</p>
<dl>
<dt><a name="index-data"></a>Instance Variable of KeymapNotify: <strong>data</strong></dt>
<dd><p>A list of 31 eight-bit integers, as returned by query_keymap.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-Expose"></a>Event: <strong>Expose</strong></dt>
<dd>
<p>This event is generated when regions of a window has to be redrawn. The
regions are decomposed into a set of rectangles, and an <code>Expose</code>
event is generated for each rectangle.
</p>
<dl>
<dt><a name="index-window-3"></a>Instance Variable of Expose: <strong>window</strong></dt>
<dd><p>The window containing regions to redraw.
</p></dd></dl>
<dl>
<dt><a name="index-x"></a>Instance Variable of Expose: <strong>x</strong></dt>
<dt><a name="index-y"></a>Instance Variable of Expose: <strong>y</strong></dt>
<dt><a name="index-width"></a>Instance Variable of Expose: <strong>width</strong></dt>
<dt><a name="index-height"></a>Instance Variable of Expose: <strong>height</strong></dt>
<dd><p>The coordinates of the rectangle to redraw.
</p></dd></dl>
<dl>
<dt><a name="index-count"></a>Instance Variable of Expose: <strong>count</strong></dt>
<dd><p>At least this many more <code>Expose</code> events will immediately follow for
this window. If this is the last event, <code>count</code> is set to 0.
</p>
<p>This allows a simple application to ignore all <code>Expose</code> events
with a non-zero <code>count</code>, and then redraw the entire window when the
zero event is received.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-GraphicsExpose"></a>Event: <strong>GraphicsExpose</strong></dt>
<dt><a name="index-NoExpose"></a>Event: <strong>NoExpose</strong></dt>
<dd>
<p>These events may be generated for drawables when a graphics context with
<code>graphics_exposures</code> selected is used. See
XGraphicsExposeEvent(3X11) for details.
</p>
<p>Both events have these attributes:
</p>
<dl>
<dt><a name="index-drawable"></a>Instance Variable of GraphicsExpose: <strong>drawable</strong></dt>
<dd><p>The drawable of the event.
</p></dd></dl>
<dl>
<dt><a name="index-major_005fevent"></a>Instance Variable of GraphicsExpose: <strong>major_event</strong></dt>
<dt><a name="index-minor_005fevent"></a>Instance Variable of GraphicsExpose: <strong>minor_event</strong></dt>
<dd><p>The major and minor number of the request that generated this event.
For the core protocol <code>major_event</code> is always 62 (CopyArea) or 63
(CopyPlane), and <code>minor_event</code> is always 0.
</p></dd></dl>
<p>GraphicsExpose have these additional attributes:
</p>
<dl>
<dt><a name="index-x-1"></a>Instance Variable of GraphicsExpose: <strong>x</strong></dt>
<dt><a name="index-y-1"></a>Instance Variable of GraphicsExpose: <strong>y</strong></dt>
<dt><a name="index-width-1"></a>Instance Variable of GraphicsExpose: <strong>width</strong></dt>
<dt><a name="index-height-1"></a>Instance Variable of GraphicsExpose: <strong>height</strong></dt>
<dd><p>The coordinates of the event region.
</p></dd></dl>
<dl>
<dt><a name="index-count-1"></a>Instance Variable of GraphicsExpose: <strong>count</strong></dt>
<dd><p>At least this many more <code>GraphicsExposure</code> events follows. The
last one has <code>count</code> set to 0.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-VisibilityNotify"></a>Event: <strong>VisibilityNotify</strong></dt>
<dd>
<p>These events are generated when the visibility of a viewable window is
changed. See XVisibilityNotifyEvent(3X11).
</p>
<dl>
<dt><a name="index-window-4"></a>Instance Variable of VisibiltyNotify: <strong>window</strong></dt>
<dd><p>The window of the event.
</p></dd></dl>
<dl>
<dt><a name="index-state-2"></a>Instance Variable of VisibiltyNotify: <strong>state</strong></dt>
<dd><p>One of <code>X.VisibilityUnobscured</code>,
<code>X.VisibilityPartiallyObscured</code>, or <code>X.VisibilityFullyObscured</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-CreateNotify"></a>Event: <strong>CreateNotify</strong></dt>
<dd>
<p>This event is generated when a window is created.
<code>X.SubstructureNotifyMask</code> must be selected on the parent of the
new window to receive this event.
</p>
<dl>
<dt><a name="index-parent"></a>Instance Variable of CreateNotify: <strong>parent</strong></dt>
<dd><p>The parent of the new window.
</p></dd></dl>
<dl>
<dt><a name="index-window-5"></a>Instance Variable of CreateNotify: <strong>window</strong></dt>
<dd><p>The new window.
</p></dd></dl>
<dl>
<dt><a name="index-x-2"></a>Instance Variable of CreateNotify: <strong>x</strong></dt>
<dt><a name="index-y-2"></a>Instance Variable of CreateNotify: <strong>y</strong></dt>
<dt><a name="index-width-2"></a>Instance Variable of CreateNotify: <strong>width</strong></dt>
<dt><a name="index-height-2"></a>Instance Variable of CreateNotify: <strong>height</strong></dt>
<dt><a name="index-border_005fwidth"></a>Instance Variable of CreateNotify: <strong>border_width</strong></dt>
<dt><a name="index-override"></a>Instance Variable of CreateNotify: <strong>override</strong></dt>
<dd><p>These values are fetched from the <code>create_window</code> call.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-DestroyNotify"></a>Event: <strong>DestroyNotify</strong></dt>
<dd>
<p>This event is generated when a window is destroyed.
</p>
<dl>
<dt><a name="index-event"></a>Instance Variable of DestroyNotify: <strong>event</strong></dt>
<dd><p>The window that the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-6"></a>Instance Variable of DestroyNotify: <strong>window</strong></dt>
<dd><p>The window that was destroyed.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-UnmapNotify"></a>Event: <strong>UnmapNotify</strong></dt>
<dd>
<p>This event is generated when a window is unmapped.
</p>
<dl>
<dt><a name="index-event-1"></a>Instance Variable of UnmapNotify: <strong>event</strong></dt>
<dd><p>The window that the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-7"></a>Instance Variable of UnmapNotify: <strong>window</strong></dt>
<dd><p>The window that was unmapped.
</p></dd></dl>
<dl>
<dt><a name="index-from_005fconfigure"></a>Instance Variable of Event: <strong>from_configure</strong></dt>
<dd><p>This is true if <code>window</code> was unmapped because its parent was
resized and <code>window</code> had win-gravity <code>X.UnmapGravity</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-MapNotify"></a>Event: <strong>MapNotify</strong></dt>
<dd>
<p>This event is generated when a window is mapped.
</p>
<dl>
<dt><a name="index-event-2"></a>Instance Variable of MapNotify: <strong>event</strong></dt>
<dd><p>The window that the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-8"></a>Instance Variable of MapNotify: <strong>window</strong></dt>
<dd><p>The window that was mapped.
</p></dd></dl>
<dl>
<dt><a name="index-override-1"></a>Instance Variable of Event: <strong>override</strong></dt>
<dd><p>This is set from the corresponding window attribute.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-MapRequest"></a>Event: <strong>MapRequest</strong></dt>
<dd>
<p>This event is reported to the client that has set
<code>X.SubstructureRedirectMask</code> on a window, and an unmapped child of
that window attempts to be mapped by some other client, unless the child
has override-redirect set.
</p>
<dl>
<dt><a name="index-parent-1"></a>Instance Variable of MapRequest: <strong>parent</strong></dt>
<dd><p>The parent window.
</p></dd></dl>
<dl>
<dt><a name="index-window-9"></a>Instance Variable of MapRequest: <strong>window</strong></dt>
<dd><p>The child window that attempts to be mapped.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ReparentNotify"></a>Event: <strong>ReparentNotify</strong></dt>
<dd>
<p>This event is reported to clients selecting
<code>X.SubstructureNotifyMask</code> on either the old or the new parent and
to clients selecting <code>X.StructureNotifyMask</code> on the reparented
window.
</p>
<dl>
<dt><a name="index-event-3"></a>Instance Variable of ReparentNotify: <strong>event</strong></dt>
<dd><p>The window the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-10"></a>Instance Variable of ReparentNotify: <strong>window</strong></dt>
<dd><p>The reparented window.
</p></dd></dl>
<dl>
<dt><a name="index-parent-2"></a>Instance Variable of ReparentNotify: <strong>parent</strong></dt>
<dd><p>The new parent window.
</p></dd></dl>
<dl>
<dt><a name="index-x-3"></a>Instance Variable of ReparentNotify: <strong>x</strong></dt>
<dt><a name="index-y-3"></a>Instance Variable of ReparentNotify: <strong>y</strong></dt>
<dd><p>The coordinates of the upper-left outer corner of <code>window</code> in
<code>parent</code>.
</p></dd></dl>
<dl>
<dt><a name="index-override-2"></a>Instance Variable of ReparentNotify: <strong>override</strong></dt>
<dd><p>This is set from the corresponding attribute on <code>window</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ConfigureNotify"></a>Event: <strong>ConfigureNotify</strong></dt>
<dd>
<p>This event is generated when a configure request actually changes the
state of the window.
</p>
<dl>
<dt><a name="index-event-4"></a>Instance Variable of ConfigureNotify: <strong>event</strong></dt>
<dd><p>The window that the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-11"></a>Instance Variable of ConfigureNotify: <strong>window</strong></dt>
<dd><p>The window that has been changed.
</p></dd></dl>
<dl>
<dt><a name="index-x-4"></a>Instance Variable of ConfigureNotify: <strong>x</strong></dt>
<dt><a name="index-y-4"></a>Instance Variable of ConfigureNotify: <strong>y</strong></dt>
<dt><a name="index-width-3"></a>Instance Variable of ConfigureNotify: <strong>width</strong></dt>
<dt><a name="index-height-3"></a>Instance Variable of ConfigureNotify: <strong>height</strong></dt>
<dt><a name="index-border_005fwidth-1"></a>Instance Variable of ConfigureNotify: <strong>border_width</strong></dt>
<dd><p>The new coordinate and geometry of <code>window</code>.
</p></dd></dl>
<dl>
<dt><a name="index-above_005fsibling"></a>Instance Variable of ConfigureNotify: <strong>above_sibling</strong></dt>
<dd><p>This is <code>X.NONE</code> if this window is at the bottom of the window
stack. Otherwise it is the sibling window that <code>window</code> is
immediately above.
</p></dd></dl>
<dl>
<dt><a name="index-override-3"></a>Instance Variable of ConfigureNotify: <strong>override</strong></dt>
<dd><p>This is set from the corresponding attribute on <code>window</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ConfigureRequest"></a>Event: <strong>ConfigureRequest</strong></dt>
<dd>
<p>This event is reported to the client that has set
<code>X.SubstructureRedirectMask</code> on the parent of a window that another
client attempts to configure, unless the window has override-redirect
set.
</p>
<dl>
<dt><a name="index-parent-3"></a>Instance Variable of ConfigureRequest: <strong>parent</strong></dt>
<dd><p>The parent of the window being configured.
</p></dd></dl>
<dl>
<dt><a name="index-window-12"></a>Instance Variable of ConfigureRequest: <strong>window</strong></dt>
<dd><p>The window being configured.
</p></dd></dl>
<dl>
<dt><a name="index-value_005fmask"></a>Instance Variable of ConfigureRequest: <strong>value_mask</strong></dt>
<dd><p>A bitmask indicating which values that the caller tries to change.
</p></dd></dl>
<dl>
<dt><a name="index-x-5"></a>Instance Variable of ConfigureRequest: <strong>x</strong></dt>
<dt><a name="index-y-5"></a>Instance Variable of ConfigureRequest: <strong>y</strong></dt>
<dt><a name="index-width-4"></a>Instance Variable of ConfigureRequest: <strong>width</strong></dt>
<dt><a name="index-height-4"></a>Instance Variable of ConfigureRequest: <strong>height</strong></dt>
<dt><a name="index-border_005fwidth-2"></a>Instance Variable of ConfigureRequest: <strong>border_width</strong></dt>
<dd><p>The window geometry in the configure call. If <code>X.CWX</code>,
<code>X.CWY</code>, <code>X.CWWidth</code>, <code>X.CWHeight</code>, or
<code>X.CWBorderWidth</code> is set in <code>value_mask</code>, the corresponding
attributes contains the new value as given in the configure call,
otherwise the current value is used.
</p></dd></dl>
<dl>
<dt><a name="index-stack_005fmode"></a>Instance Variable of ConfigureRequest: <strong>stack_mode</strong></dt>
<dd><p>If <code>X.CWStackMode</code> is set in <code>value_mask</code>, this is the stack
mode specified in the configure call, one of <code>X.Above</code>,
<code>X.Below</code>, <code>X.TopIf</code>, <code>X.BottomIf</code>, or
<code>X.Opposite</code>. If the flag is not set, this is set to
<code>X.Above</code>.
</p></dd></dl>
<dl>
<dt><a name="index-sibling"></a>Instance Variable of ConfigureRequest: <strong>sibling</strong></dt>
<dd><p>If <code>X.CWSibling</code> is set in <code>value_mask</code>, this is the sibling
window specified in the configure call. If the flag is not set, this is
set to <code>X.NONE</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-GravityNotify"></a>Event: <strong>GravityNotify</strong></dt>
<dd>
<p>This event is generated when a window is moved because its parent’s size
has changed.
</p>
<dl>
<dt><a name="index-event-5"></a>Instance Variable of GravityNotify: <strong>event</strong></dt>
<dd><p>The window the event is generated for.
</p></dd></dl>
<dl>
<dt><a name="index-window-13"></a>Instance Variable of GravityNotify: <strong>window</strong></dt>
<dd><p>The window that moved.
</p></dd></dl>
<dl>
<dt><a name="index-x-6"></a>Instance Variable of GravityNotify: <strong>x</strong></dt>
<dt><a name="index-y-6"></a>Instance Variable of GravityNotify: <strong>y</strong></dt>
<dd><p>The new coordinates of the upper-left outer corner of <code>window</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ResizeRequest"></a>Event: <strong>ResizeRequest</strong></dt>
<dd>
<p>This is reported to the client selecting <code>X.ResizeRedirectMask</code> on
a window, and another client attempts to resize it.
</p>
<dl>
<dt><a name="index-window-14"></a>Instance Variable of ResizeRedirect: <strong>window</strong></dt>
<dd><p>The window that was attempted to be resized.
</p></dd></dl>
<dl>
<dt><a name="index-width-5"></a>Instance Variable of ResizeRedirect: <strong>width</strong></dt>
<dt><a name="index-height-5"></a>Instance Variable of ResizeRedirect: <strong>height</strong></dt>
<dd><p>The requested size of the window, excluding the border.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-CirculateNotify"></a>Event: <strong>CirculateNotify</strong></dt>
<dd>
<p>This event is generated when a window is restacked caused by a circulate
call.
</p>
<dl>
<dt><a name="index-event-6"></a>Instance Variable of Event: <strong>event</strong></dt>
<dd><p>The window the event is reported on.
</p></dd></dl>
<dl>
<dt><a name="index-window-15"></a>Instance Variable of Event: <strong>window</strong></dt>
<dd><p>The window that has been restacked.
</p></dd></dl>
<dl>
<dt><a name="index-place"></a>Instance Variable of Event: <strong>place</strong></dt>
<dd><p>Either <code>X.PlaceOnTop</code> or <code>X.PlaceOnBottom</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-CirculateRequest"></a>Event: <strong>CirculateRequest</strong></dt>
<dd>
<p>This event is reported to the client that has set
<code>X.SubstructureRedirectMask</code> on the parent of a window that needs
to be restacked as a result of a circulate call on the parent.
</p>
<dl>
<dt><a name="index-parent-4"></a>Instance Variable of CirculateRequest: <strong>parent</strong></dt>
<dd><p>The parent window.
</p></dd></dl>
<dl>
<dt><a name="index-window-16"></a>Instance Variable of CirculateRequest: <strong>window</strong></dt>
<dd><p>The window that should be restacked.
</p></dd></dl>
<dl>
<dt><a name="index-place-1"></a>Instance Variable of CirculateRequest: <strong>place</strong></dt>
<dd><p>Where <code>window</code> should be placed, either <code>X.PlaceOnTop</code> or
<code>X.PlaceOnBottom</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-PropertyNotify"></a>Event: <strong>PropertyNotify</strong></dt>
<dd>
<p>This event is generated when a property on a window is changed.
</p>
<dl>
<dt><a name="index-window-17"></a>Instance Variable of Event: <strong>window</strong></dt>
<dd><p>The window which the property is or was set on.
</p></dd></dl>
<dl>
<dt><a name="index-atom"></a>Instance Variable of Event: <strong>atom</strong></dt>
<dd><p>The atom identifying the property.
</p></dd></dl>
<dl>
<dt><a name="index-time-2"></a>Instance Variable of Event: <strong>time</strong></dt>
<dd><p>The server X time when the property was changed.
</p></dd></dl>
<dl>
<dt><a name="index-state-3"></a>Instance Variable of Event: <strong>state</strong></dt>
<dd><p>What was changed, either <code>X.PropertyNewValue</code> or
<code>X.PropertyDelete</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-SelectionClear"></a>Event: <strong>SelectionClear</strong></dt>
<dd>
<p>This event is reported to the owner of a selection when it has gotten a
new owner.
</p>
<dl>
<dt><a name="index-window-18"></a>Instance Variable of SelectionClear: <strong>window</strong></dt>
<dd><p>The owner window of the selection.
</p></dd></dl>
<dl>
<dt><a name="index-atom-1"></a>Instance Variable of SelectionClear: <strong>atom</strong></dt>
<dd><p>The selection atom.
</p></dd></dl>
<dl>
<dt><a name="index-time-3"></a>Instance Variable of SelectionClear: <strong>time</strong></dt>
<dd><p>The server X time when the selection was last changed.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-SelectionRequest"></a>Event: <strong>SelectionRequest</strong></dt>
<dd>
<p>This event is reported to the owner of a selection when a client
requests it by calling convert_selection.
</p>
<dl>
<dt><a name="index-owner"></a>Instance Variable of SelectionRequest: <strong>owner</strong></dt>
<dd><p>The owner window of the selection.
</p></dd></dl>
<dl>
<dt><a name="index-requestor"></a>Instance Variable of SelectionRequest: <strong>requestor</strong></dt>
<dt><a name="index-selection"></a>Instance Variable of SelectionRequest: <strong>selection</strong></dt>
<dt><a name="index-target"></a>Instance Variable of SelectionRequest: <strong>target</strong></dt>
<dt><a name="index-property"></a>Instance Variable of SelectionRequest: <strong>property</strong></dt>
<dt><a name="index-time-4"></a>Instance Variable of SelectionRequest: <strong>time</strong></dt>
<dd><p>These attributes are fetched from the convert_selection call.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-SelectionNotify"></a>Event: <strong>SelectionNotify</strong></dt>
<dd>
<p>This event is generated by the server if there are no owner of a
selection when convert_selection is called. If there is an owner, it
should send this event to the requestor when the selection has been
converted.
</p>
<dl>
<dt><a name="index-requestor-1"></a>Instance Variable of SelectionNotify: <strong>requestor</strong></dt>
<dt><a name="index-selection-1"></a>Instance Variable of SelectionNotify: <strong>selection</strong></dt>
<dt><a name="index-target-1"></a>Instance Variable of SelectionNotify: <strong>target</strong></dt>
<dt><a name="index-property-1"></a>Instance Variable of SelectionNotify: <strong>property</strong></dt>
<dt><a name="index-time-5"></a>Instance Variable of SelectionNotify: <strong>time</strong></dt>
<dd><p>See XSelectionEvent(3X11).
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ColormapNotify"></a>Event: <strong>ColormapNotify</strong></dt>
<dd>
<p>This event is generated when the colormap attribute of a window is set,
or when a window’s colormap is installed or uninstalled.
</p>
<dl>
<dt><a name="index-window-19"></a>Instance Variable of ColormapNotify: <strong>window</strong></dt>
<dd><p>The affected window.
</p></dd></dl>
<dl>
<dt><a name="index-colormap"></a>Instance Variable of ColormapNotify: <strong>colormap</strong></dt>
<dd><p>The colormap of the window, or <code>X.NONE</code>.
</p></dd></dl>
<dl>
<dt><a name="index-new"></a>Instance Variable of ColormapNotify: <strong>new</strong></dt>
<dd><p>Set to 1 if the colormap attribute has been set, 0 when the
colormap is installed or uninstalled.
</p></dd></dl>
<dl>
<dt><a name="index-state-4"></a>Instance Variable of ColormapNotify: <strong>state</strong></dt>
<dd><p>Indicates whether the colormap is installed or not, either
<code>X.ColormapInstalled</code> or <code>X.ColormapUninstalled</code>.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-MappingNotify"></a>Event: <strong>MappingNotify</strong></dt>
<dd>
<p>This event is sent to all clients, without any event mask having to be
set. It is sent when the keyboard or pointer mapping is changed.
</p>
<dl>
<dt><a name="index-request"></a>Instance Variable of MappingNotify: <strong>request</strong></dt>
<dd><p>The mapping that has changed, one of <code>X.MappingModifier</code>,
<code>X.MappingKeyboard</code> or <code>X.Pointer</code>.
</p></dd></dl>
<dl>
<dt><a name="index-first_005fkeycode"></a>Instance Variable of MappingNotify: <strong>first_keycode</strong></dt>
<dt><a name="index-count-2"></a>Instance Variable of MappingNotify: <strong>count</strong></dt>
<dd><p>If the keyboard mapping has changed, this is the range of modified
keycodes.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-ClientMessage"></a>Event: <strong>ClientMessage</strong></dt>
<dd>
<p>This event is only generated by clients using send_event.
</p>
<dl>
<dt><a name="index-window-20"></a>Instance Variable of ClientMessage: <strong>window</strong></dt>
<dd><p>The destination window of the event.
</p></dd></dl>
<dl>
<dt><a name="index-client_005ftype"></a>Instance Variable of ClientMessage: <strong>client_type</strong></dt>
<dd><p>The type of message, an atom.
</p></dd></dl>
<dl>
<dt><a name="index-data-1"></a>Instance Variable of ClientMessage: <strong>data</strong></dt>
<dd><p>The message data as a tuple: <code>(format, mdata)</code>
</p>
<p>Format must be one of 8, 16, or 32. mdata must either be a string of
exactly 20 characters, or a list of exactly 20, 10 or 5 integers
depending of the format.
</p></dd></dl>
</dd></dl>
<dl>
<dt><a name="index-AnyEvent"></a>Event: <strong>AnyEvent</strong></dt>
<dd>
<p>This event is represents an event the Xlib does not recognise. These
should never be returned by <code>Display.next_event()</code>, but they might
be useful for sending special events to other clients.
</p>
<dl>
<dt><a name="index-detail-3"></a>Instance Variable of AnyEvent: <strong>detail</strong></dt>
<dd><p>An eight-bit integer.
</p></dd></dl>
<dl>
<dt><a name="index-data-2"></a>Instance Variable of AnyEvent: <strong>data</strong></dt>
<dd><p>A string of exactly 28 characters.
</p></dd></dl>
</dd></dl>
<hr>
<table class="header" cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="python-xlib_9.html#Event-Handling" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_11.html#Selecting-Events" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_9.html#Event-Handling" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_13.html#Sending-Events" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_14.html#X-Objects" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="python-xlib.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="python-xlib_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[Index]</td>
<td valign="middle" align="left">[<a href="python-xlib_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
<font size="-1">
This document was generated on <i>September 16, 2020</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 5.0</i></a>.
</font>
<br>
</p>
</body>
</html>