1Tickit::Event(3pm)    User Contributed Perl Documentation   Tickit::Event(3pm)
2
3
4

NAME

6       "Tickit::Event" - event information structures
7

DESCRIPTION

9       When event handlers bound to Tickit::Term or Tickit::Window instances
10       are invoked they receive an object instance to contain information
11       about the event. Details of the event can be accessed as via accessor
12       methods on these instances.
13

ACCESSORS

15       The following methods are shared between "Tickit::Event::Key" and
16       "Tickit::Event::Mouse" instances.
17
18   mod_is_alt
19   mod_is_ctrl
20   mod_is_shift
21       Convenient shortcuts to tests on the "mod" bitmask to test if each of
22       the modifiers is set.
23

Tickit::Event::Expose

25   rb
26       The Tickit::RenderBuffer instance containing the buffer for this redraw
27       cycle.
28
29   rect
30       A Tickit::Rect instance containing the region of the window that needs
31       repainting.
32

Tickit::Event::Focus

34   type
35       This accessor has two forms of operation.
36
37       The new behaviour is that it returns a dualvar giving the focus event
38       type as an integer or a string event name ("in" or "out"). This
39       behaviour is selected if the method is invoked with any true value as
40       an argument.
41
42       The legacy behaviour is that it returns a simple boolean giving the
43       focus direction; 1 for in, 0 for out. This legacy behaviour will be
44       removed in a later version.
45
46   win
47       The child Tickit::Window instance for child-focus notify events.
48

Tickit::Event::Key

50   type
51       A dualvar giving the key event type as an integer or string event name
52       ("text" or "key").
53
54   str
55       A string containing the key event string.
56
57   mod
58       An integer bitmask indicating the modifier state.
59

Tickit::Event::Mouse

61   type
62       A dualvar giving the mouse event type as an integer or string event
63       name ("press", "drag", "release" or "wheel").
64
65   button
66       An integer for non-wheel events or a dualvar for wheel events giving
67       the wheel direction ("up" or "down").
68
69   line
70   col
71       Integers giving the mouse position.
72
73   mod
74       An integer bitmask indicating the modifier state.
75

Tickit::Event::Resize

77   lines
78   cols
79       Integers giving the new size.
80

AUTHOR

82       Paul Evans <leonerd@leonerd.org.uk>
83
84
85
86perl v5.38.0                      2023-07-21                Tickit::Event(3pm)