A model for the information about an application. More...

#include <appinfo.h>

Public Member Functions
	AppInfo ()=default
	Constructs an AppInfo.

	AppInfo (const std::string &id, const std::string &name, const std::string &englishShortName)
	Constructs an AppInfo.

const std::string &	getId () const
	Gets the application id.

void	setId (const std::string &id)
	Sets the application id.

const std::string &	getName () const
	Gets the application name.

void	setName (const std::string &name)
	Sets the application name.

const std::string &	getShortName () const
	Gets the application short name.

void	setShortName (const std::string &shortName)
	Sets the application short name.

const std::string &	getEnglishShortName () const
	Gets the application English short name.

void	setEnglishShortName (const std::string &englishShortName)
	Sets the application English short name.

const std::string &	getDescription () const
	Gets the application description.

void	setDescription (const std::string &description)
	Sets the application description.

const Update::Version &	getVersion () const
	Gets the application version.

void	setVersion (const Update::Version &version)
	Sets the application version.

const std::string &	getChangelog () const
	Gets the application changelog.

void	setChangelog (const std::string &changelog)
	Sets the application changelog.

const std::string &	getHtmlChangelog () const
	Gets the application changelog in HTML form.

const std::string &	getSourceRepo () const
	Gets the application source repo url.

bool	setSourceRepo (const std::string &sourceRepo)
	Sets the application source repo url.

const std::string &	getIssueTracker () const
	Gets the application issue tracker url.

bool	setIssueTracker (const std::string &issueTracker)
	Sets the application issue tracker url.

const std::string &	getSupportUrl () const
	Gets the application support url.

bool	setSupportUrl (const std::string &supportUrl)
	Sets the application support url.

const std::string &	getHtmlDocsStore () const
	Gets the application html docs store url.

void	setHtmlDocsStore (const std::string &htmlDocsStore)
	Sets the application html docs store url.

std::unordered_map< std::string, std::string > &	getExtraLinks ()
	Gets the extra links for the application.

const std::unordered_map< std::string, std::string > &	getExtraLinks () const
	Gets the extra links for the application.

std::unordered_map< std::string, std::string > &	getDevelopers ()
	Gets the application developers.

const std::unordered_map< std::string, std::string > &	getDevelopers () const
	Gets the application developers.

std::unordered_map< std::string, std::string > &	getDesigners ()
	Gets the application designers.

const std::unordered_map< std::string, std::string > &	getDesigners () const
	Gets the application designers.

std::unordered_map< std::string, std::string > &	getArtists ()
	Gets the application artists.

const std::unordered_map< std::string, std::string > &	getArtists () const
	Gets the application artists.

const std::string &	getTranslatorCredits () const
	Gets the application translator credits.

void	setTranslatorCredits (const std::string &translatorCredits)
	Sets the application translator credits.

std::vector< std::string >	getTranslatorNames () const
	Gets the list of translator names.

Static Public Member Functions
static std::vector< std::string >	convertUrlMapToVector (const std::unordered_map< std::string, std::string > &urls)
	Converts a map of URLs to a vector.

Detailed Description

A model for the information about an application.

Constructor & Destructor Documentation

◆ AppInfo() [1/2]

Nickvision::App::AppInfo::AppInfo ( )

default

Constructs an AppInfo.

◆ AppInfo() [2/2]

Nickvision::App::AppInfo::AppInfo	(	const std::string &	id,
		const std::string &	name,
		const std::string &	englishShortName )

Constructs an AppInfo.

Parameters

id	The application id
name	The application name
englishShortName	The application short name in English

Member Function Documentation

◆ convertUrlMapToVector()

static std::vector< std::string > Nickvision::App::AppInfo::convertUrlMapToVector ( const std::unordered_map< std::string, std::string > & urls )

static

Converts a map of URLs to a vector.

Parameters

urls	The map of URLs

Returns: The vector of URLs

◆ getArtists() [1/2]

std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getArtists ( )

Gets the application artists.

Returns: The application artists

◆ getArtists() [2/2]

const std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getArtists ( ) const

Gets the application artists.

Returns: The application artists

◆ getChangelog()

const std::string & Nickvision::App::AppInfo::getChangelog ( ) const

Gets the application changelog.

Returns: The application changelog

◆ getDescription()

const std::string & Nickvision::App::AppInfo::getDescription ( ) const

Gets the application description.

Returns: The application description

◆ getDesigners() [1/2]

std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getDesigners ( )

Gets the application designers.

Returns: The application designers

◆ getDesigners() [2/2]

const std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getDesigners ( ) const

Gets the application designers.

Returns: The application designers

◆ getDevelopers() [1/2]

std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getDevelopers ( )

Gets the application developers.

Returns: The application developers

◆ getDevelopers() [2/2]

const std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getDevelopers ( ) const

Gets the application developers.

Returns: The application developers

◆ getEnglishShortName()

const std::string & Nickvision::App::AppInfo::getEnglishShortName ( ) const

Gets the application English short name.

Returns: The application English short name

◆ getExtraLinks() [1/2]

std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getExtraLinks ( )

Gets the extra links for the application.

Returns: The extra links for the application

◆ getExtraLinks() [2/2]

const std::unordered_map< std::string, std::string > & Nickvision::App::AppInfo::getExtraLinks ( ) const

Gets the extra links for the application.

Returns: The extra links for the application

