timercomponent.h

来自「这是VCF框架的代码」· C头文件 代码 · 共 181 行

#ifndef _VCF_TIMERCOMPONENT_H__
#define _VCF_TIMERCOMPONENT_H__
//TimerComponent.h

/*
Copyright 2000-2004 The VCF Project.
Please see License.txt in the top level directory
where you installed the VCF.
*/


#if _MSC_VER > 1000
#   pragma once
#endif


#define TIMERCOMPONENT_CLASSID		"69f9637c-6273-4e10-a9d1-fad815095b61"


namespace VCF  {


/**
\class TimerComponent TimerComponent.h "vcf/ApplicationKit/TimerComponent.h"
The TimerComponent is used to fire timer events. Simply create
the component, add an event handler to it's TimerPulse delegate,
set it's time out interval, and activate the timer. You can
stop the timer at any point by call it's setActivated() function
and passing in false. The default state of the timer is not 
active.
*/
class APPLICATIONKIT_API TimerComponent : public Component {
public:

	TimerComponent();

	TimerComponent( Component* owner );

	TimerComponent( const String& name, Component* owner );

	TimerComponent( const String& name );


	virtual ~TimerComponent();

	DELEGATE(TimerActivated)
	DELEGATE(TimerDeactivated)
	DELEGATE(TimerPulse)


	virtual void afterCreate( ComponentEvent* event );

	/**
	Indicates whether or not the component is active. The timer is 
	considered active if it is firing timer events. It 
	will remain active till it's destroyed, or setActive() is called
	with false for a value.
	*/
	bool isActive() {
		return isActive_;
	}

	/**
	Activates the timer. Pass in true to activate the timer, and
	false to turn it off. If the timer is activated, it will
	start to fire timer events.
	*/
	void setActivated( const bool& isActive );

	/**
	Returns the time out interval in milliseconds.
	*/
	long getTimeoutInterval() {
		return timeoutInterval_;
	}

	/**
	Set's the time out interval. A new timer event, i.e. 
	TimerPulse will fire an event, ever interval number of 
	milliseconds.
	*/
	void setTimeoutInterval( const long& interval );

protected:
	bool isActive_;
	long timeoutInterval_;
	void onInternalTimerPulse( TimerEvent* event );

	EventHandler* getTimerHandler();
};


}; //end of namespace VCF


/**
*CVS Log info
*$Log$
*Revision 1.3  2006/04/07 02:35:25  ddiego
*initial checkin of merge from 0.6.9 dev branch.
*
*Revision 1.2.6.1  2006/03/14 02:25:47  ddiego
*large amounts of source docs updated.
*
*Revision 1.2  2004/08/07 02:49:10  ddiego
*merged in the devmain-0-6-5 branch to stable
*
*Revision 1.1.2.3  2004/06/06 07:05:31  marcelloptr
*changed macros, text reformatting, copyright sections
*
*Revision 1.1.2.2  2004/04/29 03:43:15  marcelloptr
*reformatting of source files: macros and csvlog and copyright sections
*
*Revision 1.1.2.1  2004/04/28 00:28:19  ddiego
*migration towards new directory structure
*
*Revision 1.7.4.1  2004/04/26 21:58:21  marcelloptr
*changes for dir reorganization: _VCF_MACRO_H__
*
*Revision 1.7  2003/12/18 05:15:57  ddiego
*merge from devmain-0-6-2 branch into the stable branch
*
*Revision 1.6.4.3  2003/12/13 15:56:08  ddiego
**** empty log message ***
*
*Revision 1.6.4.2  2003/09/21 04:15:34  ddiego
*moved the cvs info data to teh bottom of the header instead of the
*top so it is easier to get to the actual header class declarations
*instead of having to wade through all the cvs info stuff.
*
*Revision 1.6.4.1  2003/09/12 00:09:32  ddiego
*added better tabbing behaviour - fixed an earlier bug.
*Code is easier to understand and it simplified the implementation
*a bit as well
*Moved around the RTTI definitions for various Appkit classes to a
*single inline and stripped them from the various class headers
*
*Revision 1.6  2003/05/17 20:37:04  ddiego
*this is the checkin for the 0.6.1 release - represents the merge over from
*the devmain-0-6-0 branch plus a few minor bug fixes
*
*Revision 1.5.2.1  2003/03/12 03:09:46  ddiego
*switched all member variable that used the "m_"<name> prefix to
* <name>"_" suffix nameing standard.
*Also changed all vcf builder files to accomadate this.
*Changes were made to the Stream classes to NOT multiple inheritance and to
*be a little more correct. Changes include breaking the FileStream into two
*distinct classes, one for input and one for output.
*
*Revision 1.5  2003/02/26 04:30:38  ddiego
*merge of code in the devmain-0-5-9 branch into the current tree.
*most additions are in the area of the current linux port, but the major
*addition to this release is the addition of a Condition class (currently
*still under development) and the change over to using the Delegate class
*exclusively from the older event handler macros.
*
*Revision 1.4.14.1  2003/02/24 05:42:18  ddiego
*moved the code for the VariantData calss into it's own header
*migrated to the new event style using Delegates instead of relying on
*the ugly macros that we were using before - same functionality though
*made sure everything still works and compiles, including neccessary
*changes in the VCF Builder so that it creates code in the new style
*This changes to teh new style of using Delegates completes task 58837
*
*Revision 1.4  2002/05/09 03:10:42  ddiego
*merged over code from development branch devmain-0-5-1a into the main CVS trunk
*
*Revision 1.3.4.1  2002/04/08 20:55:29  zzack
*changed include style
*
*Revision 1.3  2002/01/24 01:46:47  ddiego
*added a cvs "log" comment to the top of all files in vcf/src and vcf/include
*to facilitate change tracking
*
*/


#endif // _VCF_TIMERCOMPONENT_H__