VCF::MouseEvent Class Reference
#include <vcf/ApplicationKit/MouseEvent.h>
Inheritance diagram for VCF::MouseEvent:
List of all members.
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] |
|
|
|
Makes a complete clone of this object.
A typical implementation might be: In which the implementer simply creates a new instance on the heap and calls the copy constructor. Objects which support cloning should also have a copy constructor defined as well.
- Parameters:
-
| bool | deep if deep is true then any object instances that this object owns should probably be cloned as well, with full new copies made. Otherwise it would be acceptable to simply copy the pointer values. The default value is for deep cloning to be false. |
- Returns:
- Object a new instance that should be an copy of this. If the object doesn't support cloning the return will value will be NULL.
Reimplemented from VCF::Event. |
| 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. |
| void VCF::MouseEvent::setPoint |
( |
Point * |
point |
) |
[inline] |
|
The documentation for this class was generated from the following file:
