blob: 4f0f6f3459144c4cfe2830b3336a16cdc01e8571 (
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
141
142
|
/*
* Copyright 2007-2009 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 sigmod/Author.h
*/
#ifndef SIGMOD_AUTHOR
#define SIGMOD_AUTHOR
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Author Author.h sigmod/Author.h
* \brief Class describing an author of the sigmod.
*
* Authors are used to allow scripts to create credits.
*/
class SIGMOD_EXPORT Author : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param author The author to copy.
*/
Author(const Author& author);
/**
* Create a new author belonging to \p parent and id \p id.
*
* \param parent The parent of the author.
* \param id The id number for the author.
*/
Author(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p author as a child of \p parent and id \p id.
*
* \param author The author to copy the data from.
* \param parent The parent of the author.
* \param id The id number for the author.
*/
Author(const Author& author, const Game* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the author.
* \param id The id number for the author.
*/
Author(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the author's values are valid.
*/
void validate();
/**
* Load data from XML.
*
* \param xml The XML structure to extract data from.
*/
void load(const QDomElement& xml);
/**
* Get the data for the author in XML format.
*
* \return The XML structure representing the author.
*/
QDomElement save() const;
/**
* Sets the name of the author.
*
* \param name The name of the author.
*/
void setName(const QString& name);
/**
* Sets the email of the author. It is not checked to be well-formed until the author is \link Author::validate \p validated \endlink.
*
* \param email The email of the author.
*/
void setEmail(const QString& email);
/**
* Sets what the author did for the sigmod. The default credits generator assumes that the roles are comma-separated.
*
* \param role The role(s) of the author.
*/
void setRole(const QString& role);
/**
* \sa setName
*
* \return The name of the author.
*/
QString name() const;
/**
* \sa setEmail
*
* \return The email address of the author.
*/
QString email() const;
/**
* \sa setRole
*
* \return The role(s) of the author.
*/
QString role() const;
bool nameCheck(const QString& name) const;
bool emailCheck(const QString& email) const;
bool roleCheck(const QString& role) const;
Author& operator=(const Author& rhs);
private:
QString m_name;
QString m_email;
QString m_role;
};
}
#endif
|
