CL_GUITheme Class Reference
[clanGUI System]

GUI theme. More...

#include <gui_theme.h>

Inheritance diagram for CL_GUITheme:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_GUITheme (CL_GUIThemeProvider *provider)
 Constructs a theme.
 ~CL_GUITheme ()
Attributes

bool is_null () const
 Is Null.
CL_GUIThemeProviderget_provider () const
 Retrieves the provider.
CL_StringRef get_property (const CL_GUIThemePart &part, const CL_StringRef &name, const CL_StringRef &css_value)
 Allows the theme to alter GUI part properties.
CL_ResourceManager get_resources () const
 Returns the resource manager associated with the theme.
Operations

void set_resources (CL_ResourceManager resources)
 Sets the resource manager to be used to retrieve resources.
void add_resources (CL_ResourceManager resources)
 Adds a resource manager to be used to retrieve resources.
void render_box (CL_GraphicContext &gc, CL_GUIThemePart &part, const CL_Rect &rect, const CL_Rect &clip_rect)
 Renders a background box for the given theme part.
CL_Rect render_text (CL_GraphicContext &gc, CL_GUIThemePart &part, CL_Font &font, const CL_StringRef &text, const CL_Rect &content_rect, const CL_Rect &clip_rect)
void component_destroyed (CL_GUIComponent *component)
 Notifies the theme that a component has been destroyed.

Detailed Description

GUI theme.


Constructor & Destructor Documentation

CL_GUITheme::CL_GUITheme ( CL_GUIThemeProvider provider  ) 

Constructs a theme.

Parameters:
provider = The theme provider
CL_GUITheme::~CL_GUITheme (  ) 

Member Function Documentation

void CL_GUITheme::add_resources ( CL_ResourceManager  resources  ) 

Adds a resource manager to be used to retrieve resources.

void CL_GUITheme::component_destroyed ( CL_GUIComponent component  ) 

Notifies the theme that a component has been destroyed.

CL_StringRef CL_GUITheme::get_property ( const CL_GUIThemePart part,
const CL_StringRef name,
const CL_StringRef css_value 
)

Allows the theme to alter GUI part properties.

When a component queries a theme part for a property, the property is searched in the CSS document and then passed to get_property. If the theme does not wish to alter the value of the property, it simply returns the css_value parameter. The string returned by this function is the result of CL_GUIThemePart::get_property.

CL_GUIThemeProvider* CL_GUITheme::get_provider (  )  const

Retrieves the provider.

Reimplemented in CL_GUIThemeDefault.

CL_ResourceManager CL_GUITheme::get_resources (  )  const

Returns the resource manager associated with the theme.

bool CL_GUITheme::is_null (  )  const

Is Null.

Returns:
true = null
void CL_GUITheme::render_box ( CL_GraphicContext gc,
CL_GUIThemePart part,
const CL_Rect rect,
const CL_Rect clip_rect 
)

Renders a background box for the given theme part.

CL_Rect CL_GUITheme::render_text ( CL_GraphicContext gc,
CL_GUIThemePart part,
CL_Font font,
const CL_StringRef text,
const CL_Rect content_rect,
const CL_Rect clip_rect 
)
void CL_GUITheme::set_resources ( CL_ResourceManager  resources  ) 

Sets the resource manager to be used to retrieve resources.


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