Property reference for Vanilla
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 26th July 2010. It has been generated by [Property Finder], 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.
Contents
- 1 Vanilla
- 2 Properties
- 2.1 ActiveEditSelectionColour
- 2.2 ActiveSelectionColour
- 2.3 Alpha
- 2.4 AlwaysOnTop
- 2.5 AutoRenderingSurface
- 2.6 AutoRepeatDelay
- 2.7 AutoRepeatRate
- 2.8 BackgroundEnabled
- 2.9 BlinkCaret
- 2.10 BlinkCaretTimeout
- 2.11 CaptionColour
- 2.12 CaratIndex
- 2.13 ClippedByParent
- 2.14 CloseButtonEnabled
- 2.15 CurrentProgress
- 2.16 CustomTooltipType
- 2.17 DestroyedByParent
- 2.18 Disabled
- 2.19 DisabledColour
- 2.20 DisabledTextColour
- 2.21 DistributeCapturedInputs
- 2.22 DocumentSize
- 2.23 DragDropTarget
- 2.24 DragMovingEnabled
- 2.25 DraggingEnabled
- 2.26 EWSizingCursorImage
- 2.27 EditSelectionLength
- 2.28 EditSelectionStart
- 2.29 EnabledColour
- 2.30 EndLockEnabled
- 2.31 Font
- 2.32 ForceHorzScrollbar
- 2.33 ForceVertScrollbar
- 2.34 FrameEnabled
- 2.35 HorizontalAlignment
- 2.36 HorzExtent
- 2.37 HorzFormatting
- 2.38 HorzFree
- 2.39 HorzImageFormatting
- 2.40 HorzRange
- 2.41 HorzScrollbar
- 2.42 HotTracked
- 2.43 HoverImage
- 2.44 HoverTextColour
- 2.45 ID
- 2.46 Image
- 2.47 ImageColours
- 2.48 InactiveEditSelectionColour
- 2.49 InactiveSelectionColour
- 2.50 InheritsAlpha
- 2.51 InheritsTooltipText
- 2.52 ItemTooltips
- 2.53 LookNFeel
- 2.54 MaskCodepoint
- 2.55 MaskText
- 2.56 MaxEditTextLength
- 2.57 MaxTextLength
- 2.58 MouseButtonDownAutoRepeat
- 2.59 MouseCursorImage
- 2.60 MouseInputPropagationEnabled
- 2.61 MousePassThroughEnabled
- 2.62 MultiSelect
- 2.63 NESWSizingCursorImage
- 2.64 NSSizingCursorImage
- 2.65 NWSESizingCursorImage
- 2.66 NonClient
- 2.67 NormalEditTextColour
- 2.68 NormalImage
- 2.69 NormalTextColour
- 2.70 OverlapSize
- 2.71 PageSize
- 2.72 PushedImage
- 2.73 PushedTextColour
- 2.74 ReadOnly
- 2.75 ReadOnlyBGColour
- 2.76 RestoreOldCapture
- 2.77 ReversedProgress
- 2.78 RiseOnClick
- 2.79 RollUpEnabled
- 2.80 RollUpState
- 2.81 Rotation
- 2.82 ScrollPosition
- 2.83 SelectedEditTextColour
- 2.84 SelectedTextColour
- 2.85 SelectionBrushImage
- 2.86 SelectionLength
- 2.87 SelectionStart
- 2.88 SingleClickMode
- 2.89 SizingBorderThickness
- 2.90 SizingEnabled
- 2.91 Sort
- 2.92 SortList
- 2.93 StepSize
- 2.94 Text
- 2.95 TextColours
- 2.96 TextParsingEnabled
- 2.97 TitlebarEnabled
- 2.98 TitlebarFont
- 2.99 Tooltip
- 2.100 UnifiedAreaRect
- 2.101 UnifiedHeight
- 2.102 UnifiedMaxSize
- 2.103 UnifiedMinSize
- 2.104 UnifiedPosition
- 2.105 UnifiedSize
- 2.106 UnifiedWidth
- 2.107 UnifiedXPosition
- 2.108 UnifiedYPosition
- 2.109 UpdateMode
- 2.110 UseStandardImagery
- 2.111 ValidationString
- 2.112 VertExtent
- 2.113 VertFormatting
- 2.114 VertFree
- 2.115 VertImageFormatting
- 2.116 VertRange
- 2.117 VertScrollbar
- 2.118 VerticalAlignment
- 2.119 VerticalProgress
- 2.120 VerticalScrollbar
- 2.121 Visible
- 2.122 WantsMultiClickEvents
- 2.123 WindowRenderer
- 2.124 WordWrap
- 2.125 XRotation
- 2.126 YRotation
- 2.127 ZOrderChangeEnabled
- 2.128 ZRotation
Vanilla
Button
ComboDropList
Combobox
Editbox
FrameWindow
HorizontalScrollbar
HorizontalScrollbarThumb
Listbox
MultiLineEditbox
ProgressBar
StaticImage
StaticText
Titlebar
VerticalScrollbar
VerticalScrollbarThumb
Properties
ActiveEditSelectionColour
Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
ActiveSelectionColour
Falagard 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 FalagardStatic 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
Falagard 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
Falagard custom property definition - gets/sets a named user string.
DisabledTextColour
Falagard 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
Falagard 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
Falagard 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
Falagard 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
Falagard custom property definition - gets/sets a named user string.
HoverTextColour
Falagard 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 FalagardStaticImage widget. Value should be "set:[imageset name] image:[image name]".
ImageColours
Falagard custom property definition - gets/sets a named user string.
InactiveEditSelectionColour
Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
InactiveSelectionColour
Falagard 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
Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
NormalImage
Falagard custom property definition - gets/sets a named user string.
NormalTextColour
Falagard 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
Falagard custom property definition - gets/sets a named user string.
PushedTextColour
Falagard 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
Falagard 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
Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.
SelectedTextColour
Falagard 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 FalagardStaticText 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
Falagard 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
Falagard 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
Falagard 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
Falagard 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]".
