libnick 2024.9.2
A cross-platform base for native Nickvision applications.
Loading...
Searching...
No Matches
appinfo.h
Go to the documentation of this file.
1
23#ifndef APPINFO_H
24#define APPINFO_H
25
26#include <string>
27#include <unordered_map>
28#include <vector>
29#include "update/version.h"
30
32{
36 class AppInfo
37 {
38 public:
42 AppInfo() = default;
49 AppInfo(const std::string& id, const std::string& name, const std::string& englishShortName);
54 const std::string& getId() const;
59 void setId(const std::string& id);
64 const std::string& getName() const;
69 void setName(const std::string& name);
74 const std::string& getShortName() const;
79 void setShortName(const std::string& shortName);
84 const std::string& getEnglishShortName() const;
89 void setEnglishShortName(const std::string& englishShortName);
94 const std::string& getDescription() const;
99 void setDescription(const std::string& description);
109 void setVersion(const Update::Version& version);
114 const std::string& getChangelog() const;
119 void setChangelog(const std::string& changelog);
124 const std::string& getHtmlChangelog() const;
129 const std::string& getSourceRepo() const;
136 bool setSourceRepo(const std::string& sourceRepo);
141 const std::string& getIssueTracker() const;
148 bool setIssueTracker(const std::string& issueTracker);
153 const std::string& getSupportUrl() const;
160 bool setSupportUrl(const std::string& supportUrl);
165 const std::string& getHtmlDocsStore() const;
170 void setHtmlDocsStore(const std::string& htmlDocsStore);
175 std::unordered_map<std::string, std::string>& getExtraLinks();
180 const std::unordered_map<std::string, std::string>& getExtraLinks() const;
185 std::unordered_map<std::string, std::string>& getDevelopers();
190 const std::unordered_map<std::string, std::string>& getDevelopers() const;
195 std::unordered_map<std::string, std::string>& getDesigners();
200 const std::unordered_map<std::string, std::string>& getDesigners() const;
205 std::unordered_map<std::string, std::string>& getArtists();
210 const std::unordered_map<std::string, std::string>& getArtists() const;
215 const std::string& getTranslatorCredits() const;
220 void setTranslatorCredits(const std::string& translatorCredits);
225 std::vector<std::string> getTranslatorNames() const;
226
227 private:
228 std::string m_id;
229 std::string m_name;
230 std::string m_shortName;
231 std::string m_englishShortName;
232 std::string m_description;
233 Update::Version m_version;
234 std::string m_changelog;
235 std::string m_htmlChangelog;
236 std::string m_sourceRepo;
237 std::string m_issueTracker;
238 std::string m_supportUrl;
239 std::string m_htmlDocsStore;
240 std::unordered_map<std::string, std::string> m_extraLinks;
241 std::unordered_map<std::string, std::string> m_developers;
242 std::unordered_map<std::string, std::string> m_designers;
243 std::unordered_map<std::string, std::string> m_artists;
244 std::string m_translatorCredits;
245
246 public:
252 static std::vector<std::string> convertUrlMapToVector(const std::unordered_map<std::string, std::string>& urls);
253 };
254}
255
256#endif // APPINFO_H
A model for the information about an application.
Definition appinfo.h:37
bool setSourceRepo(const std::string &sourceRepo)
Sets the application source repo url.
const std::string & getSupportUrl() const
Gets the application support url.
void setHtmlDocsStore(const std::string &htmlDocsStore)
Sets the application html docs store url.
const std::unordered_map< std::string, std::string > & getDevelopers() const
Gets the application developers.
void setShortName(const std::string &shortName)
Sets the application short name.
void setChangelog(const std::string &changelog)
Sets the application changelog.
void setName(const std::string &name)
Sets the application name.
const std::string & getSourceRepo() const
Gets the application source repo url.
AppInfo(const std::string &id, const std::string &name, const std::string &englishShortName)
Constructs an AppInfo.
void setVersion(const Update::Version &version)
Sets the application version.
void setDescription(const std::string &description)
Sets the application description.
std::unordered_map< std::string, std::string > & getArtists()
Gets the application artists.
const std::string & getHtmlDocsStore() const
Gets the application html docs store url.
std::unordered_map< std::string, std::string > & getExtraLinks()
Gets the extra links for the application.
bool setIssueTracker(const std::string &issueTracker)
Sets the application issue tracker url.
const std::unordered_map< std::string, std::string > & getDesigners() const
Gets the application designers.
void setTranslatorCredits(const std::string &translatorCredits)
Sets the application translator credits.
std::unordered_map< std::string, std::string > & getDevelopers()
Gets the application developers.
const std::string & getTranslatorCredits() const
Gets the application translator credits.
static std::vector< std::string > convertUrlMapToVector(const std::unordered_map< std::string, std::string > &urls)
Converts a map of URLs to a vector.
const std::string & getHtmlChangelog() const
Gets the application changelog in HTML form.
AppInfo()=default
Constructs an AppInfo.
const std::string & getChangelog() const
Gets the application changelog.
std::vector< std::string > getTranslatorNames() const
Gets the list of translator names.
void setId(const std::string &id)
Sets the application id.
bool setSupportUrl(const std::string &supportUrl)
Sets the application support url.
const std::string & getId() const
Gets the application id.
const std::unordered_map< std::string, std::string > & getArtists() const
Gets the application artists.
void setEnglishShortName(const std::string &englishShortName)
Sets the application English short name.
std::unordered_map< std::string, std::string > & getDesigners()
Gets the application designers.
const std::string & getEnglishShortName() const
Gets the application English short name.
const std::string & getDescription() const
Gets the application description.
const Update::Version & getVersion() const
Gets the application version.
const std::unordered_map< std::string, std::string > & getExtraLinks() const
Gets the extra links for the application.
const std::string & getName() const
Gets the application name.
const std::string & getIssueTracker() const
Gets the application issue tracker url.
const std::string & getShortName() const
Gets the application short name.
A model for a version number.
Definition version.h:37
Definition appinfo.h:32