CEGUI::Property Class Reference

An abstract class that defines the interface to access object properties by name. More...

Inherited by CEGUI::CheckboxProperties::Selected, CEGUI::ComboboxProperties::CaratIndex, CEGUI::ComboboxProperties::EditSelectionLength, CEGUI::ComboboxProperties::EditSelectionStart, CEGUI::ComboboxProperties::ForceHorzScrollbar, CEGUI::ComboboxProperties::ForceVertScrollbar, CEGUI::ComboboxProperties::MaxEditTextLength, CEGUI::ComboboxProperties::ReadOnly, CEGUI::ComboboxProperties::SingleClickMode, CEGUI::ComboboxProperties::SortList, CEGUI::ComboboxProperties::ValidationString, CEGUI::DragContainerProperties::DragAlpha, CEGUI::DragContainerProperties::DragCursorImage, CEGUI::DragContainerProperties::DraggingEnabled, CEGUI::DragContainerProperties::DragThreshold, CEGUI::DragContainerProperties::FixedDragOffset, CEGUI::DragContainerProperties::StickyMode, CEGUI::DragContainerProperties::UseFixedDragOffset, CEGUI::EditboxProperties::ActiveSelectionColour, CEGUI::EditboxProperties::CaratIndex, CEGUI::EditboxProperties::InactiveSelectionColour, CEGUI::EditboxProperties::MaskCodepoint, CEGUI::EditboxProperties::MaskText, CEGUI::EditboxProperties::MaxTextLength, CEGUI::EditboxProperties::NormalTextColour, CEGUI::EditboxProperties::ReadOnly, CEGUI::EditboxProperties::SelectedTextColour, CEGUI::EditboxProperties::SelectionLength, CEGUI::EditboxProperties::SelectionStart, CEGUI::EditboxProperties::ValidationString, CEGUI::FalagardEditboxProperties::BlinkCaret, CEGUI::FalagardEditboxProperties::BlinkCaretTimeout, CEGUI::FalagardListHeaderProperties::SegmentWidgetType, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaret, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaretTimeout, CEGUI::FalagardProgressBarProperties::ReversedProgress, CEGUI::FalagardProgressBarProperties::VerticalProgress, CEGUI::FalagardScrollbarProperties::VerticalScrollbar, CEGUI::FalagardSliderProperties::ReversedDirection, CEGUI::FalagardSliderProperties::VerticalSlider, CEGUI::FalagardStaticImageProperties::Image, CEGUI::FalagardStaticProperties::BackgroundEnabled, CEGUI::FalagardStaticProperties::FrameEnabled, CEGUI::FalagardStaticTextProperties::HorzExtent, CEGUI::FalagardStaticTextProperties::HorzFormatting, CEGUI::FalagardStaticTextProperties::HorzScrollbar, CEGUI::FalagardStaticTextProperties::TextColours, CEGUI::FalagardStaticTextProperties::VertExtent, CEGUI::FalagardStaticTextProperties::VertFormatting, CEGUI::FalagardStaticTextProperties::VertScrollbar, CEGUI::FalagardTabControlProperties::TabButtonType, CEGUI::FrameWindowProperties::CloseButtonEnabled, CEGUI::FrameWindowProperties::DragMovingEnabled, CEGUI::FrameWindowProperties::EWSizingCursorImage, CEGUI::FrameWindowProperties::FrameEnabled, CEGUI::FrameWindowProperties::NESWSizingCursorImage, CEGUI::FrameWindowProperties::NSSizingCursorImage, CEGUI::FrameWindowProperties::NWSESizingCursorImage, CEGUI::FrameWindowProperties::RollUpEnabled, CEGUI::FrameWindowProperties::RollUpState, CEGUI::FrameWindowProperties::SizingBorderThickness, CEGUI::FrameWindowProperties::SizingEnabled, CEGUI::FrameWindowProperties::TitlebarEnabled, CEGUI::ItemEntryProperties::Selectable, CEGUI::ItemEntryProperties::Selected, CEGUI::ItemListBaseProperties::AutoResizeEnabled, CEGUI::ItemListBaseProperties::SortEnabled, CEGUI::ItemListBaseProperties::SortMode, CEGUI::ItemListboxProperties::MultiSelect, CEGUI::ListboxProperties::ForceHorzScrollbar, CEGUI::ListboxProperties::ForceVertScrollbar, CEGUI::ListboxProperties::ItemTooltips, CEGUI::ListboxProperties::MultiSelect, CEGUI::ListboxProperties::Sort, CEGUI::ListHeaderProperties::ColumnsMovable, CEGUI::ListHeaderProperties::ColumnsSizable, CEGUI::ListHeaderProperties::SortColumnID, CEGUI::ListHeaderProperties::SortDirection, CEGUI::ListHeaderProperties::SortSettingEnabled, CEGUI::ListHeaderSegmentProperties::Clickable, CEGUI::ListHeaderSegmentProperties::Dragable, CEGUI::ListHeaderSegmentProperties::MovingCursorImage, CEGUI::ListHeaderSegmentProperties::Sizable, CEGUI::ListHeaderSegmentProperties::SizingCursorImage, CEGUI::ListHeaderSegmentProperties::SortDirection, CEGUI::MenuBaseProperties::AllowMultiplePopups, CEGUI::MenuBaseProperties::ItemSpacing, CEGUI::MultiColumnListProperties::ColumnHeader, CEGUI::MultiColumnListProperties::ColumnsMovable, CEGUI::MultiColumnListProperties::ColumnsSizable, CEGUI::MultiColumnListProperties::ForceHorzScrollbar, CEGUI::MultiColumnListProperties::ForceVertScrollbar, CEGUI::MultiColumnListProperties::NominatedSelectionColumnID, CEGUI::MultiColumnListProperties::NominatedSelectionRow, CEGUI::MultiColumnListProperties::RowCount, CEGUI::MultiColumnListProperties::SelectionMode, CEGUI::MultiColumnListProperties::SortColumnID, CEGUI::MultiColumnListProperties::SortDirection, CEGUI::MultiColumnListProperties::SortSettingEnabled, CEGUI::MultiLineEditboxProperties::CaratIndex, CEGUI::MultiLineEditboxProperties::ForceVertScrollbar, CEGUI::MultiLineEditboxProperties::MaxTextLength, CEGUI::MultiLineEditboxProperties::ReadOnly, CEGUI::MultiLineEditboxProperties::SelectionBrushImage, CEGUI::MultiLineEditboxProperties::SelectionLength, CEGUI::MultiLineEditboxProperties::SelectionStart, CEGUI::MultiLineEditboxProperties::WordWrap, CEGUI::PopupMenuProperties::FadeInTime, CEGUI::PopupMenuProperties::FadeOutTime, CEGUI::ProgressBarProperties::CurrentProgress, CEGUI::ProgressBarProperties::StepSize, CEGUI::PropertyDefinitionBase, CEGUI::RadioButtonProperties::GroupID, CEGUI::RadioButtonProperties::Selected, CEGUI::ScrollablePaneProperties::ContentArea, CEGUI::ScrollablePaneProperties::ContentPaneAutoSized, CEGUI::ScrollablePaneProperties::ForceHorzScrollbar, CEGUI::ScrollablePaneProperties::ForceVertScrollbar, CEGUI::ScrollablePaneProperties::HorzOverlapSize, CEGUI::ScrollablePaneProperties::HorzScrollPosition, CEGUI::ScrollablePaneProperties::HorzStepSize, CEGUI::ScrollablePaneProperties::VertOverlapSize, CEGUI::ScrollablePaneProperties::VertScrollPosition, CEGUI::ScrollablePaneProperties::VertStepSize, CEGUI::ScrollbarProperties::DocumentSize, CEGUI::ScrollbarProperties::OverlapSize, CEGUI::ScrollbarProperties::PageSize, CEGUI::ScrollbarProperties::ScrollPosition, CEGUI::ScrollbarProperties::StepSize, CEGUI::ScrolledContainerProperties::ChildExtentsArea, CEGUI::ScrolledContainerProperties::ContentArea, CEGUI::ScrolledContainerProperties::ContentPaneAutoSized, CEGUI::ScrolledItemListBaseProperties::ForceHorzScrollbar, CEGUI::ScrolledItemListBaseProperties::ForceVertScrollbar, CEGUI::SliderProperties::ClickStepSize, CEGUI::SliderProperties::CurrentValue, CEGUI::SliderProperties::MaximumValue, CEGUI::SpinnerProperties::CurrentValue, CEGUI::SpinnerProperties::MaximumValue, CEGUI::SpinnerProperties::MinimumValue, CEGUI::SpinnerProperties::StepSize, CEGUI::SpinnerProperties::TextInputMode, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::TabPanePosition, CEGUI::TabControlProperties::TabTextPadding, CEGUI::ThumbProperties::HorzFree, CEGUI::ThumbProperties::HorzRange, CEGUI::ThumbProperties::HotTracked, CEGUI::ThumbProperties::VertFree, CEGUI::ThumbProperties::VertRange, CEGUI::TitlebarProperties::DraggingEnabled, CEGUI::TooltipProperties::DisplayTime, CEGUI::TooltipProperties::FadeTime, CEGUI::TooltipProperties::HoverTime, CEGUI::TreeProperties::ForceHorzScrollbar, CEGUI::TreeProperties::ForceVertScrollbar, CEGUI::TreeProperties::ItemTooltips, CEGUI::TreeProperties::MultiSelect, CEGUI::TreeProperties::Sort, CEGUI::WindowProperties::Alpha, CEGUI::WindowProperties::AlwaysOnTop, CEGUI::WindowProperties::AutoRenderingSurface, CEGUI::WindowProperties::AutoRepeatDelay, CEGUI::WindowProperties::AutoRepeatRate, CEGUI::WindowProperties::ClippedByParent, CEGUI::WindowProperties::CustomTooltipType, CEGUI::WindowProperties::DestroyedByParent, CEGUI::WindowProperties::Disabled, CEGUI::WindowProperties::DistributeCapturedInputs, CEGUI::WindowProperties::DragDropTarget, CEGUI::WindowProperties::Font, CEGUI::WindowProperties::HorizontalAlignment, CEGUI::WindowProperties::ID, CEGUI::WindowProperties::InheritsAlpha, CEGUI::WindowProperties::InheritsTooltipText, CEGUI::WindowProperties::LookNFeel, CEGUI::WindowProperties::MouseButtonDownAutoRepeat, CEGUI::WindowProperties::MouseCursorImage, CEGUI::WindowProperties::MousePassThroughEnabled, CEGUI::WindowProperties::NonClient, CEGUI::WindowProperties::RestoreOldCapture, CEGUI::WindowProperties::RiseOnClick, CEGUI::WindowProperties::Rotation, CEGUI::WindowProperties::Text, CEGUI::WindowProperties::TextParsingEnabled, CEGUI::WindowProperties::Tooltip, CEGUI::WindowProperties::UnifiedAreaRect, CEGUI::WindowProperties::UnifiedHeight, CEGUI::WindowProperties::UnifiedMaxSize, CEGUI::WindowProperties::UnifiedMinSize, CEGUI::WindowProperties::UnifiedPosition, CEGUI::WindowProperties::UnifiedSize, CEGUI::WindowProperties::UnifiedWidth, CEGUI::WindowProperties::UnifiedXPosition, CEGUI::WindowProperties::UnifiedYPosition, CEGUI::WindowProperties::VerticalAlignment, CEGUI::WindowProperties::Visible, CEGUI::WindowProperties::WantsMultiClickEvents, CEGUI::WindowProperties::WindowRenderer, CEGUI::WindowProperties::XRotation, CEGUI::WindowProperties::YRotation, CEGUI::WindowProperties::ZOrderChangeEnabled, CEGUI::WindowProperties::ZRotation, and CEGUI::XercesParserProperties::SchemaDefaultResourceGroup.

