undoredoevent.h

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

#ifndef _VCF_UNDOREDOEVENT_H__
#define _VCF_UNDOREDOEVENT_H__
//UndoRedoEvent.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 UNDOREDO_EVENT_UNDO				CUSTOM_EVENT_TYPES + 1000
#define UNDOREDO_EVENT_REDO				CUSTOM_EVENT_TYPES + 1001
#define UNDOREDO_EVENT_EXECUTE			CUSTOM_EVENT_TYPES + 1002
#define UNDOREDO_EVENT_STACK_CLEARED	CUSTOM_EVENT_TYPES + 1003
#define UNDOREDO_EVENT_STACK_CHANGED	CUSTOM_EVENT_TYPES + 1004

namespace VCF  {

class Command;

/**
\class UndoRedoEvent UndoRedoEvent.h "vcf/ApplicationKit/UndoRedoEvent.h"  
* the event for the UndoRedoStack operations.
* this event is mainly used to bypass the default behaviour
* performed by the UndoUndoStack instance involved.
* In this case the user needs to add an handler for this event
* to the UndoCommand or RedoCommand delegate of the UndoUndoStack 
* instance, and setAllowsUndo(false) or setAllowsRedo(false)
* inside this handler.
*
*/
class APPLICATIONKIT_API UndoRedoEvent : public Event {
public:
	/**
	* constructors
	*/
	UndoRedoEvent( Object* source, const unsigned long& eventType, Command* command=NULL ):
		Event(source,eventType), command_(command),allowUndo_(true),allowRedo_(true),allowExecute_(true){

	}

	UndoRedoEvent( const UndoRedoEvent& rhs ):Event(rhs),
		command_(NULL),allowUndo_(true),allowRedo_(true),allowExecute_(true)	{
		*this = rhs;
	}

	virtual ~UndoRedoEvent() {}

	/**
	* copy operator
	*/
	UndoRedoEvent& operator=( const UndoRedoEvent& rhs ) {
		Event::operator =( rhs );
		command_ = rhs.command_;
		allowUndo_ = rhs.allowUndo_;
		allowRedo_ = rhs.allowRedo_;
		allowExecute_ = rhs.allowExecute_;

		return *this;
	}

	/**
	* the command associated to the event.
	*/
	Command* getCommand(){
		return command_;
	}

	/**
	* sets the command to be associated to the event.
	*/
	void setCommand( Command* command ) {
		command_ = command;
	}

	/**
	*@return bool, false if the user managing this event
	* doens't want the UndoRedoStack instance to perform
	* hte default undo action.
	*
	*/
	bool getAllowsUndo() {
		return 	allowUndo_;
	}

	/**
	* if the user wants to bypass the undo action of the 
	* UndoRedoStack instance, he needs to assign this value
	* as false.
	*@param const bool& allowsUndo, true to let the default undo
	*action from the UndoRedoStack to be performed.
	*/
	void setAllowsUndo( const bool& allowsUndo ){
		allowUndo_ = allowsUndo;
		if ( false == allowUndo_ ) {
			this->setConsumed( true );//stop processing the events
		}
	}

	/**
	*@return bool, false if the user managing this event
	* doens't want the UndoRedoStack instance to perform
	* hte default redo action.
	*/
	bool getAllowsRedo() {
		return 	allowRedo_;
	}

	/**
	* if the user wants to bypass the redo action of the 
	* UndoRedoStack instance, he needs to assign this value
	* as false.
	*@param const bool& allowsRedo, true to let the default redo 
	*action from the UndoRedoStack to be performed.
	*/
	void setAllowsRedo( const bool& allowsRedo ){
		allowRedo_ = allowsRedo;
		if ( false == allowRedo_ ) {
			this->setConsumed( true );//stop processing the events
		}
	}

	/**
	* creates a new copy of this instance.
	*/
	virtual Object* clone( bool deep=false ) {
		return new UndoRedoEvent(*this);
	}

protected:
	/**
	* the command, potentially undoable, associated to this event.
	*/
	Command* command_;

	/**
	* flag to know if the user lets the default undo action of the 
	* UndoRedoStack instance to be performed.
	*/
	bool allowUndo_;

