wxJoystickEvent — wx v2.6

Search documentation of wx

# wxJoystickEvent (wx v2.6)

Copy Markdown View Source

This event class contains information about joystick events, particularly events received by windows.

This class is derived, and can use functions, from:

- `wxEvent`

wxWidgets docs: wxJoystickEvent

## Events

Use `wxEvtHandler:connect/3` with `wxJoystickEventType` to subscribe to events of this type.

## Summary

### Types

wxJoystick()
wxJoystickEvent()
wxJoystickEventType()

### Functions

buttonDown(This)

Equivalent to `buttonDown(This, [])`.

buttonDown/2

Returns true if the event was a down event from the specified button (or any button).

buttonIsDown(This)

Equivalent to `buttonIsDown(This, [])`.

buttonIsDown/2

Returns true if the specified button (or any button) was in a down state.

buttonUp(This)

Equivalent to `buttonUp(This, [])`.

buttonUp/2

Returns true if the event was an up event from the specified button (or any button).

getButtonChange(This)

Returns the identifier of the button changing state.

getButtonState(This)

Returns the down state of the buttons.

getJoystick(This)

Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2.

getPosition(This)

Returns the x, y position of the joystick event.

getZPosition(This)

Returns the z position of the joystick event.

isButton(This)

Returns true if this was a button up or down event (`not` 'is any button down?').

isMove(This)

Returns true if this was an x, y move event.

isZMove(This)

Returns true if this was a z move event.

## Types

# wxJoystick()

    -type wxJoystick() ::
              #wxJoystick{type :: wxJoystickEvent:wxJoystickEventType(),
                          pos :: {X :: integer(), Y :: integer()},
                          zPosition :: integer(),
                          buttonChange :: integer(),
                          buttonState :: integer(),
                          joyStick :: integer()}.

# wxJoystickEvent()

    -type wxJoystickEvent() :: wx:wx_object().

# wxJoystickEventType()

    -type wxJoystickEventType() :: joy_button_down | joy_button_up | joy_move | joy_zmove.

## Functions

# buttonDown(This)

    -spec buttonDown(This) -> boolean() when This :: wxJoystickEvent().

Equivalent to `buttonDown(This, [])`.

# buttonDown/2

    -spec buttonDown(This, [Option]) -> boolean() when This :: wxJoystickEvent(), Option :: {but, integer()}.

Returns true if the event was a down event from the specified button (or any button).

# buttonIsDown(This)

    -spec buttonIsDown(This) -> boolean() when This :: wxJoystickEvent().

Equivalent to `buttonIsDown(This, [])`.

# buttonIsDown/2

    -spec buttonIsDown(This, [Option]) -> boolean()
                          when This :: wxJoystickEvent(), Option :: {but, integer()}.

Returns true if the specified button (or any button) was in a down state.

# buttonUp(This)

    -spec buttonUp(This) -> boolean() when This :: wxJoystickEvent().

Equivalent to `buttonUp(This, [])`.

# buttonUp/2

    -spec buttonUp(This, [Option]) -> boolean() when This :: wxJoystickEvent(), Option :: {but, integer()}.

Returns true if the event was an up event from the specified button (or any button).

# getButtonChange(This)

    -spec getButtonChange(This) -> integer() when This :: wxJoystickEvent().

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)

    -spec getButtonState(This) -> integer() when This :: wxJoystickEvent().

Returns the down state of the buttons.

This is a `wxJOY_BUTTONn` identifier, where `n` is one of 1, 2, 3, 4.

# getJoystick(This)

    -spec getJoystick(This) -> integer() when This :: wxJoystickEvent().

Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2.

# getPosition(This)

    -spec getPosition(This) -> {X :: integer(), Y :: integer()} when This :: wxJoystickEvent().

Returns the x, y position of the joystick event.

These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.

# getZPosition(This)

    -spec getZPosition(This) -> integer() when This :: wxJoystickEvent().

Returns the z position of the joystick event.

This method can only be used for wxEVT_JOY_ZMOVE events.

# isButton(This)

    -spec isButton(This) -> boolean() when This :: wxJoystickEvent().

Returns true if this was a button up or down event (`not` 'is any button down?').

# isMove(This)

    -spec isMove(This) -> boolean() when This :: wxJoystickEvent().

Returns true if this was an x, y move event.

# isZMove(This)

    -spec isZMove(This) -> boolean() when This :: wxJoystickEvent().

Returns true if this was a z move event.