Falagard System base widgets reference

From CEGUIWiki

This is a reference containing the states and other constructs required by each of the Falagard base widget types.

Contents 1 Falagard/Button 2 Falagard/Checkbox 3 Falagard/Combobox 4 Falagard/ComboDropList 5 Falagard/Editbox 6 Falagard/FrameWindow 7 Falagard/Listbox 8 Falagard/ListHeader 9 Falagard/ListHeaderSegment 10 Falagard/Menubar 11 Falagard/MenuItem 12 Falagard/MultiColumnList 13 Falagard/MultiLineEditbox 14 Falagard/PopupMenu 15 Falagard/ProgressBar 16 Falagard/RadioButton 17 Falagard/ScrollablePane 18 Falagard/Scrollbar 19 Falagard/Slider 20 Falagard/Spinner 21 Falagard/StaticImage 22 Falagard/StaticText 23 Falagard/SystemButton 24 Falagard/TabButton 25 Falagard/TabControl 26 Falagard/TabPane 27 Falagard/Thumb 28 Falagard/Titlebar 29 Falagard/Tooltip

Falagard/Button

General purpose push button widget class.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal'):
  • Normal - Imagery used when the widget is neither pushed nor has the mouse hovering over it.
  • Hover - Imagery used when the widget has the mouse hovering over it, or when the widget is 'pushed' but the mouse has been moved out of the widget area.
  • Pushed - Imagery used when the widget is pushed and the mouse is over the widget.
  • Disabled - Imagery used when the widget is disabled.

Falagard/Checkbox

General purpose checkbox / toggle button widget class.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal' or 'SelectedNormal'):
  • Normal - Imagery used when the widget is in the deselected / off state, and is neither pushed nor has the mouse hovering over it.
  • Hover - Imagery used when the widget is in the deselected / off state, and has the mouse hovering over it, or when the widget is in the deselected / off state, and is 'pushed' but the mouse has been moved out of the widget area.
  • Pushed - Imagery used when the widget is in the deselected / off state, and is pushed with the mouse over the widget.
  • Disabled - Imagery used when the widget is in the deselected / off state, and is disabled.
  • SelectedNormal - Imagery used when the widget is in the selected / on state, and is neither pushed nor has the mouse hovering over it.
  • SelectedHover - Imagery used when the widget is in the selected / on state, and has the mouse hovering over it, or when the widget is in the selected / on state, and is 'pushed' but the mouse has been moved out of the widget area.
  • SelectedPushed - Imagery used when the widget is in the selected / on state, and is pushed with the mouse over the widget.
  • SelectedDisabled - Imagery used when the widget is in the selected / on state, and is disabled.

Falagard/Combobox

Widget providing a text box and drop down list invoked via a button.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• Child widget definitions:
  • Editbox based widget with name suffix "__auto_editbox__"
  • ComboDropList based widget with name suffix "__auto_droplist__"
  • PushButton based widget with name suffix "__auto_button__"

Falagard/ComboDropList

Listbox style widget used as the component drop-down list for Combobox widgets.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ItemRenderingArea – Target area where list items will appear when no scrollbars are visible (also acts as default area). Required.
  • ItemRenderingAreaHScroll – Target area where list items will appear when the horizontal scrollbar is visible. Optional.
  • ItemRenderingAreaVScroll – Target area where list items will appear when the vertical scrollbar is visible. Optional.
  • ItemRenderingAreaHVScroll – Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.

Falagard/Editbox

General purpose single-line text box widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - Imagery used when widget is enabled.
  • Disabled - Imagery used when widget is disabled.
  • ReadOnly - Imagery used when widget is in 'Read Only' state.
  • ActiveSelection - Additional imagery used when a text selection is defined and the widget is active. The imagery for this state will be rendered within the selection area.
  • InactiveSelection - Additional imagery used when a text selection is defined and the widget is not active. The imagery for this state will be rendered within the selection area.

• NamedArea definitions:
  • TextArea - Defines the area where the text, carat, and any selection imagery will appear.

• ImagerySection definitions:
  • Carat - Additional imagery used to display the insertion position carat.

Falagard/FrameWindow

General purpose window type which can be sized and moved.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • ActiveWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is active.
  • InactiveWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is inactive.
  • DisabledWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is disabled.
  • ActiveWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is active.
  • InactiveWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is inactive.
  • DisabledWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is disabled.
  • ActiveNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is active.
  • InactiveNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is inactive.
  • DisabledNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is disabled.
  • ActiveNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is active.
  • InactiveNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is inactive.
  • DisabledNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is disabled.

• NamedArea definitions:
  • ClientWithTitleWithFrame - Area that defines the clipping region for the client area when the widget has its title bar enabled, and has its frame enabled.
  • ClientWithTitleNoFrame - Area that defines the clipping region for the client area when the widget has its title bar enabled, and has its frame disabled.
  • ClientNoTitleWithFrame - Area that defines the clipping region for the client area when the widget has its title bar disabled, and has its frame enabled.
  • ClientNoTitleNoFrame - Area that defines the clipping region for the client area when the widget has its title bar disabled, and has its frame disabled.

• Child widget definitions:
  • Titlebar based widget with name suffix "__auto_titlebar__". This widget will be used as the title bar for the frame window.
  • SystemButton based widget with name suffix "__auto_closebutton__". This widget will be used as the close button for the frame window.

Falagard/Listbox

General purpose single column list widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ItemRenderingArea – Target area where list items will appear when no scrollbars are visible (also acts as default area). Required.
  • ItemRenderingAreaHScroll – Target area where list items will appear when the horizontal scrollbar is visible. Optional.
  • ItemRenderingAreaVScroll – Target area where list items will appear when the vertical scrollbar is visible. Optional.
  • ItemRenderingAreaHVScroll – Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.

Falagard/ListHeader

List header widget. Acts as a container for ListHeaderSegment based widgets. Usually used as a component part widget for multi-column list widgets.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• Property initialiser definitions:
  • SegmentWidgetType - specifies the name of a "ListHeaderSegment" based widget type; an instance of which will be created for each column within the header. (Required)

Falagard/ListHeaderSegment

Widget type intended for use as a single column header within a list header widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Disabled - Imagery to use when the widget is disabled.
  • Normal - Imagery to use when the widget is enabled and the mouse is not within any part of the segment widget.
  • Hover - Imagery to use when the widget is enabled and the mouse is within the main area of the widget (not the drag-sizing 'splitter' area).
  • SplitterHover - Imagery to use when the widget is enabled and the mouse is within the drag-sizing 'splitter' area.
  • DragGhost - Imagery to use for the drag-moving 'ghost' of the segment. This state should specify that its imagery be render unclipped.
  • AscendingSortIcon - Additional imagery used when the segment has the ascending sort direction set.
  • DescendingSortDown - Additional imagery used when the segment has the descending sort direction set.
  • GhostAscendingSortIcon - Additional imagery used for the drag-moving 'ghost' when the segment has the ascending sort direction set.
  • GhostDescendingSortDown - Additional imagery used for the drag-moving 'ghost' when the segment has the descending sort direction set.

• Property initialiser definitions:
  • MovingCursorImage - Property to define a mouse cursor image to use when drag-moving the widget. (Optional).
  • SizingCursorImage - Property to define a mouse cursor image to use when drag-sizing the widget. (Optional).

Falagard/Menubar

General purpose horizontal menu bar widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ItemRenderingArea - Target area where menu items will appear.

Falagard/MenuItem

General purpose textual menu item widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • EnabledNormal - Imagery used when the item is enabled and the mouse is not within its area.
  • EnabledHover - Imagery used when the item is enabled and the mouse is within its area.
  • EnabledPushed - Imagery used when the item is enabled and user has pushed the mouse button over it.
  • EnabledPopupOpen - Imagery used when the item is enabled and attached popup menu is opened.
  • DisabledNormal - Imagery used when the item is disabled and the mouse is not within its area.
  • DisabledHover - Imagery used when the item is disabled and the mouse is within its area.
  • DisabledPushed - Imagery used when the item is disabled and user has pushed the mouse button over it.
  • DisabledPopupOpen - Imagery used when the item is disabled and attached popup menu is opened.
  • PopupClosedIcon - Additional imagery used when the item is attached to a popup menu widget and has a a 'sub' popup menu attached to itself, and that popup is closed.
  • PopupOpenIcon - Additional imagery used when the item is attached to a popup menu widget and has a a 'sub' popup menu attached to itself, and that popup is open.

Falagard/MultiColumnList

General purpose multi-comumn list / grid widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ItemRenderingArea – Target area where list items will appear when no scrollbars are visible (also acts as default area). Required.
  • ItemRenderingAreaHScroll – Target area where list items will appear when the horizontal scrollbar is visible. Optional.
  • ItemRenderingAreaVScroll – Target area where list items will appear when the vertical scrollbar is visible. Optional.
  • ItemRenderingAreaHVScroll – Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.
  • ListHeader based widget with name suffix "__auto_listheader__". This widget will be used for the header (though technically, you can place it anywhere).

Falagard/MultiLineEditbox

