src/resources/modinfo.h


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

/*
 *  The ManaPlus Client
 *  Copyright (C) 2011-2014  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  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
 *  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, see <http://www.gnu.org/licenses/>.
 */

#ifndef RESOURCES_MODINFO_H
#define RESOURCES_MODINFO_H

#include <string>
#include <map>

#include "localconsts.h"

class ModInfo final
{
    public:
        ModInfo();

        A_DELETE_COPY(ModInfo)

        void setName(const std::string &name)
        { mName = name; }

        const std::string &getName() const A_WARN_UNUSED
        { return mName; }

        void setDescription(const std::string &text)
        { mDescription = text; }

        const std::string &getDescription() const A_WARN_UNUSED
        { return mDescription; }

        void setHelp(const std::string &text)
        { mHelp = text; }

        const std::string &getHelp() const A_WARN_UNUSED
        { return mHelp; }

    private:
        std::string mName;
        std::string mDescription;
        std::string mHelp;
};

typedef std::map<std::string, ModInfo*> ModInfos;
typedef ModInfos::iterator ModInfoIterator;

#endif  // RESOURCES_MODINFO_H