wxjoystickevent

this event class contains information about mouse events, particularly events received by windows.

derived from

wxevent

include files

event table macros

to process a mouse event, use these event handler macros to direct input to member functions that take a wxjoystickevent argument.

evt_joy_button_down(func)	process a wxevt_joy_button_down event.
evt_joy_button_up(func)	process a wxevt_joy_button_up event.
evt_joy_move(func)	process a wxevt_joy_move event.
evt_joy_zmove(func)	process a wxevt_joy_zmove event.
evt_joystick_events(func)	processes all joystick events.

see also

wxjoystick

members

wxjoystickevent::wxjoystickevent
wxjoystickevent::buttondown
wxjoystickevent::buttonisdown
wxjoystickevent::buttonup
wxjoystickevent::getbuttonchange
wxjoystickevent::getbuttonstate
wxjoystickevent::getjoystick
wxjoystickevent::getposition
wxjoystickevent::getzposition
wxjoystickevent::isbutton
wxjoystickevent::ismove
wxjoystickevent::iszmove

wxjoystickevent::wxjoystickevent

wxjoystickevent(wxtype eventtype = 0, int state = 0, int joystick = wxjoystick1, int change = 0)

constructor.

wxjoystickevent::buttondown

bool buttondown(int button = wxjoy_button_any) const

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

parameters

button

can be wxjoy_buttonn where n is 1, 2, 3 or 4; or wxjoy_button_any to indicate any button down event.

wxjoystickevent::buttonisdown

bool buttonisdown(int button = wxjoy_button_any) const

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

parameters

button

can be wxjoy_buttonn where n is 1, 2, 3 or 4; or wxjoy_button_any to indicate any button down event.

wxjoystickevent::buttonup

bool buttonup(int button = wxjoy_button_any) const

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

parameters

button

can be wxjoy_buttonn where n is 1, 2, 3 or 4; or wxjoy_button_any to indicate any button down event.

wxjoystickevent::getbuttonchange

int getbuttonchange() const

returns the identifier of the button changing state. this is a wxjoy_buttonn identifier, where n is one of 1, 2, 3, 4.

wxjoystickevent::getbuttonstate

int getbuttonstate() const

returns the down state of the buttons. this is a bitlist of wxjoy_buttonn identifiers, where n is one of 1, 2, 3, 4.

wxjoystickevent::getjoystick

int getjoystick() const

returns the identifier of the joystick generating the event - one of wxjoystick1 and wxjoystick2.

wxjoystickevent::getposition

wxpoint getposition() const

returns the x, y position of the joystick event.

wxjoystickevent::getzposition

int getzposition() const

returns the z position of the joystick event.

wxjoystickevent::isbutton

bool isbutton() const

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

wxjoystickevent::ismove

bool ismove() const

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

wxjoystickevent::iszmove

bool iszmove() const

returns true if this was a z move event.