	/**
	* flag to know if the user lets the default redo action of the 
	* UndoRedoStack instance to be performed.
	*/
	bool allowRedo_;

	/**
	* allow for execution
	* currently unused
	*/
	bool allowExecute_;
private:
};



/**
*UndoRedoEventHandler
*handles the following:
*onUndoCommand
*onRedoCommand
*onStackCleared
*onStackChanged
*onExecuteCommand
*/
template <class SOURCE_TYPE>
class UndoRedoEventHandler : public EventHandlerInstance<SOURCE_TYPE,UndoRedoEvent> {
public:
	UndoRedoEventHandler( SOURCE_TYPE* source,
		_typename_ EventHandlerInstance<SOURCE_TYPE,UndoRedoEvent>::OnEventHandlerMethod handlerMethod,
		const String& handlerName="") :
			EventHandlerInstance<SOURCE_TYPE,UndoRedoEvent>( source, handlerMethod, handlerName ) {

	}

};



}; //end of namespace VCF


/**
*CVS Log info
*$Log$
*Revision 1.4  2006/04/07 02:35:26  ddiego
*initial checkin of merge from 0.6.9 dev branch.
*
*Revision 1.3.4.2  2006/03/14 02:25:47  ddiego
*large amounts of source docs updated.
*
*Revision 1.3.4.1  2006/02/17 05:23:05  ddiego
*fixed some bugs, and added support for minmax in window resizing, as well as some fancier control over tooltips.
*
*Revision 1.3  2004/12/01 04:31:39  ddiego
*merged over devmain-0-6-6 code. Marcello did a kick ass job
*of fixing a nasty bug (1074768VCF application slows down modal dialogs.)
*that he found. Many, many thanks for this Marcello.
*
*Revision 1.2.2.2  2004/11/10 19:07:37  marcelloptr
*fixed documentation for doxygen
*
*Revision 1.2.2.1  2004/11/07 19:32:19  marcelloptr
*more documentation
*
*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.6.4.1  2004/04/26 21:58:37  marcelloptr
*changes for dir reorganization: _VCF_MACRO_H__
*
*Revision 1.6  2003/12/18 05:15:57  ddiego
*merge from devmain-0-6-2 branch into the stable branch
*
*Revision 1.5.2.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.5.2.1  2003/09/12 00:09:33  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.5  2003/08/09 02:56:43  ddiego
*merge over from the devmain-0-6-1 branch
*Changes
*Features:
*-Added additional implementation to better support the MVC architecture in
*the VCF
*
*-Added a Document/View architecure that is similar to MFC's or NextSteps's
*Doc/View architectures
*
*-Integrated the Anti Grain Graphics library into the GraphicsKit. There is
*now basic support for it in terms of drawing vector shapes
*(fills and strokes). Image support will come in the next release
*
*-Added several documented graphics tutorials
*
*Bugfixes:
*
*[ 775744 ] wrong buttons on a dialog
*[ 585239 ] Painting weirdness in a modal dialog ?
*[ 585238 ] Modal dialog which makes a modal Dialog
*[ 509004 ] Opening a modal Dialog causes flicker
*[ 524878 ] onDropped not called for MLTcontrol
*
*Plus an issue with some focus and getting the right popup window to activate
*has also been fixed
*
*Revision 1.4.2.1  2003/06/28 04:43:20  ddiego
*cleaned up the vcf/include/events directory and got rid of files, moving
*some of the various event handler template classes into the same header
*that the event handler's event is associated with
*also made some changes to properly take advantage of a Control's View, if it
*is set.
*
*Revision 1.4  2003/05/17 20:37:08  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.3.22.2  2003/03/13 05:07:25  ddiego
*added some more documentation, and implemented the clone() method in all of the
*core event classes for the FoundationKit, GraphicsKit, and ApplicationKit.
*
*Revision 1.3.22.1  2003/03/12 03:09:58  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.3  2002/01/24 01:46:48  ddiego
*added a cvs "log" comment to the top of all files in vcf/src and vcf/include
*to facilitate change tracking
*
*/


#endif // _VCF_UNDOREDOEVENT_H__