Crazy Eddies GUI System: CEGUI::FrameWindowProperties::CloseButtonEnabled 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::FrameWindowProperties::CloseButtonEnabled Class Reference

Property to access the setting for whether the window close button will be enabled (or displayed depending upon choice of final widget type). More...

Inheritance diagram for CEGUI::FrameWindowProperties::CloseButtonEnabled:
[legend]
Collaboration diagram for CEGUI::FrameWindowProperties::CloseButtonEnabled:
[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 the setting for whether the window close button will be enabled (or displayed depending upon choice of final widget type).

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

Where [Text] is:
  - "True" to indicate the windows close button should be enabled (and/or visible)
  - "False" to indicate the windows close button should be disabled (and/or hidden)

## Member Function Documentation

String CEGUI::FrameWindowProperties::CloseButtonEnabled::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::FrameWindowProperties::CloseButtonEnabled::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.