Difference between revisions of "Property reference for WindowsLook"
(Added introduction) |
|||
| Line 1: | Line 1: | ||
| + | This is the list of properties per widget within the WindowsLook scheme. 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. | ||
| + | |||
=== WindowsLook === | === WindowsLook === | ||
==== Button ==== | ==== Button ==== | ||
Revision as of 17:30, 29 June 2007
This is the list of properties per widget within the WindowsLook scheme. It has been generated by [Property Finder], which can generate a listing for any scheme, both Cegui schemes as well as custom made schemes.
Contents
- 1 WindowsLook
- 1.1 Button
- 1.2 Checkbox
- 1.3 ComboDropList
- 1.4 Combobox
- 1.5 Editbox
- 1.6 FrameWindow
- 1.7 HorizontalScrollbar
- 1.8 HorizontalScrollbarThumb
- 1.9 IconButton
- 1.10 ItemListbox
- 1.11 ListHeader
- 1.12 ListHeaderSegment
- 1.13 Listbox
- 1.14 ListboxItem
- 1.15 MenuItem
- 1.16 Menubar
- 1.17 MultiColumnList
- 1.18 MultiLineEditbox
- 1.19 PopupMenu
- 1.20 ProgressBar
- 1.21 RadioButton
- 1.22 ScrollablePane
- 1.23 Slider
- 1.24 SliderThumb
- 1.25 Spinner
- 1.26 Static
- 1.27 StaticImage
- 1.28 StaticText
- 1.29 SystemButton
- 1.30 TabButton
- 1.31 TabButtonPane
- 1.32 TabContentPane
- 1.33 TabControl
- 1.34 Titlebar
- 1.35 Tooltip
- 1.36 VerticalScrollbar
- 1.37 VerticalScrollbarThumb
- 2 Properties
- 2.1 ActiveEditSelectionColour
- 2.2 ActiveSelectionColour
- 2.3 AllowMultiplePopups
- 2.4 Alpha
- 2.5 AlwaysOnTop
- 2.6 AutoRepeatDelay
- 2.7 AutoRepeatRate
- 2.8 AutoResizeEnabled
- 2.9 BackgroundColours
- 2.10 BackgroundEnabled
- 2.11 BorderWidth
- 2.12 CaptionColour
- 2.13 CaratIndex
- 2.14 ClickStepSize
- 2.15 Clickable
- 2.16 ClippedByParent
- 2.17 CloseButtonEnabled
- 2.18 ColumnHeader
- 2.19 ColumnsMovable
- 2.20 ColumnsSizable
- 2.21 ContentArea
- 2.22 ContentPaneAutoSized
- 2.23 CurrentProgress
- 2.24 CurrentValue
- 2.25 CustomTooltipType
- 2.26 DestroyedByParent
- 2.27 Disabled
- 2.28 DisabledTextColour
- 2.29 DisplayTime
- 2.30 DistributeCapturedInputs
- 2.31 DocumentSize
- 2.32 DragMovingEnabled
- 2.33 Dragable
- 2.34 DraggingEnabled
- 2.35 EWSizingCursorImage
- 2.36 EditSelectionLength
- 2.37 EditSelectionStart
- 2.38 EnableBottom
- 2.39 EnableTop
- 2.40 FadeInTime
- 2.41 FadeOutTime
- 2.42 FadeTime
- 2.43 Font
- 2.44 ForceHorzScrollbar
- 2.45 ForceVertScrollbar
- 2.46 FrameColours
- 2.47 FrameEnabled
- 2.48 GroupID
- 2.49 HorizontalAlignment
- 2.50 HorzFormatting
- 2.51 HorzFree
- 2.52 HorzOverlapSize
- 2.53 HorzRange
- 2.54 HorzScrollPosition
- 2.55 HorzScrollbar
- 2.56 HorzStepSize
- 2.57 HotTracked
- 2.58 HoverColour
- 2.59 HoverImage
- 2.60 HoverTextColour
- 2.61 HoverTime
- 2.62 ID
- 2.63 IconColours
- 2.64 IconImage
- 2.65 Image
- 2.66 ImageColours
- 2.67 InactiveEditSelectionColour
- 2.68 InactiveSelectionColour
- 2.69 InheritsAlpha
- 2.70 InheritsTooltipText
- 2.71 ItemSpacing
- 2.72 ItemTooltips
- 2.73 LookNFeel
- 2.74 MaskCodepoint
- 2.75 MaskText
- 2.76 MaxEditTextLength
- 2.77 MaxTextLength
- 2.78 MaximumValue
- 2.79 MinimumValue
- 2.80 MouseButtonDownAutoRepeat
- 2.81 MouseCursorImage
- 2.82 MousePassThroughEnabled
- 2.83 MovingCursorImage
- 2.84 MultiSelect
- 2.85 NESWSizingCursorImage
- 2.86 NSSizingCursorImage
- 2.87 NWSESizingCursorImage
- 2.88 NominatedSelectionColumnID
- 2.89 NominatedSelectionRow
- 2.90 NormalEditTextColour
- 2.91 NormalImage
- 2.92 NormalTextColour
- 2.93 OpenedColour
- 2.94 OverlapSize
- 2.95 PageSize
- 2.96 PushedColour
- 2.97 PushedImage
- 2.98 PushedOffColour
- 2.99 PushedTextColour
- 2.100 ReadOnly
- 2.101 ReadOnlyBGColour
- 2.102 RestoreOldCapture
- 2.103 ReversedDirection
- 2.104 ReversedProgress
- 2.105 RiseOnClick
- 2.106 RollUpEnabled
- 2.107 RollUpState
- 2.108 RowCount
- 2.109 ScrollPosition
- 2.110 SegmentWidgetType
- 2.111 Selectable
- 2.112 Selected
- 2.113 SelectedEditTextColour
- 2.114 SelectedTextColour
- 2.115 SelectionBrush
- 2.116 SelectionBrushImage
- 2.117 SelectionColour
- 2.118 SelectionLength
- 2.119 SelectionMode
- 2.120 SelectionStart
- 2.121 SingleClickMode
- 2.122 Sizable
- 2.123 SizingBorderThickness
- 2.124 SizingCursorImage
- 2.125 SizingEnabled
- 2.126 Sort
- 2.127 SortColumnID
- 2.128 SortDirection
- 2.129 SortEnabled
- 2.130 SortList
- 2.131 SortMode
- 2.132 SortSettingEnabled
- 2.133 StepSize
- 2.134 TabButtonType
- 2.135 TabHeight
- 2.136 TabPanePosition
- 2.137 TabTextPadding
- 2.138 Text
- 2.139 TextColour
- 2.140 TextColours
- 2.141 TextInputMode
- 2.142 TextPadding
- 2.143 TitlebarEnabled
- 2.144 TitlebarFont
- 2.145 Tooltip
- 2.146 UnifiedAreaRect
- 2.147 UnifiedHeight
- 2.148 UnifiedMaxSize
- 2.149 UnifiedMinSize
- 2.150 UnifiedPosition
- 2.151 UnifiedSize
- 2.152 UnifiedWidth
- 2.153 UnifiedXPosition
- 2.154 UnifiedYPosition
- 2.155 ValidationString
- 2.156 VertFormatting
- 2.157 VertFree
- 2.158 VertOverlapSize
- 2.159 VertRange
- 2.160 VertScrollPosition
- 2.161 VertScrollbar
- 2.162 VertStepSize
- 2.163 VerticalAlignment
- 2.164 VerticalProgress
- 2.165 VerticalScrollbar
- 2.166 VerticalSlider
- 2.167 Visible
- 2.168 WantsMultiClickEvents
- 2.169 WindowRenderer
- 2.170 WordWrap
- 2.171 ZOrderChangeEnabled
WindowsLook
Button
Checkbox
ComboDropList
Combobox
Editbox
FrameWindow
HorizontalScrollbar
HorizontalScrollbarThumb
IconButton
ItemListbox
ListHeader
ListHeaderSegment
Listbox
ListboxItem
MenuItem
Menubar
MultiColumnList
MultiLineEditbox
PopupMenu
ProgressBar
RadioButton
ScrollablePane
Slider
SliderThumb
Spinner
Static
StaticImage
StaticText
SystemButton
TabButton
TabButtonPane
TabContentPane
TabControl
Titlebar
Tooltip
VerticalScrollbar
VerticalScrollbarThumb
Properties
ActiveEditSelectionColour
Falagard property link definition - links a property on this window to another defined on a child window.
ActiveSelectionColour
Falagard custom property definition - gets/sets a named user string.
AllowMultiplePopups
Property to get/set the state of the allow multiple popups setting for the menu. Value is either "True" or "False".
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".
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.
AutoResizeEnabled
Property to get/set the state of the auto resizing enabled setting for the ItemListBase. Value is either "True" or "False".
BackgroundColours
Falagard custom property definition - gets/sets a named user string.
BackgroundEnabled
Property to get/set the state of the frame background setting for the FalagardStatic widget. Value is either "True" or "False".
BorderWidth
Falagard custom property definition - gets/sets a named user string.
CaptionColour
Falagard property link definition - links a property on this window to another defined on a child window.
CaratIndex
Property to get/set the current carat index. Value is "[uint]".
ClickStepSize
Property to get/set the click-step size for the slider. Value is a float.
Clickable
Property to get/set the click-able setting of the header segment. Value is either "True" or "False".
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".
ColumnHeader
Property to set up a column (there is no getter for this property)
ColumnsMovable
Property to get/set the setting for user moving of the column headers. Value is either "True" or "False".
ColumnsSizable
Property to get/set the setting for user sizing of the column headers. Value is either "True" or "False".
ContentArea
Property to get/set the current content area rectangle of the content pane. Value is "l:[float] t:[float] r:[float] b:[float]" (where l is left, t is top, r is right, and b is bottom).
ContentPaneAutoSized
Property to get/set the setting which controls whether the content pane will auto-size itself. 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.
CurrentValue
Property to get/set the current value of the slider. Value is a float.
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".
DisabledTextColour
Falagard custom property definition - gets/sets a named user string.
DisplayTime
Property to get/set the display timeout value in seconds. Value is a float.
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.
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".
Dragable
Property to get/set the drag-able setting of the header segment. 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]".
EnableBottom
Falagard custom property definition - gets/sets a named user string.
EnableTop
Falagard custom property definition - gets/sets a named user string.
FadeInTime
Property to get/set the fade in time in seconds of the popup menu. Value is a float.
FadeOutTime
Property to get/set the fade out time in seconds of the popup menu. Value is a float.
FadeTime
Property to get/set duration of the fade effect in seconds. Value is a float.
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".
FrameColours
Falagard custom property definition - gets/sets a named user string.
FrameEnabled
Property to get/set the setting for whether the window frame will be displayed. Value is either "True" or "False".
GroupID
Property to get/set the radio button group ID. Value is an unsigned integer number.
HorizontalAlignment
Property to get/set the windows horizontal alignment. Value is one of "Left", "Centre" or "Right".
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".
HorzOverlapSize
Property to get/set the overlap size for the horizontal Scrollbar. Value is a float.
HorzRange
Property to get/set the horizontal movement range for the thumb. Value is "min:[float] max:[float]".
HorzScrollPosition
Property to get/set the scroll position of the horizontal Scrollbar as a fraction. Value is a float.
HorzScrollbar
Property to get/set the setting for the horizontal scroll bar. Value is either "True" or "False".
HorzStepSize
Property to get/set the step size for the horizontal Scrollbar. Value is a float.
HotTracked
Property to get/set the state of the state of the 'hot-tracked' setting for the thumb. Value is either "True" or "False".
HoverColour
Falagard custom property definition - gets/sets a named user string.
HoverImage
Falagard custom property definition - gets/sets a named user string.
HoverTextColour
Falagard custom property definition - gets/sets a named user string.
HoverTime
Property to get/set the hover timeout value in seconds. Value is a float.
ID
Property to get/set the ID value of the Window. Value is an unsigned integer number.
IconColours
Falagard custom property definition - gets/sets a named user string.
IconImage
Falagard custom property definition - gets/sets a named user string.
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 another defined on a child 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".
ItemSpacing
Property to get/set the item spacing of the menu. Value is a float.
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]".
MaximumValue
Property to get/set the maximum value of the slider. Value is a float.
MinimumValue
Property to get/set the minimum value setting of the spinner. Value is a float.
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>".
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".
MovingCursorImage
Property to get/set the moving cursor image for the List Header Segment. Value should be "set:[imageset name] image:[image name]".
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]".
NominatedSelectionColumnID
Property to get/set the nominated selection column (via ID). Value is an unsigned integer number.
NominatedSelectionRow
Property to get/set the nominated selection row. Value is an unsigned integer number.
NormalEditTextColour
Falagard property link definition - links a property on this window to another defined on a child window.
NormalImage
Falagard custom property definition - gets/sets a named user string.
NormalTextColour
Falagard custom property definition - gets/sets a named user string.
OpenedColour
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.
PushedColour
Falagard custom property definition - gets/sets a named user string.
PushedImage
Falagard custom property definition - gets/sets a named user string.
PushedOffColour
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".
ReversedDirection
Property to get/set whether the Slider operates in reversed direction. 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".
RowCount
Property to access the number of rows in the list (read only)
ScrollPosition
Property to get/set the scroll position of the Scrollbar. Value is a float.
SegmentWidgetType
Property to get/set the widget type used when creating header segments. Value should be "[widgetTypeName]".
Selectable
Property to get/set the state of the selectable setting for the ItemEntry. Value is either "True" or "False".
Selected
Property to get/set the selected state of the Checkbox. Value is either "True" or "False".
SelectedEditTextColour
Falagard property link definition - links a property on this window to another defined on a child window.
SelectedTextColour
Falagard custom property definition - gets/sets a named user string.
SelectionBrush
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]".
SelectionColour
Falagard custom property definition - gets/sets a named user string.
SelectionLength
Property to get/set the length of the selection (as a count of the number of code points selected). Value is "[uint]".
SelectionMode
Property to get/set the selection mode setting of the list. Value is the text of one of the SelectionMode enumerated value names.
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".
Sizable
Property to get/set the sizable setting of the header segment. 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.
SizingCursorImage
Property to get/set the sizing cursor image for the List Header Segment. Value should be "set:[imageset name] image:[image name]".
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".
SortColumnID
Property to get/set the current sort column (via ID code). Value is an unsigned integer number.
SortDirection
Property to get/set the sort direction setting of the header. Value is the text of one of the SortDirection enumerated value names.
SortEnabled
Property to get/set the state of the sorting enabled setting for the ItemListBase. Value is either "True" or "False".
SortList
Property to get/set the sort setting of the list box. Value is either "True" or "False".
SortMode
Property to get/set the sorting mode for the ItemListBase. Value is either "Ascending", "Descending" or "UserSort".
SortSettingEnabled
Property to get/set the setting for for user modification of the sort column & direction. Value is either "True" or "False".
StepSize
Property to get/set the step size for the Scrollbar. Value is a float.
TabButtonType
Property to get/set the widget type used when creating tab buttons. Value should be "[widgetTypeName]".
TabHeight
Property to get/set the height of the tabs.
TabPanePosition
Property to get/set the position of the buttons pane.
TabTextPadding
Property to get/set the padding either side of the tab buttons.
Text
Property to get/set the text / caption for the Window. Value is the text string to use.
TextColour
Falagard custom property definition - gets/sets a named user string.
TextColours
Property to get/set the text colours for the FalagardStaticText widget. Value is "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
TextInputMode
Property to get/set the TextInputMode setting for the spinner. Value is "FloatingPoint", "Integer", "Hexadecimal", or "Octal".
TextPadding
Falagard custom property definition - gets/sets a named user string.
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 another defined on a child 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".
ValidationString
Property to get/set the validation string Editbox. Value is a text string.
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".
VertOverlapSize
Property to get/set the overlap size for the vertical Scrollbar. Value is a float.
VertRange
Property to get/set the vertical movement range for the thumb. Value is "min:[float] max:[float]".
VertScrollPosition
Property to get/set the scroll position of the vertical Scrollbar as a fraction. Value is a float.
VertScrollbar
Property to get/set the setting for the vertical scroll bar. Value is either "True" or "False".
VertStepSize
Property to get/set the step size for the vertical Scrollbar. Value is a float.
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".
VerticalSlider
Property to get/set whether the Slider 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".
ZOrderChangeEnabled
Property to get/set the 'z-order changing enabled' setting for the Window. Value is either "True" or "False".
