Rocket::Controls::DataFormatter Class Reference
#include <DataFormatter.h>
Inheritance diagram for Rocket::Controls::DataFormatter:
Public Member Functions | |
| DataFormatter (const Rocket::Core::String &name="") | |
| const Rocket::Core::String & | GetDataFormatterName () |
| virtual void | FormatData (Rocket::Core::String &formatted_data, const Rocket::Core::StringList &raw_data)=0 |
| virtual void * | GetScriptObject () const |
Static Public Member Functions | |
| static DataFormatter * | GetDataFormatter (const Rocket::Core::String &data_formatter_name) |
Detailed Description
Abstract base class for a data formatter. A data formatter takes raw data and processes it into a final string. They are usually used in conjunction with a data source and a datagrid.
Member Function Documentation
| const Rocket::Core::String & Rocket::Controls::DataFormatter::GetDataFormatterName | ( | ) |
Returns the name by which this data formatter is referenced by.
- Returns:
- The name of this data formatter.
| DataFormatter * Rocket::Controls::DataFormatter::GetDataFormatter | ( | const Rocket::Core::String & | data_formatter_name | ) | [static] |
Returns a data formatter with the given name. [in] data_formatter_name The name of the data formatter to be returned.
- Returns:
- If the data formatter with the specified name has been constructed, a pointer to it will be returned. Otherwise, NULL.
| virtual void Rocket::Controls::DataFormatter::FormatData | ( | Rocket::Core::String & | formatted_data, | |
| const Rocket::Core::StringList & | raw_data | |||
| ) | [pure virtual] |
Formats the raw results of a data source request into RML.
- Parameters:
-
[out] formatted_data The formatted RML. [in] raw_data A list of the raw data fields.
Implemented in Rocket::Controls::Python::DataFormatterWrapper.
The documentation for this class was generated from the following files:
- Include/Rocket/Controls/DataFormatter.h
- Source/Controls/DataFormatter.cpp
