wxJoystickEvent(3)

MODULE
wxJoystickEvent - See external documentation: wxJoystickEvent.

DESCRIPTION

See external documentation: wxJoystickEvent <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html>.

    Use wxEvtHandler:connect/3 with EventType::
        joy_button_down, joy_button_up, joy_move, joy_zmove

See also the message variant #wxJoystick{} event record type.

This class is derived (and can use functions) from:
wxEvent

DATA TYPES

    wxJoystickEvent():

        An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

buttonDown(This::wxJoystickEvent()) -> bool()

    Equivalent to buttonDown(This, []).

buttonDown(This::wxJoystickEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventbuttondown>.

buttonIsDown(This::wxJoystickEvent()) -> bool()

    Equivalent to buttonIsDown(This, []).

buttonIsDown(This::wxJoystickEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventbuttonisdown>.

buttonUp(This::wxJoystickEvent()) -> bool()

    Equivalent to buttonUp(This, []).

buttonUp(This::wxJoystickEvent(), Options::[Option]) -> bool()

    Types
        Option = {but, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventbuttonup>.

getButtonChange(This::wxJoystickEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventgetbuttonchange>.

getButtonState(This::wxJoystickEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventgetbuttonstate>.

getJoystick(This::wxJoystickEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventgetjoystick>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventgetposition>.

getZPosition(This::wxJoystickEvent()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventgetzposition>.

isButton(This::wxJoystickEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventisbutton>.

isMove(This::wxJoystickEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventismove>.

isZMove(This::wxJoystickEvent()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxjoystickevent.html#wxjoystickeventiszmove>.