ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

#include <ThemeParser.h>

Inheritance diagram for GUI::ThemeParser:
Collaboration diagram for GUI::ThemeParser:

List of all members.

Classes

struct  PaletteColor

Public Member Functions

 ThemeParser (ThemeEngine *parent)
virtual ~ThemeParser ()
bool getPaletteColor (const Common::String &name, int &r, int &g, int &b)

Protected Member Functions

 CUSTOM_XML_PARSER (ThemeParser)
 PARSER_END () bool parserCallback_render_info(ParserNode *node)
 Render info callbacks.
bool parserCallback_defaults (ParserNode *node)
bool parserCallback_font (ParserNode *node)
bool parserCallback_text_color (ParserNode *node)
bool parserCallback_fonts (ParserNode *node)
bool parserCallback_text (ParserNode *node)
bool parserCallback_palette (ParserNode *node)
bool parserCallback_color (ParserNode *node)
bool parserCallback_drawstep (ParserNode *node)
bool parserCallback_drawdata (ParserNode *node)
bool parserCallback_bitmaps (ParserNode *node)
bool parserCallback_bitmap (ParserNode *node)
bool parserCallback_alphabitmap (ParserNode *node)
bool parserCallback_cursor (ParserNode *node)
bool parserCallback_layout_info (ParserNode *node)
 Layout info callbacks.
bool parserCallback_globals (ParserNode *node)
bool parserCallback_def (ParserNode *node)
bool parserCallback_widget (ParserNode *node)
bool parserCallback_dialog (ParserNode *node)
bool parserCallback_layout (ParserNode *node)
bool parserCallback_space (ParserNode *node)
bool parserCallback_import (ParserNode *node)
bool closedKeyCallback (ParserNode *node)
 The closed key callback function MAY be overloaded by inheriting classes to implement parser-specific functions.
bool resolutionCheck (const Common::String &resolution)
void cleanup ()
 Overload if your parser needs to support parsing the same file several times, so you can clean up the internal state of the parser before each parse.
Graphics::DrawStepnewDrawStep ()
Graphics::DrawStepdefaultDrawStep ()
bool parseDrawStep (ParserNode *stepNode, Graphics::DrawStep *drawstep, bool functionSpecific)
bool parseCommonLayoutProps (ParserNode *node, const Common::String &var)

Protected Attributes

ThemeEngine_theme
Graphics::DrawStep_defaultStepGlobal
Graphics::DrawStep_defaultStepLocal
Common::HashMap
< Common::String, PaletteColor,
Common::IgnoreCase_Hash,
Common::IgnoreCase_EqualTo
_palette

Detailed Description

Definition at line 33 of file ThemeParser.h.


Constructor & Destructor Documentation

GUI::ThemeParser::ThemeParser ( ThemeEngine parent  ) 

Definition at line 105 of file ThemeParser.cpp.

GUI::ThemeParser::~ThemeParser (  )  [virtual]

Definition at line 111 of file ThemeParser.cpp.


Member Function Documentation

void GUI::ThemeParser::cleanup (  )  [protected, virtual]

Overload if your parser needs to support parsing the same file several times, so you can clean up the internal state of the parser before each parse.

Reimplemented from Common::XMLParser.

Definition at line 116 of file ThemeParser.cpp.

bool GUI::ThemeParser::closedKeyCallback ( ParserNode node  )  [protected, virtual]

The closed key callback function MAY be overloaded by inheriting classes to implement parser-specific functions.

The closedKeyCallback is issued once a key has been finished parsing, to let the parser verify that all the required subkeys, etc, were included.

Unlike the keyCallbacks(), there's just a closedKeyCallback() for all keys. Use "node->name" to distinguish between each key type.

Returns true if the key was properly closed, false otherwise. By default, all keys are properly closed.

Reimplemented from Common::XMLParser.

Definition at line 802 of file ThemeParser.cpp.

