1wxEvent(3) Erlang Module Definition wxEvent(3)
2
3
4
6 wxEvent - Functions for wxEvent class
7
9 An event is a structure holding information about an event passed to a
10 callback or member function.
11
12 wxEvent used to be a multipurpose event object, and is an abstract base
13 class for other event classes (see below).
14
15 For more information about events, see the overview_events overview.
16
17 See: wxCommandEvent, wxMouseEvent
18
19 wxWidgets docs: wxEvent
20
22 wxEvent() = wx:wx_object()
23
25 getId(This) -> integer()
26
27 Types:
28
29 This = wxEvent()
30
31 Returns the identifier associated with this event, such as a
32 button command id.
33
34 getSkipped(This) -> boolean()
35
36 Types:
37
38 This = wxEvent()
39
40 Returns true if the event handler should be skipped, false oth‐
41 erwise.
42
43 getTimestamp(This) -> integer()
44
45 Types:
46
47 This = wxEvent()
48
49 Gets the timestamp for the event.
50
51 The timestamp is the time in milliseconds since some fixed mo‐
52 ment (not necessarily the standard Unix Epoch, so only differ‐
53 ences between the timestamps and not their absolute values usu‐
54 ally make sense).
55
56 Warning: wxWidgets returns a non-NULL timestamp only for mouse
57 and key events (see wxMouseEvent and wxKeyEvent).
58
59 isCommandEvent(This) -> boolean()
60
61 Types:
62
63 This = wxEvent()
64
65 Returns true if the event is or is derived from wxCommandEvent
66 else it returns false.
67
68 Note: exists only for optimization purposes.
69
70 resumePropagation(This, PropagationLevel) -> ok
71
72 Types:
73
74 This = wxEvent()
75 PropagationLevel = integer()
76
77 Sets the propagation level to the given value (for example re‐
78 turned from an earlier call to stopPropagation/1).
79
80 shouldPropagate(This) -> boolean()
81
82 Types:
83
84 This = wxEvent()
85
86 Test if this event should be propagated or not, i.e. if the
87 propagation level is currently greater than 0.
88
89 skip(This) -> ok
90
91 Types:
92
93 This = wxEvent()
94
95 skip(This, Options :: [Option]) -> ok
96
97 Types:
98
99 This = wxEvent()
100 Option = {skip, boolean()}
101
102 This method can be used inside an event handler to control
103 whether further event handlers bound to this event will be
104 called after the current one returns.
105
106 Without skip/2 (or equivalently if Skip(false) is used), the
107 event will not be processed any more. If Skip(true) is called,
108 the event processing system continues searching for a further
109 handler function for this event, even though it has been pro‐
110 cessed already in the current handler.
111
112 In general, it is recommended to skip all non-command events to
113 allow the default handling to take place. The command events
114 are, however, normally not skipped as usually a single command
115 such as a button click or menu item selection must only be pro‐
116 cessed by one handler.
117
118 stopPropagation(This) -> integer()
119
120 Types:
121
122 This = wxEvent()
123
124 Stop the event from propagating to its parent window.
125
126 Returns the old propagation level value which may be later
127 passed to resumePropagation/2 to allow propagating the event
128 again.
129
130
131
132wxWidgets team. wx 2.2.2 wxEvent(3)