My Project
SallyAPI::Config::CTheme Class Reference

Theme. More...

#include <Theme.h>

List of all members.

Public Member Functions

 CTheme (const std::string &name)
 Constructor.
 ~CTheme ()
 Destructor.
SallyAPI::GUI::CPictureGetPicture (int id)
 Gets a picture.
std::string GetThemePath ()
 Gets the theme path.
std::string GetThemeName ()
 Gets the theme name.
void AddPicture (const std::string &filename, int id, int graphicId, bool createMipMaps=false)
 Adds a picture.
void AddPicturePlugin (const std::string &pluginPath, const std::string &pluginName, const std::string &filename, bool createMipMaps, int id)
 Adds a picture plugin.
void AddPictureFullPath (const std::string &filename, int id, bool createMipMaps)
 Adds a picture full path.
void RemovePicture (int id)
 Removes the picture plugin described by id.
int GetPropertyInt (const std::string &component, const std::string &id, const std::string &defaultString="Unknown")
 Gets a property int.
std::string GetPropertyString (const std::string &component, const std::string &id, const std::string &defaultString="Unknown")
 Gets a property string.
std::map< int, std::string > & GetAdvancedImages ()
 Gets the advanced images.
std::map< int,
SallyAPI::Config::CThemePluginImage * > & 
GetPluginImages ()

Detailed Description

Theme.

Author:
Christian Knobloch
Date:
19.04.2010

Constructor & Destructor Documentation

CTheme::CTheme ( const std::string &  name)

Constructor.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
nameThe name.

Destructor.

Author:
Christian Knobloch
Date:
19.04.2010

Member Function Documentation

void CTheme::AddPicture ( const std::string &  filename,
int  id,
int  graphicId,
bool  createMipMaps = false 
)

Adds a picture.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
filenameFilename of the file.
idThe identifier.
graphicIdIdentifier for the graphic.
createMipMapstrue to create mip maps.
void CTheme::AddPictureFullPath ( const std::string &  filename,
int  id,
bool  createMipMaps 
)

Adds a picture full path.

Author:
Christian Knobloch
Date:
27.12.2010
Parameters:
filenameFilename of the file.
idThe identifier.
createMipMapstrue to create mip maps.
void CTheme::AddPicturePlugin ( const std::string &  pluginPath,
const std::string &  pluginName,
const std::string &  filename,
bool  createMipMaps,
int  id 
)

Adds a picture plugin.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
pluginPathFull pathname of the plugin file.
pluginNameName of the plugin.
filenameFilename of the file.
createMipMapstrue to create mip maps.
idThe identifier.
std::map< int, std::string > & CTheme::GetAdvancedImages ( )

Gets the advanced images.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The advanced images.

Gets a picture.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
idThe identifier.
Returns:
null if it fails, else the picture.
int CTheme::GetPropertyInt ( const std::string &  component,
const std::string &  id,
const std::string &  defaultString = "Unknown" 
)

Gets a property int.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
componentThe component.
idThe identifier.
defaultStringDefault string.
Returns:
The property int.
std::string CTheme::GetPropertyString ( const std::string &  component,
const std::string &  id,
const std::string &  defaultString = "Unknown" 
)

Gets a property string.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
componentThe component.
idThe identifier.
defaultStringDefault string.
Returns:
The property string.
std::string CTheme::GetThemeName ( )

Gets the theme name.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The theme name.
std::string CTheme::GetThemePath ( )

Gets the theme path.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The theme path.
void CTheme::RemovePicture ( int  id)

Removes the picture plugin described by id.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
idThe identifier.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines