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::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::FalagardListHeaderProperties::SegmentWidgetType, 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::HorzFormatting, CEGUI::FalagardStaticTextProperties::HorzScrollbar, CEGUI::FalagardStaticTextProperties::TextColours, CEGUI::FalagardStaticTextProperties::VertFormatting, CEGUI::FalagardStaticTextProperties::VertScrollbar, CEGUI::FalagardTabControlProperties::TabButtonType, CEGUI::FontProperties::AutoScaled, CEGUI::FontProperties::FileName, CEGUI::FontProperties::FreeTypeAntialiased, CEGUI::FontProperties::FreeTypePointSize, CEGUI::FontProperties::Name, CEGUI::FontProperties::NativeRes, CEGUI::FontProperties::PixmapImageset, CEGUI::FontProperties::PixmapMapping, CEGUI::FontProperties::ResourceGroup, 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::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::RestoreOldCapture, CEGUI::WindowProperties::RiseOnClick, CEGUI::WindowProperties::Text, 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, and CEGUI::WindowProperties::ZOrderChangeEnabled.

Collaboration diagram for CEGUI::Property:

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

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

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.

References d_default.

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]

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::Font, CEGUI::WindowProperties::MouseCursorImage, CEGUI::WindowProperties::Disabled, and CEGUI::WindowProperties::Visible.

References d_default.

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

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::WindowRenderer, and CEGUI::WindowProperties::LookNFeel.

References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), d_name, d_writeXML, CEGUI::String::find(), CEGUI::String::npos, CEGUI::XMLSerializer::openTag(), and CEGUI::XMLSerializer::text().


Generated on Thu Nov 27 20:34:30 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1