Dimension type that represents some dimension of a Window/widget. Implements BaseDim interface. More...
Inheritance diagram for CEGUI::WidgetDim:
Collaboration diagram for CEGUI::WidgetDim:
Public Member Functions | |
| WidgetDim (const String &name, DimensionType dim) | |
| Constructor. More... | |
| void | setWidgetName (const String &name) |
| Set the name suffix to use for this WidgetDim. More... | |
| void | setSourceDimension (DimensionType dim) |
| Sets the source dimension type for this WidgetDim. More... | |
| Public Member Functions inherited from CEGUI::BaseDim | |
| float | getValue (const Window &wnd) const |
| Return a value that represents this dimension as absolute pixels. More... | |
| float | getValue (const Window &wnd, const Rect &container) const |
| Return a value that represents this dimension as absolute pixels. More... | |
| BaseDim * | clone () const |
| Create an exact copy of the specialised class and return it as a pointer to a BaseDim object. More... | |
| DimensionOperator | getDimensionOperator () const |
| Return the DimensionOperator set for this BaseDim based object. More... | |
| void | setDimensionOperator (DimensionOperator op) |
| Set the DimensionOperator set for this BaseDim based object. More... | |
| const BaseDim * | getOperand () const |
| Return a pointer to the BaseDim set to be used as the other operand. More... | |
| void | setOperand (const BaseDim &operand) |
| Set the BaseDim set to be used as the other operand in calculations for this BaseDim. More... | |
| void | writeXMLToStream (XMLSerializer &xml_stream) const |
| Writes an xml representation of this BaseDim to out_stream. More... | |
Protected Member Functions | |
| float | getValue_impl (const Window &wnd) const |
| Implementataion method to return the base value for this BaseDim. This method should not attempt to apply the mathematical operator; this is handled automatically. | |
| float | getValue_impl (const Window &wnd, const Rect &container) const |
| Implementataion method to return the base value for this BaseDim. This method should not attempt to apply the mathematical operator; this is handled automatically by BaseDim. | |
| void | writeXMLElementName_impl (XMLSerializer &xml_stream) const |
| Implementataion method to output real xml element name. | |
| void | writeXMLElementAttributes_impl (XMLSerializer &xml_stream) const |
| Implementataion method to create the element attributes. | |
| BaseDim * | clone_impl () const |
| Implementataion method to return a clone of this sub-class of BaseDim. This method should not attempt to clone the mathematical operator or operand; theis is handled automatically by BaseDim. | |
Detailed Description
Dimension type that represents some dimension of a Window/widget. Implements BaseDim interface.
When calculating the final pixel value for the dimension, a target widget name is built by appending the name suffix specified for the WidgetDim to the name of the window passed to getValue, we then find the window/widget with that name - the final value of the dimension is taken from this window/widget.
Constructor & Destructor Documentation
| CEGUI::WidgetDim::WidgetDim | ( | const String & | name, |
| DimensionType | dim | ||
| ) |
Member Function Documentation
| void CEGUI::WidgetDim::setSourceDimension | ( | DimensionType | dim | ) |
