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

Public Member Functions

 XmlImageParser (XmlConditionalParser &oXmlConditionalParser)
 
int32_t parseImageId (ConditionalCtx &oCtx, const xmlpp::Element *p0Element, const std::string &sImgIdAttr, bool bAttrMandatory)
 Parses image id. More...
 
int32_t parseImageId (ConditionalCtx &oCtx, const xmlpp::Element *p0Element, bool bAttrMandatory)
 Parses image id using attribute name defaults. More...
 

Static Public Attributes

static const std::string s_sImagesImageIdAttr
 The default image id attribute name. More...
 

Protected Attributes

XmlConditionalParserm_oXmlConditionalParser
 

Constructor & Destructor Documentation

◆ XmlImageParser()

stmg::XmlImageParser::XmlImageParser ( XmlConditionalParser oXmlConditionalParser)

Member Function Documentation

◆ parseImageId() [1/2]

int32_t stmg::XmlImageParser::parseImageId ( ConditionalCtx oCtx,
const xmlpp::Element *  p0Element,
const std::string &  sImgIdAttr,
bool  bAttrMandatory 
)

Parses image id.

Parameters
oCtxThe context.
p0ElementThe element. Cannot be null.
sImgIdAttrThe image id attribute.
bAttrMandatoryWhether either attribute must be defined.
Returns
The image id index into Named::images() or -1 if not defined.

◆ parseImageId() [2/2]

int32_t stmg::XmlImageParser::parseImageId ( ConditionalCtx oCtx,
const xmlpp::Element *  p0Element,
bool  bAttrMandatory 
)

Parses image id using attribute name defaults.

Parameters
oCtxThe context.
p0ElementThe element. Cannot be null.
bAttrMandatoryWhether either attribute must be defined.
Returns
The image id index into Named::images() or -1 if not defined.

Member Data Documentation

◆ m_oXmlConditionalParser

XmlConditionalParser& stmg::XmlImageParser::m_oXmlConditionalParser
protected

◆ s_sImagesImageIdAttr

const std::string stmg::XmlImageParser::s_sImagesImageIdAttr
static

The default image id attribute name.