Collaboration diagram for CEGUI::Property:

Public Member Functions
	Property (const String &name, const String &help, const String &defaultValue="", bool writesXML=true)
	Creates a new Property object. More...
virtual	~Property (void)
	Destructor for Property objects.
const String &	getHelp (void) const
	Return a String that describes the purpose and usage of this Property. More...
const String &	getName (void) const
	Return a the name of this Property. More...
virtual String	get (const PropertyReceiver *receiver) const =0
	Return the current value of the Property as a String. More...
virtual void	set (PropertyReceiver *receiver, const String &value)=0
	Sets the value of the property. More...
virtual bool	isDefault (const PropertyReceiver *receiver) const
	Returns whether the property is at it's default value. More...
virtual String	getDefault (const PropertyReceiver *receiver) const
	Returns the default value of the Property as a String. More...
virtual void	writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
	Writes out an XML representation of this class to the given stream. More...

Protected Attributes
String	d_name
	String that stores the Property name.
String	d_help
	String that stores the Property help text.
String	d_default
	String that stores the Property default value string.
bool	d_writeXML
	Specifies whether writeXMLToStream should do anything for this property.

Detailed Description

An abstract class that defines the interface to access object properties by name.

Property objects allow (via a PropertySet) access to certain properties of objects by using simple get/set functions and the name of the property to be accessed.

