Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::MouseEvent Class Reference

#include <vcf/ApplicationKit/MouseEvent.h>

Inheritance diagram for VCF::MouseEvent:

VCF::Event VCF::Object List of all members.

Public Member Functions

 MouseEvent (Object *source)
 MouseEvent (Object *source, const uint32 &eventType)
 MouseEvent (Object *source, const uint32 &eventType, const uint32 &buttonMask, const uint32 &keyMask, Point *point)
 MouseEvent (const MouseEvent &rhs)
virtual ~MouseEvent ()
MouseEventoperator= (const MouseEvent &rhs)
virtual Objectclone (bool deep=false)
PointgetPoint ()
 returns the point for this mouse event
void setPoint (Point *point)
uint32 getKeyMask ()
uint32 getButtonMask ()
bool hasLeftButton ()
 indicates whether the mouse event has occurred while the user has the left button down.
bool hasMiddleButton ()
 indicates whether the mouse event has occurred while the user has the middle button down.
bool hasRightButton ()
 indicates whether the mouse event has occurred while the user has the right button down.
bool hasPrimaryButton ()
 A more general call to determine which button is pressed down.
bool hasSecondaryButton ()
 A more general call to determine which button is pressed down.
bool hasTertiaryButton ()
 A more general call to determine which button is pressed down.
bool hasShiftKey ()
bool hasAltKey ()
bool hasControlKey ()

Constructor & Destructor Documentation

VCF::MouseEvent::MouseEvent Object source  )  [inline]
 

VCF::MouseEvent::MouseEvent Object source,
const uint32 eventType
[inline]
 

VCF::MouseEvent::MouseEvent Object source,
const uint32 eventType,
const uint32 buttonMask,
const uint32 keyMask,
Point point
[inline]
 

VCF::MouseEvent::MouseEvent const MouseEvent rhs  )  [inline]
 

virtual VCF::MouseEvent::~MouseEvent  )  [inline, virtual]
 


Member Function Documentation

virtual Object* VCF::MouseEvent::clone bool  deep = false  )  [inline, virtual]
 

uint32 VCF::MouseEvent::getButtonMask  )  [inline]
 

uint32 VCF::MouseEvent::getKeyMask  )  [inline]
 

Point* VCF::MouseEvent::getPoint  )  [inline]
 

returns the point for this mouse event

bool VCF::MouseEvent::hasAltKey  )  [inline]
 

bool VCF::MouseEvent::hasControlKey  )  [inline]
 

bool VCF::MouseEvent::hasLeftButton  )  [inline]
 

indicates whether the mouse event has occurred while the user has the left button down.

See also:
hasPrimaryButton()

bool VCF::MouseEvent::hasMiddleButton  )  [inline]
 

indicates whether the mouse event has occurred while the user has the middle button down.

See also:
hasTertiaryButton()

bool VCF::MouseEvent::hasPrimaryButton  )  [inline]
 

A more general call to determine which button is pressed down.

This is the preferred call to make as it does not indicate a preference for a right-hand configured mouse.

Indicates whether the mouse event has occurred while the user has the primary button down. The primary button, on a mouse configured for right-handed users, is the left button. For a mouse configured for left-handed users it would be the right button.

bool VCF::MouseEvent::hasRightButton  )  [inline]
 

indicates whether the mouse event has occurred while the user has the right button down.

See also:
hasSecondaryButton()

bool VCF::MouseEvent::hasSecondaryButton  )  [inline]
 

A more general call to determine which button is pressed down.

This is the preferred call to make as it does not indicate a preference for a right-hand configured mouse.

Indicates whether the mouse event has occurred while the user has the secondary button down. The secondary button, on a mouse configured for right-handed users, is the right button. For a mouse configured for left-handed users it would be the left button.

bool VCF::MouseEvent::hasShiftKey  )  [inline]
 

bool VCF::MouseEvent::hasTertiaryButton  )  [inline]
 

A more general call to determine which button is pressed down.

This is the preferred call to make as it does not indicate a preference for a right-hand configured mouse.

Indicates whether the mouse event has occurred while the user has the tertiary button down. The tertiary button, on a mouse configured for right-handed or left-handed users, is the middle button.

MouseEvent& VCF::MouseEvent::operator= const MouseEvent rhs  )  [inline]
 

void VCF::MouseEvent::setPoint Point point  )  [inline]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information