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

Public Member Functions

 ThemeCtx (const shared_ptr< AppConfig > &refAppConfig, StdTheme &oTheme, const std::string &sThemeName, File oFile, const xmlpp::Element *p0RootElement)
 
 ThemeCtx (ThemeCtx &&oSource)=default
 
StdThemetheme ()
 
bool isMain () const
 
const FilegetThemeFile () const
 
const std::string & getThemeName () const
 
NamedObjIndex< const xmlpp::Element * > & localThemePainterNames ()
 
- Public Member Functions inherited from stmg::ConditionalCtx
 ConditionalCtx (const shared_ptr< AppPreferences > &refAppPreferences, Named &oNamed)
 
 ConditionalCtx (const shared_ptr< AppConfig > &refAppConfig, Named &oNamed)
 
virtual int32_t getContextTeam () const
 The context team. More...
 
virtual int32_t getContextMate () const
 The context mate. More...
 
void addChecker (const xmlpp::Element *p0Element) override
 Adds a checker for the element. More...
 
void removeChecker (const xmlpp::Element *p0Element, bool bCheckChildElements, bool bCheckAttrs) override
 Removes a checker for the element. More...
 
- Public Member Functions inherited from stmg::ParserCtx
 ParserCtx (const shared_ptr< AppConfig > &refAppConfig, Named &oNamed)
 Constructor. More...
 
 ParserCtx (const shared_ptr< AppPreferences > &refAppPreferences, Named &oNamed)
 Constructor. More...
 
virtual ~ParserCtx ()
 
const shared_ptr< AppConfig > & appConfig ()
 The app config. More...
 
const shared_ptr< AppPreferences > & appPreferences ()
 The app preferences. More...
 
Namednamed ()
 The named assets. More...
 
void pushCtx (const std::string &sStr)
 Push a context. More...
 
void popCtx ()
 Pop a context. More...
 
void addValidChildElementName (const xmlpp::Element *p0Element, const std::string &sChildElementName)
 Declares a child element name as valid. More...
 
void addValidChildElementNames (const xmlpp::Element *p0Element, const std::string &sChildElementName)
 Declares a child element name as valid. More...
 
template<typename ... Names>
void addValidChildElementNames (const xmlpp::Element *p0Element, const std::string &sChildElementName, const Names &... oNames)
 Declares multiple child element names as valid. More...
 
void addValidAttrName (const xmlpp::Element *p0Element, const std::string &sAttrName)
 Declares an attribute name as valid. More...
 
void addValidAttrNames (const xmlpp::Element *p0Element, const std::string &sAttrName)
 Declares an attribute name as valid. More...
 
template<typename ... Names>
void addValidAttrNames (const xmlpp::Element *p0Element, const std::string &sAttrName, const Names &... oNames)
 Declares attribute names as valid. More...
 
void removeChecker (const xmlpp::Element *p0Element, bool bCheck)
 Removes a checker for the element. More...
 
std::runtime_error error (const std::string &sErr)
 Creates an exception for the current context. More...
 
void dump () const
 

Protected Member Functions

std::string err (const std::string &sErr) override
 Builds complete error string from context. More...
 
- Protected Member Functions inherited from stmg::ParserCtx
std::vector< Checker >::iterator getChecker (const xmlpp::Element *p0Element)
 

Additional Inherited Members

- Static Public Member Functions inherited from stmg::ParserCtx
static int32_t getLine (const xmlpp::Element *p0Element, const std::string &sAttr)
 The line number within a document of an element or attribute. More...
 
- Protected Attributes inherited from stmg::ParserCtx
const shared_ptr< AppConfigm_refAppConfig
 
shared_ptr< AppPreferencesm_refAppPreferences
 
Namedm_oNamed
 
std::vector< std::string > m_oStack
 
std::vector< Checkerm_aCheckers
 

Constructor & Destructor Documentation

◆ ThemeCtx() [1/2]

stmg::ThemeCtx::ThemeCtx ( const shared_ptr< AppConfig > &  refAppConfig,
StdTheme oTheme,
const std::string &  sThemeName,
File  oFile,
const xmlpp::Element *  p0RootElement 
)

◆ ThemeCtx() [2/2]

stmg::ThemeCtx::ThemeCtx ( ThemeCtx &&  oSource)
default

Member Function Documentation

◆ err()

std::string stmg::ThemeCtx::err ( const std::string &  s)
overrideprotectedvirtual

Builds complete error string from context.

The base implementation concatenates strings passed to pushCtx().

Parameters
sThe error without context.
Returns
The error string with context.

Reimplemented from stmg::ParserCtx.

◆ getThemeFile()

const File& stmg::ThemeCtx::getThemeFile ( ) const
inline

◆ getThemeName()

const std::string& stmg::ThemeCtx::getThemeName ( ) const
inline

◆ isMain()

bool stmg::ThemeCtx::isMain ( ) const
inline

◆ localThemePainterNames()

NamedObjIndex<const xmlpp::Element*>& stmg::ThemeCtx::localThemePainterNames ( )
inline

◆ theme()

StdTheme& stmg::ThemeCtx::theme ( )
inline