stmm-games-doc  0.32.0
Classes | Public Member Functions | List of all members
stmg::XmlThemeLoader Class Reference
Inheritance diagram for stmg::XmlThemeLoader:
Inheritance graph
[legend]

Classes

struct  Init
 

Public Member Functions

 XmlThemeLoader (Init &&oInit)
 Constructor. More...
 
virtual ~XmlThemeLoader ()
 
const std::vector< std::string > & getThemeNames () noexcept override
 The theme names supported by this loader. More...
 
const ThemeInfogetThemeInfo (const std::string &sThemeName) noexcept override
 The theme information by name. More...
 
shared_ptr< ThemegetTheme (const std::string &sThemeName) noexcept override
 Get the theme with the given name or a default one. More...
 
const std::string & getDefaultThemeName () noexcept override
 The default theme name. More...
 
- Public Member Functions inherited from stmg::ThemeLoader
virtual ~ThemeLoader () noexcept=default
 

Constructor & Destructor Documentation

◆ XmlThemeLoader()

stmg::XmlThemeLoader::XmlThemeLoader ( Init &&  oInit)
explicit

Constructor.

Parameters
oInitInizialization data..

◆ ~XmlThemeLoader()

virtual stmg::XmlThemeLoader::~XmlThemeLoader ( )
virtual

Member Function Documentation

◆ getDefaultThemeName()

const std::string& stmg::XmlThemeLoader::getDefaultThemeName ( )
overridevirtualnoexcept

The default theme name.

Returns
The theme name. Can be empty.

Implements stmg::ThemeLoader.

◆ getTheme()

shared_ptr<Theme> stmg::XmlThemeLoader::getTheme ( const std::string &  sThemeName)
overridevirtualnoexcept

Get the theme with the given name or a default one.

Parameters
sThemeNameThe name of the theme or empty if loader should choose.
Returns
The theme or null if could not load (error string is set in ThemeInfo).

Implements stmg::ThemeLoader.

◆ getThemeInfo()

const ThemeInfo& stmg::XmlThemeLoader::getThemeInfo ( const std::string &  sThemeName)
overridevirtualnoexcept

The theme information by name.

Parameters
sThemeNameThe name. The theme must exist. Cannot be empty.
Returns
The theme information.

Implements stmg::ThemeLoader.

◆ getThemeNames()

const std::vector<std::string>& stmg::XmlThemeLoader::getThemeNames ( )
overridevirtualnoexcept

The theme names supported by this loader.

Returns
The (unique) non-empty names of the themes.

Implements stmg::ThemeLoader.