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

VCF::ButtonEvent Class Reference

A ButtonEvent is fired whenever a button is pressed or clicked. More...

#include <vcf/ApplicationKit/ButtonEvent.h>

Inheritance diagram for VCF::ButtonEvent:

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

Public Member Functions

 ButtonEvent (Object *source, const uint32 &stateMask)
 ButtonEvent (const ButtonEvent &rhs)
ButtonEvent & operator= (const ButtonEvent &rhs)
virtual ~ButtonEvent ()
uint32 getStateMask ()
virtual Object * clone (bool deep=false)
 Makes a complete clone of this object.

Detailed Description

A ButtonEvent is fired whenever a button is pressed or clicked.

Constructor & Destructor Documentation

VCF::ButtonEvent::ButtonEvent (  Object *  source,
const uint32 &  stateMask
)  [inline]
 

VCF::ButtonEvent::ButtonEvent (  const ButtonEvent &  rhs  )  [inline]
 

virtual VCF::ButtonEvent::~ButtonEvent (   )  [inline, virtual]
 

Member Function Documentation

virtual Object* VCF::ButtonEvent::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::ButtonEvent::getStateMask (   )  [inline]
 

ButtonEvent& VCF::ButtonEvent::operator= (  const ButtonEvent &  rhs  )  [inline]
 

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