File: Modification.h

package info (click to toggle)
gm-assistant 1.2.4-1.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,116 kB
  • sloc: cpp: 7,281; makefile: 3
file content (88 lines) | stat: -rw-r--r-- 2,345 bytes parent folder | download | duplicates (4)
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
/*************************************************************************
* Copyright © 2012-2014 Vincent Prat & Simon Nicolas
*
* 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 3 of the License, or
* (at your option) any later version.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*************************************************************************/

#ifndef HEADER_MODIFICATION
#define HEADER_MODIFICATION

/*!
 * \brief Modification of a scenario
 */
class Modification
{
    public:
        /*!
         * \brief Action
         */
        enum Action
        {
            //! Addition
            aAddition,
            //! Edition
            aEdition,
            //! Deletion
            aDeletion,
            //! Movement
            aMovement
        };
        /*!
         * \brief Type of modification
         */
        enum Type
        {
            //! Tree
            tTree,
            //! Character or property
            tCharacter,
            //! Note
            tNote,
            //! Metadata
            tMetadata
        };
        /*!
         * \brief Default constructor
         * \param action Action
         */
        Modification(Action action);
        /*!
         * \brief Default destructor
         */
        virtual ~Modification();
        /*!
         * \brief Getter of the action
         * \return Action
         */
        Action action() const;
        /*!
         * \brief Getter for the type
         * \return Type of the modification
         */
        virtual Type type() const = 0;
        /*!
         * \brief Undoing
         */
        virtual void undo() = 0;
        /*!
         * \brief Redoing
         */
        virtual void redo() = 0;
    private:
        //! \brief Action
        Action aAction;
};

#endif