GUI::ThemeParser::CUSTOM_XML_PARSER ( ThemeParser   )  [inline, protected]

Definition at line 53 of file ThemeParser.h.

Graphics::DrawStep * GUI::ThemeParser::defaultDrawStep (  )  [protected]

Definition at line 125 of file ThemeParser.cpp.

bool GUI::ThemeParser::getPaletteColor ( const Common::String name,
int &  r,
int &  g,
int &  b 
) [inline]

Definition at line 39 of file ThemeParser.h.

Graphics::DrawStep * GUI::ThemeParser::newDrawStep (  )  [protected]

Definition at line 142 of file ThemeParser.cpp.

bool GUI::ThemeParser::parseCommonLayoutProps ( ParserNode node,
const Common::String var 
) [protected]

Definition at line 811 of file ThemeParser.cpp.

bool GUI::ThemeParser::parseDrawStep ( ParserNode stepNode,
Graphics::DrawStep drawstep,
bool  functionSpecific 
) [protected]

Helper macro to sanitize and assign an integer value from a key to the draw step.

Parameters:
struct_name Name of the field of a DrawStep struct that must be assigned.
key_name Name as STRING of the key identifier as it appears in the theme description format.
force Sets if the key is optional or necessary.

Helper macro to sanitize and assign a RGB value from a key to the draw step. RGB values have the following syntax: "R, G, B".

Parameters:
struct_name Name of the field of a DrawStep struct that must be assigned.
key_name Name as STRING of the key identifier as it appears in the theme description format.

Definition at line 390 of file ThemeParser.cpp.

GUI::ThemeParser::PARSER_END (  )  [protected]

Render info callbacks.

bool GUI::ThemeParser::parserCallback_alphabitmap ( ParserNode node  )  [protected]

Definition at line 244 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_bitmap ( ParserNode node  )  [protected]

Definition at line 232 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_bitmaps ( ParserNode node  )  [inline, protected]

Definition at line 230 of file ThemeParser.h.

bool GUI::ThemeParser::parserCallback_color ( ParserNode node  )  [protected]

Definition at line 294 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_cursor ( ParserNode node  )  [protected]

Definition at line 215 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_def ( ParserNode node  )  [protected]

Definition at line 639 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_defaults ( ParserNode node  )  [protected]

Definition at line 155 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_dialog ( ParserNode node  )  [protected]

Definition at line 713 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_drawdata ( ParserNode node  )  [protected]

Definition at line 368 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_drawstep ( ParserNode node  )  [protected]

Definition at line 345 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_font ( ParserNode node  )  [protected]

Definition at line 173 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_fonts ( ParserNode node  )  [protected]

Definition at line 211 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_globals ( ParserNode node  )  [inline, protected]

Definition at line 238 of file ThemeParser.h.

bool GUI::ThemeParser::parserCallback_import ( ParserNode node  )  [protected]

Definition at line 749 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_layout ( ParserNode node  )  [protected]

Definition at line 756 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_layout_info ( ParserNode node  )  [protected]

Layout info callbacks.

Definition at line 283 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_palette ( ParserNode node  )  [protected]

Definition at line 290 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_space ( ParserNode node  )  [protected]

Definition at line 787 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_text ( ParserNode node  )  [protected]

Definition at line 256 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_text_color ( ParserNode node  )  [protected]

Definition at line 193 of file ThemeParser.cpp.

bool GUI::ThemeParser::parserCallback_widget ( ParserNode node  )  [protected]

Definition at line 658 of file ThemeParser.cpp.

bool GUI::ThemeParser::resolutionCheck ( const Common::String resolution  )  [protected]

Definition at line 937 of file ThemeParser.cpp.


Member Data Documentation

Definition at line 258 of file ThemeParser.h.

Definition at line 51 of file ThemeParser.h.


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


Generated on Sat May 25 2019 05:06:02 for ResidualVM by doxygen 1.7.1
curved edge   curved edge