| wxJoystickEvent(3erl) | Erlang Module Definition | wxJoystickEvent(3erl) |
wxJoystickEvent - Functions for wxJoystickEvent class
This event class contains information about joystick events, particularly events received by windows.
See: wxJoystick (not implemented in wx)
This class is derived (and can use functions) from: wxEvent
wxWidgets docs: wxJoystickEvent
Use wxEvtHandler:connect/3 with wxJoystickEventType to subscribe to events of this type.
wxJoystickEvent() = wx:wx_object()
wxJoystick() =
#wxJoystick{type = wxJoystickEvent:wxJoystickEventType(),
pos = {X :: integer(), Y :: integer()},
zPosition = integer(),
buttonChange = integer(),
buttonState = integer(),
joyStick = integer()}
wxJoystickEventType() =
joy_button_down | joy_button_up | joy_move | joy_zmove
buttonDown(This) -> boolean()
Types:
buttonDown(This, Options :: [Option]) -> boolean()
Types:
Returns true if the event was a down event from the specified button (or any button).
buttonIsDown(This) -> boolean()
Types:
buttonIsDown(This, Options :: [Option]) -> boolean()
Types:
Returns true if the specified button (or any button) was in a down state.
buttonUp(This) -> boolean()
Types:
buttonUp(This, Options :: [Option]) -> boolean()
Types:
Returns true if the event was an up event from the specified button (or any button).
getButtonChange(This) -> integer()
Types:
Returns the identifier of the button changing state.
The return value is where n is the index of the button changing state, which can also be retrieved using GetButtonOrdinal() (not implemented in wx).
Note that for n equal to 1, 2, 3 or 4 there are predefined wxJOY_BUTTONn constants which can be used for more clarity, however these constants are not defined for the buttons beyond the first four.
getButtonState(This) -> integer()
Types:
Returns the down state of the buttons.
This is a wxJOY_BUTTONn identifier, where n is one of 1, 2, 3, 4.
getJoystick(This) -> integer()
Types:
Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2.
getPosition(This) -> {X :: integer(), Y :: integer()}
Types:
Returns the x, y position of the joystick event.
These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.
getZPosition(This) -> integer()
Types:
Returns the z position of the joystick event.
This method can only be used for wxEVT_JOY_ZMOVE events.
isButton(This) -> boolean()
Types:
Returns true if this was a button up or down event (not 'is any button down?').
isMove(This) -> boolean()
Types:
Returns true if this was an x, y move event.
isZMove(This) -> boolean()
Types:
Returns true if this was a z move event.
| wx 2.2.1 | wxWidgets team. |