Difference between revisions of "Property reference for OgreTray"

Revision as of 17:13, 7 October 2010

This is the list of properties per widget within the OgreTray 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, Vanilla and WindowsLook schemes are also available.

OgreTray

AltStaticImage

BG

Button

CaptionedStaticText

Checkbox

ComboDropList

Combobox

DropDownMenu

Editbox

FrameWindow

Group

HorizontalScrollbar

ItemListbox

ListHeader

ListHeaderSegment

Listbox

ListboxItem

MenuItem

Menubar

MultiColumnList

MultiLineEditbox

PopupMenu

ProgressBar

RadioButton

ScrollablePane

Slider

Spinner

StaticImage

StaticText

TabButton

TabButtonPane

TabContentPane

TabControl

Thumb

Title

Titlebar

Tooltip

VerticalScrollbar

Properties

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".

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.

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".

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.

BorderWidth

Falagard custom property definition - gets/sets a named user string.

CaptionColour

Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.

CaptionFont

Falagard property link definition - links a property on this window to properties defined on one or more child windows, or the parent window.

CaptionText

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]".

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.

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".

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.

EndLockEnabled

Property to get/set the 'end lock' mode setting for the Scrollbar. Value is either "True" or "False".

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".

FrameEnabled

Falagard custom property definition - gets/sets a named user string.

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".

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".

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".

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.

Image

Falagard custom property definition - gets/sets a named user string.

ImageColours

Falagard custom property definition - gets/sets a named user string.

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>".

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".

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.

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.

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.

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".

Rotation

Property to get/set the windows rotation factors. Value is "x:[x_float] y:[y_float] z:[z_float]".

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 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]".

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".

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".

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".

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".

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".

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]".