General purpose multi-line text box widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - Imagery used when widget is enabled.
  • Disabled - Imagery used when widget is disabled.
  • ReadOnly - Imagery used when widget is in 'Read Only' state.

• NamedArea definitions:
  • TextArea – Target area where text lines will appear when no scrollbars are visible (also acts as default area). Required.
  • TextAreaHScroll – Target area where text lines will appear when the horizontal scrollbar is visible. Optional.
  • TextAreaVScroll – Target area where text lines will appear when the vertical scrollbar is visible. Optional.
  • TextAreaHVScroll – Target area where text lines will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.

• ImagerySection definitions:
  • Carat - Additional imagery used to display the insertion position carat.

• Property initialiser definitions:
  • SelectionBrushImage - defines name of image that will be painted for the text selection (this is applied on a per-line basis).

Falagard/PopupMenu

General purpose popup menu widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ItemRenderingArea - Target area where menu items will appear.

Falagard/ProgressBar

General purpose progress widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal' or 'SelectedNormal'):
  • Enabled - General imagery used when widget is enabled.
  • Disabled - General imagery used when widget is disabled.
  • EnabledProgress - imagery for 100% progress used when widget is enabled. The drawn imagery will appear in named area "ProgressArea" and will be clipped appropriately according to widget settings and the current progress value.
  • DisabledProgress - imagery for 100% progress used when widget is disabled. The drawn imagery will appear in named area "ProgressArea" and will be clipped appropriately according to widget settings and the current progress value.

• NamedArea definitions:
  • ProgressArea - Target area where progress imagery will appear.

• Property initialiser definitions:
  • VerticalProgress - boolean property. Determines whether the progress widget is horizontal or vertical. Default is horizontal. Optional.
  • ReversedProgress - boolean property. Determines whether the progress grows in the opposite direction to what is considered 'usual'. Set to "True" to have progress grow towards the left or bottom of the progress area. Optional.

Falagard/RadioButton

General purpose radio button style widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal' or 'SelectedNormal'):
  • Normal - Imagery used when the widget is in the deselected / off state, and is neither pushed nor has the mouse hovering over it.
  • Hover - Imagery used when the widget is in the deselected / off state, and has the mouse hovering over it, or when the widget is in the deselected / off state, and is 'pushed' but the mouse has been moved out of the widget area.
  • Pushed - Imagery used when the widget is in the deselected / off state, and is pushed with the mouse over the widget.
  • Disabled - Imagery used when the widget is in the deselected / off state, and is disabled.
  • SelectedNormal - Imagery used when the widget is in the selected / on state, and is neither pushed nor has the mouse hovering over it.
  • SelectedHover - Imagery used when the widget is in the selected / on state, and has the mouse hovering over it, or when the widget is in the selected / on state, and is 'pushed' but the mouse has been moved out of the widget area.
  • SelectedPushed - Imagery used when the widget is in the selected / on state, and is pushed with the mouse over the widget.
  • SelectedDisabled - Imagery used when the widget is in the selected / on state, and is disabled.

Falagard/ScrollablePane

General purpose scrollable pane widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ViewableArea – Target area where visible content will appear when no scrollbars are visible (also acts as default area). Required.
  • ViewableAreaHScroll – Target area where visible content will appear when the horizontal scrollbar is visible. Optional.
  • ViewableAreaVScroll – Target area where visible content will appear when the vertical scrollbar is visible. Optional.
  • ViewableAreaHVScroll – Target area where visible content will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.

Falagard/Scrollbar

General purpose scrollbar widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ThumbTrackArea - Target area in which thumb may be moved.

• Child widget definitions:
  • Thumb based widget with name suffix "__auto_thumb__". This widget will be used for the scrollbar thumb.
  • PushButton based widget with name suffix "__auto_incbtn__". This widget will be used as the increase button.
  • PushButton based widget with name suffix "__auto_decbtn__". This widget will be used as the decrease button.

• Property initialiser definitions:
  • VerticalScrollbar - boolean property. Indicates whether this scrollbar will operate in the vertical or horizontal direction. Default is for horizontal. Optional.

Falagard/Slider

General purpose slider widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • ThumbTrackArea - Target area in which thumb may be moved.

• Child widget definitions:
  • Thumb based widget with name suffix "__auto_thumb__". This widget will be used for the slider thumb.

• Property initialiser definitions:
  • VerticalSlider - boolean property. Indicates whether this slider will operate in the vertical or horizontal direction. Default is for horizontal. Optional.

Falagard/Spinner

General purpose numerical spinner widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• Child widget definitions:
  • Editbox based widget with name suffix "__auto_editbox__". This widget will be used as the text box / display portion of the widget.
  • PushButton based widget with name suffix "__auto_incbtn__". This widget will be used as the increase button.
  • PushButton based widget with name suffix "__auto_decbtn__". This widget will be used as the decrease button.

Falagard/StaticImage

Static widget that displays a configurable image.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.
  • EnabledFrame - Additional imagery used when the widget is enabled and the widget frame is enabled.
  • DisabledFrame - Additional imagery used when the widget is disabled and the widget frame is enabled.
  • EnabledBackground - Additional imagery used when the widget is enabled and the widget background is enabled.
  • DisabledBackground - Additional imagery used when the widget is disabled and the widget background is enabled.

• NamedArea definitions:
  • WithFrameImageRenderArea - Area to render image into when the frame is enabled (optional).
  • NoFrameImageRenderArea - Area to render image into when the frame is disabled (optional).

Falagard/StaticText

Static widget that displays configurable text.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.
  • EnabledFrame - Additional imagery used when the widget is enabled and the widget frame is enabled.
  • DisabledFrame - Additional imagery used when the widget is disabled and the widget frame is enabled.
  • EnabledBackground - Additional imagery used when the widget is enabled and the widget background is enabled.
  • DisabledBackground - Additional imagery used when the widget is disabled and the widget background is enabled.

• NamedArea definitions:
  • TextRenderArea – Target area where text will appear when no scrollbars are visible (also acts as default area). Required.
  • TextRenderAreaHScroll – Target area where text will appear when the horizontal scrollbar is visible. Optional.
  • TextRenderAreaVScroll – Target area where text will appear when the vertical scrollbar is visible. Optional.
  • TextRenderAreaHVScroll – Target area where text will appear when both the horizontal and vertical scrollbars are visible. Optional.

• Child widget definitions:
  • Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position.
  • Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position.

Falagard/SystemButton

Specialised push button widget intended to be used for 'system' buttons appearing outside of the client area of a frame window style widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal'):
  • Normal - Imagery used when the widget is neither pushed nor has the mouse hovering over it.
  • Hover - Imagery used when the widget has the mouse hovering over it, or when the widget is 'pushed' but the mouse has been moved out of the widget area.
  • Pushed - Imagery used when the widget is pushed and the mouse is over the widget.
  • Disabled - Imagery used when the widget is disabled.

Falagard/TabButton

Special widget type used for tab buttons within a tab control based widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal'):
  • Normal - Imagery used when the widget is neither selected nor has the mouse hovering over it.
  • Hover - Imagery used when the widget has the mouse hovering over it.
  • Selected - Imagery used when the widget is the active / selected tab.
  • Disabled - Imagery used when the widget is disabled.

Falagard/TabControl

General purpose tab control widget. The current TabControl base class enforces a strict layout, so while imagery can be customised as desired, the general layout of the component widgets is, at least for the time being, fixed.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• Child widget definitions:
  • TabPane based widget with name suffix "__auto_TabPane__". This widget will be used as the content viewing pane.
  • DefaultWindow based widget with name suffix "__auto_TabPane__Buttons". This widget will be used as a container for the tab buttons. Optional.

• Property initialiser definitions:
  • TabButtonType - specifies a TabButton based widget type to be created each time a new tab button is required.

Falagard/TabPane

Special widget type used for the content pane of a tab control based widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

Falagard/Thumb

General purpose thumb class for use as a component in widgets that require a movable thumb or knob.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal'):
  • Normal - Imagery used when the widget is neither pushed nor has the mouse hovering over it.
  • Hover - Imagery used when the widget has the mouse hovering over it, or when the widget is 'pushed' but the mouse has been moved out of the widget area.
  • Pushed - Imagery used when the widget is pushed and the mouse is over the widget.
  • Disabled - Imagery used when the widget is disabled.

Falagard/Titlebar

Title bar widget intended for use as the title bar of a frame window widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions (missing states will default to 'Normal'):
  • Active - Imagery used when the widget is active.
  • Inactive - Imagery used when the widget is inactive.
  • Disabled - Imagery used when the widget is disabled.

Falagard/Tooltip

General purpose tool-tip widget.

Assigned WidgetLook should provide the following:

• StateImagery definitions:
  • Enabled - General imagery for when the widget is enabled.
  • Disabled - General imagery for when the widget is disabled.

• NamedArea definitions:
  • TextArea - Typically this would be the same area as the TextComponent you define to receive the tool-tip text. This named area is used when deciding how to dynamically size the tool-tip so that text is not clipped.