Xrb::WidgetSkinHandler Class Reference
Manages changes to the contained WidgetSkin. More...
#include <xrb_widgetskinhandler.hpp>
Detailed Description
Manages changes to the contained WidgetSkin.This class is a baseclass for Widget. It was made separate to keep Widget from getting too bulky, and to separate the code out into nice, logical sections.
See Widget Skinning for detailed info.
Definition at line 33 of file xrb_widgetskinhandler.hpp.
Constructor & Destructor Documentation
| Xrb::WidgetSkinHandler::WidgetSkinHandler | ( | ) |
Default constructor.
The default behavior is to default m_widget_skin to NULL, and let it be set properly when attaching the Widget to its parent. The WidgetSkin is, by default, not deleted when this object is destroyed.
Definition at line 16 of file xrb_widgetskinhandler.cpp.
References m_delete_widget_skin, and m_widget_skin.
| Xrb::WidgetSkinHandler::~WidgetSkinHandler | ( | ) | [virtual] |
Destructor.
Iff m_delete_widget_skin is true, m_widget_skin is deleted.
Definition at line 22 of file xrb_widgetskinhandler.cpp.
References Xrb::Delete(), m_delete_widget_skin, and m_widget_skin.
Member Function Documentation
| WidgetBackground const* Xrb::WidgetSkinHandler::WidgetSkinWidgetBackground | ( | WidgetSkin::WidgetBackgroundType const | widget_background_type | ) | const [inline] |
Frontend for Xrb::WidgetSkin::GetWidgetBackground .
- Parameters:
-
widget_background_type The background type to retrieve.
Definition at line 61 of file xrb_widgetskinhandler.hpp.
References Xrb::WidgetSkin::GetWidgetBackground(), and m_widget_skin.
Referenced by Xrb::ModalWidget::UpdateRenderBackground().
| Resource<Font> const& Xrb::WidgetSkinHandler::WidgetSkinFont | ( | WidgetSkin::FontType const | font_type | ) | const [inline] |
Frontend for Xrb::WidgetSkin::GetFont .
- Parameters:
-
font_type The font type to retrieve.
Definition at line 69 of file xrb_widgetskinhandler.hpp.
References Xrb::WidgetSkin::GetFont(), and m_widget_skin.
| Resource<GLTexture> const& Xrb::WidgetSkinHandler::WidgetSkinTexture | ( | WidgetSkin::TextureType const | texture_type | ) | const [inline] |
Frontend for Xrb::WidgetSkin::GetTexture .
- Parameters:
-
texture_type The texture type to retrieve.
Definition at line 77 of file xrb_widgetskinhandler.hpp.
References Xrb::WidgetSkin::GetTexture(), and m_widget_skin.
| ScreenCoordVector2 const& Xrb::WidgetSkinHandler::WidgetSkinMargins | ( | WidgetSkin::MarginsType const | margins_type | ) | const [inline] |
Frontend for Xrb::WidgetSkin::Margins .
- Parameters:
-
margins_type The margins type to retrieve.
Definition at line 85 of file xrb_widgetskinhandler.hpp.
References m_widget_skin, and Xrb::WidgetSkin::Margins().
Referenced by Xrb::Widget::InitializeFromWidgetSkinProperties().
| virtual Uint32 Xrb::WidgetSkinHandler::WidgetSkinHandlerChildCount | ( | ) | const [protected, pure virtual] |
Returns the number of child WidgetSkinHandler objects this object owns.
This method must be implemented by baseclasses (Widget).
Implemented in Xrb::Widget.
| virtual WidgetSkinHandler* Xrb::WidgetSkinHandler::WidgetSkinHandlerChild | ( | Uint32 | index | ) | [protected, pure virtual] |
Returns the indexed child WidgetSkinHandler.
This method must be implemented by baseclasses (Widget).
- Parameters:
-
index The index of the child to return.
Implemented in Xrb::Widget.
| virtual WidgetSkinHandler* Xrb::WidgetSkinHandler::WidgetSkinHandlerParent | ( | ) | [protected, pure virtual] |
Returns the parent WidgetSkinHandler of this object.
This method must be implemented by baseclasses (Widget).
Implemented in Xrb::Widget.
| virtual void Xrb::WidgetSkinHandler::HandleChangedWidgetSkinWidgetBackground | ( | WidgetSkin::WidgetBackgroundType | widget_background_type | ) | [inline, protected, virtual] |
Called when a widget background is changed.
This method may be overridden by subclasses when it is necessary to know when a widget background has been changed, for example, to update the render background for a Button.
Reimplemented in Xrb::ModalWidget.
Definition at line 171 of file xrb_widgetskinhandler.hpp.
| virtual void Xrb::WidgetSkinHandler::HandleChangedWidgetSkinFont | ( | WidgetSkin::FontType | font_type | ) | [inline, protected, virtual] |
Called when a font is changed.
This method may be overridden by subclasses when it is necessary to know when a font has been changed, for example, to update the render font for a Label.
Definition at line 178 of file xrb_widgetskinhandler.hpp.
| virtual void Xrb::WidgetSkinHandler::HandleChangedWidgetSkinTexture | ( | WidgetSkin::TextureType | texture_type | ) | [inline, protected, virtual] |
Called when a texture is changed.
This method may be overridden by subclasses when it is necessary to know when a texture has been changed, for example, to update the render picture for a CheckBox.
Definition at line 185 of file xrb_widgetskinhandler.hpp.
| virtual void Xrb::WidgetSkinHandler::HandleChangedWidgetSkinMargins | ( | WidgetSkin::MarginsType | margins_type | ) | [inline, protected, virtual] |
Called when a margins vector is changed.
This method may be overridden by subclasses when it is necessary to know when a margins vector has been changed, for example, to update the properties of a Layout.
Definition at line 192 of file xrb_widgetskinhandler.hpp.
Member Data Documentation
WidgetSkin* Xrb::WidgetSkinHandler::m_widget_skin [protected] |
A pointer to the contained WidgetSkin object.
This object will only be deleted iff m_delete_widget_skin is true.
Definition at line 198 of file xrb_widgetskinhandler.hpp.
Referenced by GetWidgetSkin(), WidgetSkinFont(), WidgetSkinHandler(), WidgetSkinMargins(), WidgetSkinTexture(), WidgetSkinWidgetBackground(), and ~WidgetSkinHandler().
bool Xrb::WidgetSkinHandler::m_delete_widget_skin [protected] |
Indicates if m_widget_skin should be deleted upon destruction.
The default value is false. Widget/Screen sets this according to wether or not it is a top-level widget.
Definition at line 204 of file xrb_widgetskinhandler.hpp.
Referenced by WidgetSkinHandler(), and ~WidgetSkinHandler().
The documentation for this class was generated from the following files:
