Xrb::EventMouseButton Class Reference

Baseclass for EventMouseButtonDown and EventMouseButtonUp. More...

#include <xrb_input_events.hpp>

Inheritance diagram for Xrb::EventMouseButton:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 EventMouseButton (Key::Code button_code, ScreenCoordVector2 const &position, Key::Modifier modifier, Float time, EventType event_type)
 Constructs an EventMouseButton with the given parameters.
virtual ~EventMouseButton ()=0
 Pure virtual destructor.
Key::Code ButtonCode () const
 Returns the event's button code (see Xrb::Key::Code).
virtual bool IsMouseButtonEvent () const
 Override of Event::IsMouseButtonEvent to indicate that this is, indeed, a mouse button event.
virtual bool IsMouseButtonDownEvent () const
 Returns true iff this is a mouse button down event.
virtual bool IsMouseButtonUpEvent () const
 Returns true iff this is a mouse button up event.


Detailed Description

Baseclass for EventMouseButtonDown and EventMouseButtonUp.

Ties together the common functionality of the button down and button up events.

The code of the relevant mousebutton is returned by ButtonCode.

Definition at line 284 of file xrb_input_events.hpp.


Member Function Documentation

virtual bool Xrb::EventMouseButton::IsMouseButtonDownEvent (  )  const [inline, virtual]

Returns true iff this is a mouse button down event.

Virtual method for subclasses to override to indicate if they are a mouse button down event.

Reimplemented in Xrb::EventMouseButtonDown.

Definition at line 311 of file xrb_input_events.hpp.

virtual bool Xrb::EventMouseButton::IsMouseButtonUpEvent (  )  const [inline, virtual]

Returns true iff this is a mouse button up event.

Virtual method for subclasses to override to indicate if they are a mouse button up event.

Reimplemented in Xrb::EventMouseButtonUp.

Definition at line 316 of file xrb_input_events.hpp.


The documentation for this class was generated from the following files:

Hosted by SourceForge.net Logo -- Generated on Fri Aug 21 21:46:39 2009 for XuqRijBuh by doxygen 1.5.8