1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
28 # include <KCoreAddons/KAboutData>
33 * Represents a contributor or author for Quassel.
35 * This is used to show a list of contributors in the About Quassel dialog.
43 * @param[in] name The person's name (in the form "Firstname Surname")
44 * @param[in] nick The person's nickname, if applicable
45 * @param[in] task Things the person does or has done for the project
46 * @param[in] emailAddress The person's email address, if applicable
47 * @param[in] translatedLanguage The language the person helped translate (only applicable for translators)
49 AboutPerson(const QString &name, const QString &nick, const QString &task, const QString &emailAddress = QString(), QLocale::Language translatedLanguage = QLocale::C);
52 * Gets the person's name.
54 * @returns The person's name
59 * Gets the person's nick.
61 * @returns The person's nick
66 * Gets the person's task.
68 * @returns The person's task
73 * Gets the person's e-mail address.
75 * @returns The person's e-mail address
77 QString emailAddress() const;
80 * Gets the language this person helped translate.
82 * @returns The language this person helped translate
84 QLocale::Language translatedLanguage() const;
87 * Gets the person's formatted name and nick.
89 * @returns The person's name and nick formatted for combined output
91 QString prettyName() const;
94 QString _name; ///< The person's name
95 QString _nick; ///< The person's nick
96 QString _task; ///< The person's task
97 QString _emailAddress; ///< The person's email address
98 QLocale::Language _language; ///< The language the person helps translate
103 * Holds a list of authors, contributors and translators.
105 * This class is meant to hold the list of people who contributed to Quassel, used for displaying
106 * the About Quassel dialog. Additionally, this class can provide a KAboutData object to be shown
107 * if KDE integration is enabled.
109 class AboutData : public QObject
114 * Default constructor.
116 * @param[in] parent The parent object, if applicable
118 AboutData(QObject *parent = nullptr);
121 * Adds an author to the list of contributors.
123 * Authors are people who contributed a significant amount of code to Quassel.
125 * @param[in] author The author to add
126 * @returns A reference to this AboutData instance
128 AboutData &addAuthor(const AboutPerson &author);
131 * Adds a list of authors to the list of contributors.
133 * This method allows the use of a brace initializer in order to easily add a long list of
136 * @param[in] authors A list of authors to add
137 * @returns A reference to this AboutData instance
139 AboutData &addAuthors(std::initializer_list<AboutPerson> authors);
142 * Adds a contributor.
144 * @param[in] author The contributor to add
145 * @returns A reference to this AboutData instance
147 AboutData &addCredit(const AboutPerson &credit);
150 * Adds a list of contributors.
152 * This method allows the use of brace initializers in order to easily add a long list of
155 * @param[in] authors A list of contributors to add
156 * @returns A reference to this AboutData instance
158 AboutData &addCredits(std::initializer_list<AboutPerson> credits);
161 * Gets the list of authors stored in this AboutData instance.
163 * @returns A list of authors
165 QList<AboutPerson> authors() const;
168 * Gets the list of non-author contributors stored in this AboutData instance.
170 * @returns A list of contributors
172 QList<AboutPerson> credits() const;
176 * Creates a KAboutData instance based on the contents of this AboutData instance.
178 * @returns A KAboutData instance holding the list of contributors as well as any additional
179 * data required for KAboutDialog and friends
181 KAboutData kAboutData() const;
185 * Fills the given AboutData instance with data relevant for Quassel itself.
187 * This method adds a (hardcoded) list of contributors to the given AboutData instance.
189 * @param[in,out] aboutData An existing AboutData instance to add Quassel's contributors to
191 static void setQuasselPersons(AboutData *aboutData);
194 QList<AboutPerson> _authors; ///< The list of authors
195 QList<AboutPerson> _credits; ///< The list of other contributors