Constructor & Destructor Documentation

CEGUI::Property::Property ( const String &  name, const String &  help, const String &  defaultValue = "", bool  writesXML = true  )

inline

Creates a new Property object.

Parameters

name	String containing the name of the new Property.
help	String containing a description of the Property and it's usage.
defaultValue	String holding the textual representation of the default value for this Property
writesXML	Specifies whether the writeXMLToStream method should do anything for this Property. This enables selectivity in what properties within a PropertySet will get output as XML.

Member Function Documentation

virtual String CEGUI::Property::get ( const PropertyReceiver *  receiver ) const

pure 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

Implemented in CEGUI::WindowProperties::TextParsingEnabled, CEGUI::WindowProperties::NonClient, CEGUI::WindowProperties::ZRotation, CEGUI::WindowProperties::YRotation, CEGUI::WindowProperties::XRotation, CEGUI::WindowProperties::Rotation, CEGUI::WindowProperties::AutoRenderingSurface, CEGUI::WindowProperties::DragDropTarget, CEGUI::WindowProperties::LookNFeel, CEGUI::WindowProperties::WindowRenderer, CEGUI::WindowProperties::MousePassThroughEnabled, CEGUI::WindowProperties::UnifiedMaxSize, CEGUI::WindowProperties::UnifiedMinSize, CEGUI::WindowProperties::UnifiedHeight, CEGUI::WindowProperties::UnifiedWidth, CEGUI::WindowProperties::UnifiedSize, CEGUI::WindowProperties::UnifiedYPosition, CEGUI::WindowProperties::UnifiedXPosition, CEGUI::WindowProperties::UnifiedPosition, CEGUI::WindowProperties::UnifiedAreaRect, CEGUI::WindowProperties::HorizontalAlignment, CEGUI::WindowProperties::VerticalAlignment, CEGUI::WindowProperties::RiseOnClick, CEGUI::WindowProperties::InheritsTooltipText, CEGUI::WindowProperties::Tooltip, CEGUI::WindowProperties::CustomTooltipType, CEGUI::WindowProperties::DistributeCapturedInputs, CEGUI::WindowProperties::AutoRepeatRate, CEGUI::WindowProperties::AutoRepeatDelay, CEGUI::WindowProperties::MouseButtonDownAutoRepeat, CEGUI::WindowProperties::WantsMultiClickEvents, CEGUI::WindowProperties::ZOrderChangeEnabled, CEGUI::WindowProperties::DestroyedByParent, CEGUI::MultiColumnListProperties::RowCount, CEGUI::WindowProperties::RestoreOldCapture, CEGUI::EditboxProperties::InactiveSelectionColour, CEGUI::FrameWindowProperties::NESWSizingCursorImage, CEGUI::MultiColumnListProperties::ColumnHeader, CEGUI::EditboxProperties::ActiveSelectionColour, CEGUI::WindowProperties::Visible, CEGUI::FrameWindowProperties::NWSESizingCursorImage, CEGUI::MultiColumnListProperties::SelectionMode, CEGUI::EditboxProperties::SelectedTextColour, CEGUI::ComboboxProperties::SingleClickMode, CEGUI::FrameWindowProperties::EWSizingCursorImage, CEGUI::WindowProperties::Disabled, CEGUI::ScrollablePaneProperties::VertScrollPosition, CEGUI::EditboxProperties::NormalTextColour, CEGUI::MultiColumnListProperties::ForceHorzScrollbar, CEGUI::FrameWindowProperties::NSSizingCursorImage, CEGUI::ComboboxProperties::ForceHorzScrollbar, CEGUI::ScrollablePaneProperties::VertOverlapSize, CEGUI::WindowProperties::AlwaysOnTop, CEGUI::EditboxProperties::MaxTextLength, CEGUI::FrameWindowProperties::SizingBorderThickness, CEGUI::MultiColumnListProperties::ForceVertScrollbar, CEGUI::ComboboxProperties::ForceVertScrollbar, CEGUI::MultiLineEditboxProperties::ForceVertScrollbar, CEGUI::ScrollablePaneProperties::VertStepSize, CEGUI::WindowProperties::InheritsAlpha, CEGUI::FalagardStaticTextProperties::VertExtent, CEGUI::EditboxProperties::SelectionLength, CEGUI::FrameWindowProperties::DragMovingEnabled, CEGUI::DragContainerProperties::UseFixedDragOffset, CEGUI::MultiColumnListProperties::NominatedSelectionRow, CEGUI::ComboboxProperties::SortList, CEGUI::MultiLineEditboxProperties::SelectionBrushImage, CEGUI::ScrollablePaneProperties::HorzScrollPosition, CEGUI::WindowProperties::ClippedByParent, CEGUI::FalagardStaticTextProperties::HorzExtent, CEGUI::EditboxProperties::SelectionStart, CEGUI::FrameWindowProperties::RollUpState, CEGUI::MultiColumnListProperties::NominatedSelectionColumnID, CEGUI::DragContainerProperties::FixedDragOffset, CEGUI::MultiLineEditboxProperties::MaxTextLength, CEGUI::ComboboxProperties::MaxEditTextLength, CEGUI::ListHeaderSegmentProperties::MovingCursorImage, CEGUI::ScrollablePaneProperties::HorzOverlapSize, CEGUI::FalagardStaticTextProperties::HorzScrollbar, CEGUI::TreeProperties::ItemTooltips, CEGUI::WindowProperties::MouseCursorImage, CEGUI::EditboxProperties::CaratIndex, CEGUI::FrameWindowProperties::RollUpEnabled, CEGUI::ListHeaderProperties::SortColumnID, CEGUI::MultiColumnListProperties::SortColumnID, CEGUI::ThumbProperties::HorzRange, CEGUI::ListboxProperties::ItemTooltips, CEGUI::ListHeaderSegmentProperties::SizingCursorImage, CEGUI::MultiLineEditboxProperties::SelectionLength, CEGUI::ScrollablePaneProperties::HorzStepSize, CEGUI::ComboboxProperties::EditSelectionLength, CEGUI::ScrollbarProperties::ScrollPosition, CEGUI::DragContainerProperties::StickyMode, CEGUI::SpinnerProperties::TextInputMode, CEGUI::FalagardStaticTextProperties::VertScrollbar, CEGUI::TreeProperties::ForceHorzScrollbar, CEGUI::WindowProperties::Text, CEGUI::EditboxProperties::ValidationString, CEGUI::ListHeaderProperties::SortDirection, CEGUI::ListHeaderSegmentProperties::SortDirection, CEGUI::MultiColumnListProperties::SortDirection, CEGUI::FrameWindowProperties::CloseButtonEnabled, CEGUI::ListboxProperties::ForceHorzScrollbar, CEGUI::ThumbProperties::VertRange, CEGUI::ScrollablePaneProperties::ForceHorzScrollbar, CEGUI::MultiLineEditboxProperties::SelectionStart, CEGUI::ComboboxProperties::EditSelectionStart, CEGUI::ScrollbarProperties::OverlapSize, CEGUI::DragContainerProperties::DragCursorImage, CEGUI::SpinnerProperties::MaximumValue, CEGUI::FalagardStaticTextProperties::VertFormatting, CEGUI::EditboxProperties::MaskCodepoint, CEGUI::TreeProperties::ForceVertScrollbar, CEGUI::WindowProperties::Font, CEGUI::FrameWindowProperties::TitlebarEnabled, CEGUI::ListboxProperties::ForceVertScrollbar, CEGUI::ListHeaderProperties::SortSettingEnabled, CEGUI::ListHeaderSegmentProperties::Dragable, CEGUI::MultiColumnListProperties::SortSettingEnabled, CEGUI::ThumbProperties::HorzFree, CEGUI::MultiLineEditboxProperties::CaratIndex, CEGUI::ScrolledContainerProperties::ChildExtentsArea, CEGUI::ComboboxProperties::CaratIndex, CEGUI::ScrollablePaneProperties::ForceVertScrollbar, CEGUI::ItemListBaseProperties::SortMode, CEGUI::ScrollbarProperties::StepSize, CEGUI::SliderProperties::ClickStepSize, CEGUI::TooltipProperties::FadeTime, CEGUI::TabControlProperties::TabPanePosition, CEGUI::DragContainerProperties::DragThreshold, CEGUI::SpinnerProperties::MinimumValue, CEGUI::FalagardStaticTextProperties::HorzFormatting, CEGUI::EditboxProperties::MaskText, CEGUI::WindowProperties::Alpha, CEGUI::TreeProperties::MultiSelect, CEGUI::FrameWindowProperties::FrameEnabled, CEGUI::ListboxProperties::MultiSelect, CEGUI::ListHeaderProperties::ColumnsMovable, CEGUI::ListHeaderSegmentProperties::Clickable, CEGUI::MultiColumnListProperties::ColumnsMovable, CEGUI::MultiLineEditboxProperties::WordWrap, CEGUI::ThumbProperties::VertFree, CEGUI::FalagardStaticProperties::BackgroundEnabled, CEGUI::ComboboxProperties::ValidationString, CEGUI::RadioButtonProperties::GroupID, CEGUI::ProgressBarProperties::StepSize, CEGUI::ScrollablePaneProperties::ContentArea, CEGUI::ScrollbarProperties::PageSize, CEGUI::ScrolledContainerProperties::ContentArea, CEGUI::SliderProperties::MaximumValue, CEGUI::ScrolledItemListBaseProperties::ForceHorzScrollbar, CEGUI::ItemEntryProperties::Selected, CEGUI::ItemListBaseProperties::SortEnabled, CEGUI::FalagardProgressBarProperties::ReversedProgress, CEGUI::FalagardSliderProperties::ReversedDirection, CEGUI::TabControlProperties::TabTextPadding, CEGUI::TooltipProperties::DisplayTime, CEGUI::MenuBaseProperties::AllowMultiplePopups, CEGUI::PopupMenuProperties::FadeOutTime, CEGUI::FalagardEditboxProperties::BlinkCaretTimeout, CEGUI::DragContainerProperties::DragAlpha, CEGUI::SpinnerProperties::StepSize, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaretTimeout, CEGUI::FalagardStaticTextProperties::TextColours, CEGUI::CheckboxProperties::Selected, CEGUI::EditboxProperties::ReadOnly, CEGUI::WindowProperties::ID, CEGUI::ComboboxProperties::ReadOnly, CEGUI::FrameWindowProperties::SizingEnabled, CEGUI::ListboxProperties::Sort, CEGUI::ListHeaderProperties::ColumnsSizable, CEGUI::ListHeaderSegmentProperties::Sizable, CEGUI::MultiColumnListProperties::ColumnsSizable, CEGUI::MultiLineEditboxProperties::ReadOnly, CEGUI::RadioButtonProperties::Selected, CEGUI::ThumbProperties::HotTracked, CEGUI::TitlebarProperties::DraggingEnabled, CEGUI::TreeProperties::Sort, CEGUI::FalagardStaticImageProperties::Image, CEGUI::FalagardStaticProperties::FrameEnabled, CEGUI::ProgressBarProperties::CurrentProgress, CEGUI::ScrollbarProperties::DocumentSize, CEGUI::SliderProperties::CurrentValue, CEGUI::ItemListboxProperties::MultiSelect, CEGUI::ScrollablePaneProperties::ContentPaneAutoSized, CEGUI::ScrolledContainerProperties::ContentPaneAutoSized, CEGUI::ScrolledItemListBaseProperties::ForceVertScrollbar, CEGUI::TabControlProperties::TabHeight, CEGUI::ItemEntryProperties::Selectable, CEGUI::ItemListBaseProperties::AutoResizeEnabled, CEGUI::FalagardProgressBarProperties::VerticalProgress, CEGUI::TooltipProperties::HoverTime, CEGUI::FalagardScrollbarProperties::VerticalScrollbar, CEGUI::FalagardSliderProperties::VerticalSlider, CEGUI::FalagardEditboxProperties::BlinkCaret, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaret, CEGUI::DragContainerProperties::DraggingEnabled, CEGUI::MenuBaseProperties::ItemSpacing, CEGUI::PopupMenuProperties::FadeInTime, CEGUI::SpinnerProperties::CurrentValue, CEGUI::FalagardListHeaderProperties::SegmentWidgetType, CEGUI::FalagardTabControlProperties::TabButtonType, CEGUI::XercesParserProperties::SchemaDefaultResourceGroup, CEGUI::PropertyLinkDefinition, and CEGUI::PropertyDefinition.

