diff options
Diffstat (limited to 'intern/action/ACT_Action.h')
-rw-r--r-- | intern/action/ACT_Action.h | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/intern/action/ACT_Action.h b/intern/action/ACT_Action.h new file mode 100644 index 00000000000..2b54d10359e --- /dev/null +++ b/intern/action/ACT_Action.h @@ -0,0 +1,140 @@ +/** + * $Id$ + * ***** BEGIN GPL/BL DUAL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. The Blender + * Foundation also sells licenses for use in proprietary software under + * the Blender License. See http://www.blender.org/BL/ for information + * about this. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL/BL DUAL LICENSE BLOCK ***** + */ + +/** + + * $Id$ + * Copyright (C) 2001 NaN Technologies B.V. + * @author Maarten Gribnau + * @date March 31, 2001 + */ + +#ifndef _H_ACT_ACTION_H_ +#define _H_ACT_ACTION_H_ + +#include "MEM_RefCounted.h" +#include "STR_String.h" + +/** + * An action that can be applied or undone. + * Virtual base class for actions with a name. + * An action object inherits the shared object reference count mechanism. + * @author Maarten Gribnau + * @date March 31, 2001 + */ + +class ACT_Action : public MEM_RefCounted { +public: + /** + * Constructs an action with the given name . + * @param name the name of the action. + * @param applied state of the action after creation. + */ + ACT_Action(const STR_String& name, bool applied = false); + + /** + * Returns the name of the action. + * @param name the name of the action. + */ + inline virtual void getName(STR_String& name) const; + + /** + * Returns the name of the action as a pointer to the data of the string. + * @return pointer to the name of the action. + */ + inline virtual char* getName(); + + /** + * Sets the name of the action. + * @param name the name of the action. + */ + inline virtual void setName(const STR_String& name); + + /** + * Returns whether this action is applied. + * @return whether this action is applied. + */ + inline virtual bool getIsApplied() const; + + + /** + * Call this member to apply an action. + * Child classes should override the doApply member to implement apply functionality. + * @see doApply. + */ + virtual void apply(); + + /** + * Call this member to undo an action . + * Child classes should override the doUndo member to implement undo functionality. + * @see doApply() + */ + virtual void undo(); + +protected: + /** + * Implementations should overload this method to provide the apply functionality. + */ + virtual void doApply() = 0; + + /** + * Implementations should overload this method to provide the undo functionality. + */ + virtual void doUndo() = 0; + + /** Name of this action */ + STR_String m_name; + /** Is this action already applied? */ + bool m_applied; +}; + + +void ACT_Action::getName(STR_String& name) const +{ + name = m_name; +} + +char* ACT_Action::getName() +{ + return m_name.Ptr(); +} + +void ACT_Action::setName(const STR_String& name) +{ + m_name = name; +} + +inline bool ACT_Action::getIsApplied() const +{ + return m_applied; +} + +#endif // _H_ACT_ACTION_H_
\ No newline at end of file |