sdljava.event

Class SDLMouseButtonEvent

public class SDLMouseButtonEvent extends SDLEvent

When a mouse button press or release is detected then number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into button, the position of the mouse when this event occured is stored in the x and the y fields. Like SDL_KeyboardEvent, information on whether the event was a press or a release event is stored in both the type and state fields, but this should be obvious.

Mouse wheel events are reported as buttons 4 (up) and 5 (down). Two events are generated i.e. you get a SDL_MOUSEBUTTONDOWN followed by a SDL_MOUSEBUTTONUP event.

Version: $Id: SDLMouseButtonEvent.java,v 1.12 2005/01/30 05:15:16 ivan_ganza Exp $

Author: Ivan Z. Ganza

Field Summary
SDL_MouseButtonEvent	swigMouseButtonEvent Reference to the SWIG generated

Method Summary
int	getButton() The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT, SDL_BUTTON_WHEELUP, SDL_BUTTON_WHEELDOWN)
SDLPressedState	getState() Get the state of the button
SDL_MouseButtonEvent	getSwigMouseButtonEvent() Gets the value of swigMouseButtonEvent
int	getType() The type of the this event
int	getWhich() Describe `getWhich` method here.
int	getX() The X co-oridnate
int	getY() The Y co-ordinate
void	setSwigMouseButtonEvent(SDL_MouseButtonEvent argSwigMouseButtonEvent) Sets the value of swigMouseButtonEvent
String	toString()
String	translateButton(int button) Get string represenation of button value