virtual String CEGUI::Property::getDefault ( const PropertyReceiver *  receiver ) const

virtual

Returns the default value of the Property as a String.

Parameters

receiver

Pointer to the target object.

Returns

String object containing a textual representation of the default value for this property.

const String& CEGUI::Property::getHelp ( void  ) const

inline

Return a String that describes the purpose and usage of this Property.

Returns

String that contains the help text

const String& CEGUI::Property::getName ( void  ) const

inline

Return a the name of this Property.

Returns

String containing the name of the Property

virtual bool CEGUI::Property::isDefault ( const PropertyReceiver *  receiver ) const

virtual

Returns whether the property is at it's default value.

Parameters

receiver

Pointer to the target object.

Returns

• true if the property has it's default value.
• false if the property has been modified from it's default value.

Reimplemented in CEGUI::WindowProperties::Visible, CEGUI::WindowProperties::Disabled, CEGUI::WindowProperties::MouseCursorImage, and CEGUI::WindowProperties::Font.

virtual void CEGUI::Property::set ( PropertyReceiver *  receiver, const String &  value  )

pure 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.

Implemented in CEGUI::WindowProperties::TextParsingEnabled, CEGUI::WindowProperties::NonClient, CEGUI::WindowProperties::ZRotation, CEGUI::WindowProperties::YRotation, CEGUI::WindowProperties::XRotation, CEGUI::WindowProperties::Rotation, CEGUI::WindowProperties::AutoRenderingSurface, CEGUI::WindowProperties::DragDropTarget, CEGUI::WindowProperties::LookNFeel, CEGUI::WindowProperties::WindowRenderer, CEGUI::WindowProperties::MousePassThroughEnabled, CEGUI::WindowProperties::UnifiedMaxSize, CEGUI::WindowProperties::UnifiedMinSize, CEGUI::WindowProperties::UnifiedHeight, CEGUI::WindowProperties::UnifiedWidth, CEGUI::WindowProperties::UnifiedSize, CEGUI::WindowProperties::UnifiedYPosition, CEGUI::WindowProperties::UnifiedXPosition, CEGUI::WindowProperties::UnifiedPosition, CEGUI::WindowProperties::UnifiedAreaRect, CEGUI::WindowProperties::HorizontalAlignment, CEGUI::WindowProperties::VerticalAlignment, CEGUI::WindowProperties::RiseOnClick, CEGUI::WindowProperties::InheritsTooltipText, CEGUI::WindowProperties::Tooltip, CEGUI::WindowProperties::CustomTooltipType, CEGUI::WindowProperties::DistributeCapturedInputs, CEGUI::WindowProperties::AutoRepeatRate, CEGUI::WindowProperties::AutoRepeatDelay, CEGUI::WindowProperties::MouseButtonDownAutoRepeat, CEGUI::WindowProperties::WantsMultiClickEvents, CEGUI::WindowProperties::ZOrderChangeEnabled, CEGUI::WindowProperties::DestroyedByParent, CEGUI::MultiColumnListProperties::RowCount, CEGUI::WindowProperties::RestoreOldCapture, CEGUI::EditboxProperties::InactiveSelectionColour, CEGUI::FrameWindowProperties::NESWSizingCursorImage, CEGUI::MultiColumnListProperties::ColumnHeader, CEGUI::EditboxProperties::ActiveSelectionColour, CEGUI::WindowProperties::Visible, CEGUI::FrameWindowProperties::NWSESizingCursorImage, CEGUI::MultiColumnListProperties::SelectionMode, CEGUI::EditboxProperties::SelectedTextColour, CEGUI::ComboboxProperties::SingleClickMode, CEGUI::FrameWindowProperties::EWSizingCursorImage, CEGUI::WindowProperties::Disabled, CEGUI::ScrollablePaneProperties::VertScrollPosition, CEGUI::EditboxProperties::NormalTextColour, CEGUI::MultiColumnListProperties::ForceHorzScrollbar, CEGUI::FrameWindowProperties::NSSizingCursorImage, CEGUI::ComboboxProperties::ForceHorzScrollbar, CEGUI::ScrollablePaneProperties::VertOverlapSize, CEGUI::WindowProperties::AlwaysOnTop, CEGUI::EditboxProperties::MaxTextLength, CEGUI::FrameWindowProperties::SizingBorderThickness, CEGUI::MultiColumnListProperties::ForceVertScrollbar, CEGUI::ComboboxProperties::ForceVertScrollbar, CEGUI::MultiLineEditboxProperties::ForceVertScrollbar, CEGUI::ScrollablePaneProperties::VertStepSize, CEGUI::WindowProperties::InheritsAlpha, CEGUI::FalagardStaticTextProperties::VertExtent, CEGUI::EditboxProperties::SelectionLength, CEGUI::FrameWindowProperties::DragMovingEnabled, CEGUI::DragContainerProperties::UseFixedDragOffset, CEGUI::MultiColumnListProperties::NominatedSelectionRow, CEGUI::ComboboxProperties::SortList, CEGUI::MultiLineEditboxProperties::SelectionBrushImage, CEGUI::ScrollablePaneProperties::HorzScrollPosition, CEGUI::WindowProperties::ClippedByParent, CEGUI::FalagardStaticTextProperties::HorzExtent, CEGUI::EditboxProperties::SelectionStart, CEGUI::FrameWindowProperties::RollUpState, CEGUI::MultiColumnListProperties::NominatedSelectionColumnID, CEGUI::DragContainerProperties::FixedDragOffset, CEGUI::MultiLineEditboxProperties::MaxTextLength, CEGUI::ComboboxProperties::MaxEditTextLength, CEGUI::ListHeaderSegmentProperties::MovingCursorImage, CEGUI::ScrollablePaneProperties::HorzOverlapSize, CEGUI::FalagardStaticTextProperties::HorzScrollbar, CEGUI::TreeProperties::ItemTooltips, CEGUI::WindowProperties::MouseCursorImage, CEGUI::EditboxProperties::CaratIndex, CEGUI::FrameWindowProperties::RollUpEnabled, CEGUI::ListHeaderProperties::SortColumnID, CEGUI::MultiColumnListProperties::SortColumnID, CEGUI::ThumbProperties::HorzRange, CEGUI::ListboxProperties::ItemTooltips, CEGUI::ListHeaderSegmentProperties::SizingCursorImage, CEGUI::MultiLineEditboxProperties::SelectionLength, CEGUI::ScrollablePaneProperties::HorzStepSize, CEGUI::ComboboxProperties::EditSelectionLength, CEGUI::ScrollbarProperties::ScrollPosition, CEGUI::DragContainerProperties::StickyMode, CEGUI::SpinnerProperties::TextInputMode, CEGUI::FalagardStaticTextProperties::VertScrollbar, CEGUI::TreeProperties::ForceHorzScrollbar, CEGUI::WindowProperties::Text, CEGUI::EditboxProperties::ValidationString, CEGUI::ListHeaderProperties::SortDirection, CEGUI::ListHeaderSegmentProperties::SortDirection, CEGUI::MultiColumnListProperties::SortDirection, CEGUI::FrameWindowProperties::CloseButtonEnabled, CEGUI::ListboxProperties::ForceHorzScrollbar, CEGUI::ThumbProperties::VertRange, CEGUI::ScrollablePaneProperties::ForceHorzScrollbar, CEGUI::MultiLineEditboxProperties::SelectionStart, CEGUI::ComboboxProperties::EditSelectionStart, CEGUI::ScrollbarProperties::OverlapSize, CEGUI::DragContainerProperties::DragCursorImage, CEGUI::SpinnerProperties::MaximumValue, CEGUI::FalagardStaticTextProperties::VertFormatting, CEGUI::EditboxProperties::MaskCodepoint, CEGUI::TreeProperties::ForceVertScrollbar, CEGUI::WindowProperties::Font, CEGUI::FrameWindowProperties::TitlebarEnabled, CEGUI::ListboxProperties::ForceVertScrollbar, CEGUI::ListHeaderProperties::SortSettingEnabled, CEGUI::ListHeaderSegmentProperties::Dragable, CEGUI::MultiColumnListProperties::SortSettingEnabled, CEGUI::ThumbProperties::HorzFree, CEGUI::MultiLineEditboxProperties::CaratIndex, CEGUI::ScrolledContainerProperties::ChildExtentsArea, CEGUI::ComboboxProperties::CaratIndex, CEGUI::ScrollablePaneProperties::ForceVertScrollbar, CEGUI::ItemListBaseProperties::SortMode, CEGUI::ScrollbarProperties::StepSize, CEGUI::SliderProperties::ClickStepSize, CEGUI::TooltipProperties::FadeTime, CEGUI::TabControlProperties::TabPanePosition, CEGUI::DragContainerProperties::DragThreshold, CEGUI::SpinnerProperties::MinimumValue, CEGUI::FalagardStaticTextProperties::HorzFormatting, CEGUI::EditboxProperties::MaskText, CEGUI::WindowProperties::Alpha, CEGUI::TreeProperties::MultiSelect, CEGUI::FrameWindowProperties::FrameEnabled, CEGUI::ListboxProperties::MultiSelect, CEGUI::ListHeaderProperties::ColumnsMovable, CEGUI::ListHeaderSegmentProperties::Clickable, CEGUI::MultiColumnListProperties::ColumnsMovable, CEGUI::MultiLineEditboxProperties::WordWrap, CEGUI::ThumbProperties::VertFree, CEGUI::FalagardStaticProperties::BackgroundEnabled, CEGUI::ComboboxProperties::ValidationString, CEGUI::RadioButtonProperties::GroupID, CEGUI::ProgressBarProperties::StepSize, CEGUI::ScrollablePaneProperties::ContentArea, CEGUI::ScrollbarProperties::PageSize, CEGUI::ScrolledContainerProperties::ContentArea, CEGUI::SliderProperties::MaximumValue, CEGUI::ScrolledItemListBaseProperties::ForceHorzScrollbar, CEGUI::ItemEntryProperties::Selected, CEGUI::ItemListBaseProperties::SortEnabled, CEGUI::FalagardProgressBarProperties::ReversedProgress, CEGUI::FalagardSliderProperties::ReversedDirection, CEGUI::TabControlProperties::TabTextPadding, CEGUI::TooltipProperties::DisplayTime, CEGUI::MenuBaseProperties::AllowMultiplePopups, CEGUI::PopupMenuProperties::FadeOutTime, CEGUI::FalagardEditboxProperties::BlinkCaretTimeout, CEGUI::DragContainerProperties::DragAlpha, CEGUI::SpinnerProperties::StepSize, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaretTimeout, CEGUI::FalagardStaticTextProperties::TextColours, CEGUI::CheckboxProperties::Selected, CEGUI::EditboxProperties::ReadOnly, CEGUI::WindowProperties::ID, CEGUI::ComboboxProperties::ReadOnly, CEGUI::FrameWindowProperties::SizingEnabled, CEGUI::ListboxProperties::Sort, CEGUI::ListHeaderProperties::ColumnsSizable, CEGUI::ListHeaderSegmentProperties::Sizable, CEGUI::MultiColumnListProperties::ColumnsSizable, CEGUI::MultiLineEditboxProperties::ReadOnly, CEGUI::RadioButtonProperties::Selected, CEGUI::ThumbProperties::HotTracked, CEGUI::TitlebarProperties::DraggingEnabled, CEGUI::TreeProperties::Sort, CEGUI::FalagardStaticImageProperties::Image, CEGUI::FalagardStaticProperties::FrameEnabled, CEGUI::ProgressBarProperties::CurrentProgress, CEGUI::ScrollbarProperties::DocumentSize, CEGUI::SliderProperties::CurrentValue, CEGUI::PropertyDefinitionBase, CEGUI::ItemListboxProperties::MultiSelect, CEGUI::ScrollablePaneProperties::ContentPaneAutoSized, CEGUI::ScrolledContainerProperties::ContentPaneAutoSized, CEGUI::ScrolledItemListBaseProperties::ForceVertScrollbar, CEGUI::TabControlProperties::TabHeight, CEGUI::ItemEntryProperties::Selectable, CEGUI::ItemListBaseProperties::AutoResizeEnabled, CEGUI::FalagardProgressBarProperties::VerticalProgress, CEGUI::TooltipProperties::HoverTime, CEGUI::FalagardScrollbarProperties::VerticalScrollbar, CEGUI::FalagardSliderProperties::VerticalSlider, CEGUI::FalagardEditboxProperties::BlinkCaret, CEGUI::FalagardMultiLineEditboxProperties::BlinkCaret, CEGUI::DragContainerProperties::DraggingEnabled, CEGUI::MenuBaseProperties::ItemSpacing, CEGUI::PopupMenuProperties::FadeInTime, CEGUI::SpinnerProperties::CurrentValue, CEGUI::FalagardListHeaderProperties::SegmentWidgetType, CEGUI::FalagardTabControlProperties::TabButtonType, CEGUI::XercesParserProperties::SchemaDefaultResourceGroup, CEGUI::PropertyLinkDefinition, and CEGUI::PropertyDefinition.

virtual void CEGUI::Property::writeXMLToStream ( const PropertyReceiver *  receiver, XMLSerializer &  xml_stream  ) const

virtual

Writes out an XML representation of this class to the given stream.

Note

This would normally have been implemented via XMLGenerator base class, but in this case we require the target PropertyReceiver in order to obtain the property value.

Reimplemented in CEGUI::WindowProperties::LookNFeel, and CEGUI::WindowProperties::WindowRenderer.