Public Member Functions

CEGUI::FalagardEditboxProperties::BlinkCaret Class Reference

Property to access the setting that controls whether the caret will blink. More...

Inheritance diagram for CEGUI::FalagardEditboxProperties::BlinkCaret:
Collaboration diagram for CEGUI::FalagardEditboxProperties::BlinkCaret:

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 that controls whether the caret will blink.

Usage:
Where [Text] is:
  • "True" to indicate the caret should blink when he editbox is active.
  • "False" to indicate the caret should not blink.

Member Function Documentation

String CEGUI::FalagardEditboxProperties::BlinkCaret::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::FalagardEditboxProperties::BlinkCaret::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.