summaryrefslogtreecommitdiffstats
path: root/RomType.h
blob: 04fbd5ecff7b6bea84ea5aa194dade6a498af178 (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
/*
 * Copyright 2008 Ben Boeckel <MathStuf@gmail.com>
 * 
 * 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * \file RomType.h
 */

#ifndef ROMTYPE_H
#define ROMTYPE_H

// Qt includes
#include <QtCore/QMetaType>
#include <QtCore/QObject>
#include <QtCore/QSet>

// Forward declarations
class KConfigGroup;

/**
 * \class RomType
 * \brief Description of a ROM type.
 */
class RomType : public QObject
{
    Q_OBJECT
    /**
     * \var extensions
     * \brief The extensions the ROMs have.
     * 
     * \sa extensions
     * \sa addExtension
     * \sa removeExtension
     */
    Q_PROPERTY(QSet<QString> extensions READ extensions)
    
    public:
        /**
         * \brief Default constructor.
         */
        RomType();
        
        /**
         * \brief Config constructor.
         */
        RomType(const KConfigGroup& config);
        
        /**
         * \brief Copy constructor.
         */
        RomType(const RomType& rhs);
        
        /**
         * \brief Create a KConfigGroup for saving.
         * 
         * \param name The name of the group.
         * \param parent The parent group.
         */
        void makeGroup(const QString& name, const KConfigGroup& parent) const;
        
        /**
         * \return The set of extensions for the type.
         */
        QSet<QString> extensions() const;
        
        /**
         * \brief Assignment method.
         * 
         * \param rhs Type to copy.
         */
        RomType& operator=(const RomType& rhs);
    public slots:
        /**
         * \brief Adds an extension the type can have.
         * 
         * \param extension 
         */
        void addExtension(const QString& extension);
        
        /**
         * \brief Remove an extension for the type.
         * 
         * \param extension 
         */
        void removeExtension(const QString& extension);
    private:
        QSet<QString> m_extensions;
};
Q_DECLARE_METATYPE(RomType*)

#endif