wxEvent - Functions for wxEvent class
Please see following description for synopsis
wxEvent(3) Erlang Module Definition wxEvent(3)
NAME
wxEvent - Functions for wxEvent class
DESCRIPTION
An event is a structure holding information about an event passed to a
callback or member function.
wxEvent used to be a multipurpose event object, and is an abstract base
class for other event classes (see below).
For more information about events, see the overview_events overview.
See: wxCommandEvent, wxMouseEvent
wxWidgets docs: wxEvent
DATA TYPES
wxEvent() = wx:wx_object()
EXPORTS
getId(This) -> integer()
Types:
This = wxEvent()
Returns the identifier associated with this event, such as a
button command id.
getSkipped(This) -> boolean()
Types:
This = wxEvent()
Returns true if the event handler should be skipped, false oth-
erwise.
getTimestamp(This) -> integer()
Types:
This = wxEvent()
Gets the timestamp for the event.
The timestamp is the time in milliseconds since some fixed
moment (not necessarily the standard Unix Epoch, so only differ-
ences between the timestamps and not their absolute values usu-
ally make sense).
Warning: wxWidgets returns a non-NULL timestamp only for mouse
and key events (see wxMouseEvent and wxKeyEvent).
isCommandEvent(This) -> boolean()
Types:
This = wxEvent()
Returns true if the event is or is derived from wxCommandEvent
else it returns false.
Note: exists only for optimization purposes.
resumePropagation(This, PropagationLevel) -> ok
Types:
This = wxEvent()
PropagationLevel = integer()
Sets the propagation level to the given value (for example
returned from an earlier call to stopPropagation/1).
shouldPropagate(This) -> boolean()
Types:
This = wxEvent()
Test if this event should be propagated or not, i.e. if the
propagation level is currently greater than 0.
skip(This) -> ok
Types:
This = wxEvent()
skip(This, Options :: [Option]) -> ok
Types:
This = wxEvent()
Option = {skip, boolean()}
This method can be used inside an event handler to control
whether further event handlers bound to this event will be
called after the current one returns.
Without skip/2 (or equivalently if Skip(false) is used), the
event will not be processed any more. If Skip(true) is called,
the event processing system continues searching for a further
handler function for this event, even though it has been pro-
cessed already in the current handler.
In general, it is recommended to skip all non-command events to
allow the default handling to take place. The command events
are, however, normally not skipped as usually a single command
such as a button click or menu item selection must only be pro-
cessed by one handler.
stopPropagation(This) -> integer()
Types:
This = wxEvent()
Stop the event from propagating to its parent window.
Returns the old propagation level value which may be later
passed to resumePropagation/2 to allow propagating the event
again.
wxWidgets team. wx 2.1.1 wxEvent(3)