always adjust the frames size and position together, so there is no more weird resizi...
[mikachu/openbox.git] / doc / python / pointerdata.txt
1 PointerData
2
3 ----
4
5 This document describes the 'PointerData' class, passed to functions bound to
6 pointer events.
7
8 ----
9
10 Attributes
11
12 ----
13
14 action
15
16 The type of event. One of the input.Pointer.Action_* constants.
17
18 ----
19
20 button
21
22 The button (in the format that input.Pointer.bind() expects them) that caused
23 the event. This will be 'None' if there was no button associated with the
24 event. (This can only happen during a pointer grab.)
25
26 ----
27
28 context
29
30 A string containing the context of the event. See the Terminology section in
31 the Pointer documentation for a decription and list of common contexts.
32
33 ----
34
35 state
36
37 An integer bitmask of the modifiers pressed down when the event occured.
38
39 ----
40
41 buttonnum
42
43 An integer containing the number of the pointer button associated with the
44 event.
45
46 ----
47
48 pos
49
50 A tuple containing the current position of the cursor. The tuple has the format
51 (x, y). This is only valid when 'action' is 'Action_Motion'.
52
53 -----
54
55 presspos
56
57 A tuple containing the position of the cursor when the drag started. The tuple
58 has the format (x, y). This is only valid when 'action' is 'Action_Motion'.
59
60 ----
61
62 pressclientarea
63
64 A tuple containing the area of the client when the drag started. The tuple has
65 the format (x, y, width, height). This will be None if there is no client
66 associated with the event (during a pointer grab, or a drag on the root
67 window). This is only valid when 'action' is 'Action_Motion'.