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

VCF::KeyboardEvent Class Reference

#include <vcf/ApplicationKit/KeyboardEvent.h>

Inheritance diagram for VCF::KeyboardEvent:

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

Public Member Functions

 KeyboardEvent (Object *source)
 KeyboardEvent (Object *source, const uint32 &eventType, const uint32 &repeatCount, const uint32 &keyMask, const VCFChar &keyValue, const VirtualKeyCode &virtKeyValue)
 KeyboardEvent (const KeyboardEvent &rhs)
virtual ~KeyboardEvent ()
KeyboardEventoperator= (const KeyboardEvent &rhs)
uint32 getKeyMask ()
VCFChar getKeyValue ()
uint32 getRepeatCount ()
bool hasShiftKey ()
bool hasAltKey ()
bool hasControlKey ()
VirtualKeyCode getVirtualCode ()
virtual Objectclone (bool deep=false)
 Makes a complete clone of this object.

Constructor & Destructor Documentation

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

VCF::KeyboardEvent::KeyboardEvent Object source,
const uint32 eventType,
const uint32 repeatCount,
const uint32 keyMask,
const VCFChar keyValue,
const VirtualKeyCode virtKeyValue
[inline]
 

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

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


Member Function Documentation

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

Makes a complete clone of this object.

A typical implementation might be:

    virtual Object* clone( bool deep ) {
        return new MyObject( this );
    }
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::KeyboardEvent::getKeyMask  )  [inline]
 

VCFChar VCF::KeyboardEvent::getKeyValue  )  [inline]
 

uint32 VCF::KeyboardEvent::getRepeatCount  )  [inline]
 

VirtualKeyCode VCF::KeyboardEvent::getVirtualCode  )  [inline]
 

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

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

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

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


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