Inheritance 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. | |
virtual | ~Property (void) |
Destructor for Property objects. | |
const String & | getHelp (void) const |
Return a String that describes the purpose and usage of this Property. | |
const String & | getName (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. | |
void | writeXMLToStream (const PropertyReceiver *receiver, OutStream &out_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. |
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.
|
Creates a new Property object.
|
|
|
Returns the default value of the Property as a String.
Reimplemented in CEGUI::WindowProperties::AbsoluteMaxSize, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::AbsoluteTabHeight, CEGUI::TabControlProperties::TabTextPadding, and CEGUI::TabControlProperties::RelativeTabTextPadding. |
|
Return a String that describes the purpose and usage of this Property.
|
|
Return a the name of this Property.
|
|
Returns whether the property is at it's default value.
Reimplemented in CEGUI::WindowProperties::AbsoluteMaxSize, CEGUI::WindowProperties::Font, CEGUI::WindowProperties::MouseCursorImage, CEGUI::WindowProperties::Disabled, CEGUI::WindowProperties::Visible, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::AbsoluteTabHeight, CEGUI::TabControlProperties::TabTextPadding, and CEGUI::TabControlProperties::RelativeTabTextPadding. |
|
Sets the value of the property.
Implemented in CEGUI::WindowProperties::RelativeMinSize, CEGUI::WindowProperties::RelativeMaxSize, CEGUI::WindowProperties::AbsoluteMinSize, CEGUI::WindowProperties::AbsoluteMaxSize, CEGUI::WindowProperties::MetricsMode, 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::Width, CEGUI::WindowProperties::RelativeWidth, CEGUI::WindowProperties::AbsoluteWidth, CEGUI::WindowProperties::Height, CEGUI::WindowProperties::RelativeHeight, CEGUI::WindowProperties::AbsoluteHeight, CEGUI::WindowProperties::Size, CEGUI::WindowProperties::RelativeSize, CEGUI::WindowProperties::AbsoluteSize, CEGUI::WindowProperties::XPosition, CEGUI::WindowProperties::RelativeXPosition, CEGUI::WindowProperties::AbsoluteXPosition, CEGUI::WindowProperties::YPosition, CEGUI::WindowProperties::RelativeYPosition, CEGUI::WindowProperties::AbsoluteYPosition, CEGUI::WindowProperties::Position, CEGUI::WindowProperties::RelativePosition, CEGUI::WindowProperties::AbsolutePosition, CEGUI::WindowProperties::Rect, CEGUI::WindowProperties::RelativeRect, CEGUI::WindowProperties::AbsoluteRect, 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::ButtonBaseProperties::NormalTextColour, CEGUI::ButtonBaseProperties::HoverTextColour, CEGUI::ButtonBaseProperties::PushedTextColour, CEGUI::ButtonBaseProperties::DisabledTextColour, CEGUI::CheckboxProperties::Selected, CEGUI::ComboboxProperties::ReadOnly, CEGUI::ComboboxProperties::ValidationString, CEGUI::ComboboxProperties::CaratIndex, CEGUI::ComboboxProperties::EditSelectionStart, CEGUI::ComboboxProperties::EditSelectionLength, CEGUI::ComboboxProperties::MaxEditTextLength, CEGUI::ComboboxProperties::NormalEditTextColour, CEGUI::ComboboxProperties::SelectedEditTextColour, CEGUI::ComboboxProperties::ActiveEditSelectionColour, CEGUI::ComboboxProperties::InactiveEditSelectionColour, 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::TitlebarFont, CEGUI::FrameWindowProperties::CaptionColour, CEGUI::FrameWindowProperties::NSSizingCursorImage, CEGUI::FrameWindowProperties::EWSizingCursorImage, CEGUI::FrameWindowProperties::NWSESizingCursorImage, CEGUI::FrameWindowProperties::NESWSizingCursorImage, CEGUI::ItemListBaseProperties::AutoResizeEnabled, 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::MenuBaseProperties::ItemSpacing, CEGUI::MenuBaseProperties::HorzPadding, CEGUI::MenuBaseProperties::VertPadding, CEGUI::MenuBaseProperties::BorderWidth, CEGUI::MenuBaseProperties::BackgroundColours, CEGUI::MenuBaseProperties::AllowMultiplePopups, CEGUI::MenuItemProperties::HoverColour, CEGUI::MenuItemProperties::PushedColour, CEGUI::MenuItemProperties::OpenedColour, CEGUI::MenuItemProperties::NormalTextColour, CEGUI::MenuItemProperties::DisabledTextColour, 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::NormalTextColour, CEGUI::MultiLineEditboxProperties::SelectedTextColour, CEGUI::MultiLineEditboxProperties::ActiveSelectionColour, CEGUI::MultiLineEditboxProperties::InactiveSelectionColour, CEGUI::PopupMenuProperties::FadeInTime, CEGUI::PopupMenuProperties::FadeOutTime, CEGUI::ProgressBarProperties::CurrentProgress, CEGUI::ProgressBarProperties::StepSize, CEGUI::PushButtonProperties::NormalImage, CEGUI::PushButtonProperties::PushedImage, CEGUI::PushButtonProperties::HoverImage, CEGUI::PushButtonProperties::DisabledImage, CEGUI::PushButtonProperties::UseStandardImagery, CEGUI::PushButtonProperties::TextXOffset, 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::SliderProperties::CurrentValue, CEGUI::SliderProperties::MaximumValue, CEGUI::SliderProperties::ClickStepSize, CEGUI::SpinnerProperties::CurrentValue, CEGUI::SpinnerProperties::StepSize, CEGUI::SpinnerProperties::MinimumValue, CEGUI::SpinnerProperties::MaximumValue, CEGUI::SpinnerProperties::TextInputMode, CEGUI::StaticImageProperties::Image, CEGUI::StaticImageProperties::ImageColours, CEGUI::StaticImageProperties::HorzFormatting, CEGUI::StaticImageProperties::VertFormatting, CEGUI::StaticProperties::FrameEnabled, CEGUI::StaticProperties::BackgroundEnabled, CEGUI::StaticProperties::FrameColours, CEGUI::StaticProperties::BackgroundColours, CEGUI::StaticProperties::BackgroundImage, CEGUI::StaticProperties::TopLeftFrameImage, CEGUI::StaticProperties::TopRightFrameImage, CEGUI::StaticProperties::BottomLeftFrameImage, CEGUI::StaticProperties::BottomRightFrameImage, CEGUI::StaticProperties::LeftFrameImage, CEGUI::StaticProperties::RightFrameImage, CEGUI::StaticProperties::TopFrameImage, CEGUI::StaticProperties::BottomFrameImage, CEGUI::StaticTextProperties::TextColours, CEGUI::StaticTextProperties::HorzFormatting, CEGUI::StaticTextProperties::VertFormatting, CEGUI::StaticTextProperties::VertScrollbar, CEGUI::StaticTextProperties::HorzScrollbar, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::AbsoluteTabHeight, CEGUI::TabControlProperties::RelativeTabHeight, CEGUI::TabControlProperties::TabTextPadding, CEGUI::TabControlProperties::AbsoluteTabTextPadding, CEGUI::TabControlProperties::RelativeTabTextPadding, CEGUI::TextItemProperties::TextXOffset, CEGUI::TextItemProperties::TextColour, CEGUI::TextItemProperties::TextFormatting, CEGUI::ThumbProperties::HotTracked, CEGUI::ThumbProperties::VertFree, CEGUI::ThumbProperties::HorzFree, CEGUI::ThumbProperties::VertRange, CEGUI::ThumbProperties::HorzRange, CEGUI::TitlebarProperties::DraggingEnabled, CEGUI::TitlebarProperties::CaptionColour, CEGUI::TooltipProperties::HoverTime, CEGUI::TooltipProperties::DisplayTime, CEGUI::TooltipProperties::FadeTime, and CEGUI::PropertyDefinition. |
|
Writes out an XML representation of this class to the given stream.
|