Crazy Eddies GUI System: CEGUI::WindowProperties::TextParsingEnabled Class Reference

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
CEGUI::WindowProperties::TextParsingEnabled Class Reference

Property to access window text parsing enabled setting. More...

Inheritance diagram for CEGUI::WindowProperties::TextParsingEnabled:
[legend]
Collaboration diagram for CEGUI::WindowProperties::TextParsingEnabled:
[legend]

List of all members.

## Public Member Functions
String | get (const PropertyReceiver *receiver) const
| Return the current value of the Property as a String.
void | set (PropertyReceiver *receiver, const String &value)
| Sets the value of the property.

## Detailed Description

Property to access window text parsing enabled setting.

This property offers access to the text parsing setting for the window that specifies whether parsing will be done or whether text will be rendered verbatim.

Usage:
  - Name: TextParsingEnabled
  - Format: "[text]".

Where [Text] is:
  - "True" to indicate some form of parsing of window text is to occur.
  - "False" to indicate that text should not be parsed, but be rendered verbatim.

## Member Function Documentation

String CEGUI::WindowProperties::TextParsingEnabled::get | ( | const PropertyReceiver * | receiver | ) | const`[virtual]`

Return the current value of the Property as a String.

Parameters:

  receiver | Pointer to the target object.

Returns:
  String object containing a textual representation of the current value of the Property

Implements CEGUI::Property.

void CEGUI::WindowProperties::TextParsingEnabled::set | ( | PropertyReceiver * | receiver,
|  | const String & | value
| ) |  | `[virtual]`

Sets the value of the property.

Parameters:

  receiver | Pointer to the target object.
  value | A String object that contains a textual representation of the new value to assign to the Property.

Returns:
  Nothing.

Exceptions:

  InvalidRequestException | Thrown when the Property was unable to interpret the content of value.

Implements CEGUI::Property.