◆ getHtmlChangelog()

const std::string & Nickvision::App::AppInfo::getHtmlChangelog ( ) const

Gets the application changelog in HTML form.

Returns: The application changelog in HTML

◆ getHtmlDocsStore()

const std::string & Nickvision::App::AppInfo::getHtmlDocsStore ( ) const

Gets the application html docs store url.

Returns: The application html docs store url

◆ getId()

const std::string & Nickvision::App::AppInfo::getId ( ) const

Gets the application id.

Returns: The application id

◆ getIssueTracker()

const std::string & Nickvision::App::AppInfo::getIssueTracker ( ) const

Gets the application issue tracker url.

Returns: The application issue tracker url

◆ getName()

const std::string & Nickvision::App::AppInfo::getName ( ) const

Gets the application name.

Returns: The application name

◆ getShortName()

const std::string & Nickvision::App::AppInfo::getShortName ( ) const

Gets the application short name.

Returns: The application short name

◆ getSourceRepo()

const std::string & Nickvision::App::AppInfo::getSourceRepo ( ) const

Gets the application source repo url.

Returns: The application source repo url

◆ getSupportUrl()

const std::string & Nickvision::App::AppInfo::getSupportUrl ( ) const

Gets the application support url.

Returns: The application support url

◆ getTranslatorCredits()

const std::string & Nickvision::App::AppInfo::getTranslatorCredits ( ) const

Gets the application translator credits.

Returns: The application translator credits

◆ getTranslatorNames()

std::vector< std::string > Nickvision::App::AppInfo::getTranslatorNames ( ) const

Gets the list of translator names.

Returns: The application translator credits

◆ getVersion()

const Update::Version & Nickvision::App::AppInfo::getVersion ( ) const

Gets the application version.

Returns: The application version

◆ setChangelog()

void Nickvision::App::AppInfo::setChangelog ( const std::string & changelog )

Sets the application changelog.

Parameters

changelog The application changelog

◆ setDescription()

void Nickvision::App::AppInfo::setDescription ( const std::string & description )

Sets the application description.

Parameters

description The application description

◆ setEnglishShortName()

void Nickvision::App::AppInfo::setEnglishShortName ( const std::string & englishShortName )

Sets the application English short name.

Parameters

englishShortName The application English short name

◆ setHtmlDocsStore()

void Nickvision::App::AppInfo::setHtmlDocsStore ( const std::string & htmlDocsStore )

Sets the application html docs store url.

Parameters

htmlDocsStore The application html docs store url

◆ setId()

void Nickvision::App::AppInfo::setId ( const std::string & id )

Sets the application id.

Parameters

id	The application id

◆ setIssueTracker()

bool Nickvision::App::AppInfo::setIssueTracker ( const std::string & issueTracker )

Sets the application issue tracker url.

Parameters

issueTracker The application issue tracker url

Returns: True if the new issue tracker was set, else false; A false return value means that the issueTracker param was not a valid formatted URL

◆ setName()

void Nickvision::App::AppInfo::setName ( const std::string & name )

Sets the application name.

Parameters

name	The application name

◆ setShortName()

void Nickvision::App::AppInfo::setShortName ( const std::string & shortName )

Sets the application short name.

Parameters

shortName The application short name

◆ setSourceRepo()

bool Nickvision::App::AppInfo::setSourceRepo ( const std::string & sourceRepo )

Sets the application source repo url.

Parameters

sourceRepo The application source repo url

Returns: True if the new source repo was set, else false; A false return value means that the sourceRepo param was not a valid formatted URL

◆ setSupportUrl()

bool Nickvision::App::AppInfo::setSupportUrl ( const std::string & supportUrl )

Sets the application support url.

Parameters

supportUrl The application support url

Returns: True if the new support url was set, else false; A false return value means that the supportUrl param was not a valid formatted URL

◆ setTranslatorCredits()

void Nickvision::App::AppInfo::setTranslatorCredits ( const std::string & translatorCredits )

Sets the application translator credits.

Parameters

translatorCredits The application translator credits

◆ setVersion()

void Nickvision::App::AppInfo::setVersion ( const Update::Version & version )

Sets the application version.

Parameters

version The application version

The documentation for this class was generated from the following file:

include/app/appinfo.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AppInfo() [1/2]

◆ AppInfo() [2/2]

Member Function Documentation

◆ convertUrlMapToVector()

◆ getArtists() [1/2]

◆ getArtists() [2/2]

◆ getChangelog()

◆ getDescription()

◆ getDesigners() [1/2]

◆ getDesigners() [2/2]

◆ getDevelopers() [1/2]

◆ getDevelopers() [2/2]

◆ getEnglishShortName()

◆ getExtraLinks() [1/2]

◆ getExtraLinks() [2/2]

◆ getHtmlChangelog()

◆ getHtmlDocsStore()

◆ getId()

◆ getIssueTracker()

◆ getName()

◆ getShortName()

◆ getSourceRepo()

◆ getSupportUrl()

◆ getTranslatorCredits()

◆ getTranslatorNames()

◆ getVersion()

◆ setChangelog()

◆ setDescription()

◆ setEnglishShortName()

◆ setHtmlDocsStore()

◆ setId()

◆ setIssueTracker()

◆ setName()

◆ setShortName()

◆ setSourceRepo()

◆ setSupportUrl()

◆ setTranslatorCredits()

◆ setVersion()