Difference between revisions of "Property reference for Vanilla"

From CEGUI Wiki - Crazy Eddie's GUI System (Open Source)
Jump to: navigation, search
(Due to the length of this output, and issues MediaWiki has with it, the content is moved to a static html page here)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{VersionBadge|0.7}}
 
{{VersionBadge|0.7}}
  
This is the list of properties per widget within the Vanilla scheme, it was updated for branches/v0-7 on 26th July 2010. It has been generated by [[http://www.cegui.org.uk/wiki/index.php/PropertyFinder Property Finder]], which can generate a listing for any scheme, both Cegui schemes as well as custom made schemes. The properties for the [http://www.cegui.org.uk/wiki/index.php/SetProperty TaharezLook], [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) WindowsLook] and [http://www.cegui.org.uk/wiki/index.php/SetProperty(OgreTray) OgreTray] schemes are also available.
+
This is the list of properties per widget within the [[Vanilla]] scheme, it was updated for branches/v0-7 on 20th February 2011. It has been generated by [[PropertyFinder]], which can generate a listing for any scheme, both CEGUI schemes as well as custom made schemes. The properties for the [http://www.cegui.org.uk/wiki/index.php/SetProperty TaharezLook], [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) WindowsLook] and [http://www.cegui.org.uk/wiki/index.php/SetProperty(OgreTray) OgreTray] schemes are also available.
  
=== Vanilla ===
+
==== Due to the length of this output, and issues MediaWiki has with it, the content is moved to a [http://static.cegui.org.uk/static/VanillaProperties.html static html page here] ====
==== Button ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
+
|-
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
| bgcolor="#FFBF00" | [[#HorzImageFormatting]]
+
|-
+
| bgcolor="#FFBF00" | [[#HoverImage]]
+
| bgcolor="#FFBF00" | [[#HoverTextColour]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
|-
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
|-
+
| [[#NonClient]]
+
| bgcolor="#FFBF00" | [[#NormalImage]]
+
| bgcolor="#FFBF00" | [[#NormalTextColour]]
+
| bgcolor="#FFBF00" | [[#PushedImage]]
+
| bgcolor="#FFBF00" | [[#PushedTextColour]]
+
|-
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
|-
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
|-
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
|-
+
| [[#UpdateMode]]
+
| bgcolor="#FFBF00" | [[#UseStandardImagery]]
+
| bgcolor="#FFBF00" | [[#VertImageFormatting]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
  
==== ComboDropList ====
+
[[Category:Manuals]]
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#ForceHorzScrollbar]]
+
| [[#ForceVertScrollbar]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#ItemTooltips]]
+
| [[#LookNFeel]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#MultiSelect]]
+
|-
+
| [[#NonClient]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Sort]]
+
|-
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
|-
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
|-
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
 
+
==== Combobox ====
+
{| class="wikitable"  border="1"
+
| [[#ActiveEditSelectionColour]]
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
|-
+
| [[#AutoRepeatRate]]
+
| [[#CaratIndex]]
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
|-
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#EditSelectionLength]]
+
| [[#EditSelectionStart]]
+
|-
+
| [[#Font]]
+
| [[#ForceHorzScrollbar]]
+
| [[#ForceVertScrollbar]]
+
| [[#HorizontalAlignment]]
+
| [[#ID]]
+
|-
+
| [[#InactiveEditSelectionColour]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MaxEditTextLength]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
|-
+
| [[#NormalEditTextColour]]
+
| [[#ReadOnly]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
|-
+
| [[#SelectedEditTextColour]]
+
| [[#SingleClickMode]]
+
| [[#SortList]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
|-
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
|-
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
|-
+
| [[#UpdateMode]]
+
| [[#ValidationString]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
|-
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== Editbox ====
+
{| class="wikitable"  border="1"
+
| bgcolor="#FFBF00" | [[#ActiveSelectionColour]]
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
|-
+
| [[#AutoRepeatRate]]
+
| [[#BlinkCaret]]
+
| [[#BlinkCaretTimeout]]
+
| [[#CaratIndex]]
+
| [[#ClippedByParent]]
+
|-
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
|-
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
| [[#ID]]
+
| bgcolor="#FFBF00" | [[#InactiveSelectionColour]]
+
| [[#InheritsAlpha]]
+
|-
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MaskCodepoint]]
+
| [[#MaskText]]
+
| [[#MaxTextLength]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
|-
+
| bgcolor="#FFBF00" | [[#NormalTextColour]]
+
| [[#ReadOnly]]
+
| bgcolor="#FFBF00" | [[#ReadOnlyBGColour]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
|-
+
| [[#Rotation]]
+
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
+
| [[#SelectionLength]]
+
| [[#SelectionStart]]
+
| [[#Text]]
+
|-
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
|-
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
|-
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#ValidationString]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
 
+
==== FrameWindow ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#CaptionColour]]
+
| [[#ClippedByParent]]
+
| [[#CloseButtonEnabled]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
|-
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#DragMovingEnabled]]
+
| [[#EWSizingCursorImage]]
+
|-
+
| [[#Font]]
+
| [[#FrameEnabled]]
+
| [[#HorizontalAlignment]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
|-
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
|-
+
| [[#MousePassThroughEnabled]]
+
| [[#NESWSizingCursorImage]]
+
| [[#NSSizingCursorImage]]
+
| [[#NWSESizingCursorImage]]
+
| [[#NonClient]]
+
|-
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#RollUpEnabled]]
+
| [[#RollUpState]]
+
| [[#Rotation]]
+
|-
+
| [[#SizingBorderThickness]]
+
| [[#SizingEnabled]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#TitlebarEnabled]]
+
|-
+
| [[#TitlebarFont]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
|-
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
|-
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
|-
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== HorizontalScrollbar ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DocumentSize]]
+
| [[#DragDropTarget]]
+
| [[#EndLockEnabled]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
|-
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| [[#OverlapSize]]
+
|-
+
| [[#PageSize]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#ScrollPosition]]
+
|-
+
| [[#StepSize]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
|-
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
|-
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
|-
+
| [[#VerticalScrollbar]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
|-
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== HorizontalScrollbarThumb ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
| [[#HorzFree]]
+
| [[#HorzRange]]
+
|-
+
| [[#HotTracked]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
|-
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
|-
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
|-
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
|-
+
| [[#UpdateMode]]
+
| [[#VertFree]]
+
| [[#VertRange]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
 
+
==== Listbox ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#ForceHorzScrollbar]]
+
| [[#ForceVertScrollbar]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#ItemTooltips]]
+
| [[#LookNFeel]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#MultiSelect]]
+
|-
+
| [[#NonClient]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Sort]]
+
|-
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
|-
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
|-
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
 
+
==== MultiLineEditbox ====
+
{| class="wikitable"  border="1"
+
| bgcolor="#FFBF00" | [[#ActiveSelectionColour]]
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
|-
+
| [[#AutoRepeatRate]]
+
| [[#BlinkCaret]]
+
| [[#BlinkCaretTimeout]]
+
| [[#CaratIndex]]
+
| [[#ClippedByParent]]
+
|-
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
|-
+
| [[#Font]]
+
| [[#ForceVertScrollbar]]
+
| [[#HorizontalAlignment]]
+
| [[#ID]]
+
| bgcolor="#FFBF00" | [[#InactiveSelectionColour]]
+
|-
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MaxTextLength]]
+
| [[#MouseButtonDownAutoRepeat]]
+
|-
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| bgcolor="#FFBF00" | [[#NormalTextColour]]
+
|-
+
| [[#ReadOnly]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
+
|-
+
| [[#SelectionBrushImage]]
+
| [[#SelectionLength]]
+
| [[#SelectionStart]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
|-
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
|-
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
|-
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
|-
+
| [[#WordWrap]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== ProgressBar ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CurrentProgress]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
|-
+
| bgcolor="#FFBF00" | [[#DisabledColour]]
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| bgcolor="#FFBF00" | [[#EnabledColour]]
+
| [[#Font]]
+
|-
+
| [[#HorizontalAlignment]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
|-
+
| [[#RestoreOldCapture]]
+
| [[#ReversedProgress]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#StepSize]]
+
|-
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
|-
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
|-
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
| [[#VerticalProgress]]
+
|-
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
|-
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== StaticImage ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#BackgroundEnabled]]
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
|-
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#FrameEnabled]]
+
| [[#HorizontalAlignment]]
+
|-
+
| bgcolor="#FFBF00" | [[#HorzFormatting]]
+
| [[#ID]]
+
| [[#Image]]
+
| bgcolor="#FFBF00" | [[#ImageColours]]
+
| [[#InheritsAlpha]]
+
|-
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
|-
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
|-
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
|-
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
|-
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| bgcolor="#FFBF00" | [[#VertFormatting]]
+
| [[#VerticalAlignment]]
+
|-
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
|-
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== StaticText ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#BackgroundEnabled]]
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
|-
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#FrameEnabled]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#HorzExtent]]
+
| [[#HorzFormatting]]
+
| [[#HorzScrollbar]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
|-
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
|-
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
|-
+
| [[#Text]]
+
| [[#TextColours]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
|-
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
|-
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VertExtent]]
+
|-
+
| [[#VertFormatting]]
+
| [[#VertScrollbar]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
|-
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== Titlebar ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| bgcolor="#FFBF00" | [[#CaptionColour]]
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
|-
+
| [[#DistributeCapturedInputs]]
+
| [[#DragDropTarget]]
+
| [[#DraggingEnabled]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
|-
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| [[#RestoreOldCapture]]
+
|-
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
|-
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
|-
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
|-
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
|-
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== VerticalScrollbar ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DocumentSize]]
+
| [[#DragDropTarget]]
+
| [[#EndLockEnabled]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
|-
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
| [[#MouseButtonDownAutoRepeat]]
+
|-
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
| [[#OverlapSize]]
+
|-
+
| [[#PageSize]]
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#ScrollPosition]]
+
|-
+
| [[#StepSize]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
|-
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
|-
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
| [[#UpdateMode]]
+
| [[#VerticalAlignment]]
+
|-
+
| [[#VerticalScrollbar]]
+
| [[#Visible]]
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
|-
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
| [[#ZRotation]]
+
|}
+
 
+
==== VerticalScrollbarThumb ====
+
{| class="wikitable"  border="1"
+
| [[#Alpha]]
+
| [[#AlwaysOnTop]]
+
| [[#AutoRenderingSurface]]
+
| [[#AutoRepeatDelay]]
+
| [[#AutoRepeatRate]]
+
|-
+
| [[#ClippedByParent]]
+
| [[#CustomTooltipType]]
+
| [[#DestroyedByParent]]
+
| [[#Disabled]]
+
| [[#DistributeCapturedInputs]]
+
|-
+
| [[#DragDropTarget]]
+
| [[#Font]]
+
| [[#HorizontalAlignment]]
+
| [[#HorzFree]]
+
| [[#HorzRange]]
+
|-
+
| [[#HotTracked]]
+
| [[#ID]]
+
| [[#InheritsAlpha]]
+
| [[#InheritsTooltipText]]
+
| [[#LookNFeel]]
+
|-
+
| [[#MouseButtonDownAutoRepeat]]
+
| [[#MouseCursorImage]]
+
| [[#MouseInputPropagationEnabled]]
+
| [[#MousePassThroughEnabled]]
+
| [[#NonClient]]
+
|-
+
| [[#RestoreOldCapture]]
+
| [[#RiseOnClick]]
+
| [[#Rotation]]
+
| [[#Text]]
+
| [[#TextParsingEnabled]]
+
|-
+
| [[#Tooltip]]
+
| [[#UnifiedAreaRect]]
+
| [[#UnifiedHeight]]
+
| [[#UnifiedMaxSize]]
+
| [[#UnifiedMinSize]]
+
|-
+
| [[#UnifiedPosition]]
+
| [[#UnifiedSize]]
+
| [[#UnifiedWidth]]
+
| [[#UnifiedXPosition]]
+
| [[#UnifiedYPosition]]
+
|-
+
| [[#UpdateMode]]
+
| [[#VertFree]]
+
| [[#VertRange]]
+
| [[#VerticalAlignment]]
+
| [[#Visible]]
+
|-
+
| [[#WantsMultiClickEvents]]
+
| [[#WindowRenderer]]
+
| [[#XRotation]]
+
| [[#YRotation]]
+
| [[#ZOrderChangeEnabled]]
+
|-
+
| [[#ZRotation]]
+
|}
+
 
+
=== Properties ===
+
==== ActiveEditSelectionColour ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== ActiveSelectionColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== Alpha ====
+
Property to get/set the alpha value of the Window.  Value is floating point number.
+
 
+
==== AlwaysOnTop ====
+
Property to get/set the 'always on top' setting for the Window.  Value is either "True" or "False".
+
 
+
==== AutoRenderingSurface ====
+
Property to get/set whether the Window will automatically attempt to use a full imagery caching RenderingSurface (if supported by the renderer).  Here, full imagery caching usually will mean caching a window's representation onto a texture (although no such implementation requirement is specified.)  Value is either "True" or "False".
+
 
+
==== AutoRepeatDelay ====
+
Property to get/set the autorepeat delay.  Value is a floating point number indicating the delay required in seconds.
+
 
+
==== AutoRepeatRate ====
+
Property to get/set the autorepeat rate.  Value is a floating point number indicating the rate required in seconds.
+
 
+
==== BackgroundEnabled ====
+
Property to get/set the state of the frame background setting for the <font COLOR="#FFBF00">Falagard</font>Static widget.  Value is either "True" or "False".
+
 
+
==== BlinkCaret ====
+
Property to get/set whether the Editbox caret should blink.  Value is either "True" or "False".
+
 
+
==== BlinkCaretTimeout ====
+
Property to get/set the caret blink timeout / speed.  Value is a float value indicating the timeout in seconds.
+
 
+
==== CaptionColour ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== CaratIndex ====
+
Property to get/set the current carat index.  Value is "[uint]".
+
 
+
==== ClippedByParent ====
+
Property to get/set the 'clipped by parent' setting for the Window.  Value is either "True" or "False".
+
 
+
==== CloseButtonEnabled ====
+
Property to get/set the setting for whether the window close button will be enabled (or displayed depending upon choice of final widget type).  Value is either "True" or "False".
+
 
+
==== CurrentProgress ====
+
Property to get/set the current progress of the progress bar.  Value is a float  value between 0.0 and 1.0 specifying the progress.
+
 
+
==== CustomTooltipType ====
+
Property to get/set the custom tooltip for the window.  Value is the type name of the custom tooltip.
+
 
+
==== DestroyedByParent ====
+
Property to get/set the 'destroyed by parent' setting for the Window.  Value is either "True" or "False".
+
 
+
==== Disabled ====
+
Property to get/set the 'disabled state' setting for the Window.  Value is either "True" or "False".
+
 
+
==== DisabledColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== DisabledTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== DistributeCapturedInputs ====
+
Property to get/set whether captured inputs are passed to child windows.  Value is either "True" or "False".
+
 
+
==== DocumentSize ====
+
Property to get/set the document size for the Scrollbar.  Value is a float.
+
 
+
==== DragDropTarget ====
+
Property to get/set whether the Window will receive drag and drop related notifications.  Value is either "True" or "False".
+
 
+
==== DragMovingEnabled ====
+
Property to get/set the setting for whether the user may drag the window around by its title bar.  Value is either "True" or "False".
+
 
+
==== DraggingEnabled ====
+
Property to get/set the state of the dragging enabled setting for the Titlebar.  Value is either "True" or "False".
+
 
+
==== EWSizingCursorImage ====
+
Property to get/set the E-W (left-right) sizing cursor image for the FramwWindow.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== EditSelectionLength ====
+
Property to get/set the length of the selection (as a count of the number of code points selected).  Value is "[uint]".
+
 
+
==== EditSelectionStart ====
+
Property to get/set the zero based index of the selection start position within the text.  Value is "[uint]".
+
 
+
==== EnabledColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== EndLockEnabled ====
+
Property to get/set the 'end lock' mode setting for the Scrollbar. Value is either "True" or "False".
+
 
+
==== Font ====
+
Property to get/set the font for the Window.  Value is the name of the font to use (must be loaded already).
+
 
+
==== ForceHorzScrollbar ====
+
Property to get/set the 'always show' setting for the horizontal scroll bar of the list box.  Value is either "True" or "False".
+
 
+
==== ForceVertScrollbar ====
+
Property to get/set the 'always show' setting for the vertical scroll bar of the list box.  Value is either "True" or "False".
+
 
+
==== FrameEnabled ====
+
Property to get/set the setting for whether the window frame will be displayed.  Value is either "True" or "False".
+
 
+
==== HorizontalAlignment ====
+
Property to get/set the windows horizontal alignment.  Value is one of "Left", "Centre" or "Right".
+
 
+
==== HorzExtent ====
+
Property to get the current horizontal extent of the formatted text string.  Value is a float indicating the pixel extent.
+
 
+
==== HorzFormatting ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== HorzFree ====
+
Property to get/set the state the setting to free the thumb horizontally.  Value is either "True" or "False".
+
 
+
==== HorzImageFormatting ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== HorzRange ====
+
Property to get/set the horizontal movement range for the thumb.  Value is "min:[float] max:[float]".
+
 
+
==== HorzScrollbar ====
+
Property to get/set the setting for the horizontal scroll bar.  Value is either "True" or "False".
+
 
+
==== HotTracked ====
+
Property to get/set the state of the state of the 'hot-tracked' setting for the thumb.  Value is either "True" or "False".
+
 
+
==== HoverImage ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== HoverTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== ID ====
+
Property to get/set the ID value of the Window.  Value is an unsigned integer number.
+
 
+
==== Image ====
+
Property to get/set the image for the <font COLOR="#FFBF00">Falagard</font>StaticImage widget.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== ImageColours ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== InactiveEditSelectionColour ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== InactiveSelectionColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== InheritsAlpha ====
+
Property to get/set the 'inherits alpha' setting for the Window.  Value is either "True" or "False".
+
 
+
==== InheritsTooltipText ====
+
Property to get/set whether the window inherits its parents tooltip text when it has none of its own.  Value is either "True" or "False".
+
 
+
==== ItemTooltips ====
+
Property to access the show item tooltips setting of the list box.  Value is either "True" or "False".
+
 
+
==== LookNFeel ====
+
Property to get/set the windows assigned look'n'feel.  Value is a string.
+
 
+
==== MaskCodepoint ====
+
Property to get/set the utf32 codepoint value used for masking text.  Value is "[uint]".
+
 
+
==== MaskText ====
+
Property to get/set the mask text setting for the Editbox.  Value is either "True" or "False".
+
 
+
==== MaxEditTextLength ====
+
Property to get/set the the maximum allowed text length (as a count of code points).  Value is "[uint]".
+
 
+
==== MaxTextLength ====
+
Property to get/set the the maximum allowed text length (as a count of code points).  Value is "[uint]".
+
 
+
==== MouseButtonDownAutoRepeat ====
+
Property to get/set whether the window will receive autorepeat mouse button down events.  Value is either "True" or "False".
+
 
+
==== MouseCursorImage ====
+
Property to get/set the mouse cursor image for the Window.  Value should be "set:<imageset name> image:<image name>".
+
 
+
==== MouseInputPropagationEnabled ====
+
Property to get/set whether unhandled mouse inputs should be propagated back to the Window's parent.  Value is either "True" or "False".
+
 
+
==== MousePassThroughEnabled ====
+
Property to get/set whether the window ignores mouse events and pass them through to any windows behind it. Value is either "True" or "False".
+
 
+
==== MultiSelect ====
+
Property to get/set the multi-select setting of the list box.  Value is either "True" or "False".
+
 
+
==== NESWSizingCursorImage ====
+
Property to get/set the NE-SW diagonal sizing cursor image for the FramwWindow.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== NSSizingCursorImage ====
+
Property to get/set the N-S (up-down) sizing cursor image for the FramwWindow.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== NWSESizingCursorImage ====
+
Property to get/set the NW-SE diagonal sizing cursor image for the FramwWindow.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== NonClient ====
+
Property to get/set the 'non-client' setting for the Window.  Value is either "True" or "False".
+
 
+
==== NormalEditTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== NormalImage ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== NormalTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== OverlapSize ====
+
Property to get/set the overlap size for the Scrollbar.  Value is a float.
+
 
+
==== PageSize ====
+
Property to get/set the page size for the Scrollbar.  Value is a float.
+
 
+
==== PushedImage ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== PushedTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== ReadOnly ====
+
Property to get/set the read-only setting for the Editbox.  Value is either "True" or "False".
+
 
+
==== ReadOnlyBGColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== RestoreOldCapture ====
+
Property to get/set the 'restore old capture' setting for the Window.  Value is either "True" or "False".
+
 
+
==== ReversedProgress ====
+
Property to get/set whether the ProgressBar operates in reversed direction.  Value is either "True" or "False".
+
 
+
==== RiseOnClick ====
+
Property to get/set whether the window will come tot he top of the z order hwn clicked.  Value is either "True" or "False".
+
 
+
==== RollUpEnabled ====
+
Property to get/set the setting for whether the user is able to roll-up / shade the window.  Value is either "True" or "False".
+
 
+
==== RollUpState ====
+
Property to get/set the roll-up / shade state of the window.  Value is either "True" or "False".
+
 
+
==== Rotation ====
+
Property to get/set the windows rotation factors.  Value is "x:[x_float] y:[y_float] z:[z_float]".
+
 
+
==== ScrollPosition ====
+
Property to get/set the scroll position of the Scrollbar.  Value is a float.
+
 
+
==== SelectedEditTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== SelectedTextColour ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== SelectionBrushImage ====
+
Property to get/set the selection brush image for the editbox.  Value should be "set:[imageset name] image:[image name]".
+
 
+
==== SelectionLength ====
+
Property to get/set the length of the selection (as a count of the number of code points selected).  Value is "[uint]".
+
 
+
==== SelectionStart ====
+
Property to get/set the zero based index of the selection start position within the text.  Value is "[uint]".
+
 
+
==== SingleClickMode ====
+
Property to get/set the 'single click mode' setting for the combo box.  Value is either "True" or "False".
+
 
+
==== SizingBorderThickness ====
+
Property to get/set the setting for the sizing border thickness.  Value is a float specifying the border thickness in pixels.
+
 
+
==== SizingEnabled ====
+
Property to get/set the state of the sizable setting for the FrameWindow.  Value is either "True" or "False".
+
 
+
==== Sort ====
+
Property to get/set the sort setting of the list box.  Value is either "True" or "False".
+
 
+
==== SortList ====
+
Property to get/set the sort setting of the list box.  Value is either "True" or "False".
+
 
+
==== StepSize ====
+
Property to get/set the step size for the Scrollbar.  Value is a float.
+
 
+
==== Text ====
+
Property to get/set the text / caption for the Window.  Value is the text string to use.
+
 
+
==== TextColours ====
+
Property to get/set the text colours for the <font COLOR="#FFBF00">Falagard</font>StaticText widget.  Value is "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
+
 
+
==== TextParsingEnabled ====
+
Property to get/set the text parsing setting for the Window.  Value is either "True" or "False".
+
 
+
==== TitlebarEnabled ====
+
Property to get/set the setting for whether the window title-bar will be enabled (or displayed depending upon choice of final widget type).  Value is either "True" or "False".
+
 
+
==== TitlebarFont ====
+
<font COLOR="#FFBF00">Falagard</font> property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
+
 
+
==== Tooltip ====
+
Property to get/set the tooltip text for the window.  Value is the tooltip text for the window.
+
 
+
==== UnifiedAreaRect ====
+
Property to get/set the windows unified area rectangle.  Value is a "URect".
+
 
+
==== UnifiedHeight ====
+
Property to get/set the windows unified height.  Value is a "UDim".
+
 
+
==== UnifiedMaxSize ====
+
Property to get/set the windows unified maximum size.  Value is a "UVector2".
+
 
+
==== UnifiedMinSize ====
+
Property to get/set the windows unified minimum size.  Value is a "UVector2".
+
 
+
==== UnifiedPosition ====
+
Property to get/set the windows unified position.  Value is a "UVector2".
+
 
+
==== UnifiedSize ====
+
Property to get/set the windows unified size.  Value is a "UVector2".
+
 
+
==== UnifiedWidth ====
+
Property to get/set the windows unified width.  Value is a "UDim".
+
 
+
==== UnifiedXPosition ====
+
Property to get/set the windows unified position x-coordinate.  Value is a "UDim".
+
 
+
==== UnifiedYPosition ====
+
Property to get/set the windows unified position y-coordinate.  Value is a "UDim".
+
 
+
==== UpdateMode ====
+
Property to get/set the window update mode setting.  Value is one of "Always", "Never" or "Visible".
+
 
+
==== UseStandardImagery ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== ValidationString ====
+
Property to get/set the validation string Editbox.  Value is a text string.
+
 
+
==== VertExtent ====
+
Property to get the current vertical extent of the formatted text string.  Value is a float indicating the pixel extent.
+
 
+
==== VertFormatting ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== VertFree ====
+
Property to get/set the state the setting to free the thumb vertically.  Value is either "True" or "False".
+
 
+
==== VertImageFormatting ====
+
<font COLOR="#FFBF00">Falagard</font> custom property definition - gets/sets a named user string.
+
 
+
==== VertRange ====
+
Property to get/set the vertical movement range for the thumb.  Value is "min:[float] max:[float]".
+
 
+
==== VertScrollbar ====
+
Property to get/set the setting for the vertical scroll bar.  Value is either "True" or "False".
+
 
+
==== VerticalAlignment ====
+
Property to get/set the windows vertical alignment.  Value is one of "Top", "Centre" or "Bottom".
+
 
+
==== VerticalProgress ====
+
Property to get/set whether the ProgressBar operates in the vertical direction.  Value is either "True" or "False".
+
 
+
==== VerticalScrollbar ====
+
Property to get/set whether the Scrollbar operates in the vertical direction.  Value is either "True" or "False".
+
 
+
==== Visible ====
+
Property to get/set the 'visible state' setting for the Window.  Value is either "True" or "False".
+
 
+
==== WantsMultiClickEvents ====
+
Property to get/set whether the window will receive double-click and triple-click events.  Value is either "True" or "False".
+
 
+
==== WindowRenderer ====
+
Property to get/set the windows assigned window renderer objects name.  Value is a string.
+
 
+
==== WordWrap ====
+
Property to get/set the word-wrap setting of the edit box.  Value is either "True" or "False".
+
 
+
==== XRotation ====
+
Property to get/set the window's x axis rotation factor.  Value is "[float]".
+
 
+
==== YRotation ====
+
Property to get/set the window's y axis rotation factor.  Value is "[float]".
+
 
+
==== ZOrderChangeEnabled ====
+
Property to get/set the 'z-order changing enabled' setting for the Window.  Value is either "True" or "False".
+
 
+
==== ZRotation ====
+
Property to get/set the window's z axis rotation factor.  Value is "[float]".
+

Latest revision as of 17:19, 7 February 2014

Written for CEGUI 0.7


Works with versions 0.7.x (obsolete)

This is the list of properties per widget within the Vanilla scheme, it was updated for branches/v0-7 on 20th February 2011. It has been generated by PropertyFinder, which can generate a listing for any scheme, both CEGUI schemes as well as custom made schemes. The properties for the TaharezLook, WindowsLook and OgreTray schemes are also available.

Due to the length of this output, and issues MediaWiki has with it, the content is moved to a static html page here