blob: 2b54d10359edd95aef45d222061886f7081ae507 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
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_
|
