CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Sample code for all Widgets

2008-02-19T16:46:58Z

Rackle: Link toward PseudoListbox

This code goes through every widget and demonstrates how to retrieve and set their data as well as some of their particularities. Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=7967#7967 Widget Galore]

=== Widgets===

==== General ====
A widget can be enabled/disabled via setEnabled(). Disabling a widget prevents the user from activating it and manipulating its contents. A widget can be hidden/shown via setVisible().

==== Tooltip ====
A Tooltip widget displays text when the mouse has been hovering over a widget for a certain amount of time. This widget requires that time be injected within CEGUI via injectTimePulse().

The graphical aspect (the scheme) of the tooltip can be specified via setTooltip(). The amount of hovering time required to activate the tooltip can be specified via setHoverTime(). The amount of time the tooltip is displayed can be specified via setDisplayTime(). And the fade transition time can be specified via setFadeTime(); this affects both the fade in and the fade out times. The tooltip text of a widget can be specified via setTooltipText(). Please note that some complex widgets are composed of several widgets. In order to have a tooltip text displayed while hovering over any region of the complex widget then every component widget needs to have a tooltip text specified. For example a Spinner widget is composed of an Editbox widget and two Button widgets.

==== StaticText ====
There is no StaticText within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed text can be specified via setText(). The color of this text can be specified via the "TextColours" property. The value of this property contains 4 color definitions: top left, top right, bottom left, and bottom right. Each color is specified as a two-digit hexadecimal value of the format AARRGGBB (alpha, red, green, blue). The text is aligned vertically via the "VertFormatting" property with a value of TopAligned, BottomAligned, or VertCentred. The text is aligned horizontally via the "HorzFormatting" property with a value of LeftAligned, RightAligned, HorzCentred, HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, or WordWrapJustified.

==== StaticImage ====
There is no StaticImage within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed image can be specified via the "Image" property. This property takes two parameters, the imageset ("set") and the image name ("image").

==== ProgressBar ====
A ProgressBar widget displays a progression; it does not receive inputs from a user.

The current progress can be specified via setProgress(). Progress can be advanced through steps. The step size can be specified via setStepSize() and a step performed via step(). Progress can be adjusted by a delta value via adjustProgress(). The current progress value can be obtained via getProgress().

==== Button ====
A Button widget displays a text and receives an activation instruction from the user.

The text can be specified via setText().

==== ScrollablePane ====
A ScrollablePane widget displays contents that can be scrolled. Contents can be added via addChildWindow(). When that content exceeds the dimensions of the ScrollablePane then scrollbars appear to allow the use to view and interact with that hidden content.

==== Checkbox ====
A Checkbox widget controls a boolean value; true when checked and false when unchecked. This value can be obtained via isSelected() and specified via setSelected(true) to check or setSelected(false) to uncheck.

==== Spinner ====
A Spinner widget controls a numerical values (float) through an editbox or the use of the increment or decrement buttons.

This value is bounded within a minimum and a maximum by calling setMinimumValue() and setMaximumValue(). The arrow buttons increment or decrement the value by the amount specified with setStepSize(). The numerical value can be displayed in four formats: FloatingPoint, Integer, Hexadecimal, Octal.

The current value is obtained via getCurrentValue() and specified via setCurrentValue().

==== Editbox ====
An Editbox widget controls printable character values; letters, numbers, punctuations, and symbols.

The maximal number of characters that can be specified is bound by setMaxTextLength(). The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). The value can be masked via setTextMasked() and the default value of * can be modified via setMaskCodePoint().

The current value can be obtained via getText() and specified via setText().

==== Slider ====
A Slider widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setMaxValue(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setClickStep().

The current value can be obtained via getCurrentValue() and specified via setCurrentValue().

==== Scrollbar ====
A Scrollbar widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setDocumentSize(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setPageSize(). The arrow buttons increment or decrement the value by the amount specified with setStepSize().

The current value can be obtained via getScrollPosition() and specified via setScrollPosition(). Note that the actual maximum value that the scrollbar will return is set by the following formula: document_size - page_size. Thus, a document of size 100 and a page size of 10 will have a value from 0 to 90.

==== MultiLineEditbox ====
A MultiLineEditbox widget controls printable character values; letters, numbers, punctuations, and symbols.

Unlike the Editbox widget there is no maximal number of characters that can be specified. The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). Text can be automatically wrapped via a call to setWordWrapping(true).

The current value can be obtained via getText() and specified via setText().

==== RadioButton ====
A RadioButton widget controls a single selection among many choices.

The choices are grouped by calling setGroupID(). Only one RadioButton per group ID can be selected; this widget does not support multiple selection. However it is possible for a choice to possess no decision; initially every RadioButton of a group is unselected.

The currently selected RadioButton can be obtained via getSelectedButtonInGroup(). This RadioButton pointer can then be used to query the ID via getID(), the text (visible label of the RadioButton) via getText(), or user data via getUserData(). A RadioButton can be selected via setSelected(true). Passing false will deselect the RadioButton, potentially making every RadioButton of the group unselected.

==== Listbox ====
A Listbox widget controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setMultiselectEnabled().

The choices are listbox text items (ListboxTextItem) added to the listbox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage(). The call to ensureItemIsVisible() ensures that the item is visible; the listbox will automatically scroll down if necessary. The text of the ListboxTextItem can be changed via the setText() function. However this new text will not be displayed until you call the Listbox's handleUpdatedItemData() function.

The selected ListboxItem can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). A selection can be specified via setItemSelectState().

It is possible for a Listbox to contain list items that are not simply composed of text. [http://www.cegui.org.uk/wiki/index.php/Create_a_CheckListboxItem CheckListboxItem] demonstrates this advanced feature. Another approach would be to simulate the behavior of a listbox such that each row is composed of various widgets. [[PseudoListbox]] demonstrates this.

==== Combobox ====
A Combobox widget controls a single selection among many choices.

The choices are listbox text items (ListboxTextItem) added to the combobox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage().

The value of the text within the Editbox can be obtained via getText() and the last selected ListboxItem can be obtained via getSelectedItem(). However there is no guarantee that both are synchronized; typing text within the Editbox will not automatically select the corresponding ListboxItem. Fortunately the reverse is not true; selecting a ListboxItem will place that text within the Editbox. Placing the Editbox in read-only mode with setReadOnly(true) can avoid problems. The current value can be specified via listboxTextItem->setSelected(true) and a setText(itemCombobox->getText()).

==== MultiColumnList ====
A MultiColumnList widget controls controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setSelectionMode(MultiColumnList::RowMultiple).

A MultiColumnList widget may contain a single column or multiple columns. Columns are added via addColumn(), specifying a label, a column ID, and a column width.

Three steps are required to add a row. The first step is to add a new row with addRow(). The second step is to create a ListboxTextItem for each cell of the row and specify the selection indicator via setSelectionBrushImage(). The third step is to add the newly created ListboxTextItem to the MultiColumnList via setItem(), specifying the ListboxTextItem, the column ID, and the row ID.

The selected row can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). This will iterate through every selected cell, returning each selected ListboxTextItem . A selection can be specified via setItemSelectState(); by setting the selection mode to rows (either RowSingle or RowMultiple) you actually only need to select the ListboxTextItem of the first column.

==== TabControl ====
A TabControl widget allows multiple windows to be displayed one at a time, via tab buttons.

Two objects must be created within the Layout Editor to generate a functional tab control. The first is a window of type "TabControl". This will be the parent window of the tab buttons as well as the pages. The second is a window of type "DefaultWindow". This window will be placed within the TabControl (in code via addTab(), not through the Layout Editor) and will specify the contents of a page. Widgets are to be placed within these TabPane via the Layout Editor. The "TabButton" windows are not to be specified via the Layout Editor since they will be automatically created when a TabPane is added to the TabControl.

In this demo the TabControl widget was placed within a FrameWindow. This is not a requirement. It could have just easily been placed alongside the widgets of the other window.

==== Menu & Popup Menu ====

See [[http://www.cegui.org.uk/wiki/index.php/MenuAndPopup Menu & Popup Menu]]

=== Files ===

==== WidgetGalore.h ====
<code><cpp/>
#ifndef _WidgetGalore_h_
#define _WidgetGalore_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("WidgetGalore.layout");
sheet->addChildWindow(guiLayout);

/* Tooltip */
System::getSingleton().setDefaultTooltip("TaharezLook/Tooltip"); // Set the name of the default tooltip
Tooltip* tooltip = System::getSingleton().getDefaultTooltip();
tooltip->setHoverTime(0.5f); // Display the tooltip after the mouse has been hovering over the widget for half a second
tooltip->setDisplayTime(10.0f); // Display for 15 seconds then disappear
tooltip->setFadeTime(1.0f); // Duration of the transition between fully visible and fully invisible
// To set the tooltip text for a window simply call setTooltipText() see staticText for an example

/* StaticText */
DefaultWindow* staticText = static_cast<DefaultWindow*>(winMgr.getWindow("StaticText"));
staticText->setText("Red Static Text");
// Colors are specified as aarrggbb in Hexadecimal
// Where aa is alpha, rr is red, gg is green, and bb is blue
// tl: top left, tr: top right, bl: bottom left, br: bottom right
staticText->setProperty("TextColours", "tl:FFFF0000 tr:FFFF0000 bl:FFFF0000 br:FFFF0000");
staticText->setProperty("VertFormatting", "VertCentred"); // TopAligned, BottomAligned, VertCentred
staticText->setProperty("HorzFormatting", "HorzCentred"); // LeftAligned, RightAligned, HorzCentred
// HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified
staticText->setTooltipText("This is a StaticText widget");

/* StaticImage */
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForStaticImage", "GPN-2000-001437.tga");
DefaultWindow* staticImage = static_cast<DefaultWindow*>(winMgr.getWindow("StaticImage"));
staticImage->setProperty("Image", "set:ImageForStaticImage image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()

/* ProgressBar */
ProgressBar* progressBar = static_cast<ProgressBar*>(winMgr.getWindow("ProgressBar"));
progressBar->setProgress(0.25f); // Initial progress of 25%
progressBar->setStepSize(0.10f); // Calling step() will increase the progress by 10%
progressBar->step(); // Advance the progress by the size specified in setStepSize()
progressBar->adjustProgress(-0.05f); // Adjust the progress by a delta value rather than setting a new value through setProgress
float valueProgressBar = progressBar->getProgress(); // initial 0.25f + step 0.10f - adjustment 0.05f = 0.30f

/* Button */
PushButton* btnClose = static_cast<PushButton*>(winMgr.getWindow("btnClose"));
btnClose->setText("Exit");

/* ScrollablePane */
ScrollablePane* scrollablePane = static_cast<ScrollablePane*>(winMgr.getWindow("ScrollablePane"));
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForScrollablePane", "GPN-2000-001437.tga");
DefaultWindow* staticImageInScrollablePane = static_cast<DefaultWindow*>(winMgr.createWindow("TaharezLook/StaticImage", "StaticImageInScrollablePane"));
staticImageInScrollablePane->setProperty("Image", "set:ImageForScrollablePane image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()
staticImageInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Start in the upper left corner
staticImageInScrollablePane->setWidth(UDim(2.0f, 0.0f)); // Twice the width of the parent, the ScrollablePane
staticImageInScrollablePane->setHeight(UDim(2.0f, 0.0f)); // Twice the height of the parent, the ScrollablePane
scrollablePane->addChildWindow(staticImageInScrollablePane); // Add the image to the // Twice the width of the parent, the ScrollablePane
Editbox* editboxInScrollablePane = static_cast<Editbox*>(winMgr.createWindow("TaharezLook/Editbox", "EditboxInScrollablePane"));
editboxInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(2.1f, 0.0f))); // Start below the image
editboxInScrollablePane->setWidth(UDim(2.0f, 0.0f));
editboxInScrollablePane->setHeight(UDim(0.3f, 0.0f));
scrollablePane->addChildWindow(editboxInScrollablePane);

/* Check box */
Checkbox* checkbox = static_cast<Checkbox*>(winMgr.getWindow("Checkbox"));
checkbox->setSelected( true );
bool valueCheckbox = checkbox->isSelected(); // Retrieve whether it is checked

/* Spinner */
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));
spinner->setTextInputMode(Spinner::FloatingPoint); // FloatingPoint, Integer, Hexadecimal, Octal
spinner->setMinimumValue(-10.0f);
spinner->setMaximumValue(10.0f);
spinner->setStepSize(0.2f);
spinner->setCurrentValue(5.2f);
float valueSpinner = spinner->getCurrentValue(); // Retrieve the value

/* Editbox */
Editbox* editbox = static_cast<Editbox*>(winMgr.getWindow("Editbox"));
editbox->setText("Editbox values");
editbox->setMaxTextLength(13); // The trailing 's' will not be displayed
editbox->setReadOnly(false);
editbox->setTextMasked(false);
editbox->setMaskCodePoint(0x002A); // *
String valueEditbox = editbox->getText(); // Retrieve the text

/* Slider */
Slider* slider = static_cast<Slider*>(winMgr.getWindow("Slider"));
slider->setMaxValue(100.0f);
slider->setClickStep(10.0f);
slider->setCurrentValue(20.0f);
float valueSlider = slider->getCurrentValue(); // Retrieve the value

/* Scrollbar (Horizontal) */
Scrollbar* scrollbarHorizontal = static_cast<Scrollbar*>(winMgr.getWindow("HorizontalScrollbar"));
scrollbarHorizontal->setDocumentSize(100.0f);
scrollbarHorizontal->setPageSize(10.0f);
scrollbarHorizontal->setStepSize(1.0f);
scrollbarHorizontal->setScrollPosition(75.0f);
float valueScrollbarHorizontal = scrollbarHorizontal->getScrollPosition(); // Retrieve the scroll position

/* Scrollbar (Vertical) */
Scrollbar* scrollbarVertical = static_cast<Scrollbar*>(winMgr.getWindow("VerticalScrollbar"));
scrollbarVertical->setDocumentSize(100.0f);
scrollbarVertical->setPageSize(10.0f);
scrollbarVertical->setStepSize(1.0f);
scrollbarVertical->setScrollPosition(25.0f);
float valueScrollbarVertical = scrollbarVertical->getScrollPosition(); // Retrieve the scroll position

/* MultiLineEditbox */
MultiLineEditbox* multiLineEditbox = static_cast<MultiLineEditbox*>(winMgr.getWindow("MultiLineEditbox"));
multiLineEditbox->setText("MultiLineEditbox value");
multiLineEditbox->setReadOnly(false);
multiLineEditbox->setWordWrapping(true);
String valueMultiLineEditbox = multiLineEditbox->getText(); // Retrieve the text

/* RadioButton */
RadioButton* radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A"));
radioButton->setGroupID(1);
radioButton->setID(101);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_B"));
radioButton->setGroupID(1);
radioButton->setID(102);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_C"));
radioButton->setGroupID(1);
radioButton->setID(103);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_1"));
radioButton->setGroupID(2);
radioButton->setID(201);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_2"));
radioButton->setGroupID(2);
radioButton->setID(202);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3"));
radioButton->setGroupID(2);
radioButton->setID(203);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A")); // Get handle of one radio button from the group
uint valueRadioButtonLetters = radioButton->getSelectedButtonInGroup()->getID(); // Get selected ID
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3")); // Can obtain the handle of any radio button in the group
uint valueRadioButtonNumbers = radioButton->getSelectedButtonInGroup()->getID();
radioButton->setSelected(true); // Specify which button should appear selected by default

/* Listbox */
Listbox* listbox = static_cast<Listbox*>(winMgr.getWindow("Listbox"));
listbox->setMultiselectEnabled(false);
ListboxTextItem* itemListbox = new ListboxTextItem("Value A", 1);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value B", 2);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value C", 3);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value D", 4);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
listbox->setItemSelectState(itemListbox, true);
listbox->ensureItemIsVisible(itemListbox);
uint valueListbox = listbox->getFirstSelectedItem()->getID(); // Retrieve the ID of the selected listbox item

/* Combobox */
Combobox* combobox = static_cast<Combobox*>(winMgr.getWindow("Combobox"));
combobox->setReadOnly(true);
ListboxTextItem* itemCombobox = new ListboxTextItem("Value 1", 1);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 2", 2);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox->setSelected(true); // Select this item
combobox->setText(itemCombobox->getText()); // Copy the item's text into the Editbox
itemCombobox = new ListboxTextItem("Value 3", 3);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 4", 4);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
String valueCombobox = combobox->getText(); // Retrieve the displayed text
uint idCombobox = combobox->getSelectedItem()->getID(); // Retrieve the ID of the selected combobox item

/* MultiColumnList */
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("MultiColumnList"));\
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));
multiColumnList->setSelectionMode(MultiColumnList::RowSingle); // MultiColumnList::RowMultiple
ListboxTextItem* itemMultiColumnList;
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A1", 101);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B1", 102);
//itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
// By commenting the line above a cell does not specify a selection indicator
// selecting that line will show a "gap" in the selection.
multiColumnList->setItem(itemMultiColumnList, 1, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C1", 103);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 0); // ColumnID, RowID
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A2", 201);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B2", 202);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 1, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C2", 203);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 1); // ColumnID, RowID
MCLGridRef grid_ref(1, 0); // Select according to a grid reference; second row
multiColumnList->setItemSelectState(grid_ref, true);
ListboxItem* listboxItem = multiColumnList->getFirstSelectedItem();
uint valueColumnA = listboxItem->getID(); // Retrieve the value of the selected item from column A
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnB = listboxItem->getID(); // Retrieve the value of the selected item from column B
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnC = listboxItem->getID(); // Retrieve the value of the selected item from column C

/* TabControl */
TabControl* winTabControl = static_cast<TabControl*>(winMgr.getWindow("TabControl"));
winTabControl->setTabHeight(UDim(0.15f, 0.0f)); // Make the tab buttons a little bigger
Window* tabPage = winMgr.getWindow("TabPane1");
tabPage->setText("Page 1");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f))); // Size to 100% of its parent, the TabControl
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Move to the upper left corner of its parent
winTabControl->addTab(tabPage);
tabPage = winMgr.getWindow("TabPane2");
tabPage->setText("Page 2");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f)));
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f)));
winTabControl->addTab(tabPage);

}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}
};

#endif // _WidgetGalore_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "WidgetGalore.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== WidgetGalore.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="Text" >1</Property>
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="DefaultWindow" Name="TabPane2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.7185,0},{0.97875,0},{0.9685,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >In Page 2:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winTabControl" >
<Property Name="Text" >Tab Control Window</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.695627,0},{0.2725,0},{0.993122,0},{0.704167,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/TabControl" Name="TabControl" >
<Property Name="TabHeight" Value="{0,0}" />
<Property Name="TabTextPadding" Value="{0,0}" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.088566,0},{0.174378,0},{0.931404,0},{0.804637,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="btnOk" >
<Property Name="Text" >Ok</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.128412,0},{0.841464,0},{0.365583,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnCancel" >
<Property Name="Text" >Cancel</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.400429,0},{0.841464,0},{0.637601,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnApply" >
<Property Name="Text" >Apply</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.668224,0},{0.843977,0},{0.905394,0},{0.928516,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
</Window>
<Window Type="DefaultWindow" Name="TabPane1" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.012178,0},{0.97875,0},{0.262178,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage1" >
<Property Name="Text" >In Page 1:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage1" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winWidgets" >
<Property Name="Text" >Dave, it's full of widgets!</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00375,0},{0.143333,0},{0.751248,0},{0.806665,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="btnClose" >
<Property Name="Text" >Close</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.895137,0},{0.976465,0},{0.975697,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Editbox" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.62442,0},{0.090471,0},{0.969776,0},{0.153443,0}}" />
</Window>
<Window Type="TaharezLook/Checkbox" Name="Checkbox" >
<Property Name="Text" >Check</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.396859,0},{0.944201,0},{0.453147,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Combobox" >
<Property Name="Text" >Combo Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.090471,0},{0.613522,0},{0.413287,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_A" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >A</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.652856,0},{0.189876,0},{0.704964,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_B" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >B</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.707569,0},{0.189876,0},{0.759678,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_C" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >C</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.761542,0},{0.189876,0},{0.813651,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >1</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.189876,0},{0.897272,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >2</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.245152,0},{0.897272,0},{0.30144,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >3</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.300429,0},{0.897272,0},{0.356717,0}}" />
</Window>
<Window Type="TaharezLook/HorizontalScrollbar" Name="HorizontalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.185427,0},{0.613522,0},{0.26206,0}}" />
</Window>
<Window Type="TaharezLook/VerticalScrollbar" Name="VerticalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.026087,0},{0.090471,0},{0.082106,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Listbox" Name="Listbox" >
<Property Name="Text" >List Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.626634,0},{0.427903,0},{0.876634,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiColumnList" Name="MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.271357,0},{0.816779,0},{0.551507,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiLineEditbox" Name="MultiLineEditbox" >
<Property Name="Text" >
</Property>
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.626634,0},{0.706566,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/ProgressBar" Name="ProgressBar" >
<Property Name="StepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="CurrentProgress" Value="0" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.559296,0},{0.816779,0},{0.608291,0}}" />
</Window>
<Window Type="TaharezLook/Slider" Name="Slider" >
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="1" />
<Property Name="ClickStepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.099415,0},{0.090471,0},{0.155434,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="Spinner" >
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.48995,0},{0.944201,0},{0.551507,0}}" />
</Window>
<Window Type="TaharezLook/StaticImage" Name="StaticImage" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.626634,0},{0.976465,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="StaticText" >
<Property Name="Text" >Static Text</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.895137,0},{0.706566,0},{0.975697,0}}" />
</Window>
<Window Type="TaharezLook/ScrollablePane" Name="ScrollablePane" >
<Property Name="ContentArea" Value="l:0 t:0 r:0 b:0" />
<Property Name="HorzStepSize" Value="0.1" />
<Property Name="VertStepSize" Value="0.1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="HorzOverlapSize" Value="0.01" />
<Property Name="UnifiedAreaRect" Value="{{0.019063,0},{0.629399,0},{0.157023,0},{0.879399,0}}" />
<Property Name="VertOverlapSize" Value="0.01" />
<Property Name="HorzScrollPosition" Value="0" />
<Property Name="VertScrollPosition" Value="0" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

PseudoListbox

2008-02-19T16:41:16Z

Rackle:

This code emulates a multi-column listbox where each row is composed of different widgets. Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13620 Pseudo-Listbox]

=== Introduction ===
The .layout arranges three widgets in a row; a StaticText, an Editbox, and a Combobox. This "row" is then copied to result in 5 "rows". These are not real Listbox rows but they will appear to be. Next to these rows is a scrollbar, to navigate through the rows.

Just like a real Listbox the pseudo-listbox displays a subset of the data; there could be 10 data items to display but only 5 rows on the screen. This means that the scrollbar will be used to navigate through the data.

The Scrollbar is configured within two functions. The first is initRowCount() where the .layout is analyzed to figure out the number of rows contained within the pseudo-listbox. The page size is specified as the number of rows such that if rows 0 to 4 are displayed scrolling to the next page would display rows 5 to 9, 10 to 14, etc.

The line size is is specified as 1, to ensure that when the scrollbar is moved it does so by a whole unit, a whole row.

The number of rows could have been defined (hard-coded) in code. However the benefits of the current approach is that a GUI designer could change the appearance of the pseudo-listbox (size and position of the widgets) or change the number of rows and the program would still function (as long as the contents of each row remains the same).

The second Scrollbar configuration is within the initData() function, when the number of data item changes. The document size is specified as the number (count) of data items. This will let the Scrollbar properly move the contents by a line or by a page.

=== Files ===

==== PseudoListbox.h ====
<code><cpp/>
#ifndef _PseudoListbox_h_
#define _PseudoListbox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"
#include "CEGUIDefaultResourceProvider.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Load a layout and set the GUI Sheet
Window* guiLayout = winMgr.loadWindowLayout("PseudoListbox.layout");
Window* sheet = winMgr.getWindow("Root");
System::getSingleton().setGUISheet(sheet);
sheet->addChildWindow(guiLayout);

// Initialize the scrollbar events
Scrollbar* scrollbar = static_cast<Scrollbar*>(winMgr.getWindow("Root/PseudoList/Scrollbar"));
scrollbar->subscribeEvent(Scrollbar::EventScrollPositionChanged, Event::Subscriber(&DemoSample::Event_ScrollChange, this));

// Initialize the apply event
PushButton* apply = static_cast<PushButton*>(winMgr.getWindow("Root/Config/Apply"));
apply->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::Event_DataCountChange, this));

// Figure out how many rows have been defined within the .layout
// based on the specified prefix.
initRowCount("Root/PseudoList/LabelRow");

// Initialize the data based on the value provided by the .layout
// This code simulates a click on the apply button, which will then query
// the value specified of the Editbox within the .layout
CEGUI::EventArgs args;
apply->fireEvent(PushButton::EventClicked, args);
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

void initRowCount(const CEGUI::String& pPrefix)
{
// This function should only be called once, to initialize the
// rows that compose our pseudo-list.
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

mRowCount = 0;
while(winMgr.isWindowPresent(pPrefix + CEGUI::PropertyHelper::intToString(mRowCount)))
{
mRowCount++;
}

// Configure the scrollbar
Scrollbar* scrollbar = static_cast<Scrollbar*>(winMgr.getWindow("Root/PseudoList/Scrollbar"));
scrollbar->setPageSize(static_cast<float>(mRowCount)); // Scroll the entire set of rows
scrollbar->setStepSize(1.0f); // Scroll one row at a time
}

void initData(const int& pDataCount)
{
// This function should be called everytime the number of data changes
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
DataRow row;
CEGUI::String rowId;
mListData.clear();
for(int data = 0; data < pDataCount; data++)
{
rowId = CEGUI::PropertyHelper::intToString(data);
row.label = "Label #" + rowId;
row.text = "Text #" + rowId;
row.choice = "Choice #" + rowId;
mListData.push_back(row);
}

// Configure the scrollbar
Scrollbar* scrollbar = static_cast<Scrollbar*>(winMgr.getWindow("Root/PseudoList/Scrollbar"));
scrollbar->setDocumentSize(static_cast<float>(mListData.size())); // Specify the total number of rows
}

void showData(const int& pOffset)
{
// This function updates the contents of the displayed rows.
// The "trick" is that the scrollbar offset determines the
// first data being displayed.
using namespace CEGUI;
DefaultWindow* label;
Editbox* text;
Combobox* choice;
String rowId;
WindowManager& winMgr = WindowManager::getSingleton();

DataRow row;
for(int rowIndex = 0; rowIndex < mRowCount; rowIndex++)
{
if(rowIndex < static_cast<int>(mListData.size()))
{
// Display the offsetted data
row = mListData[rowIndex + pOffset];
}
else
{
// There is less data than can be displayed
// Could disable or hide some of the row widgets and hide the scrollbar.
row.label = "";
row.text = "";
row.choice = "";
}
rowId = CEGUI::PropertyHelper::intToString(rowIndex);
label = static_cast<DefaultWindow*>(winMgr.getWindow("Root/PseudoList/LabelRow" + rowId));
label->setText(row.label);

text = static_cast<Editbox*>(winMgr.getWindow("Root/PseudoList/TextRow" + rowId));
text->setText(row.text);

choice = static_cast<Combobox*>(winMgr.getWindow("Root/PseudoList/ChoiceRow" + rowId));
choice->setText(row.text);
}
}

bool Event_ScrollChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Scrollbar* scrollbar = static_cast<Scrollbar*>(winMgr.getWindow("Root/PseudoList/Scrollbar"));
int scrollOffset = static_cast<int>(scrollbar->getScrollPosition());
showData(scrollOffset);
return true;
}

bool Event_DataCountChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* dataRows = static_cast<Editbox*>(winMgr.getWindow("Root/Config/DataRows"));
int dataCount = PropertyHelper::stringToInt(dataRows->getText());
initData(dataCount);

Scrollbar* scrollbar = static_cast<Scrollbar*>(winMgr.getWindow("Root/PseudoList/Scrollbar"));
EventArgs scrollArgs;
scrollbar->fireEvent(Scrollbar::EventScrollPositionChanged, scrollArgs);

return true;
}

private:
// The number of rows defined within the .layout
int mRowCount;

struct DataRow
{
CEGUI::String label;
CEGUI::String text;
CEGUI::String choice;
};

typedef std::vector<DataRow> DataList;
DataList mListData;
};

#endif // _PseudoListbox_h_
</code>

==== PseudoListbox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="DefaultWindow" Name="Root/PseudoList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.01,0},{0.5,0},{0.391667,0}}" />
<Window Type="TaharezLook/VerticalScrollbar" Name="Root/PseudoList/Scrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.95,0},{0.01,0},{0.99,0},{0.99,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/PseudoList/LabelRow0" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.01,0},{0.25,0},{0.2,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/PseudoList/TextRow0" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.26,0},{0.01,0},{0.5,0},{0.2,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Root/PseudoList/ChoiceRow0" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.51,0},{0.01,0},{0.9,0},{0.2,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/PseudoList/LabelRow1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.21,0},{0.25,0},{0.4,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/PseudoList/TextRow1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.26,0},{0.21,0},{0.5,0},{0.4,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Root/PseudoList/ChoiceRow1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.51,0},{0.21,0},{0.9,0},{0.4,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/PseudoList/LabelRow2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.41,0},{0.25,0},{0.6,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/PseudoList/TextRow2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.26,0},{0.41,0},{0.5,0},{0.6,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Root/PseudoList/ChoiceRow2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.51,0},{0.41,0},{0.9,0},{0.6,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/PseudoList/LabelRow3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.61,0},{0.25,0},{0.8,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/PseudoList/TextRow3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.26,0},{0.61,0},{0.5,0},{0.8,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Root/PseudoList/ChoiceRow3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.51,0},{0.61,0},{0.9,0},{0.8,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/PseudoList/LabelRow4" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.81,0},{0.25,0},{0.99,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/PseudoList/TextRow4" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.26,0},{0.81,0},{0.5,0},{1,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Root/PseudoList/ChoiceRow4" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.51,0},{0.81,0},{0.9,0},{1,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="Root/Config" >
<Property Name="Text" Value="Configuration" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.6,0},{0.01,0},{0.9,0},{0.3,0}}" />
<Window Type="TaharezLook/StaticText" Name="Root/Config/Label" >
<Property Name="Text" Value="Data rows:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.03,0},{0.3,0},{0.4,0},{0.5,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Root/Config/DataRows" >
<Property Name="Text" Value="10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.4,0},{0.3,0},{0.95,0},{0.5,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="Root/Config/Apply" >
<Property Name="Text" Value="Apply" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.6,0},{0.7,0},{0.95,0},{0.9,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "PseudoListbox.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

Template:CEGUIWikiWhatsNew

2008-02-19T16:04:43Z

Rackle:

{{Section|1=The last 5 additions to the wiki ([http://www.cegui.org.uk/wiki/index.php?title=Template:CEGUIWikiWhatsNew&action=edit edit])|2=


* Code Snippets: [[PseudoListbox]] : Implement a multi-column listbox with any widgets
* Articles: [[All About RenderTargets]] : Info about CEGUI's RenderTarget development.
* Code Snippets: [[DynamicFont]] : Dynamically create fonts
* Articles: [[Introduction To Auto Windows]] : "Auto Windows" article by CrazyEddie
* Code Snippets: [[MovingAnyWindow]] : How to move any window, not just FrameWindow

 
''To all wiki author, please edit this section when you add a new page to the wiki.''
}}

Template:CEGUIWikiWhatsNew

2008-02-19T15:57:20Z

Rackle:

{{Section|1=The last 5 additions to the wiki ([http://www.cegui.org.uk/wiki/index.php?title=Template:CEGUIWikiWhatsNew&action=edit edit])|2=


* Code Snippets: [[PseudoList]] : Implement a multi-column listbox with any widgets
* Articles: [[All About RenderTargets]] : Info about CEGUI's RenderTarget development.
* Code Snippets: [[DynamicFont]] : Dynamically create fonts
* Articles: [[Introduction To Auto Windows]] : "Auto Windows" article by CrazyEddie
* Code Snippets: [[MovingAnyWindow]] : How to move any window, not just FrameWindow

 
''To all wiki author, please edit this section when you add a new page to the wiki.''
}}

Sample code for all Widgets

2008-02-12T20:10:08Z

Rackle: /* WidgetGalore.h */

This code goes through every widget and demonstrates how to retrieve and set their data as well as some of their particularities. Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=7967#7967 Widget Galore]

=== Widgets===

==== General ====
A widget can be enabled/disabled via setEnabled(). Disabling a widget prevents the user from activating it and manipulating its contents. A widget can be hidden/shown via setVisible().

==== Tooltip ====
A Tooltip widget displays text when the mouse has been hovering over a widget for a certain amount of time. This widget requires that time be injected within CEGUI via injectTimePulse().

The graphical aspect (the scheme) of the tooltip can be specified via setTooltip(). The amount of hovering time required to activate the tooltip can be specified via setHoverTime(). The amount of time the tooltip is displayed can be specified via setDisplayTime(). And the fade transition time can be specified via setFadeTime(); this affects both the fade in and the fade out times. The tooltip text of a widget can be specified via setTooltipText(). Please note that some complex widgets are composed of several widgets. In order to have a tooltip text displayed while hovering over any region of the complex widget then every component widget needs to have a tooltip text specified. For example a Spinner widget is composed of an Editbox widget and two Button widgets.

==== StaticText ====
There is no StaticText within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed text can be specified via setText(). The color of this text can be specified via the "TextColours" property. The value of this property contains 4 color definitions: top left, top right, bottom left, and bottom right. Each color is specified as a two-digit hexadecimal value of the format AARRGGBB (alpha, red, green, blue). The text is aligned vertically via the "VertFormatting" property with a value of TopAligned, BottomAligned, or VertCentred. The text is aligned horizontally via the "HorzFormatting" property with a value of LeftAligned, RightAligned, HorzCentred, HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, or WordWrapJustified.

==== StaticImage ====
There is no StaticImage within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed image can be specified via the "Image" property. This property takes two parameters, the imageset ("set") and the image name ("image").

==== ProgressBar ====
A ProgressBar widget displays a progression; it does not receive inputs from a user.

The current progress can be specified via setProgress(). Progress can be advanced through steps. The step size can be specified via setStepSize() and a step performed via step(). Progress can be adjusted by a delta value via adjustProgress(). The current progress value can be obtained via getProgress().

==== Button ====
A Button widget displays a text and receives an activation instruction from the user.

The text can be specified via setText().

==== ScrollablePane ====
A ScrollablePane widget displays contents that can be scrolled. Contents can be added via addChildWindow(). When that content exceeds the dimensions of the ScrollablePane then scrollbars appear to allow the use to view and interact with that hidden content.

==== Checkbox ====
A Checkbox widget controls a boolean value; true when checked and false when unchecked. This value can be obtained via isSelected() and specified via setSelected(true) to check or setSelected(false) to uncheck.

==== Spinner ====
A Spinner widget controls a numerical values (float) through an editbox or the use of the increment or decrement buttons.

This value is bounded within a minimum and a maximum by calling setMinimumValue() and setMaximumValue(). The arrow buttons increment or decrement the value by the amount specified with setStepSize(). The numerical value can be displayed in four formats: FloatingPoint, Integer, Hexadecimal, Octal.

The current value is obtained via getCurrentValue() and specified via setCurrentValue().

==== Editbox ====
An Editbox widget controls printable character values; letters, numbers, punctuations, and symbols.

The maximal number of characters that can be specified is bound by setMaxTextLength(). The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). The value can be masked via setTextMasked() and the default value of * can be modified via setMaskCodePoint().

The current value can be obtained via getText() and specified via setText().

==== Slider ====
A Slider widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setMaxValue(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setClickStep().

The current value can be obtained via getCurrentValue() and specified via setCurrentValue().

==== Scrollbar ====
A Scrollbar widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setDocumentSize(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setPageSize(). The arrow buttons increment or decrement the value by the amount specified with setStepSize().

The current value can be obtained via getScrollPosition() and specified via setScrollPosition(). Note that the actual maximum value that the scrollbar will return is set by the following formula: document_size - page_size. Thus, a document of size 100 and a page size of 10 will have a value from 0 to 90.

==== MultiLineEditbox ====
A MultiLineEditbox widget controls printable character values; letters, numbers, punctuations, and symbols.

Unlike the Editbox widget there is no maximal number of characters that can be specified. The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). Text can be automatically wrapped via a call to setWordWrapping(true).

The current value can be obtained via getText() and specified via setText().

==== RadioButton ====
A RadioButton widget controls a single selection among many choices.

The choices are grouped by calling setGroupID(). Only one RadioButton per group ID can be selected; this widget does not support multiple selection. However it is possible for a choice to possess no decision; initially every RadioButton of a group is unselected.

The currently selected RadioButton can be obtained via getSelectedButtonInGroup(). This RadioButton pointer can then be used to query the ID via getID(), the text (visible label of the RadioButton) via getText(), or user data via getUserData(). A RadioButton can be selected via setSelected(true). Passing false will deselect the RadioButton, potentially making every RadioButton of the group unselected.

==== Listbox ====
A Listbox widget controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setMultiselectEnabled().

The choices are listbox text items (ListboxTextItem) added to the listbox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage(). The call to ensureItemIsVisible() ensures that the item is visible; the listbox will automatically scroll down if necessary. The text of the ListboxTextItem can be changed via the setText() function. However this new text will not be displayed until you call the Listbox's handleUpdatedItemData() function.

The selected ListboxItem can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). A selection can be specified via setItemSelectState().

It is possible for a Listbox to contain list items that are not simply composed of text. [http://www.cegui.org.uk/wiki/index.php/Create_a_CheckListboxItem CheckListboxItem] demonstrates this advanced feature.

==== Combobox ====
A Combobox widget controls a single selection among many choices.

The choices are listbox text items (ListboxTextItem) added to the combobox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage().

The value of the text within the Editbox can be obtained via getText() and the last selected ListboxItem can be obtained via getSelectedItem(). However there is no guarantee that both are synchronized; typing text within the Editbox will not automatically select the corresponding ListboxItem. Fortunately the reverse is not true; selecting a ListboxItem will place that text within the Editbox. Placing the Editbox in read-only mode with setReadOnly(true) can avoid problems. The current value can be specified via listboxTextItem->setSelected(true) and a setText(itemCombobox->getText()).

==== MultiColumnList ====
A MultiColumnList widget controls controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setSelectionMode(MultiColumnList::RowMultiple).

A MultiColumnList widget may contain a single column or multiple columns. Columns are added via addColumn(), specifying a label, a column ID, and a column width.

Three steps are required to add a row. The first step is to add a new row with addRow(). The second step is to create a ListboxTextItem for each cell of the row and specify the selection indicator via setSelectionBrushImage(). The third step is to add the newly created ListboxTextItem to the MultiColumnList via setItem(), specifying the ListboxTextItem, the column ID, and the row ID.

The selected row can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). This will iterate through every selected cell, returning each selected ListboxTextItem . A selection can be specified via setItemSelectState(); by setting the selection mode to rows (either RowSingle or RowMultiple) you actually only need to select the ListboxTextItem of the first column.

==== TabControl ====
A TabControl widget allows multiple windows to be displayed one at a time, via tab buttons.

Two objects must be created within the Layout Editor to generate a functional tab control. The first is a window of type "TabControl". This will be the parent window of the tab buttons as well as the pages. The second is a window of type "DefaultWindow". This window will be placed within the TabControl (in code via addTab(), not through the Layout Editor) and will specify the contents of a page. Widgets are to be placed within these TabPane via the Layout Editor. The "TabButton" windows are not to be specified via the Layout Editor since they will be automatically created when a TabPane is added to the TabControl.

In this demo the TabControl widget was placed within a FrameWindow. This is not a requirement. It could have just easily been placed alongside the widgets of the other window.

==== Menu & Popup Menu ====

See [[http://www.cegui.org.uk/wiki/index.php/MenuAndPopup Menu & Popup Menu]]

=== Files ===

==== WidgetGalore.h ====
<code><cpp/>
#ifndef _WidgetGalore_h_
#define _WidgetGalore_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("WidgetGalore.layout");
sheet->addChildWindow(guiLayout);

/* Tooltip */
System::getSingleton().setDefaultTooltip("TaharezLook/Tooltip"); // Set the name of the default tooltip
Tooltip* tooltip = System::getSingleton().getDefaultTooltip();
tooltip->setHoverTime(0.5f); // Display the tooltip after the mouse has been hovering over the widget for half a second
tooltip->setDisplayTime(10.0f); // Display for 15 seconds then disappear
tooltip->setFadeTime(1.0f); // Duration of the transition between fully visible and fully invisible
// To set the tooltip text for a window simply call setTooltipText() see staticText for an example

/* StaticText */
DefaultWindow* staticText = static_cast<DefaultWindow*>(winMgr.getWindow("StaticText"));
staticText->setText("Red Static Text");
// Colors are specified as aarrggbb in Hexadecimal
// Where aa is alpha, rr is red, gg is green, and bb is blue
// tl: top left, tr: top right, bl: bottom left, br: bottom right
staticText->setProperty("TextColours", "tl:FFFF0000 tr:FFFF0000 bl:FFFF0000 br:FFFF0000");
staticText->setProperty("VertFormatting", "VertCentred"); // TopAligned, BottomAligned, VertCentred
staticText->setProperty("HorzFormatting", "HorzCentred"); // LeftAligned, RightAligned, HorzCentred
// HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified
staticText->setTooltipText("This is a StaticText widget");

/* StaticImage */
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForStaticImage", "GPN-2000-001437.tga");
DefaultWindow* staticImage = static_cast<DefaultWindow*>(winMgr.getWindow("StaticImage"));
staticImage->setProperty("Image", "set:ImageForStaticImage image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()

/* ProgressBar */
ProgressBar* progressBar = static_cast<ProgressBar*>(winMgr.getWindow("ProgressBar"));
progressBar->setProgress(0.25f); // Initial progress of 25%
progressBar->setStepSize(0.10f); // Calling step() will increase the progress by 10%
progressBar->step(); // Advance the progress by the size specified in setStepSize()
progressBar->adjustProgress(-0.05f); // Adjust the progress by a delta value rather than setting a new value through setProgress
float valueProgressBar = progressBar->getProgress(); // initial 0.25f + step 0.10f - adjustment 0.05f = 0.30f

/* Button */
PushButton* btnClose = static_cast<PushButton*>(winMgr.getWindow("btnClose"));
btnClose->setText("Exit");

/* ScrollablePane */
ScrollablePane* scrollablePane = static_cast<ScrollablePane*>(winMgr.getWindow("ScrollablePane"));
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForScrollablePane", "GPN-2000-001437.tga");
DefaultWindow* staticImageInScrollablePane = static_cast<DefaultWindow*>(winMgr.createWindow("TaharezLook/StaticImage", "StaticImageInScrollablePane"));
staticImageInScrollablePane->setProperty("Image", "set:ImageForScrollablePane image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()
staticImageInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Start in the upper left corner
staticImageInScrollablePane->setWidth(UDim(2.0f, 0.0f)); // Twice the width of the parent, the ScrollablePane
staticImageInScrollablePane->setHeight(UDim(2.0f, 0.0f)); // Twice the height of the parent, the ScrollablePane
scrollablePane->addChildWindow(staticImageInScrollablePane); // Add the image to the // Twice the width of the parent, the ScrollablePane
Editbox* editboxInScrollablePane = static_cast<Editbox*>(winMgr.createWindow("TaharezLook/Editbox", "EditboxInScrollablePane"));
editboxInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(2.1f, 0.0f))); // Start below the image
editboxInScrollablePane->setWidth(UDim(2.0f, 0.0f));
editboxInScrollablePane->setHeight(UDim(0.3f, 0.0f));
scrollablePane->addChildWindow(editboxInScrollablePane);

/* Check box */
Checkbox* checkbox = static_cast<Checkbox*>(winMgr.getWindow("Checkbox"));
checkbox->setSelected( true );
bool valueCheckbox = checkbox->isSelected(); // Retrieve whether it is checked

/* Spinner */
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));
spinner->setTextInputMode(Spinner::FloatingPoint); // FloatingPoint, Integer, Hexadecimal, Octal
spinner->setMinimumValue(-10.0f);
spinner->setMaximumValue(10.0f);
spinner->setStepSize(0.2f);
spinner->setCurrentValue(5.2f);
float valueSpinner = spinner->getCurrentValue(); // Retrieve the value

/* Editbox */
Editbox* editbox = static_cast<Editbox*>(winMgr.getWindow("Editbox"));
editbox->setText("Editbox values");
editbox->setMaxTextLength(13); // The trailing 's' will not be displayed
editbox->setReadOnly(false);
editbox->setTextMasked(false);
editbox->setMaskCodePoint(0x002A); // *
String valueEditbox = editbox->getText(); // Retrieve the text

/* Slider */
Slider* slider = static_cast<Slider*>(winMgr.getWindow("Slider"));
slider->setMaxValue(100.0f);
slider->setClickStep(10.0f);
slider->setCurrentValue(20.0f);
float valueSlider = slider->getCurrentValue(); // Retrieve the value

/* Scrollbar (Horizontal) */
Scrollbar* scrollbarHorizontal = static_cast<Scrollbar*>(winMgr.getWindow("HorizontalScrollbar"));
scrollbarHorizontal->setDocumentSize(100.0f);
scrollbarHorizontal->setPageSize(10.0f);
scrollbarHorizontal->setStepSize(1.0f);
scrollbarHorizontal->setScrollPosition(75.0f);
float valueScrollbarHorizontal = scrollbarHorizontal->getScrollPosition(); // Retrieve the scroll position

/* Scrollbar (Vertical) */
Scrollbar* scrollbarVertical = static_cast<Scrollbar*>(winMgr.getWindow("VerticalScrollbar"));
scrollbarVertical->setDocumentSize(100.0f);
scrollbarVertical->setPageSize(10.0f);
scrollbarVertical->setStepSize(1.0f);
scrollbarVertical->setScrollPosition(25.0f);
float valueScrollbarVertical = scrollbarVertical->getScrollPosition(); // Retrieve the scroll position

/* MultiLineEditbox */
MultiLineEditbox* multiLineEditbox = static_cast<MultiLineEditbox*>(winMgr.getWindow("MultiLineEditbox"));
multiLineEditbox->setText("MultiLineEditbox value");
multiLineEditbox->setReadOnly(false);
multiLineEditbox->setWordWrapping(true);
String valueMultiLineEditbox = multiLineEditbox->getText(); // Retrieve the text

/* RadioButton */
RadioButton* radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A"));
radioButton->setGroupID(1);
radioButton->setID(101);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_B"));
radioButton->setGroupID(1);
radioButton->setID(102);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_C"));
radioButton->setGroupID(1);
radioButton->setID(103);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_1"));
radioButton->setGroupID(2);
radioButton->setID(201);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_2"));
radioButton->setGroupID(2);
radioButton->setID(202);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3"));
radioButton->setGroupID(2);
radioButton->setID(203);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A")); // Get handle of one radio button from the group
uint valueRadioButtonLetters = radioButton->getSelectedButtonInGroup()->getID(); // Get selected ID
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3")); // Can obtain the handle of any radio button in the group
uint valueRadioButtonNumbers = radioButton->getSelectedButtonInGroup()->getID();
radioButton->setSelected(true); // Specify which button should appear selected by default

/* Listbox */
Listbox* listbox = static_cast<Listbox*>(winMgr.getWindow("Listbox"));
listbox->setMultiselectEnabled(false);
ListboxTextItem* itemListbox = new ListboxTextItem("Value A", 1);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value B", 2);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value C", 3);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value D", 4);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
listbox->setItemSelectState(itemListbox, true);
listbox->ensureItemIsVisible(itemListbox);
uint valueListbox = listbox->getFirstSelectedItem()->getID(); // Retrieve the ID of the selected listbox item

/* Combobox */
Combobox* combobox = static_cast<Combobox*>(winMgr.getWindow("Combobox"));
combobox->setReadOnly(true);
ListboxTextItem* itemCombobox = new ListboxTextItem("Value 1", 1);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 2", 2);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox->setSelected(true); // Select this item
combobox->setText(itemCombobox->getText()); // Copy the item's text into the Editbox
itemCombobox = new ListboxTextItem("Value 3", 3);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 4", 4);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
String valueCombobox = combobox->getText(); // Retrieve the displayed text
uint idCombobox = combobox->getSelectedItem()->getID(); // Retrieve the ID of the selected combobox item

/* MultiColumnList */
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("MultiColumnList"));\
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));
multiColumnList->setSelectionMode(MultiColumnList::RowSingle); // MultiColumnList::RowMultiple
ListboxTextItem* itemMultiColumnList;
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A1", 101);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B1", 102);
//itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
// By commenting the line above a cell does not specify a selection indicator
// selecting that line will show a "gap" in the selection.
multiColumnList->setItem(itemMultiColumnList, 1, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C1", 103);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 0); // ColumnID, RowID
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A2", 201);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B2", 202);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 1, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C2", 203);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 1); // ColumnID, RowID
MCLGridRef grid_ref(1, 0); // Select according to a grid reference; second row
multiColumnList->setItemSelectState(grid_ref, true);
ListboxItem* listboxItem = multiColumnList->getFirstSelectedItem();
uint valueColumnA = listboxItem->getID(); // Retrieve the value of the selected item from column A
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnB = listboxItem->getID(); // Retrieve the value of the selected item from column B
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnC = listboxItem->getID(); // Retrieve the value of the selected item from column C

/* TabControl */
TabControl* winTabControl = static_cast<TabControl*>(winMgr.getWindow("TabControl"));
winTabControl->setTabHeight(UDim(0.15f, 0.0f)); // Make the tab buttons a little bigger
Window* tabPage = winMgr.getWindow("TabPane1");
tabPage->setText("Page 1");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f))); // Size to 100% of its parent, the TabControl
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Move to the upper left corner of its parent
winTabControl->addTab(tabPage);
tabPage = winMgr.getWindow("TabPane2");
tabPage->setText("Page 2");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f)));
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f)));
winTabControl->addTab(tabPage);

}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}
};

#endif // _WidgetGalore_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "WidgetGalore.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== WidgetGalore.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="Text" >1</Property>
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="DefaultWindow" Name="TabPane2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.7185,0},{0.97875,0},{0.9685,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >In Page 2:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winTabControl" >
<Property Name="Text" >Tab Control Window</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.695627,0},{0.2725,0},{0.993122,0},{0.704167,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/TabControl" Name="TabControl" >
<Property Name="TabHeight" Value="{0,0}" />
<Property Name="TabTextPadding" Value="{0,0}" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.088566,0},{0.174378,0},{0.931404,0},{0.804637,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="btnOk" >
<Property Name="Text" >Ok</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.128412,0},{0.841464,0},{0.365583,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnCancel" >
<Property Name="Text" >Cancel</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.400429,0},{0.841464,0},{0.637601,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnApply" >
<Property Name="Text" >Apply</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.668224,0},{0.843977,0},{0.905394,0},{0.928516,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
</Window>
<Window Type="DefaultWindow" Name="TabPane1" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.012178,0},{0.97875,0},{0.262178,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage1" >
<Property Name="Text" >In Page 1:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage1" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winWidgets" >
<Property Name="Text" >Dave, it's full of widgets!</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00375,0},{0.143333,0},{0.751248,0},{0.806665,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="btnClose" >
<Property Name="Text" >Close</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.895137,0},{0.976465,0},{0.975697,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Editbox" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.62442,0},{0.090471,0},{0.969776,0},{0.153443,0}}" />
</Window>
<Window Type="TaharezLook/Checkbox" Name="Checkbox" >
<Property Name="Text" >Check</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.396859,0},{0.944201,0},{0.453147,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Combobox" >
<Property Name="Text" >Combo Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.090471,0},{0.613522,0},{0.413287,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_A" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >A</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.652856,0},{0.189876,0},{0.704964,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_B" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >B</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.707569,0},{0.189876,0},{0.759678,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_C" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >C</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.761542,0},{0.189876,0},{0.813651,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >1</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.189876,0},{0.897272,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >2</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.245152,0},{0.897272,0},{0.30144,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >3</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.300429,0},{0.897272,0},{0.356717,0}}" />
</Window>
<Window Type="TaharezLook/HorizontalScrollbar" Name="HorizontalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.185427,0},{0.613522,0},{0.26206,0}}" />
</Window>
<Window Type="TaharezLook/VerticalScrollbar" Name="VerticalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.026087,0},{0.090471,0},{0.082106,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Listbox" Name="Listbox" >
<Property Name="Text" >List Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.626634,0},{0.427903,0},{0.876634,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiColumnList" Name="MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.271357,0},{0.816779,0},{0.551507,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiLineEditbox" Name="MultiLineEditbox" >
<Property Name="Text" >
</Property>
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.626634,0},{0.706566,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/ProgressBar" Name="ProgressBar" >
<Property Name="StepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="CurrentProgress" Value="0" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.559296,0},{0.816779,0},{0.608291,0}}" />
</Window>
<Window Type="TaharezLook/Slider" Name="Slider" >
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="1" />
<Property Name="ClickStepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.099415,0},{0.090471,0},{0.155434,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="Spinner" >
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.48995,0},{0.944201,0},{0.551507,0}}" />
</Window>
<Window Type="TaharezLook/StaticImage" Name="StaticImage" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.626634,0},{0.976465,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="StaticText" >
<Property Name="Text" >Static Text</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.895137,0},{0.706566,0},{0.975697,0}}" />
</Window>
<Window Type="TaharezLook/ScrollablePane" Name="ScrollablePane" >
<Property Name="ContentArea" Value="l:0 t:0 r:0 b:0" />
<Property Name="HorzStepSize" Value="0.1" />
<Property Name="VertStepSize" Value="0.1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="HorzOverlapSize" Value="0.01" />
<Property Name="UnifiedAreaRect" Value="{{0.019063,0},{0.629399,0},{0.157023,0},{0.879399,0}}" />
<Property Name="VertOverlapSize" Value="0.01" />
<Property Name="HorzScrollPosition" Value="0" />
<Property Name="VertScrollPosition" Value="0" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Menu and Popup

2008-02-06T16:53:11Z

Rackle: /* Introduction */

=== Introduction ===
This code demonstrates the usage of a menu as well as popup menus, created from the Layout Editor.

Please discuss this snippet within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=11724 Menu and Submenus] thread.

This [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13433#13433 message board post] demonstrates the creation of a menu via code rather than loaded from a .layout file.

==== Menu ====
The Menubar widget creates a menu bar, an horizontal bar containing top-level popup menus. Traditionally menu bars are displayed just below the title bar however the Cegui menubar is not bound by this limitation; it could be placed at the bottom of a FrameWindow, or even outside of a FrameWindow.

The configureMenu() function recursively traverses a menu hierarchy and registers three events: EventMouseEnters, EventMouseLeaves, and EventClicked.

The most important event triggered by a menu is the selection of a menu item. This is accomplished by subscribing to the MenuItem::EventClicked event. This code is within the onMenuItemClicked() function.

Another noteworthy event is PopupMenu::EventPopupOpened, allowing you to modify the menuitems that are displayed, such as potentially (not presented here) enabling/disabling items or changing the displayed text. This is an approach to have menus query the application to determin the state of the menu items that will be presented to the user; for example disabling a "paste" menuitem when there is nothing to paste.

The demo subscribes to the MenuItem::EventMouseEnters event for two features. The first is to display a message when the mouse hovers over a menuitem. The text displayed is stored within the Tooltip property within the Layout Editor. The second is to automatically open a submenu. This code is within the onMouseEntersMenuItem() function.

The code to automatically close a menu (when the mouse leaves) is within the onMouseLeavesMenuItem() and onMouseLeavesPopupMenuItem() functions, called in response to a MenuItem::EventMouseLeaves event.

By subscribing to the Window::EventCharacterKey event it becomes possible to open the menu in response to a special key. The ALT key will not work in windowed mode (as opposed to fullscreen), since it is a system key. Try pressing ALT followed by SPACE; the system menu will open (the menu in the upper left corner of a Windows window). I've used the SLASH "/" key as an alternate. Note that for the slash key to open the menu the FrameWindow must possess the focus.

==== Popup Menu ====

Since the Layout Editor does not allow us to create popup menus directly, I opted to reuse the menubar. Traditionally a menu bar contains horizontal categories and within each category are sub-categories. Since an application may contain numerous popup menus we would rapidly run out of space. A better approach is to have a menu bar with a single top-level menu and popup menus defined as its sub-menus.

For example:
* Popup Menubar
** Popup Menu 1
*** Item 1.1
*** Item 1.2
** Popup Menu 2
*** Item 2.1
*** Item 2.2

Should you run out of room vertically then a second top-level menu could be created.

The configureMenu() is called for each popup menu, to automatically open and close their submenus. The Window::EventMouseButtonUp event is used to open the proper popup menu, based on which widget was right-clicked. This code is within the onPopupMenu() function.

The mouse cursor is traditionally displayed to the left of the popup menu. The problem with that is that the cursor hides the first menu item. The value of the mouseToLeftOfPopupMenu variable determines whether the traditional position is used or whether the popup menu is opened such that the mouse cursor appears to the right. The mouseOffset variable specifies the mouse offset from the upper-left or the upper-right corner. In addition the popup menu is moved to prevent it from opening offscreen.

To add menuitems runtime to a popupMenu you add a CEGUI::Window childWindow to the popupMenu. You don't create a new CEGUI::MenuItem as you might think:

<code><cpp/>
CEGUI::PopupMenu* popupMenu = (CEGUI::PopupMenu*)CEGUI::WindowManager::getSingleton().getWindow("Root/Popup/PopupMenus/FirstPopup/AutoPopup");
CEGUI::Window* menuitem = CEGUI::WindowManager::getSingleton().createWindow("TaharezLook/MenuItem");
menuitem->setText("Quit");
menuitem->subscribeEvent("Clicked", Event::Subscriber(&ScrollablePaneSample::fileQuit, this));
popupMenu->addChildWindow(menuitem);
</code>

==== Wishlist ====

These feature are not implemented but would be nice to have:

* A delay before automatically opening/closing a submenu.
* Closing the entire submenu tree when a parent submenu is closed. This way the next time the submenu is opened its children are in their default mode (i.e. closed).
* Displaying accelerator/shortcut keys to the right of the menuitems.
* Keyboard navigation through the menus (up, down, left, right). This requires access to the CeguiMenuItem::d_hover variable, which (I think) draws the menuitem as highlighted.
* Graphical menuitems
* Support for a separtor (horizontal line) menuitem.
* Support for a checkbox menuitem, to activate a feature
* Support for a radiobutton-like group of menuitems, to activate one feature among multiple choices.

=== Files ===
==== Menu_Demo.h ====
<code><cpp/>
#ifndef _Menu_h_
#define _Menu_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIDefaultResourceProvider.h"

//-------------------------------------------------------------------
// Offset to ensure that the mouse cursor will be within the popup menu
// This will automatically close the popup menu whe the mouse is moved;
// without the offset the mouse is not really within the popup menu.
const float mouseOffset = 5.0f;

//-------------------------------------------------------------------
// Specifies whether the popup menu will open to the right (default) or
// to the left of the mouse. Opening to the left gives better results
// with the Taharez scheme since the mouse cursor is not covering the
// menu item.
const bool mouseToLeftOfPopupMenu = false;

//-------------------------------------------------------------------
class DemoSample : public CEGuiSample
{
public:
//-------------------------------------------------------------------
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("Menu.layout");
sheet->addChildWindow(guiLayout);

// Subscribe to the keyboard events to control the menu
winMgr.getWindow("Root/FrameWindow")->subscribeEvent(CEGUI::Window::EventCharacterKey, CEGUI::Event::Subscriber(&DemoSample::onMenuKey, this));

// Configure the menu bar
configureMenu( winMgr.getWindow("Root/FrameWindow/Menubar"), true );

// Hide the menubar of the popup menus
winMgr.getWindow("Root/Popup")->hide();

// Configure the popup menus
configureMenu( winMgr.getWindow("Root/Popup/PopupMenus"), false );

// These "widgets" will display a contextual popup menu when right-clicked
winMgr.getWindow("Root/FrameWindow/FirstPopup")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root/FrameWindow/SecondPopup")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root/FrameWindow")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

//-------------------------------------------------------------------
void cleanupSample(void)
{
}

//-------------------------------------------------------------------
void configureMenu(CEGUI::Window* pParent, const bool& pMenubar)
{
// Recursively subscribe every menu item to the mouse enters/leaves/clicked events
size_t childCount = pParent->getChildCount();
for(size_t childIdx = 0; childIdx < childCount; childIdx++)
{
if(pParent->getChildAtIdx(childIdx)->testClassName("MenuItem")
|| pParent->getChildAtIdx(childIdx)->testClassName("PopupMenu") )
{
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventMouseEnters, CEGUI::Event::Subscriber(&DemoSample::onMouseEntersMenuItem, this));
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventMouseLeaves, pMenubar ? CEGUI::Event::Subscriber(&DemoSample::onMouseLeavesMenuItem, this)
: CEGUI::Event::Subscriber(&DemoSample::onMouseLeavesPopupMenuItem, this));
if(pParent->getChildAtIdx(childIdx)->testClassName("MenuItem"))
{
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventClicked, CEGUI::Event::Subscriber(&DemoSample::onMenuItemClicked, this));
}
}
configureMenu(pParent->getChildAtIdx(childIdx), pMenubar);
}
}

//-------------------------------------------------------------------
bool onMouseEntersMenuItem(const CEGUI::EventArgs& e)
{
// Open or close a submenu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
CEGUI::MenuItem* menuItem = static_cast<CEGUI::MenuItem*>(we.window);
if(menuItem)
{
setStatusText( menuItem->getTooltipText() );
if( menuItem->getPopupMenu() )
{
if( menuItem->isOpened() )
{
if(menuItem->testClassName("MenuItem"))
{
menuItem->closePopupMenu();
}
}
else
{
menuItem->openPopupMenu();
}
}
}
else
{
setStatusText( "" );
}
return true;
}

//-------------------------------------------------------------------
bool onMouseLeavesMenuItem(const CEGUI::EventArgs& e)
{
// Close a menu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "" );

CEGUI::Window* menubar = we.window;
while(menubar)
{
if( menubar->testClassName("Menubar") )
{
// We found the root; a menu bar
CEGUI::Vector2 childPosition = CEGUI::MouseCursor::getSingleton().getPosition();
CEGUI::Window* windowUnderTheCursor = menubar->getTargetChildAtPosition(childPosition);
if(!windowUnderTheCursor)
{
CEGUI::MenuItem* popupMenu = static_cast<CEGUI::Menubar*>(menubar)->getPopupMenuItem();
if(popupMenu)
{
// This does not close sub-popup menus, only the current one
popupMenu->closePopupMenu();
}
}
break;
}
menubar = menubar->getParent();
}

return true;
}

//-------------------------------------------------------------------
bool onMouseLeavesPopupMenuItem(const CEGUI::EventArgs& e)
{
// Close a popup menu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "" );

CEGUI::Window* menubar = we.window;
CEGUI::Window* popupParent;
while(menubar)
{
popupParent = menubar->getParent();
if( popupParent
&& !popupParent->testClassName("Menubar")
&& !popupParent->testClassName("PopupMenu")
&& !popupParent->testClassName("MenuItem")
)
{
// We found the root; a popup menu
CEGUI::Window* popupMenu = menubar;
menubar = menubar->getParent();
CEGUI::Vector2 childPosition = CEGUI::MouseCursor::getSingleton().getPosition();
CEGUI::Window* windowUnderTheCursor = menubar->getTargetChildAtPosition(childPosition);
if(!windowUnderTheCursor)
{
popupMenu->hide();
}
break;
}
menubar = menubar->getParent();
}

return true;
}

//-------------------------------------------------------------------
bool onMenuItemClicked(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "Clicked " + we.window->getName() );
return true;
}

//-------------------------------------------------------------------
bool onMenuKey(const CEGUI::EventArgs& e)
{
// Open or close a menu
const CEGUI::KeyEventArgs& ke = static_cast<const CEGUI::KeyEventArgs&>(e);
if(ke.sysKeys == CEGUI::Key::LeftAlt
|| ke.sysKeys == CEGUI::Key::RightAlt
|| ke.sysKeys == CEGUI::Key::Slash
|| ke.codepoint == 47) // Slash
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
CEGUI::Menubar* menuBar = static_cast<CEGUI::Menubar*>(winMgr.getWindow("Root/FrameWindow/Menubar"));
CEGUI::MenuItem* menuItem = menuBar->getPopupMenuItem();
if(menuItem)
{
// There's a menu opened, let's close it
menuBar->changePopupMenuItem(0);
}
else
{
// The menu is closed, let's open the first menu
menuItem = static_cast<CEGUI::MenuItem*>(winMgr.getWindow("Root/FrameWindow/Menubar/File"));
menuBar->changePopupMenuItem(menuItem);

// Select the first item from this menu ??
}
}

return true;
}

//-------------------------------------------------------------------
bool onPopupMenu(const CEGUI::EventArgs& e)
{
// Open a context-sensitive menu
const CEGUI::MouseEventArgs& me = static_cast<const CEGUI::MouseEventArgs&>(e);
if(me.button == CEGUI::RightButton)
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
CEGUI::PopupMenu* popupMenu = 0;
if(me.window->getName().compare("Root/FrameWindow/FirstPopup") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/FirstPopup/AutoPopup"));
}
else if(me.window->getName().compare("Root/FrameWindow/SecondPopup") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/SecondPopup/AutoPopup"));
}
else if(me.window->getName().compare("Root/FrameWindow") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/FramePopup/AutoPopup"));
}
else if(me.window->getName().compare("Root") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/SheetPopup/AutoPopup"));
}

if(popupMenu)
{
// Make the window the popup's parent
me.window->addChildWindow(popupMenu);

// Position of the popup menu
CEGUI::UVector2 popupPosition;

// Ensure the popup menu will be fully displayed horizontally on the screen
float screenWidth = CEGUI::System::getSingleton().getRenderer()->getWidth();
float popupMenuWidth = popupMenu->getWidth().d_offset;
if(popupMenuWidth < screenWidth)
{
// The x coordinate is either the mouse position or the right side of the
// screen minus the width of the popup menu. This ensures that the popup
// menu is fully displayed rather than clipped.
float x;
if(mouseToLeftOfPopupMenu)
{
x = me.position.d_x + popupMenuWidth > screenWidth ? screenWidth - popupMenuWidth
: me.position.d_x - mouseOffset;
}
else
{
x = me.position.d_x < popupMenuWidth ? 0.0f
: me.position.d_x - popupMenuWidth + mouseOffset;
}
popupPosition.d_x = cegui_absdim(CEGUI::CoordConverter::screenToWindowX(*me.window, x));
}
else
{
// The popup menu is too wide to fit within the screen
popupPosition.d_x = CEGUI::UDim(0.0f, 0.0f);
}

// Ensure the popup menu will be fully displayed vertically on the screen
float screenHeight = CEGUI::System::getSingleton().getRenderer()->getHeight();
float popupMenuHeight = popupMenu->getHeight().d_offset;
if(popupMenuHeight < screenHeight)
{
// The y coordinate is either the mouse position or the bottom side of the
// screen minus the height of the popup menu. This ensures that the popup
// menu is fully displayed rather than clipped.
float y = me.position.d_y + popupMenuHeight > screenHeight ? screenHeight - popupMenuHeight
: me.position.d_y - mouseOffset;
popupPosition.d_y = cegui_absdim(CEGUI::CoordConverter::screenToWindowY(*me.window, y));
}
else
{
// The popup menu is too tall to fit within the screen
popupPosition.d_y = CEGUI::UDim(0.0f, 0.0f);
}

// Position the context menu
popupMenu->setPosition(popupPosition);

// Show the popup menu
popupMenu->show();

// Ensure it appears on top of the other widgets
popupMenu->moveToFront();
}
}
return true;
}

//-------------------------------------------------------------------
void setStatusText(const CEGUI::String& pText)
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
winMgr.getWindow("Root/FrameWindow/Status")->setText(pText);
}

private:

};

#endif // _Menu_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "Menu_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== Menu.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="Root/FrameWindow" >
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00952756,0},{0.0104167,0},{0.51085,0},{0.585417,0}}" />
<Window Type="TaharezLook/Menubar" Name="Root/FrameWindow/Menubar" >
<Property Name="ItemSpacing" Value="10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0.09,0},{0.997727,0},{0.191014,0}}" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File" >
<Property Name="Text" Value="File" />
<Property Name="Tooltip" Value="Yes, primary menuitems can have a tooltip" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,7},{0,0},{0,30},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/File/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,42},{0,119.174}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/New" >
<Property Name="Text" Value="New" />
<Property Name="Tooltip" Value="Creates a new document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,39},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Open" >
<Property Name="Text" Value="Open..." />
<Property Name="Tooltip" Value="Opens an existing document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,39},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Close" >
<Property Name="Text" Value="Close" />
<Property Name="Tooltip" Value="Closes the active document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,39},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Save" >
<Property Name="Text" Value="Save" />
<Property Name="Tooltip" Value="Saves the active document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,39},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Exit" >
<Property Name="Text" Value="Exit" />
<Property Name="Tooltip" Value="Quits the application; prompts you to save documents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,39},{0,115}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit" >
<Property Name="Text" Value="Edit" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,40},{0,0},{0,64},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Edit/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,65},{0,118.661}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Cut" >
<Property Name="Text" Value="Cut" />
<Property Name="Tooltip" Value="Cuts the selection and puts it on the Clipboard." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,62},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Copy" >
<Property Name="Text" Value="Copy" />
<Property Name="Tooltip" Value="Copies the selection and puts it on the Clipboard." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,62},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Paste" >
<Property Name="Text" Value="Paste" />
<Property Name="Tooltip" Value="Inserts the Clipboard contents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,62},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Delete" >
<Property Name="Text" Value="Delete" />
<Property Name="Tooltip" Value="Erases the selection." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,62},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu" >
<Property Name="Text" Value="SubMenu" />
<Property Name="Tooltip" Value="This menuitem has a submenu" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,62},{0,115}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Edit/SubMenu/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,43},{0,49.5221}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu/Item1" >
<Property Name="Text" Value="Item 1" />
<Property Name="Tooltip" Value="This is sub-menu #1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,40},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu/Item2" >
<Property Name="Text" Value="Item 2" />
<Property Name="Tooltip" Value="This is sub-menu #2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,40},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help" >
<Property Name="Text" Value="Help" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,74},{0,0},{0,100},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Help/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,64},{0,49.1331}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help/Contents" >
<Property Name="Text" Value="Contents..." />
<Property Name="Tooltip" Value="Displays the help contents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,61},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help/About" >
<Property Name="Text" Value="About..." />
<Property Name="Tooltip" Value="Displays program information, version number, and copyright." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,61},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/Status" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.031818,0},{0.873954,0},{0.972728,0},{0.967087,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/FirstPopup" >
<Property Name="Text" Value="First Popup" />
<Property Name="HorzFormatting" Value="HorzCentred" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.131194,0},{0.701449,0},{0.431194,0},{0.795652,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/SecondPopup" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Second Popup" />
<Property Name="HorzFormatting" Value="HorzCentred" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.572904,0},{0.701449,0},{0.872903,0},{0.795652,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/Menubar" Name="Root/Popup" >
<Property Name="ItemSpacing" Value="10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.565585,0},{0.07,0},{0.684029,0},{0.140833,0}}" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus" >
<Property Name="Text" Value="PopupMenus" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,7},{0,0},{0,73},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,21},{0,57},{0,116.749}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup" >
<Property Name="Text" Value="First" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,54},{0,23}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/FirstPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,97},{0,119.266}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-1" >
<Property Name="Text" Value="First-1" />
<Property Name="Tooltip" Value="First-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,42},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-2" >
<Property Name="Text" Value="First-2" />
<Property Name="Tooltip" Value="First-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,42},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-3" >
<Property Name="Text" Value="First-3" />
<Property Name="Tooltip" Value="First-3" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,42},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-4" >
<Property Name="Text" Value="First-4" />
<Property Name="Tooltip" Value="First-4" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,42},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-5" >
<Property Name="Text" Value="First-5" />
<Property Name="Tooltip" Value="First-5" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,42},{0,115}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup" >
<Property Name="Text" Value="Second" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,54},{0,46}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SecondPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,117},{0,119.11}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-1" >
<Property Name="Text" Value="Second-1" />
<Property Name="Tooltip" Value="Second-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,62},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-2" >
<Property Name="Text" Value="Second-2" />
<Property Name="Tooltip" Value="Second-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,62},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-3" >
<Property Name="Text" Value="Second-3" />
<Property Name="Tooltip" Value="Second-3" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,62},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-4" >
<Property Name="Text" Value="Second-4" />
<Property Name="Tooltip" Value="Second-4" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,62},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu" >
<Property Name="Text" Value="SubMenu" />
<Property Name="Tooltip" Value="SubMenu" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,62},{0,115}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,60},{0,0},{0,118},{0,49.3892}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/SubItem1" >
<Property Name="Text" Value="SubItem1" />
<Property Name="Tooltip" Value="SubItem1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,55},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/SubItem2" >
<Property Name="Text" Value="SubItem2" />
<Property Name="Tooltip" Value="SubItem2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,55},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup" >
<Property Name="Text" Value="Frame" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,54},{0,69}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/FramePopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,104},{0,49.3892}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup/Frame-1" >
<Property Name="Text" Value="Frame-1" />
<Property Name="Tooltip" Value="Frame-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,49},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup/Frame-2" >
<Property Name="Text" Value="Frame-2" />
<Property Name="Tooltip" Value="Frame-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,49},{0,46}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup" >
<Property Name="Text" Value="Sheet" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,54},{0,92}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SheetPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,87},{0,119.243}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Allo" >
<Property Name="Text" Value="Allo" />
<Property Name="Tooltip" Value="FranÃ§ais" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,32},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hello" >
<Property Name="Text" Value="Hello" />
<Property Name="Tooltip" Value="English" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,32},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hallo" >
<Property Name="Text" Value="Hallo" />
<Property Name="Tooltip" Value="Deutsch" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,32},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Ciao" >
<Property Name="Text" Value="Ciao" />
<Property Name="Tooltip" Value="Italiano" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,32},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hola" >
<Property Name="Text" Value="Hola" />
<Property Name="Tooltip" Value="EspaÃ±ol" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,32},{0,115}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Game chat box

2008-02-02T19:50:26Z

Rackle: /* Introduction */

=== Introduction ===
This snippet implements a chat box that can display text in various fonts and font sizes as well as limiting the number of entries (history) to a certain number. Please discuss this article within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13333 GameChatBox] thread.

==== .layout Special Features ====
The layout definition is deceptively simple. It defines a FrameWindow containing two widgets; a Listbox in the upper region for chat history and an Editbox at the lower region for text input.

What is not apparent is how the bottom portion of the Listbox and the entire Editbox are defined; they specify a proportion of 100% of their parent but with a negative offset. Essentially the bottom of the Listbox extends to the bottom of the FrameWindow (the parent) and is then moved "up" to make room for the Editbox. And the Editbox follows the same pattern. This allows the Editbox to retain its height as the parent FrameWindow is resized. The height of the Editbox is controlled by the height of the font used.

Another feature is that rather than initializing values in code I opted to initialize them via the .layout. Thus the history has an initial value of 5 and the default font size is 10. The font name Combobox defines the logical font name for the dynamic font used within the chat box. This type of definition, rather than Commonwealth-10, Commonwealth-12, etc allows us to change the font of the chat box without affecting any other widget that may use a font of the same logical name.

For more details on dynamically creating fonts consult [[DynamicFont]]

=== Files ===
==== ChatBox_demo.h ====
<code><cpp/>
#ifndef _ChatBox_h_
#define _ChatBox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("ChatBox.layout");
sheet->addChildWindow(guiLayout);

// Obtain the handles of some widgets
Window* historySize = winMgr.getWindow("/ChatBox/History");
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");

// Disable widgets until a valid font is registered
fontName->setEnabled(false);
fontSize->setEnabled(false);
chatText->setEnabled(false);

// Retrieve the design-specified values
mHistorySize = static_cast<size_t>(PropertyHelper::stringToUint(historySize->getText()));
mDefaultFontSize = fontSize->getText();
mChatFontName = fontName->getText();
setHistorySize(mHistorySize);
fontName->setText("");

// Configure the history size
// Pressing <ENTER> changes the maximal number of entries within the history Listbox
historySize->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_HistorySizeChange, this));

// Configure the text Editbox
// Pressing <ENTER> puts the text into the history Listbox
chatText->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_ChatTextAdded, this));

// Configure the font name Combobox
// Selecting a name changes the font used in the history Listbox and the text Editbox
fontName->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));

// Configure the font size Spinner
// Selecting a size changes the font size used in the history Listbox and the text Editbox
fontSize->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));
fontSize->setTextInputMode(Spinner::Integer);
fontSize->setMinimumValue(4.0f);
fontSize->setMaximumValue(72.0f);
fontSize->setStepSize(1.0f);
fontSize->setCurrentValue(PropertyHelper::stringToFloat(mDefaultFontSize));

// Initialize the list of fonts
// The first registered font becomes the active font
registerFont("Commonwealth", "Commonv2c.ttf");
registerFont("DejaVuSans", "DejaVuSans.ttf");
registerFont("Iconified", "Iconiv2.ttf");
registerFont("MissingFile", "MissingFile.ttf"); // What happens if a font is missing?
registerFont("Pixmap Font", "FairChar-30.font"); // And what about a non-Freetype font?
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool Event_HistorySizeChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* historySize = winMgr.getWindow("/ChatBox/History");
int size = PropertyHelper::stringToInt( historySize->getText() );
setHistorySize(size);
return true;
}

bool Event_ChatTextAdded(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* chatText = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
addChatText(chatText->getText());

// Clear the text in the Editbox
chatText->setText("");
return true;
}

bool Event_FontChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
String name = fontName->getText();

Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
String size = PropertyHelper::floatToString(fontSize->getCurrentValue());

Window* chatText = winMgr.getWindow("/ChatBox/Text");
chatText->setText(name + " - " + size);

changeFont(name, size);
return true;
}

void setHistorySize(const size_t& pSize)
{
using namespace CEGUI;

if(pSize > 0)
{
// A better validation would be to enforce a minimal and a maximal size
mHistorySize = pSize;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
ListboxItem* chatItem;
while(chatHistory->getItemCount() > mHistorySize)
{
// There are too many items within the history Listbox, purging them one at a time
chatItem = chatHistory->getListboxItemFromIndex(0);
chatHistory->removeItem(chatItem);
}
}
}

void addChatText(const CEGUI::String& pText)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));

// If there's text then add it
if(pText.size())
{
// Add the Editbox text to the history Listbox
ListboxTextItem* chatItem;
if(chatHistory->getItemCount() == mHistorySize)
{
/* We have reached the capacity of the Listbox so re-use the first Listbox item.
This code is a little crafty. By default the ListboxTextItem is created with
the auto-delete flag set to true, which results in its automatic deletion when
removed from the Listbox. So we change that flag to false, extract the item
from the Listbox, change its text, put the auto-delete flag back to true, and
finally put the item back into the Listbox. */
chatItem = static_cast<ListboxTextItem*>(chatHistory->getListboxItemFromIndex(0));
chatItem->setAutoDeleted(false);
chatHistory->removeItem(chatItem);
chatItem->setAutoDeleted(true);
chatItem->setText(pText);
}
else
{
// Create a new listbox item
chatItem = new ListboxTextItem(pText);
}
chatHistory->addItem(chatItem);
chatHistory->ensureItemIsVisible(chatHistory->getItemCount());
}
}

void registerFont(const CEGUI::String& pLogicalName, const CEGUI::String& pFileName)
{
using namespace CEGUI;

// Ensure that font names are registered only once
if(mFontList.find(pLogicalName) == mFontList.end())
{
// Test the font so that only valid fonts are available
String testFont = mChatFontName;
if(mFontList.size() != 0)
{
// If the list is empty then attempt to create the font using the "real" font name
// Otherwise use a "test" font name so as not to corrupt the "real" one
testFont += "__test_font__";
}
Font* font = makeFont(testFont, pFileName, mDefaultFontSize);
if(mFontList.size() != 0
&& FontManager::getSingleton().isFontPresent(testFont))
{
// Since this was only a test font we destroy it
FontManager::getSingleton().destroyFont(testFont);
}
if(!font)
{
// This font is invalid
if(FontManager::getSingleton().isFontPresent(testFont))
return;
else
return;
}

WindowManager& winMgr = WindowManager::getSingleton();
Combobox* fontName = static_cast<Combobox*>(winMgr.getWindow("/ChatBox/FontName"));
mFontList[pLogicalName] = pFileName;
ListboxTextItem* fontNameItem = new ListboxTextItem(pLogicalName);
fontNameItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
fontName->addItem(fontNameItem);
if(fontName->getItemCount() == 1)
{
// Enable widgets now that at least one valid font has been found
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");
fontName->setEnabled(true);
fontSize->setEnabled(true);
chatText->setEnabled(true);

// The first registered font becomes the active font
fontName->setText(pLogicalName); // This triggers a call to changeFont
fontName->setItemSelectState(fontNameItem, true);
}
}
}

protected:
CEGUI::Font* makeFont(const CEGUI::String& pFontName, const CEGUI::String& pFileName, const CEGUI::String& pSize)
{
using namespace CEGUI;

Font* font;
try
{
if(FontManager::getSingleton().isFontPresent(pFontName))
{
// The chat font is reused rather than deleted and recreated
// every time an attribute changes. For this reason it is
// important to use a unique logical name for the font.
font = FontManager::getSingleton().getFont(pFontName);
font->setProperty("FileName", pFileName);
font->setProperty("PointSize", pSize);
}
else
{
// This is the first time we make the chat font so we need to create it
XMLAttributes xmlAttributes;

// CEGUIFont.cpp
xmlAttributes.add("Name", pFontName);
xmlAttributes.add("Filename", pFileName);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
}
font->load();
}
catch(Exception& e)
{
// Display the error message in the chat window
addChatText(e.getMessage());
font = 0;
}

return font;
}

void changeFont(const CEGUI::String& pFontLogicalName, const CEGUI::String& pFontSize)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

if(!FontManager::getSingleton().isFontPresent(mChatFontName))
{
addChatText("You must call registerFont() at least once with a valid font");
return;
}

FontList::iterator itFontList = mFontList.find(pFontLogicalName);
if(itFontList == mFontList.end())
{
addChatText(pFontLogicalName + " has not been registered");
return;
}

// Measure the height of the selected font
Font* currentFont = makeFont(mChatFontName, (*itFontList).second, pFontSize);
float fontHeight = currentFont->getFontHeight();

/* Alter the area of the Editbox. The original value is {{0.01,0},{1,-30},{0.99,0},{1,-5}}
The value we are altering is the "-30" within the second couplet, defining the position of
the upper y coordinate of the Editbox. We base the new value on the position of the lower
y coordinate, which is "-5", and the height of the font. To this we add some space "10" to
account for the Editbox's border. */
Editbox* editBox = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
URect chatTextArea = editBox->getArea();
chatTextArea.d_min.d_y.d_offset = chatTextArea.d_max.d_y.d_offset
- fontHeight
- 10;
editBox->setArea(chatTextArea);
editBox->setFont(currentFont);

/* Alther the area of the Listbox. Here we only need the lower y coordinate. Since this
value is the same as the upper y coordinate of the Editbox we do not need to calculate
it. We also change the font of the Listbox and call upon handleUpdatedItemData() to
update the current Listbox items. Finally we ensure that the last entry is still
visible. */
Listbox* listBox = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
URect listTextArea = listBox->getArea();
listTextArea.d_max.d_y.d_offset = chatTextArea.d_min.d_y.d_offset;
listBox->setArea(listTextArea);
listBox->setFont(currentFont);
listBox->handleUpdatedItemData();
size_t itemCount = listBox->getItemCount();
if(itemCount)
{
ListboxItem* currentItem = listBox->getListboxItemFromIndex(itemCount - 1);
listBox->ensureItemIsVisible(currentItem);
}
}

private:
// Type of list for registered fonts
typedef std::map<CEGUI::String, CEGUI::String> FontList;

// List of registered fonts
FontList mFontList;

// Maximal number of entries to retain within the Listbox
size_t mHistorySize;

// Logical font name dedicated to the chat box
// This allows us to modify the properties of that font and not affect the fonts used elsewhere
CEGUI::String mChatFontName;

// Default font size
CEGUI::String mDefaultFontSize;
};

#endif // _ChatBox_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "ChatBox_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== ChatBox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="/ChatBox" >
<Property Name="Text" Value="Chat" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />
<Window Type="TaharezLook/Listbox" Name="/ChatBox/List" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{0.078,0},{0.98,0},{1,-30}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/Text" >
<Property Name="Text" Value="Error: you did not register any font or none were valid" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{1,-30},{0.98,0},{1,-5}}" />
</Window>
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/History" >
<Property Name="Text" Value="5" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.03,0},{0.81,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/HistoryLabel" >
<Property Name="Text" Value="History size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.03,0},{0.77,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FonSizeLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.1,0},{0.77,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="/ChatBox/FontSize" >
<Property Name="Text" Value="10" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="10" />
<Property Name="MaximumValue" Value="72" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.1,0},{0.83,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FontNameLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font name:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.17,0},{0.77,0},{0.24,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="/ChatBox/FontName" >
<Property Name="Text" Value="ChatBoxFont" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.17,0},{0.99,0},{0.45,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
</GUILayout>
</pre>

Game chat box

2008-02-02T19:48:45Z

Rackle:

=== Introduction ===
This snippet implements a chat box that can display text in 3 font sizes as well as limiting the number of entries (history) to a certain number. Please discuss this article within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13333 GameChatBox] thread.

==== .layout Special Features ====
The layout definition is deceptively simple. It defines a FrameWindow containing two widgets; a Listbox in the upper region for chat history and an Editbox at the lower region for text input.

What is not apparent is how the bottom portion of the Listbox and the entire Editbox are defined; they specify a proportion of 100% of their parent but with a negative offset. Essentially the bottom of the Listbox extends to the bottom of the FrameWindow (the parent) and is then moved "up" to make room for the Editbox. And the Editbox follows the same pattern. This allows the Editbox to retain its height as the parent FrameWindow is resized. The height of the Editbox is controlled by the height of the font used.

Another feature is that rather than initializing values in code I opted to initialize them via the .layout. Thus the history has an initial value of 5 and the default font size is 10. The font name Combobox defines the logical font name for the dynamic font used within the chat box. This type of definition, rather than Commonwealth-10, Commonwealth-12, etc allows us to change the font of the chat box without affecting any other widget that may use a font of the same logical name.

For more details on dynamically creating fonts consult [[DynamicFont]]

=== Files ===
==== ChatBox_demo.h ====
<code><cpp/>
#ifndef _ChatBox_h_
#define _ChatBox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("ChatBox.layout");
sheet->addChildWindow(guiLayout);

// Obtain the handles of some widgets
Window* historySize = winMgr.getWindow("/ChatBox/History");
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");

// Disable widgets until a valid font is registered
fontName->setEnabled(false);
fontSize->setEnabled(false);
chatText->setEnabled(false);

// Retrieve the design-specified values
mHistorySize = static_cast<size_t>(PropertyHelper::stringToUint(historySize->getText()));
mDefaultFontSize = fontSize->getText();
mChatFontName = fontName->getText();
setHistorySize(mHistorySize);
fontName->setText("");

// Configure the history size
// Pressing <ENTER> changes the maximal number of entries within the history Listbox
historySize->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_HistorySizeChange, this));

// Configure the text Editbox
// Pressing <ENTER> puts the text into the history Listbox
chatText->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_ChatTextAdded, this));

// Configure the font name Combobox
// Selecting a name changes the font used in the history Listbox and the text Editbox
fontName->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));

// Configure the font size Spinner
// Selecting a size changes the font size used in the history Listbox and the text Editbox
fontSize->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));
fontSize->setTextInputMode(Spinner::Integer);
fontSize->setMinimumValue(4.0f);
fontSize->setMaximumValue(72.0f);
fontSize->setStepSize(1.0f);
fontSize->setCurrentValue(PropertyHelper::stringToFloat(mDefaultFontSize));

// Initialize the list of fonts
// The first registered font becomes the active font
registerFont("Commonwealth", "Commonv2c.ttf");
registerFont("DejaVuSans", "DejaVuSans.ttf");
registerFont("Iconified", "Iconiv2.ttf");
registerFont("MissingFile", "MissingFile.ttf"); // What happens if a font is missing?
registerFont("Pixmap Font", "FairChar-30.font"); // And what about a non-Freetype font?
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool Event_HistorySizeChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* historySize = winMgr.getWindow("/ChatBox/History");
int size = PropertyHelper::stringToInt( historySize->getText() );
setHistorySize(size);
return true;
}

bool Event_ChatTextAdded(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* chatText = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
addChatText(chatText->getText());

// Clear the text in the Editbox
chatText->setText("");
return true;
}

bool Event_FontChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
String name = fontName->getText();

Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
String size = PropertyHelper::floatToString(fontSize->getCurrentValue());

Window* chatText = winMgr.getWindow("/ChatBox/Text");
chatText->setText(name + " - " + size);

changeFont(name, size);
return true;
}

void setHistorySize(const size_t& pSize)
{
using namespace CEGUI;

if(pSize > 0)
{
// A better validation would be to enforce a minimal and a maximal size
mHistorySize = pSize;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
ListboxItem* chatItem;
while(chatHistory->getItemCount() > mHistorySize)
{
// There are too many items within the history Listbox, purging them one at a time
chatItem = chatHistory->getListboxItemFromIndex(0);
chatHistory->removeItem(chatItem);
}
}
}

void addChatText(const CEGUI::String& pText)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));

// If there's text then add it
if(pText.size())
{
// Add the Editbox text to the history Listbox
ListboxTextItem* chatItem;
if(chatHistory->getItemCount() == mHistorySize)
{
/* We have reached the capacity of the Listbox so re-use the first Listbox item.
This code is a little crafty. By default the ListboxTextItem is created with
the auto-delete flag set to true, which results in its automatic deletion when
removed from the Listbox. So we change that flag to false, extract the item
from the Listbox, change its text, put the auto-delete flag back to true, and
finally put the item back into the Listbox. */
chatItem = static_cast<ListboxTextItem*>(chatHistory->getListboxItemFromIndex(0));
chatItem->setAutoDeleted(false);
chatHistory->removeItem(chatItem);
chatItem->setAutoDeleted(true);
chatItem->setText(pText);
}
else
{
// Create a new listbox item
chatItem = new ListboxTextItem(pText);
}
chatHistory->addItem(chatItem);
chatHistory->ensureItemIsVisible(chatHistory->getItemCount());
}
}

void registerFont(const CEGUI::String& pLogicalName, const CEGUI::String& pFileName)
{
using namespace CEGUI;

// Ensure that font names are registered only once
if(mFontList.find(pLogicalName) == mFontList.end())
{
// Test the font so that only valid fonts are available
String testFont = mChatFontName;
if(mFontList.size() != 0)
{
// If the list is empty then attempt to create the font using the "real" font name
// Otherwise use a "test" font name so as not to corrupt the "real" one
testFont += "__test_font__";
}
Font* font = makeFont(testFont, pFileName, mDefaultFontSize);
if(mFontList.size() != 0
&& FontManager::getSingleton().isFontPresent(testFont))
{
// Since this was only a test font we destroy it
FontManager::getSingleton().destroyFont(testFont);
}
if(!font)
{
// This font is invalid
if(FontManager::getSingleton().isFontPresent(testFont))
return;
else
return;
}

WindowManager& winMgr = WindowManager::getSingleton();
Combobox* fontName = static_cast<Combobox*>(winMgr.getWindow("/ChatBox/FontName"));
mFontList[pLogicalName] = pFileName;
ListboxTextItem* fontNameItem = new ListboxTextItem(pLogicalName);
fontNameItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
fontName->addItem(fontNameItem);
if(fontName->getItemCount() == 1)
{
// Enable widgets now that at least one valid font has been found
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");
fontName->setEnabled(true);
fontSize->setEnabled(true);
chatText->setEnabled(true);

// The first registered font becomes the active font
fontName->setText(pLogicalName); // This triggers a call to changeFont
fontName->setItemSelectState(fontNameItem, true);
}
}
}

protected:
CEGUI::Font* makeFont(const CEGUI::String& pFontName, const CEGUI::String& pFileName, const CEGUI::String& pSize)
{
using namespace CEGUI;

Font* font;
try
{
if(FontManager::getSingleton().isFontPresent(pFontName))
{
// The chat font is reused rather than deleted and recreated
// every time an attribute changes. For this reason it is
// important to use a unique logical name for the font.
font = FontManager::getSingleton().getFont(pFontName);
font->setProperty("FileName", pFileName);
font->setProperty("PointSize", pSize);
}
else
{
// This is the first time we make the chat font so we need to create it
XMLAttributes xmlAttributes;

// CEGUIFont.cpp
xmlAttributes.add("Name", pFontName);
xmlAttributes.add("Filename", pFileName);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
}
font->load();
}
catch(Exception& e)
{
// Display the error message in the chat window
addChatText(e.getMessage());
font = 0;
}

return font;
}

void changeFont(const CEGUI::String& pFontLogicalName, const CEGUI::String& pFontSize)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

if(!FontManager::getSingleton().isFontPresent(mChatFontName))
{
addChatText("You must call registerFont() at least once with a valid font");
return;
}

FontList::iterator itFontList = mFontList.find(pFontLogicalName);
if(itFontList == mFontList.end())
{
addChatText(pFontLogicalName + " has not been registered");
return;
}

// Measure the height of the selected font
Font* currentFont = makeFont(mChatFontName, (*itFontList).second, pFontSize);
float fontHeight = currentFont->getFontHeight();

/* Alter the area of the Editbox. The original value is {{0.01,0},{1,-30},{0.99,0},{1,-5}}
The value we are altering is the "-30" within the second couplet, defining the position of
the upper y coordinate of the Editbox. We base the new value on the position of the lower
y coordinate, which is "-5", and the height of the font. To this we add some space "10" to
account for the Editbox's border. */
Editbox* editBox = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
URect chatTextArea = editBox->getArea();
chatTextArea.d_min.d_y.d_offset = chatTextArea.d_max.d_y.d_offset
- fontHeight
- 10;
editBox->setArea(chatTextArea);
editBox->setFont(currentFont);

/* Alther the area of the Listbox. Here we only need the lower y coordinate. Since this
value is the same as the upper y coordinate of the Editbox we do not need to calculate
it. We also change the font of the Listbox and call upon handleUpdatedItemData() to
update the current Listbox items. Finally we ensure that the last entry is still
visible. */
Listbox* listBox = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
URect listTextArea = listBox->getArea();
listTextArea.d_max.d_y.d_offset = chatTextArea.d_min.d_y.d_offset;
listBox->setArea(listTextArea);
listBox->setFont(currentFont);
listBox->handleUpdatedItemData();
size_t itemCount = listBox->getItemCount();
if(itemCount)
{
ListboxItem* currentItem = listBox->getListboxItemFromIndex(itemCount - 1);
listBox->ensureItemIsVisible(currentItem);
}
}

private:
// Type of list for registered fonts
typedef std::map<CEGUI::String, CEGUI::String> FontList;

// List of registered fonts
FontList mFontList;

// Maximal number of entries to retain within the Listbox
size_t mHistorySize;

// Logical font name dedicated to the chat box
// This allows us to modify the properties of that font and not affect the fonts used elsewhere
CEGUI::String mChatFontName;

// Default font size
CEGUI::String mDefaultFontSize;
};

#endif // _ChatBox_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "ChatBox_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== ChatBox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="/ChatBox" >
<Property Name="Text" Value="Chat" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />
<Window Type="TaharezLook/Listbox" Name="/ChatBox/List" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{0.078,0},{0.98,0},{1,-30}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/Text" >
<Property Name="Text" Value="Error: you did not register any font or none were valid" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{1,-30},{0.98,0},{1,-5}}" />
</Window>
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/History" >
<Property Name="Text" Value="5" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.03,0},{0.81,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/HistoryLabel" >
<Property Name="Text" Value="History size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.03,0},{0.77,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FonSizeLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.1,0},{0.77,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="/ChatBox/FontSize" >
<Property Name="Text" Value="10" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="10" />
<Property Name="MaximumValue" Value="72" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.1,0},{0.83,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FontNameLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font name:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.17,0},{0.77,0},{0.24,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="/ChatBox/FontName" >
<Property Name="Text" Value="ChatBoxFont" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.17,0},{0.99,0},{0.45,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
</GUILayout>
</pre>

Game chat box

2008-02-02T19:45:06Z

Rackle: /* .layout Special Features */

=== Introduction ===
This snippet implements a chat box that can display text in 3 font sizes as well as limiting the number of entries (history) to a certain number. Please discuss this article within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13333 GameChatBox] thread.

==== .layout Special Features ====
The layout definition is deceptively simple. It defines a FrameWindow containing two widgets; a Listbox in the upper region for chat history and an Editbox at the lower region for text input.

What is not apparent is how the bottom portion of the Listbox and the entire Editbox are defined; they specify a proportion of 100% of their parent but with a negative offset. Essentially the bottom of the Listbox extends to the bottom of the FrameWindow (the parent) and is then moved "up" to make room for the Editbox. And the Editbox follows the same pattern. This allows the Editbox to retain its height as the parent FrameWindow is resized. The height of the Editbox is controlled by the height of the font used.

Another feature is that rather than initializing values in code I opted to initialize them via the .layout. Thus the history has an initial value of 5 and the default font size is 10. The font name Combobox defines the logical font name for the dynamic font used within the chat box. This type of definition, rather than Commonwealth-10, Commonwealth-12, etc allows us to change the font of the chat box without affecting any other widget that may use a font of the same logical name.

==== Creating the necessary .font files ====
A .font file is a simple text file that defines a font within Cegui. They are located within the datafiles\fonts directory.

This snippet uses the Commonwealth font in sizes 10, 36, and 72. To create the missing font definitions for sizes 36 and 72 simply make two copies of the existing "Commonwealth-10.font" file. The first copy is to be named "Commonwealth-36.font" and the second copy "Commonwealth-72.font". Edit the "Commonwealth-36.font" file and replace the value "10" by the value "36". Similarly edit the "Commonwealth-72.font" file and replace the value "10" by the value "72".

Another approach is to dynamically create fonts. For more details consult [[DynamicFont]]

=== Files ===
==== ChatBox_demo.h ====
<code><cpp/>
#ifndef _ChatBox_h_
#define _ChatBox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("ChatBox.layout");
sheet->addChildWindow(guiLayout);

// Obtain the handles of some widgets
Window* historySize = winMgr.getWindow("/ChatBox/History");
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");

// Disable widgets until a valid font is registered
fontName->setEnabled(false);
fontSize->setEnabled(false);
chatText->setEnabled(false);

// Retrieve the design-specified values
mHistorySize = static_cast<size_t>(PropertyHelper::stringToUint(historySize->getText()));
mDefaultFontSize = fontSize->getText();
mChatFontName = fontName->getText();
setHistorySize(mHistorySize);
fontName->setText("");

// Configure the history size
// Pressing <ENTER> changes the maximal number of entries within the history Listbox
historySize->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_HistorySizeChange, this));

// Configure the text Editbox
// Pressing <ENTER> puts the text into the history Listbox
chatText->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_ChatTextAdded, this));

// Configure the font name Combobox
// Selecting a name changes the font used in the history Listbox and the text Editbox
fontName->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));

// Configure the font size Spinner
// Selecting a size changes the font size used in the history Listbox and the text Editbox
fontSize->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));
fontSize->setTextInputMode(Spinner::Integer);
fontSize->setMinimumValue(4.0f);
fontSize->setMaximumValue(72.0f);
fontSize->setStepSize(1.0f);
fontSize->setCurrentValue(PropertyHelper::stringToFloat(mDefaultFontSize));

// Initialize the list of fonts
// The first registered font becomes the active font
registerFont("Commonwealth", "Commonv2c.ttf");
registerFont("DejaVuSans", "DejaVuSans.ttf");
registerFont("Iconified", "Iconiv2.ttf");
registerFont("MissingFile", "MissingFile.ttf"); // What happens if a font is missing?
registerFont("Pixmap Font", "FairChar-30.font"); // And what about a non-Freetype font?
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool Event_HistorySizeChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* historySize = winMgr.getWindow("/ChatBox/History");
int size = PropertyHelper::stringToInt( historySize->getText() );
setHistorySize(size);
return true;
}

bool Event_ChatTextAdded(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* chatText = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
addChatText(chatText->getText());

// Clear the text in the Editbox
chatText->setText("");
return true;
}

bool Event_FontChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
String name = fontName->getText();

Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
String size = PropertyHelper::floatToString(fontSize->getCurrentValue());

Window* chatText = winMgr.getWindow("/ChatBox/Text");
chatText->setText(name + " - " + size);

changeFont(name, size);
return true;
}

void setHistorySize(const size_t& pSize)
{
using namespace CEGUI;

if(pSize > 0)
{
// A better validation would be to enforce a minimal and a maximal size
mHistorySize = pSize;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
ListboxItem* chatItem;
while(chatHistory->getItemCount() > mHistorySize)
{
// There are too many items within the history Listbox, purging them one at a time
chatItem = chatHistory->getListboxItemFromIndex(0);
chatHistory->removeItem(chatItem);
}
}
}

void addChatText(const CEGUI::String& pText)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));

// If there's text then add it
if(pText.size())
{
// Add the Editbox text to the history Listbox
ListboxTextItem* chatItem;
if(chatHistory->getItemCount() == mHistorySize)
{
/* We have reached the capacity of the Listbox so re-use the first Listbox item.
This code is a little crafty. By default the ListboxTextItem is created with
the auto-delete flag set to true, which results in its automatic deletion when
removed from the Listbox. So we change that flag to false, extract the item
from the Listbox, change its text, put the auto-delete flag back to true, and
finally put the item back into the Listbox. */
chatItem = static_cast<ListboxTextItem*>(chatHistory->getListboxItemFromIndex(0));
chatItem->setAutoDeleted(false);
chatHistory->removeItem(chatItem);
chatItem->setAutoDeleted(true);
chatItem->setText(pText);
}
else
{
// Create a new listbox item
chatItem = new ListboxTextItem(pText);
}
chatHistory->addItem(chatItem);
chatHistory->ensureItemIsVisible(chatHistory->getItemCount());
}
}

void registerFont(const CEGUI::String& pLogicalName, const CEGUI::String& pFileName)
{
using namespace CEGUI;

// Ensure that font names are registered only once
if(mFontList.find(pLogicalName) == mFontList.end())
{
// Test the font so that only valid fonts are available
String testFont = mChatFontName;
if(mFontList.size() != 0)
{
// If the list is empty then attempt to create the font using the "real" font name
// Otherwise use a "test" font name so as not to corrupt the "real" one
testFont += "__test_font__";
}
Font* font = makeFont(testFont, pFileName, mDefaultFontSize);
if(mFontList.size() != 0
&& FontManager::getSingleton().isFontPresent(testFont))
{
// Since this was only a test font we destroy it
FontManager::getSingleton().destroyFont(testFont);
}
if(!font)
{
// This font is invalid
if(FontManager::getSingleton().isFontPresent(testFont))
return;
else
return;
}

WindowManager& winMgr = WindowManager::getSingleton();
Combobox* fontName = static_cast<Combobox*>(winMgr.getWindow("/ChatBox/FontName"));
mFontList[pLogicalName] = pFileName;
ListboxTextItem* fontNameItem = new ListboxTextItem(pLogicalName);
fontNameItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
fontName->addItem(fontNameItem);
if(fontName->getItemCount() == 1)
{
// Enable widgets now that at least one valid font has been found
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");
fontName->setEnabled(true);
fontSize->setEnabled(true);
chatText->setEnabled(true);

// The first registered font becomes the active font
fontName->setText(pLogicalName); // This triggers a call to changeFont
fontName->setItemSelectState(fontNameItem, true);
}
}
}

protected:
CEGUI::Font* makeFont(const CEGUI::String& pFontName, const CEGUI::String& pFileName, const CEGUI::String& pSize)
{
using namespace CEGUI;

Font* font;
try
{
if(FontManager::getSingleton().isFontPresent(pFontName))
{
// The chat font is reused rather than deleted and recreated
// every time an attribute changes. For this reason it is
// important to use a unique logical name for the font.
font = FontManager::getSingleton().getFont(pFontName);
font->setProperty("FileName", pFileName);
font->setProperty("PointSize", pSize);
}
else
{
// This is the first time we make the chat font so we need to create it
XMLAttributes xmlAttributes;

// CEGUIFont.cpp
xmlAttributes.add("Name", pFontName);
xmlAttributes.add("Filename", pFileName);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
}
font->load();
}
catch(Exception& e)
{
// Display the error message in the chat window
addChatText(e.getMessage());
font = 0;
}

return font;
}

void changeFont(const CEGUI::String& pFontLogicalName, const CEGUI::String& pFontSize)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

if(!FontManager::getSingleton().isFontPresent(mChatFontName))
{
addChatText("You must call registerFont() at least once with a valid font");
return;
}

FontList::iterator itFontList = mFontList.find(pFontLogicalName);
if(itFontList == mFontList.end())
{
addChatText(pFontLogicalName + " has not been registered");
return;
}

// Measure the height of the selected font
Font* currentFont = makeFont(mChatFontName, (*itFontList).second, pFontSize);
float fontHeight = currentFont->getFontHeight();

/* Alter the area of the Editbox. The original value is {{0.01,0},{1,-30},{0.99,0},{1,-5}}
The value we are altering is the "-30" within the second couplet, defining the position of
the upper y coordinate of the Editbox. We base the new value on the position of the lower
y coordinate, which is "-5", and the height of the font. To this we add some space "10" to
account for the Editbox's border. */
Editbox* editBox = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
URect chatTextArea = editBox->getArea();
chatTextArea.d_min.d_y.d_offset = chatTextArea.d_max.d_y.d_offset
- fontHeight
- 10;
editBox->setArea(chatTextArea);
editBox->setFont(currentFont);

/* Alther the area of the Listbox. Here we only need the lower y coordinate. Since this
value is the same as the upper y coordinate of the Editbox we do not need to calculate
it. We also change the font of the Listbox and call upon handleUpdatedItemData() to
update the current Listbox items. Finally we ensure that the last entry is still
visible. */
Listbox* listBox = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
URect listTextArea = listBox->getArea();
listTextArea.d_max.d_y.d_offset = chatTextArea.d_min.d_y.d_offset;
listBox->setArea(listTextArea);
listBox->setFont(currentFont);
listBox->handleUpdatedItemData();
size_t itemCount = listBox->getItemCount();
if(itemCount)
{
ListboxItem* currentItem = listBox->getListboxItemFromIndex(itemCount - 1);
listBox->ensureItemIsVisible(currentItem);
}
}

private:
// Type of list for registered fonts
typedef std::map<CEGUI::String, CEGUI::String> FontList;

// List of registered fonts
FontList mFontList;

// Maximal number of entries to retain within the Listbox
size_t mHistorySize;

// Logical font name dedicated to the chat box
// This allows us to modify the properties of that font and not affect the fonts used elsewhere
CEGUI::String mChatFontName;

// Default font size
CEGUI::String mDefaultFontSize;
};

#endif // _ChatBox_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "ChatBox_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== ChatBox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="/ChatBox" >
<Property Name="Text" Value="Chat" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />
<Window Type="TaharezLook/Listbox" Name="/ChatBox/List" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{0.078,0},{0.98,0},{1,-30}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/Text" >
<Property Name="Text" Value="Error: you did not register any font or none were valid" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{1,-30},{0.98,0},{1,-5}}" />
</Window>
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/History" >
<Property Name="Text" Value="5" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.03,0},{0.81,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/HistoryLabel" >
<Property Name="Text" Value="History size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.03,0},{0.77,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FonSizeLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.1,0},{0.77,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="/ChatBox/FontSize" >
<Property Name="Text" Value="10" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="10" />
<Property Name="MaximumValue" Value="72" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.1,0},{0.83,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FontNameLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font name:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.17,0},{0.77,0},{0.24,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="/ChatBox/FontName" >
<Property Name="Text" Value="ChatBoxFont" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.17,0},{0.99,0},{0.45,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
</GUILayout>
</pre>

Game chat box

2008-02-02T19:21:01Z

Rackle: /* ChatBox.layout */

=== Introduction ===
This snippet implements a chat box that can display text in 3 font sizes as well as limiting the number of entries (history) to a certain number. Please discuss this article within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13333 GameChatBox] thread.

==== .layout Special Features ====
The layout definition is deceptively simple. It defines a FrameWindow containing two widgets; a Listbox in the upper region for chat history and an Editbox at the lower region for text input.

What is not apparent is how the bottom portion of the Listbox and the entire Editbox are defined; they specify a proportion of 100% of their parent but with a negative offset. Essentially the bottom of the Listbox extends to the bottom of the FrameWindow (the parent) and is then moved "up" to make room for the Editbox. And the Editbox follows the same pattern. This allows the Editbox to retain its height as the parent FrameWindow is resized.

==== Creating the necessary .font files ====
A .font file is a simple text file that defines a font within Cegui. They are located within the datafiles\fonts directory.

This snippet uses the Commonwealth font in sizes 10, 36, and 72. To create the missing font definitions for sizes 36 and 72 simply make two copies of the existing "Commonwealth-10.font" file. The first copy is to be named "Commonwealth-36.font" and the second copy "Commonwealth-72.font". Edit the "Commonwealth-36.font" file and replace the value "10" by the value "36". Similarly edit the "Commonwealth-72.font" file and replace the value "10" by the value "72".

Another approach is to dynamically create fonts. For more details consult [[DynamicFont]]

=== Files ===
==== ChatBox_demo.h ====
<code><cpp/>
#ifndef _ChatBox_h_
#define _ChatBox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("ChatBox.layout");
sheet->addChildWindow(guiLayout);

// Obtain the handles of some widgets
Window* historySize = winMgr.getWindow("/ChatBox/History");
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");

// Disable widgets until a valid font is registered
fontName->setEnabled(false);
fontSize->setEnabled(false);
chatText->setEnabled(false);

// Retrieve the design-specified values
mHistorySize = static_cast<size_t>(PropertyHelper::stringToUint(historySize->getText()));
mDefaultFontSize = fontSize->getText();
mChatFontName = fontName->getText();
setHistorySize(mHistorySize);
fontName->setText("");

// Configure the history size
// Pressing <ENTER> changes the maximal number of entries within the history Listbox
historySize->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_HistorySizeChange, this));

// Configure the text Editbox
// Pressing <ENTER> puts the text into the history Listbox
chatText->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_ChatTextAdded, this));

// Configure the font name Combobox
// Selecting a name changes the font used in the history Listbox and the text Editbox
fontName->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));

// Configure the font size Spinner
// Selecting a size changes the font size used in the history Listbox and the text Editbox
fontSize->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));
fontSize->setTextInputMode(Spinner::Integer);
fontSize->setMinimumValue(4.0f);
fontSize->setMaximumValue(72.0f);
fontSize->setStepSize(1.0f);
fontSize->setCurrentValue(PropertyHelper::stringToFloat(mDefaultFontSize));

// Initialize the list of fonts
// The first registered font becomes the active font
registerFont("Commonwealth", "Commonv2c.ttf");
registerFont("DejaVuSans", "DejaVuSans.ttf");
registerFont("Iconified", "Iconiv2.ttf");
registerFont("MissingFile", "MissingFile.ttf"); // What happens if a font is missing?
registerFont("Pixmap Font", "FairChar-30.font"); // And what about a non-Freetype font?
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool Event_HistorySizeChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* historySize = winMgr.getWindow("/ChatBox/History");
int size = PropertyHelper::stringToInt( historySize->getText() );
setHistorySize(size);
return true;
}

bool Event_ChatTextAdded(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* chatText = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
addChatText(chatText->getText());

// Clear the text in the Editbox
chatText->setText("");
return true;
}

bool Event_FontChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
String name = fontName->getText();

Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
String size = PropertyHelper::floatToString(fontSize->getCurrentValue());

Window* chatText = winMgr.getWindow("/ChatBox/Text");
chatText->setText(name + " - " + size);

changeFont(name, size);
return true;
}

void setHistorySize(const size_t& pSize)
{
using namespace CEGUI;

if(pSize > 0)
{
// A better validation would be to enforce a minimal and a maximal size
mHistorySize = pSize;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
ListboxItem* chatItem;
while(chatHistory->getItemCount() > mHistorySize)
{
// There are too many items within the history Listbox, purging them one at a time
chatItem = chatHistory->getListboxItemFromIndex(0);
chatHistory->removeItem(chatItem);
}
}
}

void addChatText(const CEGUI::String& pText)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));

// If there's text then add it
if(pText.size())
{
// Add the Editbox text to the history Listbox
ListboxTextItem* chatItem;
if(chatHistory->getItemCount() == mHistorySize)
{
/* We have reached the capacity of the Listbox so re-use the first Listbox item.
This code is a little crafty. By default the ListboxTextItem is created with
the auto-delete flag set to true, which results in its automatic deletion when
removed from the Listbox. So we change that flag to false, extract the item
from the Listbox, change its text, put the auto-delete flag back to true, and
finally put the item back into the Listbox. */
chatItem = static_cast<ListboxTextItem*>(chatHistory->getListboxItemFromIndex(0));
chatItem->setAutoDeleted(false);
chatHistory->removeItem(chatItem);
chatItem->setAutoDeleted(true);
chatItem->setText(pText);
}
else
{
// Create a new listbox item
chatItem = new ListboxTextItem(pText);
}
chatHistory->addItem(chatItem);
chatHistory->ensureItemIsVisible(chatHistory->getItemCount());
}
}

void registerFont(const CEGUI::String& pLogicalName, const CEGUI::String& pFileName)
{
using namespace CEGUI;

// Ensure that font names are registered only once
if(mFontList.find(pLogicalName) == mFontList.end())
{
// Test the font so that only valid fonts are available
String testFont = mChatFontName;
if(mFontList.size() != 0)
{
// If the list is empty then attempt to create the font using the "real" font name
// Otherwise use a "test" font name so as not to corrupt the "real" one
testFont += "__test_font__";
}
Font* font = makeFont(testFont, pFileName, mDefaultFontSize);
if(mFontList.size() != 0
&& FontManager::getSingleton().isFontPresent(testFont))
{
// Since this was only a test font we destroy it
FontManager::getSingleton().destroyFont(testFont);
}
if(!font)
{
// This font is invalid
if(FontManager::getSingleton().isFontPresent(testFont))
return;
else
return;
}

WindowManager& winMgr = WindowManager::getSingleton();
Combobox* fontName = static_cast<Combobox*>(winMgr.getWindow("/ChatBox/FontName"));
mFontList[pLogicalName] = pFileName;
ListboxTextItem* fontNameItem = new ListboxTextItem(pLogicalName);
fontNameItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
fontName->addItem(fontNameItem);
if(fontName->getItemCount() == 1)
{
// Enable widgets now that at least one valid font has been found
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");
fontName->setEnabled(true);
fontSize->setEnabled(true);
chatText->setEnabled(true);

// The first registered font becomes the active font
fontName->setText(pLogicalName); // This triggers a call to changeFont
fontName->setItemSelectState(fontNameItem, true);
}
}
}

protected:
CEGUI::Font* makeFont(const CEGUI::String& pFontName, const CEGUI::String& pFileName, const CEGUI::String& pSize)
{
using namespace CEGUI;

Font* font;
try
{
if(FontManager::getSingleton().isFontPresent(pFontName))
{
// The chat font is reused rather than deleted and recreated
// every time an attribute changes. For this reason it is
// important to use a unique logical name for the font.
font = FontManager::getSingleton().getFont(pFontName);
font->setProperty("FileName", pFileName);
font->setProperty("PointSize", pSize);
}
else
{
// This is the first time we make the chat font so we need to create it
XMLAttributes xmlAttributes;

// CEGUIFont.cpp
xmlAttributes.add("Name", pFontName);
xmlAttributes.add("Filename", pFileName);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
}
font->load();
}
catch(Exception& e)
{
// Display the error message in the chat window
addChatText(e.getMessage());
font = 0;
}

return font;
}

void changeFont(const CEGUI::String& pFontLogicalName, const CEGUI::String& pFontSize)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

if(!FontManager::getSingleton().isFontPresent(mChatFontName))
{
addChatText("You must call registerFont() at least once with a valid font");
return;
}

FontList::iterator itFontList = mFontList.find(pFontLogicalName);
if(itFontList == mFontList.end())
{
addChatText(pFontLogicalName + " has not been registered");
return;
}

// Measure the height of the selected font
Font* currentFont = makeFont(mChatFontName, (*itFontList).second, pFontSize);
float fontHeight = currentFont->getFontHeight();

/* Alter the area of the Editbox. The original value is {{0.01,0},{1,-30},{0.99,0},{1,-5}}
The value we are altering is the "-30" within the second couplet, defining the position of
the upper y coordinate of the Editbox. We base the new value on the position of the lower
y coordinate, which is "-5", and the height of the font. To this we add some space "10" to
account for the Editbox's border. */
Editbox* editBox = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
URect chatTextArea = editBox->getArea();
chatTextArea.d_min.d_y.d_offset = chatTextArea.d_max.d_y.d_offset
- fontHeight
- 10;
editBox->setArea(chatTextArea);
editBox->setFont(currentFont);

/* Alther the area of the Listbox. Here we only need the lower y coordinate. Since this
value is the same as the upper y coordinate of the Editbox we do not need to calculate
it. We also change the font of the Listbox and call upon handleUpdatedItemData() to
update the current Listbox items. Finally we ensure that the last entry is still
visible. */
Listbox* listBox = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
URect listTextArea = listBox->getArea();
listTextArea.d_max.d_y.d_offset = chatTextArea.d_min.d_y.d_offset;
listBox->setArea(listTextArea);
listBox->setFont(currentFont);
listBox->handleUpdatedItemData();
size_t itemCount = listBox->getItemCount();
if(itemCount)
{
ListboxItem* currentItem = listBox->getListboxItemFromIndex(itemCount - 1);
listBox->ensureItemIsVisible(currentItem);
}
}

private:
// Type of list for registered fonts
typedef std::map<CEGUI::String, CEGUI::String> FontList;

// List of registered fonts
FontList mFontList;

// Maximal number of entries to retain within the Listbox
size_t mHistorySize;

// Logical font name dedicated to the chat box
// This allows us to modify the properties of that font and not affect the fonts used elsewhere
CEGUI::String mChatFontName;

// Default font size
CEGUI::String mDefaultFontSize;
};

#endif // _ChatBox_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "ChatBox_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== ChatBox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="/ChatBox" >
<Property Name="Text" Value="Chat" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />
<Window Type="TaharezLook/Listbox" Name="/ChatBox/List" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{0.078,0},{0.98,0},{1,-30}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/Text" >
<Property Name="Text" Value="Error: you did not register any font or none were valid" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{1,-30},{0.98,0},{1,-5}}" />
</Window>
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/History" >
<Property Name="Text" Value="5" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.03,0},{0.81,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/HistoryLabel" >
<Property Name="Text" Value="History size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.03,0},{0.77,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FonSizeLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.1,0},{0.77,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="/ChatBox/FontSize" >
<Property Name="Text" Value="10" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="10" />
<Property Name="MaximumValue" Value="72" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.1,0},{0.83,0},{0.17,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/FontNameLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Font name:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.65,0},{0.17,0},{0.77,0},{0.24,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="/ChatBox/FontName" >
<Property Name="Text" Value="ChatBoxFont" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.77,0},{0.17,0},{0.99,0},{0.45,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
</GUILayout>
</pre>

Game chat box

2008-02-02T19:20:36Z

Rackle: /* ChatBox_demo.h */

=== Introduction ===
This snippet implements a chat box that can display text in 3 font sizes as well as limiting the number of entries (history) to a certain number. Please discuss this article within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13333 GameChatBox] thread.

==== .layout Special Features ====
The layout definition is deceptively simple. It defines a FrameWindow containing two widgets; a Listbox in the upper region for chat history and an Editbox at the lower region for text input.

What is not apparent is how the bottom portion of the Listbox and the entire Editbox are defined; they specify a proportion of 100% of their parent but with a negative offset. Essentially the bottom of the Listbox extends to the bottom of the FrameWindow (the parent) and is then moved "up" to make room for the Editbox. And the Editbox follows the same pattern. This allows the Editbox to retain its height as the parent FrameWindow is resized.

==== Creating the necessary .font files ====
A .font file is a simple text file that defines a font within Cegui. They are located within the datafiles\fonts directory.

This snippet uses the Commonwealth font in sizes 10, 36, and 72. To create the missing font definitions for sizes 36 and 72 simply make two copies of the existing "Commonwealth-10.font" file. The first copy is to be named "Commonwealth-36.font" and the second copy "Commonwealth-72.font". Edit the "Commonwealth-36.font" file and replace the value "10" by the value "36". Similarly edit the "Commonwealth-72.font" file and replace the value "10" by the value "72".

Another approach is to dynamically create fonts. For more details consult [[DynamicFont]]

=== Files ===
==== ChatBox_demo.h ====
<code><cpp/>
#ifndef _ChatBox_h_
#define _ChatBox_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("ChatBox.layout");
sheet->addChildWindow(guiLayout);

// Obtain the handles of some widgets
Window* historySize = winMgr.getWindow("/ChatBox/History");
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");

// Disable widgets until a valid font is registered
fontName->setEnabled(false);
fontSize->setEnabled(false);
chatText->setEnabled(false);

// Retrieve the design-specified values
mHistorySize = static_cast<size_t>(PropertyHelper::stringToUint(historySize->getText()));
mDefaultFontSize = fontSize->getText();
mChatFontName = fontName->getText();
setHistorySize(mHistorySize);
fontName->setText("");

// Configure the history size
// Pressing <ENTER> changes the maximal number of entries within the history Listbox
historySize->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_HistorySizeChange, this));

// Configure the text Editbox
// Pressing <ENTER> puts the text into the history Listbox
chatText->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&DemoSample::Event_ChatTextAdded, this));

// Configure the font name Combobox
// Selecting a name changes the font used in the history Listbox and the text Editbox
fontName->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));

// Configure the font size Spinner
// Selecting a size changes the font size used in the history Listbox and the text Editbox
fontSize->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::Event_FontChange, this));
fontSize->setTextInputMode(Spinner::Integer);
fontSize->setMinimumValue(4.0f);
fontSize->setMaximumValue(72.0f);
fontSize->setStepSize(1.0f);
fontSize->setCurrentValue(PropertyHelper::stringToFloat(mDefaultFontSize));

// Initialize the list of fonts
// The first registered font becomes the active font
registerFont("Commonwealth", "Commonv2c.ttf");
registerFont("DejaVuSans", "DejaVuSans.ttf");
registerFont("Iconified", "Iconiv2.ttf");
registerFont("MissingFile", "MissingFile.ttf"); // What happens if a font is missing?
registerFont("Pixmap Font", "FairChar-30.font"); // And what about a non-Freetype font?
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool Event_HistorySizeChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* historySize = winMgr.getWindow("/ChatBox/History");
int size = PropertyHelper::stringToInt( historySize->getText() );
setHistorySize(size);
return true;
}

bool Event_ChatTextAdded(const CEGUI::EventArgs& args)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Editbox* chatText = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
addChatText(chatText->getText());

// Clear the text in the Editbox
chatText->setText("");
return true;
}

bool Event_FontChange(const CEGUI::EventArgs& args)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* fontName = winMgr.getWindow("/ChatBox/FontName");
String name = fontName->getText();

Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
String size = PropertyHelper::floatToString(fontSize->getCurrentValue());

Window* chatText = winMgr.getWindow("/ChatBox/Text");
chatText->setText(name + " - " + size);

changeFont(name, size);
return true;
}

void setHistorySize(const size_t& pSize)
{
using namespace CEGUI;

if(pSize > 0)
{
// A better validation would be to enforce a minimal and a maximal size
mHistorySize = pSize;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
ListboxItem* chatItem;
while(chatHistory->getItemCount() > mHistorySize)
{
// There are too many items within the history Listbox, purging them one at a time
chatItem = chatHistory->getListboxItemFromIndex(0);
chatHistory->removeItem(chatItem);
}
}
}

void addChatText(const CEGUI::String& pText)
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Listbox* chatHistory = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));

// If there's text then add it
if(pText.size())
{
// Add the Editbox text to the history Listbox
ListboxTextItem* chatItem;
if(chatHistory->getItemCount() == mHistorySize)
{
/* We have reached the capacity of the Listbox so re-use the first Listbox item.
This code is a little crafty. By default the ListboxTextItem is created with
the auto-delete flag set to true, which results in its automatic deletion when
removed from the Listbox. So we change that flag to false, extract the item
from the Listbox, change its text, put the auto-delete flag back to true, and
finally put the item back into the Listbox. */
chatItem = static_cast<ListboxTextItem*>(chatHistory->getListboxItemFromIndex(0));
chatItem->setAutoDeleted(false);
chatHistory->removeItem(chatItem);
chatItem->setAutoDeleted(true);
chatItem->setText(pText);
}
else
{
// Create a new listbox item
chatItem = new ListboxTextItem(pText);
}
chatHistory->addItem(chatItem);
chatHistory->ensureItemIsVisible(chatHistory->getItemCount());
}
}

void registerFont(const CEGUI::String& pLogicalName, const CEGUI::String& pFileName)
{
using namespace CEGUI;

// Ensure that font names are registered only once
if(mFontList.find(pLogicalName) == mFontList.end())
{
// Test the font so that only valid fonts are available
String testFont = mChatFontName;
if(mFontList.size() != 0)
{
// If the list is empty then attempt to create the font using the "real" font name
// Otherwise use a "test" font name so as not to corrupt the "real" one
testFont += "__test_font__";
}
Font* font = makeFont(testFont, pFileName, mDefaultFontSize);
if(mFontList.size() != 0
&& FontManager::getSingleton().isFontPresent(testFont))
{
// Since this was only a test font we destroy it
FontManager::getSingleton().destroyFont(testFont);
}
if(!font)
{
// This font is invalid
if(FontManager::getSingleton().isFontPresent(testFont))
return;
else
return;
}

WindowManager& winMgr = WindowManager::getSingleton();
Combobox* fontName = static_cast<Combobox*>(winMgr.getWindow("/ChatBox/FontName"));
mFontList[pLogicalName] = pFileName;
ListboxTextItem* fontNameItem = new ListboxTextItem(pLogicalName);
fontNameItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
fontName->addItem(fontNameItem);
if(fontName->getItemCount() == 1)
{
// Enable widgets now that at least one valid font has been found
Spinner* fontSize = static_cast<Spinner*>(winMgr.getWindow("/ChatBox/FontSize"));
Window* chatText = winMgr.getWindow("/ChatBox/Text");
fontName->setEnabled(true);
fontSize->setEnabled(true);
chatText->setEnabled(true);

// The first registered font becomes the active font
fontName->setText(pLogicalName); // This triggers a call to changeFont
fontName->setItemSelectState(fontNameItem, true);
}
}
}

protected:
CEGUI::Font* makeFont(const CEGUI::String& pFontName, const CEGUI::String& pFileName, const CEGUI::String& pSize)
{
using namespace CEGUI;

Font* font;
try
{
if(FontManager::getSingleton().isFontPresent(pFontName))
{
// The chat font is reused rather than deleted and recreated
// every time an attribute changes. For this reason it is
// important to use a unique logical name for the font.
font = FontManager::getSingleton().getFont(pFontName);
font->setProperty("FileName", pFileName);
font->setProperty("PointSize", pSize);
}
else
{
// This is the first time we make the chat font so we need to create it
XMLAttributes xmlAttributes;

// CEGUIFont.cpp
xmlAttributes.add("Name", pFontName);
xmlAttributes.add("Filename", pFileName);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
}
font->load();
}
catch(Exception& e)
{
// Display the error message in the chat window
addChatText(e.getMessage());
font = 0;
}

return font;
}

void changeFont(const CEGUI::String& pFontLogicalName, const CEGUI::String& pFontSize)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

if(!FontManager::getSingleton().isFontPresent(mChatFontName))
{
addChatText("You must call registerFont() at least once with a valid font");
return;
}

FontList::iterator itFontList = mFontList.find(pFontLogicalName);
if(itFontList == mFontList.end())
{
addChatText(pFontLogicalName + " has not been registered");
return;
}

// Measure the height of the selected font
Font* currentFont = makeFont(mChatFontName, (*itFontList).second, pFontSize);
float fontHeight = currentFont->getFontHeight();

/* Alter the area of the Editbox. The original value is {{0.01,0},{1,-30},{0.99,0},{1,-5}}
The value we are altering is the "-30" within the second couplet, defining the position of
the upper y coordinate of the Editbox. We base the new value on the position of the lower
y coordinate, which is "-5", and the height of the font. To this we add some space "10" to
account for the Editbox's border. */
Editbox* editBox = static_cast<Editbox*> (winMgr.getWindow("/ChatBox/Text"));
URect chatTextArea = editBox->getArea();
chatTextArea.d_min.d_y.d_offset = chatTextArea.d_max.d_y.d_offset
- fontHeight
- 10;
editBox->setArea(chatTextArea);
editBox->setFont(currentFont);

/* Alther the area of the Listbox. Here we only need the lower y coordinate. Since this
value is the same as the upper y coordinate of the Editbox we do not need to calculate
it. We also change the font of the Listbox and call upon handleUpdatedItemData() to
update the current Listbox items. Finally we ensure that the last entry is still
visible. */
Listbox* listBox = static_cast<Listbox*> (winMgr.getWindow("/ChatBox/List"));
URect listTextArea = listBox->getArea();
listTextArea.d_max.d_y.d_offset = chatTextArea.d_min.d_y.d_offset;
listBox->setArea(listTextArea);
listBox->setFont(currentFont);
listBox->handleUpdatedItemData();
size_t itemCount = listBox->getItemCount();
if(itemCount)
{
ListboxItem* currentItem = listBox->getListboxItemFromIndex(itemCount - 1);
listBox->ensureItemIsVisible(currentItem);
}
}

private:
// Type of list for registered fonts
typedef std::map<CEGUI::String, CEGUI::String> FontList;

// List of registered fonts
FontList mFontList;

// Maximal number of entries to retain within the Listbox
size_t mHistorySize;

// Logical font name dedicated to the chat box
// This allows us to modify the properties of that font and not affect the fonts used elsewhere
CEGUI::String mChatFontName;

// Default font size
CEGUI::String mDefaultFontSize;
};

#endif // _ChatBox_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "ChatBox_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== ChatBox.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="/ChatBox" >
<Property Name="Text" Value="Chat" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.15,0},{0.03,0},{0.7,0},{0.7,0}}" />
<Window Type="TaharezLook/Listbox" Name="/ChatBox/List" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.078,0},{0.99,0},{1,-30}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/Text" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{1,-30},{0.99,0},{1,-5}}" />
</Window>
</Window>
<Window Type="TaharezLook/Editbox" Name="/ChatBox/History" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.9,0},{0.03,0},{0.95,0},{0.1,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="/ChatBox/HistoryLabel" >
<Property Name="Text" Value="History size:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.78,0},{0.03,0},{0.9,0},{0.1,0}}" />
</Window>
</Window>
</GUILayout>
</pre>

Sample code for all Widgets

2008-02-01T14:20:04Z

Rackle: Link toward CheckListboxItem

This code goes through every widget and demonstrates how to retrieve and set their data as well as some of their particularities. Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=7967#7967 Widget Galore]

=== Widgets===

==== General ====
A widget can be enabled/disabled via setEnabled(). Disabling a widget prevents the user from activating it and manipulating its contents. A widget can be hidden/shown via setVisible().

==== Tooltip ====
A Tooltip widget displays text when the mouse has been hovering over a widget for a certain amount of time. This widget requires that time be injected within CEGUI via injectTimePulse().

The graphical aspect (the scheme) of the tooltip can be specified via setTooltip(). The amount of hovering time required to activate the tooltip can be specified via setHoverTime(). The amount of time the tooltip is displayed can be specified via setDisplayTime(). And the fade transition time can be specified via setFadeTime(); this affects both the fade in and the fade out times. The tooltip text of a widget can be specified via setTooltipText(). Please note that some complex widgets are composed of several widgets. In order to have a tooltip text displayed while hovering over any region of the complex widget then every component widget needs to have a tooltip text specified. For example a Spinner widget is composed of an Editbox widget and two Button widgets.

==== StaticText ====
There is no StaticText within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed text can be specified via setText(). The color of this text can be specified via the "TextColours" property. The value of this property contains 4 color definitions: top left, top right, bottom left, and bottom right. Each color is specified as a two-digit hexadecimal value of the format AARRGGBB (alpha, red, green, blue). The text is aligned vertically via the "VertFormatting" property with a value of TopAligned, BottomAligned, or VertCentred. The text is aligned horizontally via the "HorzFormatting" property with a value of LeftAligned, RightAligned, HorzCentred, HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, or WordWrapJustified.

==== StaticImage ====
There is no StaticImage within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed image can be specified via the "Image" property. This property takes two parameters, the imageset ("set") and the image name ("image").

==== ProgressBar ====
A ProgressBar widget displays a progression; it does not receive inputs from a user.

The current progress can be specified via setProgress(). Progress can be advanced through steps. The step size can be specified via setStepSize() and a step performed via step(). Progress can be adjusted by a delta value via adjustProgress(). The current progress value can be obtained via getProgress().

==== Button ====
A Button widget displays a text and receives an activation instruction from the user.

The text can be specified via setText().

==== ScrollablePane ====
A ScrollablePane widget displays contents that can be scrolled. Contents can be added via addChildWindow(). When that content exceeds the dimensions of the ScrollablePane then scrollbars appear to allow the use to view and interact with that hidden content.

==== Checkbox ====
A Checkbox widget controls a boolean value; true when checked and false when unchecked. This value can be obtained via isSelected() and specified via setSelected(true) to check or setSelected(false) to uncheck.

==== Spinner ====
A Spinner widget controls a numerical values (float) through an editbox or the use of the increment or decrement buttons.

This value is bounded within a minimum and a maximum by calling setMinimumValue() and setMaximumValue(). The arrow buttons increment or decrement the value by the amount specified with setStepSize(). The numerical value can be displayed in four formats: FloatingPoint, Integer, Hexadecimal, Octal.

The current value is obtained via getCurrentValue() and specified via setCurrentValue().

==== Editbox ====
An Editbox widget controls printable character values; letters, numbers, punctuations, and symbols.

The maximal number of characters that can be specified is bound by setMaxTextLength(). The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). The value can be masked via setTextMasked() and the default value of * can be modified via setMaskCodePoint().

The current value can be obtained via getText() and specified via setText().

==== Slider ====
A Slider widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setMaxValue(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setClickStep().

The current value can be obtained via getCurrentValue() and specified via setCurrentValue().

==== Scrollbar ====
A Scrollbar widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setDocumentSize(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setPageSize(). The arrow buttons increment or decrement the value by the amount specified with setStepSize().

The current value can be obtained via getScrollPosition() and specified via setScrollPosition(). Note that the actual maximum value that the scrollbar will return is set by the following formula: document_size - page_size. Thus, a document of size 100 and a page size of 10 will have a value from 0 to 90.

==== MultiLineEditbox ====
A MultiLineEditbox widget controls printable character values; letters, numbers, punctuations, and symbols.

Unlike the Editbox widget there is no maximal number of characters that can be specified. The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). Text can be automatically wrapped via a call to setWordWrapping(true).

The current value can be obtained via getText() and specified via setText().

==== RadioButton ====
A RadioButton widget controls a single selection among many choices.

The choices are grouped by calling setGroupID(). Only one RadioButton per group ID can be selected; this widget does not support multiple selection. However it is possible for a choice to possess no decision; initially every RadioButton of a group is unselected.

The currently selected RadioButton can be obtained via getSelectedButtonInGroup(). This RadioButton pointer can then be used to query the ID via getID(), the text (visible label of the RadioButton) via getText(), or user data via getUserData(). A RadioButton can be selected via setSelected(true). Passing false will deselect the RadioButton, potentially making every RadioButton of the group unselected.

==== Listbox ====
A Listbox widget controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setMultiselectEnabled().

The choices are listbox text items (ListboxTextItem) added to the listbox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage(). The call to ensureItemIsVisible() ensures that the item is visible; the listbox will automatically scroll down if necessary. The text of the ListboxTextItem can be changed via the setText() function. However this new text will not be displayed until you call the Listbox's handleUpdatedItemData() function.

The selected ListboxItem can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). A selection can be specified via setItemSelectState().

It is possible for a Listbox to contain list items that are not simply composed of text. [http://www.cegui.org.uk/wiki/index.php/Create_a_CheckListboxItem CheckListboxItem] demonstrates this advanced feature.

==== Combobox ====
A Combobox widget controls a single selection among many choices.

The choices are listbox text items (ListboxTextItem) added to the combobox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage().

The value of the text within the Editbox can be obtained via getText() and the last selected ListboxItem can be obtained via getSelectedItem(). However there is no guarantee that both are synchronized; typing text within the Editbox will not automatically select the corresponding ListboxItem. Fortunately the reverse is not true; selecting a ListboxItem will place that text within the Editbox. Placing the Editbox in read-only mode with setReadOnly(true) can avoid problems. The current value can be specified via listboxTextItem->setSelected(true) and a setText(itemCombobox->getText()).

==== MultiColumnList ====
A MultiColumnList widget controls controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setSelectionMode(MultiColumnList::RowMultiple).

A MultiColumnList widget may contain a single column or multiple columns. Columns are added via addColumn(), specifying a label, a column ID, and a column width.

Three steps are required to add a row. The first step is to add a new row with addRow(). The second step is to create a ListboxTextItem for each cell of the row and specify the selection indicator via setSelectionBrushImage(). The third step is to add the newly created ListboxTextItem to the MultiColumnList via setItem(), specifying the ListboxTextItem, the column ID, and the row ID.

The selected row can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). This will iterate through every selected cell, returning each selected ListboxTextItem . A selection can be specified via setItemSelectState(); by setting the selection mode to rows (either RowSingle or RowMultiple) you actually only need to select the ListboxTextItem of the first column.

==== TabControl ====
A TabControl widget allows multiple windows to be displayed one at a time, via tab buttons.

Two objects must be created within the Layout Editor to generate a functional tab control. The first is a window of type "TabControl". This will be the parent window of the tab buttons as well as the pages. The second is a window of type "DefaultWindow". This window will be placed within the TabControl (in code via addTab(), not through the Layout Editor) and will specify the contents of a page. Widgets are to be placed within these TabPane via the Layout Editor. The "TabButton" windows are not to be specified via the Layout Editor since they will be automatically created when a TabPane is added to the TabControl.

In this demo the TabControl widget was placed within a FrameWindow. This is not a requirement. It could have just easily been placed alongside the widgets of the other window.

==== Menu & Popup Menu ====

See [[http://www.cegui.org.uk/wiki/index.php/MenuAndPopup Menu & Popup Menu]]

=== Files ===

==== WidgetGalore.h ====
<code><cpp/>
#ifndef _WidgetGalore_h_
#define _WidgetGalore_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("WidgetGalore.layout");
sheet->addChildWindow(guiLayout);

/* Tooltip */
System::getSingleton().setDefaultTooltip("TaharezLook/Tooltip"); // Set the name of the default tooltip
Tooltip* tooltip = System::getSingleton().getDefaultTooltip();
tooltip->setHoverTime(0.5f); // Display the tooltip after the mouse has been hovering over the widget for half a second
tooltip->setDisplayTime(10.0f); // Display for 15 seconds then disappear
tooltip->setFadeTime(1.0f); // Duration of the transition between fully visible and fully invisible
// To set the tooltip text for a window simply call setTooltipText() see staticText for an example

/* StaticText */
DefaultWindow* staticText = static_cast<DefaultWindow*>(winMgr.getWindow("StaticText"));
staticText->setText("Red Static Text");
staticText->setProperty("TextColours", "tl:FFFF0000 tr:FFFF0000 bl:FFFF0000 br:FFFF0000"); // aarrggbb in Hexadecimal
// tl: top left, tr: top right, bl: bottom left, br: bottom right
staticText->setProperty("VertFormatting", "VertCentred"); // TopAligned, BottomAligned, VertCentred
staticText->setProperty("HorzFormatting", "HorzCentred"); // LeftAligned, RightAligned, HorzCentred
// HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified
staticText->setTooltipText("This is a StaticText widget");

/* StaticImage */
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForStaticImage", "GPN-2000-001437.tga");
DefaultWindow* staticImage = static_cast<DefaultWindow*>(winMgr.getWindow("StaticImage"));
staticImage->setProperty("Image", "set:ImageForStaticImage image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()

/* ProgressBar */
ProgressBar* progressBar = static_cast<ProgressBar*>(winMgr.getWindow("ProgressBar"));
progressBar->setProgress(0.25f); // Initial progress of 25%
progressBar->setStepSize(0.10f); // Calling step() will increase the progress by 10%
progressBar->step(); // Advance the progress by the size specified in setStepSize()
progressBar->adjustProgress(-0.05f); // Adjust the progress by a delta value rather than setting a new value through setProgress
float valueProgressBar = progressBar->getProgress(); // initial 0.25f + step 0.10f - adjustment 0.05f = 0.30f

/* Button */
PushButton* btnClose = static_cast<PushButton*>(winMgr.getWindow("btnClose"));
btnClose->setText("Exit");

/* ScrollablePane */
ScrollablePane* scrollablePane = static_cast<ScrollablePane*>(winMgr.getWindow("ScrollablePane"));
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForScrollablePane", "GPN-2000-001437.tga");
DefaultWindow* staticImageInScrollablePane = static_cast<DefaultWindow*>(winMgr.createWindow("TaharezLook/StaticImage", "StaticImageInScrollablePane"));
staticImageInScrollablePane->setProperty("Image", "set:ImageForScrollablePane image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()
staticImageInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Start in the upper left corner
staticImageInScrollablePane->setWidth(UDim(2.0f, 0.0f)); // Twice the width of the parent, the ScrollablePane
staticImageInScrollablePane->setHeight(UDim(2.0f, 0.0f)); // Twice the height of the parent, the ScrollablePane
scrollablePane->addChildWindow(staticImageInScrollablePane); // Add the image to the // Twice the width of the parent, the ScrollablePane
Editbox* editboxInScrollablePane = static_cast<Editbox*>(winMgr.createWindow("TaharezLook/Editbox", "EditboxInScrollablePane"));
editboxInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(2.1f, 0.0f))); // Start below the image
editboxInScrollablePane->setWidth(UDim(2.0f, 0.0f));
editboxInScrollablePane->setHeight(UDim(0.3f, 0.0f));
scrollablePane->addChildWindow(editboxInScrollablePane);

/* Check box */
Checkbox* checkbox = static_cast<Checkbox*>(winMgr.getWindow("Checkbox"));
checkbox->setSelected( true );
bool valueCheckbox = checkbox->isSelected(); // Retrieve whether it is checked

/* Spinner */
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));
spinner->setTextInputMode(Spinner::FloatingPoint); // FloatingPoint, Integer, Hexadecimal, Octal
spinner->setMinimumValue(-10.0f);
spinner->setMaximumValue(10.0f);
spinner->setStepSize(0.2f);
spinner->setCurrentValue(5.2f);
float valueSpinner = spinner->getCurrentValue(); // Retrieve the value

/* Editbox */
Editbox* editbox = static_cast<Editbox*>(winMgr.getWindow("Editbox"));
editbox->setText("Editbox values");
editbox->setMaxTextLength(13); // The trailing 's' will not be displayed
editbox->setReadOnly(false);
editbox->setTextMasked(false);
editbox->setMaskCodePoint(0x002A); // *
String valueEditbox = editbox->getText(); // Retrieve the text

/* Slider */
Slider* slider = static_cast<Slider*>(winMgr.getWindow("Slider"));
slider->setMaxValue(100.0f);
slider->setClickStep(10.0f);
slider->setCurrentValue(20.0f);
float valueSlider = slider->getCurrentValue(); // Retrieve the value

/* Scrollbar (Horizontal) */
Scrollbar* scrollbarHorizontal = static_cast<Scrollbar*>(winMgr.getWindow("HorizontalScrollbar"));
scrollbarHorizontal->setDocumentSize(100.0f);
scrollbarHorizontal->setPageSize(10.0f);
scrollbarHorizontal->setStepSize(1.0f);
scrollbarHorizontal->setScrollPosition(75.0f);
float valueScrollbarHorizontal = scrollbarHorizontal->getScrollPosition(); // Retrieve the scroll position

/* Scrollbar (Vertical) */
Scrollbar* scrollbarVertical = static_cast<Scrollbar*>(winMgr.getWindow("VerticalScrollbar"));
scrollbarVertical->setDocumentSize(100.0f);
scrollbarVertical->setPageSize(10.0f);
scrollbarVertical->setStepSize(1.0f);
scrollbarVertical->setScrollPosition(25.0f);
float valueScrollbarVertical = scrollbarVertical->getScrollPosition(); // Retrieve the scroll position

/* MultiLineEditbox */
MultiLineEditbox* multiLineEditbox = static_cast<MultiLineEditbox*>(winMgr.getWindow("MultiLineEditbox"));
multiLineEditbox->setText("MultiLineEditbox value");
multiLineEditbox->setReadOnly(false);
multiLineEditbox->setWordWrapping(true);
String valueMultiLineEditbox = multiLineEditbox->getText(); // Retrieve the text

/* RadioButton */
RadioButton* radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A"));
radioButton->setGroupID(1);
radioButton->setID(101);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_B"));
radioButton->setGroupID(1);
radioButton->setID(102);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_C"));
radioButton->setGroupID(1);
radioButton->setID(103);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_1"));
radioButton->setGroupID(2);
radioButton->setID(201);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_2"));
radioButton->setGroupID(2);
radioButton->setID(202);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3"));
radioButton->setGroupID(2);
radioButton->setID(203);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A")); // Get handle of one radio button from the group
uint valueRadioButtonLetters = radioButton->getSelectedButtonInGroup()->getID(); // Get selected ID
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3")); // Can obtain the handle of any radio button in the group
uint valueRadioButtonNumbers = radioButton->getSelectedButtonInGroup()->getID();
radioButton->setSelected(true); // Specify which button should appear selected by default

/* Listbox */
Listbox* listbox = static_cast<Listbox*>(winMgr.getWindow("Listbox"));
listbox->setMultiselectEnabled(false);
ListboxTextItem* itemListbox = new ListboxTextItem("Value A", 1);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value B", 2);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value C", 3);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value D", 4);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
listbox->setItemSelectState(itemListbox, true);
listbox->ensureItemIsVisible(itemListbox);
uint valueListbox = listbox->getFirstSelectedItem()->getID(); // Retrieve the ID of the selected listbox item

/* Combobox */
Combobox* combobox = static_cast<Combobox*>(winMgr.getWindow("Combobox"));
combobox->setReadOnly(true);
ListboxTextItem* itemCombobox = new ListboxTextItem("Value 1", 1);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 2", 2);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox->setSelected(true); // Select this item
combobox->setText(itemCombobox->getText()); // Copy the item's text into the Editbox
itemCombobox = new ListboxTextItem("Value 3", 3);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 4", 4);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
String valueCombobox = combobox->getText(); // Retrieve the displayed text
uint idCombobox = combobox->getSelectedItem()->getID(); // Retrieve the ID of the selected combobox item

/* MultiColumnList */
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("MultiColumnList"));\
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));
multiColumnList->setSelectionMode(MultiColumnList::RowSingle); // MultiColumnList::RowMultiple
ListboxTextItem* itemMultiColumnList;
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A1", 101);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B1", 102);
//itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
// By commenting the line above a cell does not specify a selection indicator
// selecting that line will show a "gap" in the selection.
multiColumnList->setItem(itemMultiColumnList, 1, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C1", 103);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 0); // ColumnID, RowID
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A2", 201);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B2", 202);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 1, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C2", 203);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 1); // ColumnID, RowID
MCLGridRef grid_ref(1, 0); // Select according to a grid reference; second row
multiColumnList->setItemSelectState(grid_ref, true);
ListboxItem* listboxItem = multiColumnList->getFirstSelectedItem();
uint valueColumnA = listboxItem->getID(); // Retrieve the value of the selected item from column A
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnB = listboxItem->getID(); // Retrieve the value of the selected item from column B
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnC = listboxItem->getID(); // Retrieve the value of the selected item from column C

/* TabControl */
TabControl* winTabControl = static_cast<TabControl*>(winMgr.getWindow("TabControl"));
winTabControl->setTabHeight(UDim(0.15f, 0.0f)); // Make the tab buttons a little bigger
Window* tabPage = winMgr.getWindow("TabPane1");
tabPage->setText("Page 1");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f))); // Size to 100% of its parent, the TabControl
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Move to the upper left corner of its parent
winTabControl->addTab(tabPage);
tabPage = winMgr.getWindow("TabPane2");
tabPage->setText("Page 2");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f)));
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f)));
winTabControl->addTab(tabPage);

}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}
};

#endif // _WidgetGalore_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "WidgetGalore.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== WidgetGalore.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="Text" >1</Property>
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="DefaultWindow" Name="TabPane2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.7185,0},{0.97875,0},{0.9685,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >In Page 2:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winTabControl" >
<Property Name="Text" >Tab Control Window</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.695627,0},{0.2725,0},{0.993122,0},{0.704167,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/TabControl" Name="TabControl" >
<Property Name="TabHeight" Value="{0,0}" />
<Property Name="TabTextPadding" Value="{0,0}" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.088566,0},{0.174378,0},{0.931404,0},{0.804637,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="btnOk" >
<Property Name="Text" >Ok</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.128412,0},{0.841464,0},{0.365583,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnCancel" >
<Property Name="Text" >Cancel</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.400429,0},{0.841464,0},{0.637601,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnApply" >
<Property Name="Text" >Apply</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.668224,0},{0.843977,0},{0.905394,0},{0.928516,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
</Window>
<Window Type="DefaultWindow" Name="TabPane1" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.012178,0},{0.97875,0},{0.262178,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage1" >
<Property Name="Text" >In Page 1:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage1" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winWidgets" >
<Property Name="Text" >Dave, it's full of widgets!</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00375,0},{0.143333,0},{0.751248,0},{0.806665,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="btnClose" >
<Property Name="Text" >Close</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.895137,0},{0.976465,0},{0.975697,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Editbox" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.62442,0},{0.090471,0},{0.969776,0},{0.153443,0}}" />
</Window>
<Window Type="TaharezLook/Checkbox" Name="Checkbox" >
<Property Name="Text" >Check</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.396859,0},{0.944201,0},{0.453147,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Combobox" >
<Property Name="Text" >Combo Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.090471,0},{0.613522,0},{0.413287,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_A" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >A</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.652856,0},{0.189876,0},{0.704964,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_B" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >B</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.707569,0},{0.189876,0},{0.759678,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_C" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >C</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.761542,0},{0.189876,0},{0.813651,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >1</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.189876,0},{0.897272,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >2</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.245152,0},{0.897272,0},{0.30144,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >3</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.300429,0},{0.897272,0},{0.356717,0}}" />
</Window>
<Window Type="TaharezLook/HorizontalScrollbar" Name="HorizontalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.185427,0},{0.613522,0},{0.26206,0}}" />
</Window>
<Window Type="TaharezLook/VerticalScrollbar" Name="VerticalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.026087,0},{0.090471,0},{0.082106,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Listbox" Name="Listbox" >
<Property Name="Text" >List Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.626634,0},{0.427903,0},{0.876634,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiColumnList" Name="MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.271357,0},{0.816779,0},{0.551507,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiLineEditbox" Name="MultiLineEditbox" >
<Property Name="Text" >
</Property>
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.626634,0},{0.706566,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/ProgressBar" Name="ProgressBar" >
<Property Name="StepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="CurrentProgress" Value="0" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.559296,0},{0.816779,0},{0.608291,0}}" />
</Window>
<Window Type="TaharezLook/Slider" Name="Slider" >
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="1" />
<Property Name="ClickStepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.099415,0},{0.090471,0},{0.155434,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="Spinner" >
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.48995,0},{0.944201,0},{0.551507,0}}" />
</Window>
<Window Type="TaharezLook/StaticImage" Name="StaticImage" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.626634,0},{0.976465,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="StaticText" >
<Property Name="Text" >Static Text</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.895137,0},{0.706566,0},{0.975697,0}}" />
</Window>
<Window Type="TaharezLook/ScrollablePane" Name="ScrollablePane" >
<Property Name="ContentArea" Value="l:0 t:0 r:0 b:0" />
<Property Name="HorzStepSize" Value="0.1" />
<Property Name="VertStepSize" Value="0.1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="HorzOverlapSize" Value="0.01" />
<Property Name="UnifiedAreaRect" Value="{{0.019063,0},{0.629399,0},{0.157023,0},{0.879399,0}}" />
<Property Name="VertOverlapSize" Value="0.01" />
<Property Name="HorzScrollPosition" Value="0" />
<Property Name="VertScrollPosition" Value="0" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Dynamic Fonts

2008-02-01T13:11:48Z

Rackle: /* DynamicFont.h */

===Introduction===
The datafiles\fonts folder contains static font definitions such as Commonwealth-10.font. The XML contents of that file specify one particular font, mainly a logical name (Commonwealth-10), a filename (Commonv2c.ttf), and a size (10). To load this static font definition you'd write the following line of code:
<code>
CEGUI::FontManager::getSingleton().createFont("Commonwealth-10.font");
</code>

This works well, but sometimes you need to display a same font in various sizes. One approach is to create multiple .font files, one per font size. But there is a better approach, a way to dynamically create fonts.

Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=13350 DynamicFont]

===Files===

====DynamicFont.h====
<code></cpp>
#ifndef _DynamicFont_h_
#define _DynamicFont_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIXMLAttributes.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("DynamicFont.layout");
sheet->addChildWindow(guiLayout);

// Configure the event for the list of created fonts
CEGUI::Combobox* existingFonts = static_cast<CEGUI::Combobox*>(winMgr.getWindow("DynamicFont/Fonts"));
existingFonts->subscribeEvent(CEGUI::Combobox::EventListSelectionAccepted, CEGUI::Event::Subscriber(&DemoSample::eventSelectExistingFont, this));

// Configure the event for the add button
CEGUI::PushButton* add = static_cast<CEGUI::PushButton*>(winMgr.getWindow("DynamicFont/Add"));
add->subscribeEvent(CEGUI::PushButton::EventMouseClick, CEGUI::Event::Subscriber(&DemoSample::eventAddFont, this));

// Add the font previously created
addExistingFont("Commonwealth-10");
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

bool eventAddFont(const CEGUI::EventArgs& args)
{
// Add a font from the specified parameters
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();
Window* nameText = winMgr.getWindow("DynamicFont/Name");
Window* filenameText = winMgr.getWindow("DynamicFont/Filename");
Window* sizeText = winMgr.getWindow("DynamicFont/Size");

setFont(nameText->getText(), filenameText->getText(), sizeText->getText());
return true;
}

void addExistingFont(const CEGUI::String& pName)
{
// Once a font has been created we add it to the combobox of fonts
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

Combobox* existingFonts = static_cast<CEGUI::Combobox*>(winMgr.getWindow("DynamicFont/Fonts"));
ListboxTextItem* itemCombobox = new ListboxTextItem(pName);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
itemCombobox->setSelected(true);
existingFonts->addItem(itemCombobox);
}

bool eventSelectExistingFont(const CEGUI::EventArgs& args)
{
// Use an already created font
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Combobox* existingFonts = static_cast<CEGUI::Combobox*>(winMgr.getWindow("DynamicFont/Fonts"));
setFont(existingFonts->getText(), "", "");
return true;
}

void setFont(const CEGUI::String& pName, const CEGUI::String& pFilename, const CEGUI::String& pSize)
{
// Set the font displayed within the multiline editbox
using namespace CEGUI;

String sampleText(pName);

WindowManager& winMgr = WindowManager::getSingleton();
CEGUI::Window* text = winMgr.getWindow("DynamicFont/Text");
Font* font;

if(FontManager::getSingleton().isFontPresent(pName))
{
// Select a previously created font
font = FontManager::getSingleton().getFont(pName);
}
else
{
// Dynamically create a new font
XMLAttributes xmlAttributes;

// Attributes specified within CEGUIFont.cpp
xmlAttributes.add("Name", pName);
xmlAttributes.add("Filename", pFilename);
xmlAttributes.add("ResourceGroup", "");
xmlAttributes.add("AutoScaled", "true");
xmlAttributes.add("NativeHorzRes", "800");
xmlAttributes.add("NativeVertRes", "600");

// Attributes specified within CEGUIXMLAttributes.cpp
xmlAttributes.add("Size", pSize);
xmlAttributes.add("AntiAlias", "true");

try
{
font = FontManager::getSingleton().createFont("FreeType", xmlAttributes);
if(font)
{
font->load(); // This function must be used
addExistingFont(pName);
}
}
catch(Exception &e)
{
// Display the error message
sampleText = e.getMessage();
}
}

text->setFont(font);
text->setText(sampleText);
}

private:
};

#endif // _DynamicFont_h_
</code>

====main.cpp====
<code></cpp>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "DynamicFont.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}</code>

====DynamicFont.layout====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="TaharezLook/FrameWindow" Name="DynamicFont" >
<Property Name="Text" Value="Dynamic Font" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.02,0},{0.054167,0},{0.98,0},{0.781251,0}}" />
<Window Type="TaharezLook/MultiLineEditbox" Name="DynamicFont/Text" >
<Property Name="Text" >
</Property>
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.075,0},{0.99,0},{0.715617,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DynamicFont/NameLabel" >
<Property Name="Text" Value="Name:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.018409,0},{0.881661,0},{0.0809004,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="DynamicFont/Name" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.0809,0},{0.881661,0},{0.328819,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DynamicFont/FilenameLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Filename:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.347544,0},{0.881661,0},{0.438807,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="DynamicFont/Filename" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.438807,0},{0.881661,0},{0.713682,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DynamicFont/SizeLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Size:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.731982,0},{0.881661,0},{0.793499,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="DynamicFont/Size" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.793499,0},{0.881661,0},{0.858294,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DynamicFont/Add" >
<Property Name="Text" Value="Add" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.867109,0},{0.881661,0},{0.974324,0},{0.968338,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DynamicFont/FontsLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Fonts:" />
<Property Name="HorzFormatting" Value="RightAligned" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.018409,0},{0.768338,0},{0.0859395,0},{0.855015,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="DynamicFont/Fonts" >
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.085939,0},{0.768338,0},{0.974324,0},{0.994412,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
</Window>
</GUILayout>
</pre>

Moving any Window

2008-02-01T13:11:31Z

Rackle: /* MovingAnyWindow.h */

=== Introduction ===
This bit of code shows how you can play with the Cegui events to move any window, not just FrameWindows.

The current implementation listens for a right mouse click. When a CEGUI::Window* is right clicked it is flagged as being a "moving window". The GUI Sheet then subscribes to mouse move events, and upon a mouse movement event the "moving window"'s position is changed appropriately. Right clicking again releases the window.

A better implementation would be to have a border around the edge of the window. When the cursor would be positioned above that border it would display a moving cursor. Dragging (pressing down and holding the left mouse button) while above that border would move the window around.

=== Files ===
==== MovingAnyWindow.h ====
<code><cpp/>
#ifndef _00MovingAnyWindow_h_
#define _00MovingAnyWindow_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class DemoSample : public CEGuiSample
{
public:
// method to initialise the sample windows and events.
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
Scheme* currentScheme = SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Initially we are not moving any window
mMovingWindow = 0;

// We have not yet clicked on the button
mClickCount = 0;

// Create a button
PushButton* pushButton = static_cast<PushButton*>(winMgr.createWindow("TaharezLook/Button", "Pushbutton"));
sheet->addChildWindow(pushButton);
pushButton->setPosition(UVector2(cegui_reldim(0.81f), cegui_reldim( 0.32f)));
pushButton->setSize(UVector2(cegui_reldim(0.15f), cegui_reldim( 0.2f)));
pushButton->setText("Click");
pushButton->subscribeEvent(CEGUI::PushButton::EventMouseClick, Event::Subscriber(&DemoSample::onRightClick, this));
pushButton->subscribeEvent(CEGUI::PushButton::EventClicked, Event::Subscriber(&DemoSample::onLeftClick, this));

// Create a multicolum list
MultiColumnList* mcl = static_cast<MultiColumnList*>(winMgr.createWindow("TaharezLook/MultiColumnList", "MultiColumnList"));
sheet->addChildWindow(mcl);
mcl->setPosition(UVector2(cegui_reldim(0.01f), cegui_reldim( 0.1f)));
mcl->setSize(UVector2(cegui_reldim(0.5f), cegui_reldim( 0.8f)));
mcl->subscribeEvent(CEGUI::MultiColumnList::EventMouseClick, Event::Subscriber(&DemoSample::onRightClick, this));
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

// method to perform any required cleanup operations.
void cleanupSample(void)
{
}

bool onRightClick(const CEGUI::EventArgs& pEventArgs)
{
using namespace CEGUI;
const MouseEventArgs mouseEventArgs = static_cast<const MouseEventArgs&>(pEventArgs);
if(mouseEventArgs.button == CEGUI::RightButton)
{
if(mMovingWindow)
{
// We were moving a window, stop doing so on a second right click
mMovingEvent->disconnect();
mMovingWindow = 0;
}
else
{
// Start moving a window when right clicking
const WindowEventArgs windowEventArgs = static_cast<const WindowEventArgs&>(pEventArgs);
mMovingWindow = windowEventArgs.window;
mMovingEvent = System::getSingleton().getGUISheet()->subscribeEvent(CEGUI::Window::EventMouseMove, Event::Subscriber(&DemoSample::onWindowMove, this));
mMousePosInWindow = CoordConverter::screenToWindow(*mMovingWindow, MouseCursor::getSingleton().getPosition());
}
return false; // Do not propagate this event to other subscribers
}
return true;
}

bool onLeftClick(const CEGUI::EventArgs& pEventArgs)
{
// This is to check that the event is not propagated
using namespace CEGUI;
const WindowEventArgs windowEventArgs = static_cast<const WindowEventArgs&>(pEventArgs);
++mClickCount;
windowEventArgs.window->setText("Click " + CEGUI::PropertyHelper::intToString(mClickCount));
return true;
}

bool onWindowMove(const CEGUI::EventArgs& pEventArgs)
{
using namespace CEGUI;
const MouseEventArgs mouseEventArgs = static_cast<const MouseEventArgs&>(pEventArgs);
Vector2 localMousePos = CoordConverter::screenToWindow(*mMovingWindow, mouseEventArgs.position);
UVector2 mouseMoveOffset(cegui_absdim(localMousePos.d_x), cegui_absdim(localMousePos.d_y));
UVector2 mouseOffsetInWindow(cegui_absdim(mMousePosInWindow.d_x), cegui_absdim(mMousePosInWindow.d_y));
mMovingWindow->setPosition(mMovingWindow->getPosition() + mouseMoveOffset - mouseOffsetInWindow);
return true;
}

private:
CEGUI::Window* mMovingWindow;
CEGUI::Event::Connection mMovingEvent;
CEGUI::Vector2 mMousePosInWindow;
int mClickCount;
};

#endif // _00MovingAnyWindow_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "MovingAnyWindow.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

Most important events

2008-02-01T13:10:54Z

Rackle: /* EventGalore.h */

This article is going to show you the most important and usefull events of each widget.

===Getting started===
I'm only going to change the initialiseSample function for each widget + adding some others.
====EventGalore.h====
<code><cpp/>
#ifndef _EventGalore_h_
#define _EventGalore_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class EventGalore : public CEGuiSample
{
public:
bool initialiseSample()
{
try
{
using namespace CEGUI;

WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Place here the code from the widgets, place functions below this function.

}
catch(CEGUI::Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}
return true;
}
void cleanupSample(void)
{
}
};
#endif // _EventGalore_h_
</code>

====main.cpp====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "EventGalore.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
EventGalore app;
return app.run();
}
</code>

===Widgets===

====Window====

The Window widget is a important baseclass, all widgets inherit this class. It has lots 'n lots of events, where a few are introduced by other widgets, and where many are unimportant. If a event is taken from this Window class, it is mentioned.

* EventDragDropItemEnters - Fired when a drag and drop item floats over the window.
* EventDragDropItemLeaves - Fired when a drag and drop item floats out of the window.
* EventDragDropItemDropped - Fired when the item has been dropped on the window.

====PushButton====

The button is a simple, expected widget. It contains only one important event, but we are going to add a few more.

* EventClicked - Fired when the button has been clicked.
* EventMouseEnters - Fired when the mouse enters the widget. Inherited from Window.
* EventMouseLeaves - Fired when the mouse leaves the widget. Inherited from Window.

<code><cpp/>
PushButton * pushButton = static_cast<PushButton*>(winMgr.createWindow("TaharezLook/Button", "Button1"));
sheet->addChildWindow(pb);
pushButton->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
pushButton->setSize(UVector2(cegui_reldim(0.2f), cegui_reldim(0.08f)));
pushButton->setText("Hey! Come here!");

pushButton->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&EventGalore::onPushButtonClicked, this));
pushButton->subscribeEvent(PushButton::EventMouseEnters, Event::Subscriber(&EventGalore::onMouseEnters, this));
pushButton->subscribeEvent(PushButton::EventMouseLeaves, Event::Subscriber(&EventGalore::onMouseLeaves, this));
</code>
<code><cpp/>
bool onPushButtonClicked(const CEGUI::EventArgs &e)
{
// Our button has been clicked!
CEGUI::PushButton * pushButton = static_cast<CEGUI::PushButton*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Button1"));
pushButton->setText("We got clicked!");
return true;
}

bool onMouseEnters(const CEGUI::EventArgs &e)
{
// Mouse has entered the button. (Hover)
CEGUI::PushButton * pushButton = static_cast<CEGUI::PushButton*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Button1"));
pushButton->setText("Now click!");
return true;
}

bool onMouseLeaves(const CEGUI::EventArgs &e)
{
// Mouse has left the button.
CEGUI::PushButton * pushButton = static_cast<CEGUI::PushButton*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Button1"));
// Back to its original state!
pushButton->setText("Hey! Come here!");
return true;
}
</code>

====Listbox====

The listbox is a very usefull listing widget. Only has one important event.

* EventSelectionChanged - Fired when a or another item has been selected.

<code><cpp/>
Listbox * listBox = static_cast<Listbox*>(winMgr.createWindow("TaharezLook/Listbox", "Listbox1"));
sheet->addChildWindow(listBox);

listBox->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
listBox->setSize(UVector2(cegui_reldim(0.4f), cegui_reldim(0.4f)));

ListboxTextItem * listBoxItem = new ListboxTextItem("Our very first item.", 1);
listBoxItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listBox->addItem(listBoxItem);

listBoxItem = new ListboxTextItem("Our second item.", 2);
listBoxItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listBox->addItem(listBoxItem);

listBox->subscribeEvent(Listbox::EventSelectionChanged, Event::Subscriber(&EventGalore::onSelectionChanged, this));
</code>
<code><cpp/>
bool onSelectionChanged(const CEGUI::EventArgs &e)
{
// The selection has changed.
CEGUI::Listbox * listBox = static_cast<CEGUI::Listbox*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Listbox1"));
// Get the item we selected
CEGUI::ListboxItem * selectedItem = listBox->getFirstSelectedItem();
selectedItem->setText("Oh we got selected!");

return true;
}
</code>

====Checkbox====

A checkable item useful for boolean(true or false) 'questions'.

* EventCheckStateChanged - Fired when the checkbox got checked or un-checked.
* EventMouseEnters - Fired when the mouse hovers over the checkbox. Inherited from Window.
* EventMouseLeaves - Fired when the mouse moves out of the checkbox. Inherited from Window.

<code><cpp/>
Checkbox * checkBox = static_cast<Checkbox*>(winMgr.createWindow("TaharezLook/Checkbox", "Checkbox1"));
sheet->addChildWindow(checkBox);
checkBox->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
checkBox->setSize(UVector2(cegui_reldim(0.4f), cegui_reldim(0.1f)));

// A question where people can only answer yes or no (true or false)
checkBox->setText("Hey! Do you want to be rich?");

checkBox->subscribeEvent(Checkbox::EventCheckStateChanged, Event::Subscriber(&EventGalore::onCheckStateChanged, this));
checkBox->subscribeEvent(Checkbox::EventMouseEnters, Event::Subscriber(&EventGalore::onMouseEnters, this));
checkBox->subscribeEvent(Checkbox::EventMouseLeaves, Event::Subscriber(&EventGalore::onMouseLeaves, this));
</code>
<code><cpp/>
bool onCheckStateChanged(const CEGUI::EventArgs &e)
{
// Our item has been checked or unchecked, update our item accordingly.
updateCheckbox();
return true;
}

bool onMouseEnters(const CEGUI::EventArgs &e)
{
// The mouse has entered, update the checkbox accordingly.
updateCheckbox();
return true;
}

bool onMouseLeaves(const CEGUI::EventArgs &e)
{
CEGUI::Checkbox * checkBox = static_cast<CEGUI::Checkbox*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Checkbox1"));
// Reset
checkBox->setText("Hey! Do you want to be rich?");
return true;
}

void updateCheckbox()
{
CEGUI::Checkbox * checkBox = static_cast<CEGUI::Checkbox*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Checkbox1"));

if (checkBox->isSelected())
{
// Our checkbox is selected, so someone has previously said 'yes'.
checkBox->setText("Click to choose no!");
}
else
{
// Our item is not selected, so someone hasn't done anything yet, or it has been previously
// unchecked.
checkBox->setText("Click to choose yes!");
}
}
</code>
This might confuse at first sight. Let me go through this here, in steps.
* First, our checkbox is created and our mouse remains still.
* Second, the mouse enters the checkbox, updateCheckbox is called. In this case, our checkbox isn't selected by default, so the text becomes 'Click to choose yes!'.
* Third, we click. The onCheckStateChanged function is called, and that function calls updateCheckbox again to instantly change the text again. We have clicked the checkbox, while it wasn't previously checked, this means its checked now. Text becomes 'Click to choose no!'.
* Fourth, we move our mouse away from the checkbox. The onMouseLeaves function is called, where we reset the text to our question.

====RadioButton====

Similar to Checkbox, only it can be grouped, and once selected, it cannot be unselected (except when another button has been selected). Note, in this case, both functions are called when you click the unselected radiobutton. This is because one is unselected and one is selected.

* EventSelectStateChanged - Fired when the radiobutton has been selected.

<code><cpp/>
RadioButton * radioButton = static_cast<RadioButton*>(winMgr.createWindow("TaharezLook/RadioButton", "RadioButton1"));
sheet->addChildWindow(radioButton);

radioButton->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
radioButton->setSize(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
radioButton->setText("Yes");
radioButton->setGroupID(0);

radioButton->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&EventGalore::onButton1SelectChanged, this));
// To make sure the event is fired.
radioButton->setSelected(true);

radioButton = static_cast<RadioButton*>(winMgr.createWindow("TaharezLook/RadioButton", "RadioButton2"));
sheet->addChildWindow(radioButton);

radioButton->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.2f)));
radioButton->setSize(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
radioButton->setText("No");
radioButton->setGroupID(0);

radioButton->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&EventGalore::onButton2SelectChanged, this));
</code>
<code><cpp/>
bool onButton1SelectChanged(const CEGUI::EventArgs &e)
{
CEGUI::RadioButton * radioButton1 = static_cast<CEGUI::RadioButton*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("RadioButton1"));

if (radioButton1->isSelected())
{
// This one just got selected.
radioButton1->setText("Ok then. Yes it is.");
}
else
{
// This one got unselected. Reset it.
radioButton1->setText("Yes");
}
return true;
}

bool onButton2SelectChanged(const CEGUI::EventArgs &e)
{
// We have chosen no.
CEGUI::RadioButton * radioButton2 = static_cast<CEGUI::RadioButton*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("RadioButton2"));

if (radioButton2->isSelected())
{
// This one just got selected.
radioButton2->setText("Ok then. No it is.");
}
else
{
// This one got unselected. Reset it.
radioButton2->setText("No");
}
return true;
}
</code>

====Editbox====

A simple editable box where text can be entered.

* EventTextAccepted - Fired when someone has pressed TAB or RETURN, or when someone has clicked another window.

<code><cpp/>
Editbox * editBox = static_cast<Editbox*>(winMgr.createWindow("TaharezLook/Editbox", "Editbox1"));
sheet->addChildWindow(editBox);

editBox->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
editBox->setSize(UVector2(cegui_reldim(0.4f), cegui_reldim(0.1f)));
editBox->setText("Edit me!");

editBox->subscribeEvent(Editbox::EventTextAccepted, Event::Subscriber(&EventGalore::onTextAccepted, this));
</code>
<code><cpp/>
bool onTextAccepted(const CEGUI::EventArgs &e)
{
// Our text has been accepted by either deactivating it or pressing tab or enter.
CEGUI::Editbox * editBox = static_cast<CEGUI::Editbox*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("Editbox1"));
// So we got the text here, do something with it. Lets just..put the text back in reverse order.
CEGUI::String currentText = editBox->getText();

std::string finalString;

CEGUI::String::reverse_iterator ppkNode = currentText.rbegin();
CEGUI::String::reverse_iterator ppkEnd = currentText.rend();

for (; ppkNode != ppkEnd; ++ppkNode)
{
finalString.push_back((*ppkNode));
}
editBox->setText(finalString);
return true;
}
</code>

====MultiLineEditbox====

This widget is pretty much the same as editbox, but allows more lines.

* EventTextChanged - Fired when text has been changed. Inherited from window.

This widget doesn't have the event TextAccepted, so you'll need to 'apply' the input by a button for example.

<code><cpp/>
MultiLineEditbox * multiLineEditbox = static_cast<MultiLineEditbox*>(winMgr.createWindow("TaharezLook/MultiLineEditbox", "MultiEditbox1"));
sheet->addChildWindow(multiLineEditbox);
multiLineEditbox->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
multiLineEditbox->setSize(UVector2(cegui_reldim(0.3f), cegui_reldim(0.3f)));
multiLineEditbox->setText("Now edit me!");

multiLineEditbox->subscribeEvent(MultiLineEditbox::EventTextChanged, Event::Subscriber(&EventGalore::onTextChanged, this));

// This text is going to show the result.
Window * textWindow = winMgr.createWindow("TaharezLook/StaticText", "StaticText1");
sheet->addChildWindow(textWindow);
textWindow->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.5f)));
textWindow->setSize(UVector2(cegui_reldim(0.6f), cegui_reldim(0.1f)));
textWindow->setText("Now edit me!");
</code>
<code><cpp/>
bool onTextChanged(const CEGUI::EventArgs &e)
{
CEGUI::WindowManager * winMgr = CEGUI::WindowManager::getSingletonPtr();
CEGUI::MultiLineEditbox * multiLineEditbox = static_cast<CEGUI::MultiLineEditbox*>(winMgr->getWindow("MultiEditbox1"));
CEGUI::Window * textWindow = winMgr->getWindow("StaticText1");

textWindow->setText(multiLineEditbox->getText());
return true;
}
</code>
Notice what happens when you enter text on another line though :)

====FrameWindow====

This is a window where you usually put your widgets on.

* EventCloseClicked - Fired when the 'X' in the upper right corner is clicked (of the Framewindow).
* EventRollupToggled - Fired when the window gets rolled up, or rolled down.

<code><cpp/>
FrameWindow * frameWindow = static_cast<FrameWindow*>(winMgr.createWindow("TaharezLook/FrameWindow", "FrameWindow1"));
sheet->addChildWindow(frameWindow)
frameWindow->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
frameWindow->setSize(UVector2(cegui_reldim(0.4f), cegui_reldim(0.4f)));
frameWindow->setText("Our window");

frameWindow->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&EventGalore::onCloseClicked, this));
frameWindow->subscribeEvent(FrameWindow::EventRollupToggled, Event::Subscriber(&EventGalore::onRollupToggled, this));
</code>
<code><cpp/>
bool onCloseClicked(const CEGUI::EventArgs &e)
{
// Someone has clicked the upper right 'X'.

// We don't HAVE to cast to FrameWindow, as the method we are going to use to close the window
// is available in Window, but for the sake of clarity...
CEGUI::FrameWindow * frameWindow = static_cast<CEGUI::FrameWindow*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("FrameWindow1"));
frameWindow->destroy();
// Note: Dont try to delete the pointer.
return true;
}

bool onRollupToggled(const CEGUI::EventArgs &e)
{
CEGUI::FrameWindow * frameWindow = static_cast<CEGUI::FrameWindow*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("FrameWindow1"));

if (frameWindow->isRolledup())
{
frameWindow->setText("Rolled up");
}
else
{
frameWindow->setText("Our window");
}
return true;
}
</code>

====ProgressBar====

A progress widget.

* EventProgressDone - Fired when the progress bar reaches 100%(1.0f).
* EventProgressChanged - Fired when the progress changes.
* EventMouseClick - Fired when someone clicked on the window. Inherited from Window.

<code><cpp/>
ProgressBar * progressBar = static_cast<ProgressBar*>(winMgr.createWindow("TaharezLook/ProgressBar", "ProgressBar1"));
sheet->addChildWindow(progressBar);
progressBar->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
progressBar->setSize(UVector2(cegui_reldim(0.5f), cegui_reldim(0.04f)));

progressBar->subscribeEvent(ProgressBar::EventProgressDone, Event::Subscriber(&EventGalore::onProgressDone, this));
progressBar->subscribeEvent(ProgressBar::EventProgressChanged, Event::Subscriber(&EventGalore::onProgressChanged, this));
progressBar->subscribeEvent(ProgressBar::EventMouseClick, Event::Subscriber(&EventGalore::onMouseClick, this));

Window * resultWindow = winMgr.createWindow("TaharezLook/StaticText", "StaticText1");
sheet->addChildWindow(resultWindow);
resultWindow->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.05f)));
resultWindow->setSize(UVector2(cegui_reldim(0.5f), cegui_reldim(0.06f)));
resultWindow->setText("Lets start progressing!");
resultWindow->setProperty("FrameEnabled", "false");
resultWindow->setProperty("BackgroundEnabled", "false");
</code>
<code><cpp/>
bool onProgressDone(const CEGUI::EventArgs &e)
{
// The progress bar is full.
CEGUI::Window * resultWindow = CEGUI::WindowManager::getSingletonPtr()->getWindow("StaticText1");

resultWindow->setText("We are done!");
return true;
}

bool onProgressChanged(const CEGUI::EventArgs &e)
{
// The progress changed.
CEGUI::WindowManager * winMgr = CEGUI::WindowManager::getSingletonPtr();
CEGUI::ProgressBar * progressBar = static_cast<CEGUI::ProgressBar*>(winMgr->getWindow("ProgressBar1"));
CEGUI::Window * resultWindow = winMgr->getWindow("StaticText1");

float progress = progressBar->getProgress();
int finalProgress = static_cast<int>(progress*100);
std::stringstream resultStr;
resultStr << "Progress: " << finalProgress << "%";

resultWindow->setText(resultStr.str());
return true;
}

bool onMouseClick(const CEGUI::EventArgs &e)
{
CEGUI::ProgressBar * progressBar = static_cast<CEGUI::ProgressBar*>(CEGUI::WindowManager::getSingletonPtr()->getWindow("ProgressBar1"));
progressBar->setProgress(progressBar->getProgress() + 0.05f);
return true;
}
</code>

====Slider====

A widget which accepts input though moving a 'thumb' between a range.

* EventValueChanged - Fired when the slider's thumb has moved one step left or right.
* EventThumbTrackEnded - Fired when the user stops moving the slider's thumb. Handy when a change causes an CPU expensive operation, because now you only catch the 'final' change.

<code><cpp/>
Slider * slider = static_cast<Slider*>(winMgr.createWindow("TaharezLook/Slider", "Slider1"));
sheet->addChildWindow(slider);
slider->setPosition(UVector2(cegui_reldim(0.1f), cegui_reldim(0.1f)));
slider->setSize(UVector2(cegui_reldim(0.5f), cegui_reldim(0.04f)));
slider->setMaxValue(1.0f);
slider->setClickStep(0.1f);
slider->setCurrentValue(0.5f); // Start half way

slider->subscribeEvent(Slider::EventValueChanged, Event::Subscriber(&EventGalore::onSliderValueChanged, this));
slider->subscribeEvent(Slider::EventProgressChanged, Event::Subscriber(&EventGalore::onSliderChangeEnded, this));

</code>
<code><cpp/>
bool onSliderValueChanged(const CEGUI::EventArgs &e)
{
// The slider moved.
CEGUI::WindowManager * winMgr = CEGUI::WindowManager::getSingletonPtr();
CEGUI::Slider * slider = static_cast<CEGUI::Slider*>(winMgr->getWindow("Slider1"));
CEGUI::Window * resultWindow = winMgr->getWindow("StaticText1");

std::stringstream resultStr;
resultStr << "Moved to: " << slider->getCurrentValue();

resultWindow->setText(resultStr);
return true;
}

bool onSliderChangeEnded(const CEGUI::EventArgs &e)
{
// The slider stopped moving (user released mouse)
CEGUI::WindowManager * winMgr = CEGUI::WindowManager::getSingletonPtr();
CEGUI::Slider * slider = static_cast<CEGUI::Slider*>(winMgr->getWindow("Slider1"));
CEGUI::Window * resultWindow = winMgr->getWindow("StaticText1");

std::stringstream resultStr;
resultStr << "Moving stopped at: " << slider->getCurrentValue();

resultWindow->setText(resultStr);
return true;
}

</code>

====Spinner====

====MultiColumnList====

PropertyFinder

2008-02-01T13:10:11Z

Rackle: /* PropertyFinder.h */

=== Introduction ===
This code creates a tool to list the properties associated with the widgets of a scheme. It loads the .scheme files from within the Scheme directory and displays the widgets defined within that scheme. Selecting a widget will list every property associated to that widget by default. And selecting a property will display its help.

Please discuss this snippet within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=11670#11670 Property Finder] thread. The properties for the widgets within the Taharez scheme are presented in [[http://www.cegui.org.uk/wiki/index.php/SetProperty SetProperty]] and [[SetProperty (WindowsLook)]]. The Cegui API also [http://www.cegui.org.uk/api_reference/classCEGUI_1_1Property.html lists the properties].

=== Files ===
==== PropertyFinder.h ====
<code><cpp/>
#ifndef _PropertyFinder_h_
#define _PropertyFinder_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIDefaultResourceProvider.h"

#include <io.h>
#include <direct.h>
#include <map>
#include <vector>
#include <algorithm>

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;

// The executable is stored within <cegui>/bin
// The following will change the location of the datafiles from their default of
// ../datafiles (which works well for the samples) to <cegui>/samples/datafiles
DefaultResourceProvider* rp = reinterpret_cast<DefaultResourceProvider*>(System::getSingleton().getResourceProvider());
rp->setResourceGroupDirectory("fonts", "../samples/datafiles/fonts/");
rp->setResourceGroupDirectory("imagesets", "../samples/datafiles/imagesets/");
rp->setResourceGroupDirectory("layouts", "c:/programming/_Projects/CeguiTestBed/");
rp->setResourceGroupDirectory("looknfeels", "../samples/datafiles/looknfeel/");
rp->setResourceGroupDirectory("lua_scripts", "../samples/datafiles/lua_scripts/");
rp->setResourceGroupDirectory("schemes", "../samples/datafiles/schemes/");
Font::setDefaultResourceGroup("fonts");
Imageset::setDefaultResourceGroup("imagesets");
WindowManager::setDefaultResourceGroup("layouts");
WidgetLookManager::setDefaultResourceGroup("looknfeels");
ScriptModule::setDefaultResourceGroup("lua_scripts");
Scheme::setDefaultResourceGroup("schemes");

try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
Scheme* currentScheme = SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("PropertyFinder.layout");
sheet->addChildWindow(guiLayout);

// Retrieve the handle to the often used widgets
mSchemes = static_cast<CEGUI::Combobox*>(winMgr.getWindow("PropertyFinder/SchemeList"));
mWidgets = static_cast<CEGUI::Combobox*>(winMgr.getWindow("PropertyFinder/WidgetList"));
mProperties = static_cast<CEGUI::Listbox*>(winMgr.getWindow("PropertyFinder/Properties"));
mInformation = static_cast<CEGUI::MultiLineEditbox*>(winMgr.getWindow("PropertyFinder/Information"));
mRadioButton = static_cast<CEGUI::RadioButton*>(winMgr.getWindow("PropertyFinder/ExportWiki"));

// Configure the schemes
mSchemes->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::onSchemeChanged, this));
mSchemes->subscribeEvent(Combobox::EventListSelectionAccepted, Event::Subscriber(&DemoSample::onSchemeChanged, this));
mSchemes->setSortingEnabled(true);

// Configure the widgets
mWidgets->subscribeEvent(Combobox::EventTextChanged, Event::Subscriber(&DemoSample::onWidgetChanged, this));
mWidgets->subscribeEvent(Combobox::EventListSelectionAccepted, Event::Subscriber(&DemoSample::onWidgetChanged, this));
mWidgets->setSortingEnabled(true);

// Configure the properties
mProperties->setSortingEnabled(true);
mProperties->setMultiselectEnabled(false);
mProperties->subscribeEvent(Listbox::EventSelectionChanged, Event::Subscriber(&DemoSample::onPropertyChanged, this));

// Configure the export
CEGUI::PushButton* btnExport = static_cast<CEGUI::PushButton*>(winMgr.getWindow("PropertyFinder/Export"));
btnExport->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::onExport, this));
mRadioButton->setGroupID(1);
mRadioButton->setID(Wiki);
mRadioButton->setSelected(true);
CEGUI::RadioButton* radioButton = static_cast<CEGUI::RadioButton*>(winMgr.getWindow("PropertyFinder/ExportHtml"));
radioButton->setGroupID(1);
radioButton->setID(Html);
radioButton->setSelected(false);
radioButton = static_cast<CEGUI::RadioButton*>(winMgr.getWindow("PropertyFinder/ExportXml"));
radioButton->setGroupID(1);
radioButton->setID(Xml);
radioButton->setSelected(false);

// Load every scheme
loadEverySchemes(currentScheme);
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}

void loadEverySchemes(CEGUI::Scheme* pCurrentScheme)
{
// Locate the scheme directory and suffix the scheme file search pattern
CEGUI::DefaultResourceProvider* rp = reinterpret_cast<CEGUI::DefaultResourceProvider*>(CEGUI::System::getSingleton().getResourceProvider());
CEGUI::String schemeDirectory = rp->getResourceGroupDirectory("schemes") + "\\*.scheme";

// Read the filtered contents of the scheme directory
struct _finddata_t c_file;
intptr_t hFile = _findfirst(schemeDirectory.c_str(), &c_file );
if(hFile != -1L)
{
do
{
loadScheme(c_file.name);
} while( _findnext( hFile, &c_file ) == 0 );
_findclose( hFile );
}

// Parse the loaded schemes and determine their internal names (as widget prefixes)
const CEGUI::String separator("/");
CEGUI::String currentFal;
CEGUI::String::size_type pos;
CEGUI::String newLook, currentLook;
CEGUI::String widget;
CEGUI::WindowFactoryManager::FalagardMappingIterator itFalagardMapping = CEGUI::WindowFactoryManager::getSingletonPtr()->getFalagardMappingIterator();
while( !itFalagardMapping.isAtEnd() )
{
currentFal = itFalagardMapping.getCurrentKey();
pos = currentFal.find(separator);
newLook = currentFal.substr(0, pos);
if(currentLook.compare(newLook) != 0)
{
currentLook = newLook;
addScheme(newLook);
}
itFalagardMapping++;
}

// Select the "current" scheme
CEGUI::ListboxItem* current = mSchemes->findItemWithText( pCurrentScheme->getName(), 0 );
if(current)
{
mSchemes->setText( pCurrentScheme->getName() );
}
}

void loadScheme(const CEGUI::String& pScheme, const CEGUI::String& pResourceGroup = "")
{
try
{
if( !CEGUI::SchemeManager::getSingleton().isSchemePresent(pScheme) )
{
CEGUI::Scheme* scheme = CEGUI::SchemeManager::getSingleton().loadScheme(pScheme, pResourceGroup);
}
}
catch(...)
{
// Silently ignore errors
}
}

void addScheme(const CEGUI::String& pScheme)
{
if( !mSchemes->findItemWithText(pScheme, 0) )
{
// This scheme has not yet been added
CEGUI::ListboxTextItem* schemeItem = new CEGUI::ListboxTextItem(pScheme);
schemeItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
mSchemes->addItem(schemeItem);
}
}

bool onSchemeChanged(const CEGUI::EventArgs& args)
{
// Refresh the widget list
mWidgets->resetList();
getWidgets( mSchemes->getText() );

CEGUI::ListboxTextItem* widgetItem;
WidgetList::iterator itWidgetList;
for(itWidgetList = mWidgetList.begin(); itWidgetList != mWidgetList.end(); itWidgetList++)
{
widgetItem = new CEGUI::ListboxTextItem( (*itWidgetList) );
widgetItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
mWidgets->addItem(widgetItem);
}

// Select the first widget
if(mWidgets->getItemCount() > 0)
{
mWidgets->setText( mWidgets->getListboxItemFromIndex(0)->getText() );
}
else
{
mWidgets->setText("");
}

return true;
}

void getWidgets(const CEGUI::String& pScheme)
{
mWidgetList.clear();

const CEGUI::String separator("/");
CEGUI::String currentFal;
CEGUI::String::size_type pos;
CEGUI::String newLook;
CEGUI::String widget;
CEGUI::WindowFactoryManager::FalagardMappingIterator itFalagardMapping = CEGUI::WindowFactoryManager::getSingletonPtr()->getFalagardMappingIterator();
while( !itFalagardMapping.isAtEnd() )
{
currentFal = itFalagardMapping.getCurrentKey();
pos = currentFal.find(separator);
newLook = currentFal.substr(0, pos);
if(pScheme.compare(newLook) == 0)
{
widget = currentFal.substr(pos + 1);
mWidgetList.push_back(widget);
}
itFalagardMapping++;
}

std::sort( mWidgetList.begin(), mWidgetList.end() );
}

bool onWidgetChanged(const CEGUI::EventArgs& args)
{
// Refresh the property list
mProperties->resetList();
getProperties( mSchemes->getText(), mWidgets->getText() );

CEGUI::ListboxTextItem* propertyItem;
PropertyList::iterator itPropertyList;
for(itPropertyList = mPropertyList.begin(); itPropertyList != mPropertyList.end(); itPropertyList++)
{
propertyItem = new CEGUI::ListboxTextItem( (*itPropertyList).first );
propertyItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
if( (*itPropertyList).second.find("Falagard") != CEGUI::String::npos)
{
propertyItem->setTextColours(CEGUI::colour(128.0f, 128.0f, 128.0f));
}
mProperties->addItem(propertyItem);
}

// Select the first property
if(mProperties->getItemCount() > 0)
{
CEGUI::ListboxItem* selectedProperty = mProperties->getListboxItemFromIndex(0);
mProperties->setItemSelectState(selectedProperty, true);
mProperties->ensureItemIsVisible(selectedProperty);
}
else
{
mInformation->setText("");
}

return true;
}

void getProperties(const CEGUI::String& pScheme, const CEGUI::String& pWidget)
{
const CEGUI::String separator("/");
mPropertyList.clear();

try
{
CEGUI::Window* widget = CEGUI::WindowManager::getSingleton().createWindow(pScheme + separator + pWidget);
CEGUI::PropertySet::Iterator itPropertySet = ((CEGUI::PropertySet*) widget)->getIterator();
while (!itPropertySet.isAtEnd() )
{
mPropertyList[itPropertySet.getCurrentKey()] = (*itPropertySet)->getHelp();
itPropertySet++;
}
CEGUI::WindowManager::getSingleton().destroyWindow(widget);
}
catch(...)
{
// Silently ignore errors
// TaharezLook/TabPane generates one such error
}
}

bool onPropertyChanged(const CEGUI::EventArgs& args)
{
// Display the appropriate help information
CEGUI::ListboxItem* selectedItem = mProperties->getFirstSelectedItem();
if(selectedItem)
{
PropertyList::iterator itPropertyList = mPropertyList.find( selectedItem->getText() );
if( itPropertyList != mPropertyList.end() )
{
mInformation->setText( (*itPropertyList).second );
}
}
else
{
mInformation->setText("");
}

return true;
}

bool onExport(const CEGUI::EventArgs& args)
{
CEGUI::uint exportType = mRadioButton->getSelectedButtonInGroup()->getID();
switch(exportType)
{
case Wiki:
ExportWiki();
break;
case Html:
ExportHtml();
break;
case Xml:
ExportXml();
break;
}

return true;
}

void ExportWiki()
{
std::ofstream out("PropertyFinder.txt");
const CEGUI::String sectionHeader("===");
const CEGUI::String widgetHeader("====");
const CEGUI::String propertyHeader("====");
const CEGUI::String falagardColor("bgcolor=\"#FFBF00\"");

PropertyList completePropertyList;

CEGUI::String schemeName;
WidgetList::iterator itWidgetList;
PropertyList::iterator itPropertyList;

const int propertiesPerLine = 5;
int propertiesOnLine;

/******************* Option 1 *******************/
// Export every detected scheme
/*
for(size_t schemeItem = 0; schemeItem < mSchemes->getItemCount(); schemeItem++)
{
schemeName = mSchemes->getListboxItemFromIndex(schemeItem)->getText();
getWidgets(schemeName);
if(mWidgetList.size() == 0)
{
continue;
}
*/

/******************* Option 2 *******************/
// Only export the currently selected scheme
{
schemeName = mSchemes->getText();
getWidgets(schemeName);
/************** End of the options **************/

out << sectionHeader
<< " "
<< schemeName
<< " "
<< sectionHeader
<< "\n";

for(itWidgetList = mWidgetList.begin(); itWidgetList != mWidgetList.end(); itWidgetList++)
{
getProperties( schemeName, (*itWidgetList) );
if(mPropertyList.size() == 0)
{
continue;
}

out << widgetHeader
<< " "
<< (*itWidgetList)
<< " "
<< widgetHeader
<< "\n";

propertiesOnLine = 0;
out << "{| class=\"wikitable\" border=\"1\" \n";
for(itPropertyList = mPropertyList.begin(); itPropertyList != mPropertyList.end(); itPropertyList++)
{
if( propertiesOnLine == propertiesPerLine )
{
out << "|-\n";
propertiesOnLine = 0;
}
out << "| ";
if( (*itPropertyList).second.find("Falagard") != CEGUI::String::npos)
{
out << falagardColor
<< " | ";
}
out << "[[#"
<< (*itPropertyList).first
<< "]]\n";
++propertiesOnLine;

if( completePropertyList.find( (*itPropertyList).first ) == completePropertyList.end() )
{
completePropertyList[(*itPropertyList).first] = (*itPropertyList).second;
}
}
out << "|}\n\n";
}
}

out << sectionHeader
<< " Properties "
<< sectionHeader
<< "\n";
const CEGUI::String falagardKeyword("Falagard");
CEGUI::String::size_type falagardPos;
CEGUI::String propertyDescription;
PropertyList::iterator itCompletePropertyList;
for(itCompletePropertyList = completePropertyList.begin();
itCompletePropertyList != completePropertyList.end();
itCompletePropertyList++)
{
out << propertyHeader
<< " "
<< (*itCompletePropertyList).first
<< " "
<< propertyHeader
<< "\n";

propertyDescription = (*itCompletePropertyList).second;
falagardPos = (*itCompletePropertyList).second.find(falagardKeyword);
if( falagardPos != CEGUI::String::npos)
{
propertyDescription = propertyDescription.replace(falagardPos,
falagardKeyword.length(),
"Falagard");
}

out << propertyDescription
<< "\n\n";
}

out.close();
}

void ExportHtml()
{
}

void ExportXml()
{
}

private:

// Widget containing the list of schemes
CEGUI::Combobox* mSchemes;

// Widget containing the list of widgets in a scheme
CEGUI::Combobox* mWidgets;

// Widget containing the list of properties
CEGUI::Listbox* mProperties;

// Type of list of widgets for a scheme
typedef std::vector<CEGUI::String> WidgetList;

// List of widgets for a scheme
WidgetList mWidgetList;

// Type of list of properties for a widget <property, help>
typedef std::map<CEGUI::String, CEGUI::String> PropertyList;

// List of properties for a widget
PropertyList mPropertyList;

// Widget displaying additional information on a property
CEGUI::MultiLineEditbox* mInformation;

// Radiobutton part of a group
CEGUI::RadioButton* mRadioButton;

// Defines the types of export
enum ExportType :CEGUI::uint {Wiki, Html, Xml};
};

#endif // _PropertyFinder_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "PropertyFinder.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== PropertyFinder.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="TaharezLook/FrameWindow" Name="PropertyFinder" >
<Property Name="Text" Value="Property Finder" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.0643816,0},{0.0124997,0},{0.903446,0},{0.891667,0}}" />
<Window Type="TaharezLook/StaticText" Name="PropertyFinder/SchemeLabel" >
<Property Name="Text" Value="Scheme:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.019553,0},{0.0836117,0},{0.114991,0},{0.146434,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="PropertyFinder/SchemeList" >
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.116201,0},{0.0836117,0},{0.440692,0},{0.84974,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="PropertyFinder/WidgetLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Widget:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.473929,0},{0.0836117,0},{0.569368,0},{0.146434,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="PropertyFinder/WidgetList" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.570578,0},{0.0836117,0},{0.969551,0},{0.823935,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/Listbox" Name="PropertyFinder/Properties" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.019553,0},{0.164195,0},{0.440692,0},{0.89201,0}}" />
</Window>
<Window Type="TaharezLook/MultiLineEditbox" Name="PropertyFinder/Information" >
<Property Name="Text" >
</Property>
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.473929,0},{0.164195,0},{0.969551,0},{0.89201,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="PropertyFinder/Export" >
<Property Name="Text" Value="Export" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.019553,0},{0.904265,0},{0.161971,0},{0.983649,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="PropertyFinder/ExportWiki" >
<Property Name="Text" Value="Wiki" />
<Property Name="Selected" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.186517,0},{0.904265,0},{0.251611,0},{0.981279,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="PropertyFinder/ExportHtml" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="HTML" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.271818,0},{0.904265,0},{0.336911,0},{0.98128,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="PropertyFinder/ExportXml" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="XML" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.357547,0},{0.904265,0},{0.42264,0},{0.98128,0}}" />
</Window>
</Window>
</GUILayout>
</pre>

Tab Order

2008-02-01T13:09:48Z

Rackle: /* TabNavigation_demo.h */

=== Introduction ===
This code provides Tab and Shift+Tab navigation through a list of widgets.

Create an instance of TabNavigation for each group of tab order, such as one per dialog. Specify the parent via a call to setParent(). This will help catch '''Tab''' and '''Shift+Tab''' keys, which will then properly cycle through the widgets specified via addWidget(). Note that addWidget() accepts window names as well as the handle of TabControl; this will automatically add the TabButton of that TabControl.

Please discuss this snippet within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=8676#8676 Tab Order] thread.

=== Files ===
==== TabNavigation.h ====
<code><cpp/>
#ifndef _TabNavigation_h_
#define _TabNavigation_h_

#include <vector>
#include "CEGUI.h"

class TabNavigation
{
public:
/* Specifies the parent or container.
Used to trap Tab and Shift+Tab keys and relay them to the list of tab navigation. */
void setParent(const CEGUI::String& window);

/* Adds a TabControl widget.
Its tab buttons will be added to the list of tab navigation. */
void addWidget(const CEGUI::TabControl* tabControl);

/* Adds a widget to the list of tab navigation.
The order in which they are added corresponds to the tab order. */
void addWidget(const CEGUI::String& window);

private:
/* Ensures that the last known focused widget regains input. */
bool _onParentActivated(const CEGUI::EventArgs& e);

/* Handles non-tab key activation.
This will ensure that the next tab key navigation will start from
the relevant widget. */
bool _onActivated(const CEGUI::EventArgs& e);

/* Traps the Tab and Shift+Tab key and activates the next or previous
widget accordingly. */
bool _onCharacterKey(const CEGUI::EventArgs& e);

/* Maintains the list of widgets that participate in the tab order */
std::vector<CEGUI::String> _tabNavigation;

/* Maintains the last known widget to have the focus. */
std::vector<CEGUI::String>::iterator _lastKnownFocus;
};

#endif // _TabNavigation_h_
</code>

==== TabNavigation.cpp ====
<code><cpp/>
#include "TabNavigation.h"

/* These provide a visual focus cue when the scheme does not provide one
* for every widget, such as TaharezLook's PushButton */
#define HACKED_FOCUS_GAIN(window) CEGUI::WindowManager::getSingleton().getWindow(window)->setAlpha(1.0f)
#define HACKED_FOCUS_LOSS(window) CEGUI::WindowManager::getSingleton().getWindow(window)->setAlpha(0.8f)

/* You can deactivate these hacked focus functions by defining the macro as a comment:
#define HACKED_FOCUS_GAIN(window) //
#define HACKED_FOCUS_LOSS(window) //
*/

void TabNavigation::setParent(const CEGUI::String& window)
{
// Parent will feed the tab and shift+tab navigation to the list of monitored widgets
CEGUI::WindowManager& wmgr = CEGUI::WindowManager::getSingleton();
wmgr.getWindow(window)->subscribeEvent(CEGUI::Window::EventCharacterKey, CEGUI::Event::Subscriber(&TabNavigation::_onCharacterKey, this));
wmgr.getWindow(window)->subscribeEvent(CEGUI::Window::EventActivated, CEGUI::Event::Subscriber(&TabNavigation::_onParentActivated, this));
}

void TabNavigation::addWidget(const CEGUI::String& window)
{
// Add a widget to the list of widget navigation
CEGUI::WindowManager& wmgr = CEGUI::WindowManager::getSingleton();

wmgr.getWindow(window)->subscribeEvent(CEGUI::Window::EventCharacterKey, CEGUI::Event::Subscriber(&TabNavigation::_onCharacterKey, this));
wmgr.getWindow(window)->subscribeEvent(CEGUI::Window::EventActivated, CEGUI::Event::Subscriber(&TabNavigation::_onActivated, this));
HACKED_FOCUS_LOSS(window);
if(!_tabNavigation.size())
{
wmgr.getWindow(window)->activate(); // Activate the first widget by default
HACKED_FOCUS_GAIN(window);
}
_tabNavigation.push_back(window);
_lastKnownFocus = _tabNavigation.begin(); // Reset the iterator after each modification to the vector
}

void TabNavigation::addWidget(const CEGUI::TabControl* tabControl)
{
// Add every tab buttons of a tab control
CEGUI::WindowManager& wmgr = CEGUI::WindowManager::getSingleton();
CEGUI::Window* tabPaneButtons = wmgr.getWindow(tabControl->getName() + "__auto_TabPane__Buttons");
for(size_t idx = 0; idx < tabPaneButtons->getChildCount(); idx++)
{
addWidget(tabPaneButtons->getChildAtIdx(idx)->getName());
}
}

bool TabNavigation::_onParentActivated(const CEGUI::EventArgs& e)
{
// Parent is being activated, activate the widget with the last known focus
if(_tabNavigation.size() && _lastKnownFocus != _tabNavigation.end())
{
CEGUI::WindowManager& wmgr = CEGUI::WindowManager::getSingleton();
CEGUI::Window* window = wmgr.getWindow(*_lastKnownFocus);
if(window)
window->activate();
}
return true;
}

bool TabNavigation::_onActivated(const CEGUI::EventArgs& e)
{
// A focus widget has been activated without tabbing (could be a mouse click)
CEGUI::String currentlyFocused = static_cast<const CEGUI::WindowEventArgs&>(e).window->getName();
if(_tabNavigation.size()
&& (_lastKnownFocus == _tabNavigation.end()
|| (*_lastKnownFocus).compare(currentlyFocused)) )
{
if(_lastKnownFocus != _tabNavigation.end())
{
// These curly braces are IMPORTANT!!!
HACKED_FOCUS_LOSS(*_lastKnownFocus);
}
for(_lastKnownFocus = _tabNavigation.begin(); _lastKnownFocus != _tabNavigation.end(); _lastKnownFocus++)
{
if(!(*_lastKnownFocus).compare(currentlyFocused))
{
HACKED_FOCUS_GAIN(currentlyFocused);
return true;
}
}
// Can't figure out who has the focus
_lastKnownFocus = _tabNavigation.begin();
HACKED_FOCUS_GAIN(*_lastKnownFocus);
}
return true;
}

bool TabNavigation::_onCharacterKey(const CEGUI::EventArgs& e)
{
// Handle Tab (next) and Shift+Tab (previous) widget navigation
assert(_tabNavigation.size() && "Don't simply call setParent(), also call addWidget()");
if(static_cast<const CEGUI::KeyEventArgs&>(e).codepoint == 9) // Tab or Shift+Tab
{
// Identify who currently has the focus
CEGUI::WindowManager& wmgr = CEGUI::WindowManager::getSingleton();
std::vector<CEGUI::String>::iterator itFocus, itCurrent;
if(_lastKnownFocus != _tabNavigation.end() && wmgr.getWindow(*_lastKnownFocus)->isActive())
{
// The last known focus is still in focus
itCurrent = _lastKnownFocus;
}
else
{
// Figure out who (if anyone) has the focus
for(itCurrent = _tabNavigation.begin(); itCurrent != _tabNavigation.end(); itCurrent++)
{
if(wmgr.getWindow(*itCurrent)->isActive())
{
// Found who has the focus
break;
}
}
if(itCurrent == _tabNavigation.end())
{
// We did not find who had the focus
// Someone not in our list of monitored widgets has STOLEN the focus!
// Use the last known focus or, if that's invalid, the first widget
itCurrent = _lastKnownFocus != _tabNavigation.end() ? _lastKnownFocus : _tabNavigation.begin();
}
}

// Change the focus
itFocus = itCurrent; // The search starts from the currently focused
CEGUI::Window* newWidget = 0;
do
{
if(static_cast<const CEGUI::KeyEventArgs&>(e).sysKeys & CEGUI::Shift)
{
// Search previous
if(itFocus == _tabNavigation.begin())
itFocus = --_tabNavigation.end();
else
itFocus--;
}
else
{
// Search next
itFocus++;
if(itFocus == _tabNavigation.end())
itFocus = _tabNavigation.begin();
}
newWidget = wmgr.getWindow(*itFocus);
if(newWidget->isVisible() && !newWidget->isDisabled())
{
// We have found a valid focus target
_lastKnownFocus = itFocus;
break;
}
newWidget = 0;
} while(itFocus != itCurrent); // Iterate while we're on a different widget

if(newWidget)
{
// Remove the focus from this widget
HACKED_FOCUS_LOSS(*itCurrent);

// Give the focus to this widget
newWidget->activate();
HACKED_FOCUS_GAIN(newWidget->getName());
return true;
}
}
return false;
}

</code>

==== TabNavigation_demo.h ====
<code><cpp/>
#ifndef _WidgetFocus_Demo_h_
#define _WidgetFocus_Demo_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "TabNavigation.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("TabNavigation.layout");
sheet->addChildWindow(guiLayout);

/* TabNavigation-specific code */
navMainWindow.setParent("TabOrder/MainWindow");
navMainWindow.addWidget("TabOrder/MainWindow/Field_1");
navMainWindow.addWidget("TabOrder/MainWindow/Field_2");
navMainWindow.addWidget("TabOrder/MainWindow/Field_3");

navSecondaryWindow.setParent("TabOrder/SecondaryWindow");
navSecondaryWindow.addWidget("TabOrder/SecondaryWindow/Field_1");
navSecondaryWindow.addWidget("TabOrder/SecondaryWindow/Field_2");
navSecondaryWindow.addWidget("TabOrder/SecondaryWindow/Field_3");
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}
private:
TabNavigation navMainWindow;
TabNavigation navSecondaryWindow;
};

#endif // _WidgetFocus_Demo_h_
</code>

==== TabNavigation.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="TabOrder" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="TabOrder/MainWindow" >
<Property Name="Text" Value="Main Window" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.0296875,0},{0.0583334,0},{0.43125,0},{0.468749,0}}" />
<Window Type="TaharezLook/Editbox" Name="TabOrder/MainWindow/Field_1" >
<Property Name="Text" Value="Field 1" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.0719849,0},{0.19543,0},{0.905642,0},{0.354059,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="TabOrder/MainWindow/Field_2" >
<Property Name="Text" Value="Field 2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.071985,0},{0.413199,0},{0.905642,0},{0.663199,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="TabOrder/MainWindow/Field_3" >
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.071985,0},{0.711169,0},{0.905642,0},{0.961169,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="TabOrder/SecondaryWindow" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Secondary Window" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.454688,0},{0.0583334,0},{0.856251,0},{0.468749,0}}" />
<Window Type="TaharezLook/Editbox" Name="TabOrder/SecondaryWindow/Field_1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Field 1" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.071985,0},{0.19543,0},{0.905642,0},{0.354059,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="TabOrder/SecondaryWindow/Field_2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Field 2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.071985,0},{0.413199,0},{0.905642,0},{0.663199,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="TabOrder/SecondaryWindow/Field_3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.071985,0},{0.711169,0},{0.905642,0},{0.961169,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Formatted Numeric Data

2008-02-01T13:09:33Z

Rackle: /* FormattedData.h */

International Components for Unicode (ICU) is IBM's toolkit to internationalise applications. Initially developped for Java it has been ported to C/C++. Now it has been partially ported to CEGUI. Please use this [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=8097#8097 thread] for discussion.

==IBM's ICU==
===Useful Links===
*[http://www-306.ibm.com/software/globalization/icu/index.jsp Home page]
*[http://icu.sourceforge.net/ Source Forge]
*[http://www-306.ibm.com/software/globalization/icu/license.jsp Licence]
*[http://icu.sourceforge.net/userguide/ Documentation]
*[http://icu.sourceforge.net/apiref/icu4c/index.html Doxygen API]
*[http://www.loc.gov/standards/iso639-2/ ISO Language Codes]
*[http://www.iso.ch/iso/en/prods-services/iso3166ma/index.html ISO Country Codes]
*[http://en.wikipedia.org/wiki/ISO_4217 ISO Currency Codes]
*[http://icu.sourceforge.net/apiref/icu4c/classDecimalFormat.html#_details ICU Decimal Format Syntax]
*[http://icu.sourceforge.net/userguide/formatDateTime.html ICU Date/Time Format Syntax]

===Getting started===
Download these [http://www-306.ibm.com/software/globalization/icu/downloads.jsp files from IBM]
*Source: icu-3.4.1.zip OR icu-3.4.1.tgz
*Documentation: icu-3.4-docs.zip
*User Guide: icu-3.4-userguide.zip

Compile these solutions:
*icu/source/allinone/allinone.sln
*icu/source/samples/all/all.sln

Fix the following errors:
*For projects strsrch and coll
**Move:
<pre>
if (pOpt->name == 0)
{
fprintf(stderr, "Unrecognized option \"%s\"\n", pArgName);
return FALSE;
}</pre>
**Upward just after the line:
<pre>
for (OptSpec *pOpt = opts; pOpt->name != 0; pOpt ++) {
</pre>

*For project legacy
**remove dependencies to:
*** ../../../../icu-1-8-1/lib/icuucd.lib
*** ../../../../icu-1-8-1/lib/icuind.lib

*For project GDIFontInstance
**cast 6th parameter: (LPCWSTR) &ttGlyphs[dyStart]

Please note that samples will NOT run in their compilation directories. In order to run any of the samples you must place the executable within the icu/bin directory, where the required DLLs are situated.

===Incorporating ICU within an existing project===

Additional include directories:
*$(ICU)\include

Additional library directories:
*$(ICU)\lib

Link with:
*debug: icuucd.lib icuind.lib
*release: icuuc.lib icuin.lib

Make certain these DLLs are present with your executable:
*debug: icuuc34d.dll icuin34d.dll icudt34.dll
*release: icuuc34.dll icuin34.dll icudt34.dll

==CEGUI's ICU==
IBM's ICU provides many features to support internationalisation. The class I've created encapsultes some (not all) of these features.

===Locale===
A Locale describes the rules in effect within a country for a specific language. These rules specify the formatting of currencies, numeric values, dates, and others. Unfortunately these rules do not take into consideration the modifications that may have been applied within the Regional Settings of Window's Control Panel. However most functions accept a formatting mask. This allows applications to recreate some of the features of the control panel, allowing users to specify their desired formats. The setLocale() and setCurrency() functions will configure the class to adopt the rules specified by the specified language, country, and currency.

===formatNumber===
The formatNumber() function formats a numeric value given the specified mask. Three versions are available. The versions accepting a CEGUI::String has been customised to allow large numbers to be formatted: numbers having up to 18 integers and 7 decimals. The current implementation of this function is limited to accepting a single format for positive numbers. If the numeric value to be formatted is negative then a negative sign will precede the formatted value. However it is impossible to format a negative value within parentheses: formatting -1234.56 to (1,234.56).

===numberToText===
The numberToText() function converts a numeric value into a textual representation. For example the numeric value 123 is converted into "one hundred twenty-three" in english and "cent vingt-trois" in french.

===numberToOrdinal===
The numberToOrdinal() function converts a numeric value into an ordinal representation. For example the numeric value 1 is converted into "1st" in english. Support for other languages is either buggy or lacking (or I have improperly coded this feature).

===formatText===
The formatText() function will parse a numeric value and sprinkle digits into the slots specified by the formatting mask. A North American telephone number of "12223334444" can be formatted into "1 (222) 333-4444" with the mask "0 (000) 000-0000". This non-localised function accepts three format specifier. A "0" represents a forced digit. If the numerical value possesses a digit at that position then the digit will be displayed, otherwise the place holder character(s) will be used. A "#" represents a potential digit. If the numerical value possesses a digit at that position the the digit will be displayed, otherwise nothing is displayed. Finally the apostrophe "'" allows the mask to specify the characters "0", "#", or "'", rather than using them as format specifiers.

===formatCurrency===
The formatCurrency() function will format a numerical value according to the currently configured locale and currency. It will NOT convert the monetary value of one currency to another.

===formatDateTime===
The formatDateTime() function will format a date, time, or date/time given the specified mask. The UDate variable type is a double. According to [http://icu.sourceforge.net/userguide/dateCalendar.html IBM's documentation] A UDate value is stored as UTC time in milliseconds, which means it is calendar and time zone independent. UDate is the most compact and portable way to store and transmit a date and time. However I have found that attempting to specify a date AND time within the UDate data type results in imprecisions of up to 1 minute 47 seconds. My solution is to use two UDate data variables, one to hold a date and another to hold a time.

===localToGmt and gmtToLocal===
The localToGmt() and the gmtToLocal() functions convert a date and a time between a local and a GMT value.

===CeguiStringToDateTime===
The CeguiStringToDateTime() function will parse a string specifying a date or a time into it's corresponding UDate value. Although it is possible to parse a string containing both a date and a time the resulting UDate value will be inaccurate, varying from its intended value by up to 1 minute 47 seconds. A better approach is to keep the date and time separated.

==Source Code==

===icu.h===
<pre>
#ifndef _ICU_h_
#define _ICU_h_

/* Useful links
ISO Language Codes: http://www.loc.gov/standards/iso639-2/
ISO Country Codes: http://www.iso.ch/iso/en/prods-services/iso3166ma/index.html
ISO Currency Codes: http://en.wikipedia.org/wiki/ISO_4217
ICU Decimal Format Syntax: http://icu.sourceforge.net/apiref/icu4c/classDecimalFormat.html#_details
ICU Date/Time Format Syntax: http://icu.sourceforge.net/userguide/formatDateTime.html
*/

#include "unicode/utypes.h"
#include "unicode/unistr.h"
#include "unicode/numfmt.h"
#include "unicode/dcfmtsym.h"
#include "unicode/decimfmt.h"
#include "unicode/locid.h"
#include "unicode/uclean.h"
#include "unicode/calendar.h"
#include "unicode/datefmt.h"
#include "unicode/smpdtfmt.h"
#include "unicode/rbnf.h"
#include "CEGUI.h"

class ICU
{
public:
ICU(bool cleanupICU = true);
~ICU();
bool setLocale(const CEGUI::String& language, const CEGUI::String& country);
const Locale& getLocale();
bool setCurrency(const char *currency);

bool formatNumber(const CEGUI::String& rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue);
bool formatNumber(const double rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue);
bool formatNumber(const int32_t rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue);

bool numberToText(const double rawValue, CEGUI::String& formattedValue);
bool numberToText(const int32_t rawValue, CEGUI::String& formattedValue);

bool numberToOrdinal(const double rawValue, CEGUI::String& formattedValue);
bool numberToOrdinal(const int32_t rawValue, CEGUI::String& formattedValue);

bool formatText(const CEGUI::String& rawValue, const CEGUI::String& mask, const CEGUI::String& zeroPlaceHolder, CEGUI::String& formattedValue);

bool formatCurrency(const double& currency, CEGUI::String& formattedValue);

bool formatDateTime(UDate rawDateTime, const CEGUI::String& mask, CEGUI::String& formattedDateTime);
bool localToGmt(const UDate& localDate, const UDate& localTime, UDate& gmtDate, UDate& gmtTime);
bool gmtToLocal(const UDate& gmtDate, const UDate& gmtTime, UDate& localDate, UDate& localTime);

bool CeguiStringToDateTime(const CEGUI::String& stringDateTime, const CEGUI::String& mask, UDate& unicodeDateTime);
bool CeguiStringToInt32(const CEGUI::String& stringValue, int32_t& int32Value);
void UnicodeToCeguiString(const UnicodeString& unicodeString, CEGUI::String& ceguiString);
private:
void _splitIntegerDecimal(const CEGUI::String& combined, CEGUI::String& integerPart, CEGUI::String& decimalPart);
bool _convertLocalAndGmt(const UDate& localDate, const UDate& localTime, UDate& gmtDate, UDate& gmtTime, bool fromLocalToGMT);
bool _ruleBasedNumberFormat(const double rawValue, URBNFRuleSetTag tag, CEGUI::String& formattedValue);
bool _ruleBasedNumberFormat(const int32_t rawValue, URBNFRuleSetTag tag, CEGUI::String& formattedValue);
Locale m_locale; // Current locale of the computer
UChar m_currency[4]; // Currency code
bool m_cleanupICU; // Whether to call ICU's cleanup function
};

#endif // _ICU_h_
</pre>

===icu.cpp===

<pre>
#include "ICU.h"
#include <vector>

ICU::ICU(bool cleanupICU)
{
m_cleanupICU = cleanupICU;
}

ICU::~ICU()
{
// http://icu.sourceforge.net/userguide/design.html
// The paragraph "ICU Initialization and Termination" mentions that this function
// should be called to force the ICU library to release any allocated heap storage
// otherwise memory leak checking tools will falsely report leaks.
// My thinking with this m_cleanupICU variable is that the library should not release
// its memory allocation if it is also used outside of this class. This
// implementation grants you some control over when this cleanup occurs.
if(m_cleanupICU)
u_cleanup();
}

bool ICU::setLocale(const CEGUI::String& language, const CEGUI::String& country)
{
// Set the locale
Locale tempLocale = Locale::createFromName((language + "_" + country).c_str());
if(tempLocale.isBogus())
return false;

m_locale = tempLocale;
return true;
}

const Locale& ICU::getLocale()
{
// Retrive the locale
return m_locale;
}

bool ICU::setCurrency(const char *currency)
{
// Set the currency
if(currency==NULL || strlen(currency)!=3)
return false;

// Invariant-character conversion to UChars
u_charsToUChars(currency, m_currency, 4);
return true;
}

bool ICU::formatNumber(const CEGUI::String& rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue)
{
// Format a unformatted number according to the rules specified within the mask
// An unformatted number only contains numeric digits and a period as the decimal point
// Note that a decimal value is broken down into two numbers, an
// integer and a decimal number for formatting and then reassembled
// into a single string. This makes it possible to handle numbers
// as large as 999,999,999,999,999,999.9999999 (18 integers and 7 decimals).
// However it makes it impossible to specify a positive mask as well as a
// negative mask; only one mask is supported. It is also impossible to
// format a negative value with a mask similar to "(#,##0.00)"
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();
CEGUI::String formattedInteger, formattedDecimal;
CEGUI::String::size_type idx;

// Separate the integer and the decimal parts from the value
CEGUI::String maskInteger, maskDecimal, integerValue, decimalValue;
idx = rawValue.find(".");
if(idx == CEGUI::String::npos)
{
// If the value is empty then force the integer to 0, otherwise use the value
// Since there is no decimal point force a decimal value of .0
integerValue = rawValue.empty() ? "0" : rawValue;
decimalValue = ".0";
}
else
{
// If there is no integer portion then force an integer value of 0
integerValue = idx == 0 ? "0" : rawValue.substr(0, idx);
decimalValue = rawValue.substr(idx);
}

// Separate the integer and the decimal parts from the mask
_splitIntegerDecimal(mask, maskInteger, maskDecimal);

// Prepare the numeric formatter
DecimalFormatSymbols* decimalFormatSymbols = new DecimalFormatSymbols(m_locale, status);
if( U_FAILURE(status) )
return false;

if(!maskInteger.empty())
{
// Prepare the integer parser
UnicodeString patternInteger(maskInteger.c_str());
DecimalFormat* fmt = new DecimalFormat(patternInteger, *decimalFormatSymbols, status);
if( U_FAILURE(status) )
{
delete decimalFormatSymbols;
return false;
}

// Parse the string value into an integer value
UnicodeString uIntegerValue(integerValue.c_str());
Formattable fIntegerValue;
fmt->parse(uIntegerValue, fIntegerValue, status);
if( U_FAILURE(status) )
{
status = U_ZERO_ERROR;
fIntegerValue.setInt64(0);
}

// Format the integer value
uIntegerValue = "";
((NumberFormat*)fmt)->format(fIntegerValue.getInt64(), uIntegerValue);
delete fmt;

UnicodeToCeguiString(uIntegerValue, formattedInteger);
}

if(!maskDecimal.empty())
{
// Prepare the decimal parser
DecimalFormat* fmtParse = new DecimalFormat(status);
if( U_FAILURE(status) )
{
delete decimalFormatSymbols;
return false;
}
fmtParse->applyLocalizedPattern("0.0000003", status);

// Parse the string value into a decimal value
UnicodeString uDecimalValue(decimalValue.c_str());
Formattable fDecimalValue;
fmtParse->parse(uDecimalValue, fDecimalValue, status);
delete fmtParse;
if( U_FAILURE(status) )
{
status = U_ZERO_ERROR;
fDecimalValue.setDouble(0.0);
}

// Prepare the decimal formatter
UnicodeString patternDecimal(maskDecimal.c_str());
DecimalFormat* fmt = new DecimalFormat(patternDecimal, *decimalFormatSymbols, status);
if( U_FAILURE(status) )
{
delete decimalFormatSymbols;
return false;
}

// Format the decimal value
uDecimalValue = "";
fmt->format(fDecimalValue.getDouble(), uDecimalValue);
delete fmt;

UnicodeToCeguiString(uDecimalValue, formattedDecimal);
}

delete decimalFormatSymbols;

formattedValue = formattedInteger + formattedDecimal;
return true;
}

bool ICU::formatNumber(const double rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue)
{
// Format a number using the appropriate locale rules
// Note that the use of a double limits the effective range
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();

// Prepare the numeric formatter
DecimalFormatSymbols* symbols = new DecimalFormatSymbols(m_locale, status);
if( U_FAILURE(status) )
return false;

// Create a number formatter for the current locale
UnicodeString pattern(mask.c_str());
DecimalFormat* fmt = new DecimalFormat(pattern, *symbols, status);
if( U_FAILURE(status) )
{
delete symbols;
return false;
}

// Format the number
UnicodeString uValue;
fmt->format(rawValue, uValue, status);
delete symbols;
delete fmt;
if( U_FAILURE(status) )
return false;

UnicodeToCeguiString(uValue, formattedValue);
return true;
}

bool ICU::formatNumber(const int32_t rawValue, const CEGUI::String& mask, CEGUI::String& formattedValue)
{
// Format a number using the appropriate locale rules
// Note that the use of a double limits the effective range
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();

// Prepare the numeric formatter
DecimalFormatSymbols* symbols = new DecimalFormatSymbols(m_locale, status);
if( U_FAILURE(status) )
return false;

// Create a number formatter for the current locale
UnicodeString pattern(mask.c_str());
DecimalFormat* fmt = new DecimalFormat(pattern, *symbols, status);
if( U_FAILURE(status) )
{
delete symbols;
return false;
}

// Format the number
UnicodeString uValue;
fmt->format(rawValue, uValue, status);
delete symbols;
delete fmt;
if( U_FAILURE(status) )
return false;

UnicodeToCeguiString(uValue, formattedValue);
return true;
}

bool ICU::numberToText(const double rawValue, CEGUI::String& formattedValue)
{
// Convert a number to a text
// "1.2" to "one point two"
return _ruleBasedNumberFormat(rawValue, URBNF_SPELLOUT, formattedValue);
}

bool ICU::numberToText(const int32_t rawValue, CEGUI::String& formattedValue)
{
// Convert a number to a text
// "12" to "twelve"
return _ruleBasedNumberFormat(rawValue, URBNF_SPELLOUT, formattedValue);
}

bool ICU::numberToOrdinal(const double rawValue, CEGUI::String& formattedValue)
{
// Convert a number to ordinal text
// "1.5" to "2nd"
return _ruleBasedNumberFormat(rawValue, URBNF_ORDINAL, formattedValue);
}

bool ICU::numberToOrdinal(const int32_t rawValue, CEGUI::String& formattedValue)
{
// Convert a number to ordinal text
// "1" to "1st"
return _ruleBasedNumberFormat(rawValue, URBNF_ORDINAL, formattedValue);
}

bool ICU::formatText(const CEGUI::String& rawValue, const CEGUI::String& mask, const CEGUI::String& zeroPlaceHolder, CEGUI::String& formattedValue)
{
/* Format a value according to a pattern
* Format specifiers:
* 0 forced digit: will be replaced by a digit or if there is no digit, by 'zeroPlaceHolder'
* # potential digit: will be replaced by a digit if there is one otherwise nothing
* ' literal character: the following character is to be treated as a character
* rather than a format specifier
* ex the value "1" with the format "'00" will result in the string "01"
* Note that if the value is larger than the pattern then it is truncated to the left
* ex the value "1234" with the format "#0" results in the string "34"
*/
formattedValue.clear();

if(!rawValue.length() || !mask.length())
return false;

// Parse the mask
std::vector<CEGUI::String> maskList;
CEGUI::String maskDigit;
for(CEGUI::String::size_type idxMask = 0; idxMask < mask.length(); ++idxMask)
{
if(!mask.compare(idxMask, 1, "0"))
{
maskDigit = "ForcedDigit";
maskList.push_back(maskDigit);
}
else if(!mask.compare(idxMask, 1, "#"))
{
maskDigit = "PotentialDigit";
maskList.push_back(maskDigit);
}
else
{
if(!mask.compare(idxMask, 1, "'") && idxMask < mask.length() - 1)
++idxMask; // Literal specifier followed by a mask digit, so skip over the apostrophe
maskDigit = mask.at(idxMask);
maskList.push_back(maskDigit);
}
}

// Format the numeric value
CEGUI::String::size_type idxValue;
idxValue = rawValue.length();
std::vector<CEGUI::String>::reverse_iterator itMask;
for(itMask = maskList.rbegin(); itMask != maskList.rend(); ++itMask)
{
if(!(*itMask).compare("ForcedDigit"))
{
if(idxValue)
{
// We have a digit remaining
--idxValue;
formattedValue = rawValue.at(idxValue) + formattedValue;
}
else
{
// We're out of digits
formattedValue = zeroPlaceHolder + formattedValue;
}
}
else if(!(*itMask).compare("PotentialDigit"))
{
if(idxValue)
{
// We have a digit remaining
--idxValue;
formattedValue = rawValue.at(idxValue) + formattedValue;
}
}
else
{
// Literal character
formattedValue = (*itMask) + formattedValue;
}
}
return true;
}

bool ICU::formatCurrency(const double& currency, CEGUI::String& formattedValue)
{
// Format a number using the appropriate locale rules
// Note that the use of a double limits the effective range
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();

// Create a number formatter for the current locale
NumberFormat *fmt = NumberFormat::createCurrencyInstance(m_locale, status);
if( U_FAILURE(status) )
return false;

// Format the currency
UnicodeString uValue;
fmt->format(currency, uValue);
delete fmt;

UnicodeToCeguiString(uValue, formattedValue);
return true;
}

bool ICU::formatDateTime(UDate rawDateTime, const CEGUI::String& mask, CEGUI::String& formattedDateTime)
{
// Format a date/time given the specified mask
// Note that although a UDate can support both date and time in
// realite the resolution is insufficient. In order to precisely
// represent a date/time value they should be processed separately
UErrorCode status = U_ZERO_ERROR;
formattedDateTime.clear();

// Create a Date/Time formatter
DateFormat* fmt = DateFormat::createDateTimeInstance(DateFormat::kDefault, DateFormat::kDefault, m_locale); // kDefault is not really used

// Activate our pattern (overrides DateFormat::kDefault)
UnicodeString pattern(mask.c_str());
((SimpleDateFormat*) fmt)->applyPattern(pattern);

// Format the date/time
UnicodeString uValue;
fmt->format(rawDateTime, uValue, status);
delete fmt;
if( U_FAILURE(status) )
return false;

UnicodeToCeguiString(uValue, formattedDateTime);
return true;
}

bool ICU::localToGmt(const UDate& localDate, const UDate& localTime, UDate& gmtDate, UDate& gmtTime)
{
// Convert a local date/time into a GMT date/time
return _convertLocalAndGmt(localDate, localTime, gmtDate, gmtTime, true);
}

bool ICU::gmtToLocal(const UDate& gmtDate, const UDate& gmtTime, UDate& localDate, UDate& localTime)
{
// Convert a GMT date/time into a local date/time string
return _convertLocalAndGmt(gmtDate, gmtTime, localDate, localTime, false);
}

bool ICU::CeguiStringToDateTime(const CEGUI::String& stringDateTime, const CEGUI::String& mask, UDate& unicodeDateTime)
{
// Convert a string date/time into a UDate
UErrorCode status = U_ZERO_ERROR;
unicodeDateTime = 0.0;

// Create a Date/Time formatter
DateFormat* fmt = DateFormat::createDateTimeInstance(DateFormat::kDefault, DateFormat::kDefault, m_locale);

// Activate our pattern
UnicodeString pattern(mask.c_str());
((SimpleDateFormat*) fmt)->applyPattern(pattern);

// Parse the string into a date/time
UnicodeString uValue(stringDateTime.c_str());
unicodeDateTime = fmt->parse(uValue, status);
delete fmt;
if( U_FAILURE(status) )
return false;

return true;
}

bool ICU::CeguiStringToInt32(const CEGUI::String& stringValue, int32_t& int32Value)
{
// Convert a string into an int32_t
UErrorCode status = U_ZERO_ERROR;
int32Value = 0;

// Create an integer formatter
NumberFormat *fmt = NumberFormat::createInstance(Locale::getUS(), status);
if( U_FAILURE(status) )
return false;

// Activate our pattern
UnicodeString pattern("#,##0");
((DecimalFormat*) fmt)->applyPattern(pattern, status);
if( U_FAILURE(status) )
{
delete fmt;
return false;
}

// Parse the string into a double
UnicodeString uValue(stringValue.c_str());
Formattable result;
fmt->parse(uValue, result, status);
delete fmt;
if( U_FAILURE(status) )
return false;

int32Value = result.getLong();

return true;
}

void ICU::UnicodeToCeguiString(const UnicodeString& unicodeString, CEGUI::String& ceguiString)
{
// Convert a unicode string to a CEGUI string
ceguiString.clear();

CEGUI::String digit;
for(int32_t i = 0; i < unicodeString.length(); ++i)
{
digit = unicodeString.charAt(i);
ceguiString.append(digit);
}
}

void ICU::_splitIntegerDecimal(const CEGUI::String& combined, CEGUI::String& integerPart, CEGUI::String& decimalPart)
{
// Split a decimal value into its constituent integer and decimal parts
CEGUI::String::size_type idx = combined.find(".");
if(idx == CEGUI::String::npos)
{
integerPart = combined;
decimalPart.clear();
}
else
{
integerPart = combined.substr(0, idx);
decimalPart = combined.substr(idx);
}
}

bool ICU::_convertLocalAndGmt(const UDate& localDate, const UDate& localTime, UDate& gmtDate, UDate& gmtTime, bool fromLocalToGMT)
{
// Helper function to convert between a local and a GMT date/time
UErrorCode status = U_ZERO_ERROR;
gmtDate = gmtTime = 0.0;

// Create a calendar for the local date
Calendar* calLocalDate = Calendar::createInstance(m_locale, status);
if( U_FAILURE(status) )
return false;
calLocalDate->clear();
calLocalDate->setTime(localDate, status);
if( U_FAILURE(status) )
{
delete calLocalDate;
return false;
}

// Create a calendar for the local time
Calendar* calLocalTime = Calendar::createInstance(m_locale, status);
if( U_FAILURE(status) )
{
delete calLocalDate;
return false;
}
calLocalTime->clear();
calLocalTime->setTime(localTime, status);
if( U_FAILURE(status) )
{
delete calLocalDate;
delete calLocalTime;
return false;
}

// Retrieve the offset between this time zone and the GMT time zone
// The Daylight Saving Time offset is zero when DST is not in effect
// Note that adding the local date and time together introduces an
// inaccuracy of up to 1 minute 47 seconds. However the only impact
// of this inaccuracy is to advance/delay the activation or deactivation
// of daylight savings
int32_t rawOffset, dstOffset, gmtOffset;
calLocalDate->getTimeZone().getOffset(localDate + localTime, true, rawOffset, dstOffset, status);
gmtOffset = (rawOffset + dstOffset) / 1000 / 60 / 60; // Convert from milliseconds to hours

// Converting from local to GMT requires "reversing" the time zone
// EST is GMT-5 so it requires adding 5 hours to local time to obtain GMT
// Converting from GMT to local requires the opposite
int32_t hour = calLocalTime->get(UCAL_HOUR_OF_DAY, status);
if(fromLocalToGMT)
hour -= gmtOffset;
else
hour += gmtOffset;

// Adjust the time and date if necessary
if(hour >= 24)
{
// We've moved to the next day
hour -= 24;
calLocalDate->add(UCAL_DAY_OF_MONTH, 1, status);
if( U_FAILURE(status) )
{
delete calLocalDate;
delete calLocalTime;
return false;
}
}
else if(hour < 0)
{
// We've moved to the previous day
hour += 24;
calLocalDate->add(UCAL_DAY_OF_MONTH, -1, status);
if( U_FAILURE(status) )
{
delete calLocalDate;
delete calLocalTime;
return false;
}
}
calLocalTime->set(UCAL_HOUR_OF_DAY, hour);

// Retrieve the converted date and time
gmtDate = calLocalDate->getTime(status);
gmtTime = calLocalTime->getTime(status);

delete calLocalDate;
delete calLocalTime;
if( U_FAILURE(status) )
return false;

return true;
}

bool ICU::_ruleBasedNumberFormat(const double rawValue, URBNFRuleSetTag tag, CEGUI::String& formattedValue)
{
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();

// Create a rule based number formatter
RuleBasedNumberFormat* fmt = new RuleBasedNumberFormat(tag, m_locale, status);
if( U_FAILURE(status) )
return false;

UnicodeString uValue;
fmt->format(rawValue, uValue);
delete fmt;

formattedValue.clear();
UnicodeToCeguiString(uValue, formattedValue);
return true;
}

bool ICU::_ruleBasedNumberFormat(const int32_t rawValue, URBNFRuleSetTag tag, CEGUI::String& formattedValue)
{
UErrorCode status = U_ZERO_ERROR;
formattedValue.clear();

// Create a rule based number formatter
RuleBasedNumberFormat* fmt = new RuleBasedNumberFormat(tag, m_locale, status);
if( U_FAILURE(status) )
return false;

UnicodeString uValue;
Formattable fValue(rawValue);
fmt->format(fValue, uValue, status);
delete fmt;
if( U_FAILURE(status) )
return false;

formattedValue.clear();
UnicodeToCeguiString(uValue, formattedValue);
return true;
}
</pre>

===FormattedData.h===
<pre>
#ifndef _FormattedData_h_
#define _FormattedData_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

#include "ICU.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("FormattedData.layout");
sheet->addChildWindow(guiLayout);

/******** ICU Stuff ********/

// Display one ISO country in a combo box
Combobox* countries = static_cast<Combobox*>(winMgr.getWindow("Countries"));
countries->setReadOnly(true);
ListboxTextItem* listboxTextItem;
listboxTextItem = new ListboxTextItem( Locale::getDefault().getCountry() );
listboxTextItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
countries->addItem(listboxTextItem);
countries->setText( Locale::getDefault().getCountry() );
countries->subscribeEvent(Combobox::EventListSelectionAccepted, Event::Subscriber(&DemoSample::onLocaleChanged, this));

// Display two ISO languages in a combo box
Combobox* languages = static_cast<Combobox*>(winMgr.getWindow("Languages"));
languages->subscribeEvent(Combobox::EventListSelectionAccepted, Event::Subscriber(&DemoSample::onLocaleChanged, this));
languages->setReadOnly(true);
listboxTextItem = new ListboxTextItem("en");
listboxTextItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
languages->addItem(listboxTextItem);
listboxTextItem = new ListboxTextItem("fr");
listboxTextItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
languages->addItem(listboxTextItem);
languages->setText("en");
languages->subscribeEvent(Combobox::EventListSelectionAccepted, Event::Subscriber(&DemoSample::onLocaleChanged, this));
PushButton* everyISO = static_cast<PushButton*>(winMgr.getWindow("EveryISO"));
everyISO->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::onLoadEveryISO, this));

// Configure the currency widgets
Editbox* currencyValue = static_cast<Editbox*>(winMgr.getWindow("CurrencyValue"));
currencyValue->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onCurrencyChanged, this));
RadioButton* radio;
radio = static_cast<RadioButton*>(winMgr.getWindow("RadioCAD"));
radio->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&DemoSample::onCurrencySelected, this));
radio->setID(1);
radio->setSelected(true);
radio = static_cast<RadioButton*>(winMgr.getWindow("RadioUSD"));
radio->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&DemoSample::onCurrencySelected, this));
radio->setID(2);
radio = static_cast<RadioButton*>(winMgr.getWindow("RadioEUR"));
radio->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&DemoSample::onCurrencySelected, this));
radio->setID(3);
radio = static_cast<RadioButton*>(winMgr.getWindow("RadioMRO"));
radio->subscribeEvent(RadioButton::EventSelectStateChanged, Event::Subscriber(&DemoSample::onCurrencySelected, this));
radio->setID(4);

// Configure the numeric widgets
Editbox* numericValue = static_cast<Editbox*>(winMgr.getWindow("NumericValue"));
numericValue->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onNumericChanged, this));
Editbox* numericFormat = static_cast<Editbox*>(winMgr.getWindow("NumericFormat"));
numericFormat->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onNumericChanged, this));
PushButton* numericFormatButton = static_cast<PushButton*>(winMgr.getWindow("NumericFormatButton"));
numericFormatButton->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::onNumericFormatClicked, this));

// Configure the date/time widgets
Editbox* dateValue = static_cast<Editbox*>(winMgr.getWindow("DateValue"));
dateValue->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onDateTimeChanged, this));
Editbox* timeValue = static_cast<Editbox*>(winMgr.getWindow("TimeValue"));
timeValue->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onDateTimeChanged, this));
Editbox* dateFormat = static_cast<Editbox*>(winMgr.getWindow("DateFormat"));
dateFormat->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onDateTimeChanged, this));
Editbox* timeFormat = static_cast<Editbox*>(winMgr.getWindow("TimeFormat"));
timeFormat->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onDateTimeChanged, this));
PushButton* dateTimeFormatButton = static_cast<PushButton*>(winMgr.getWindow("DateTimeFormatButton"));
dateTimeFormatButton->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::onDateTimeFormatClicked, this));

// Configure the spinner
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));
spinner->subscribeEvent(Spinner::EventValueChanged, Event::Subscriber(&DemoSample::onSpinnerValueChanged, this));
static_cast<Editbox*>(winMgr.getWindow(spinner->getName() + "__auto_editbox__"))->setReadOnly(true); // We cannot handle manually specified values yet
spinner->setTextInputMode(Spinner::FloatingPoint); // FloatingPoint, Integer, Hexadecimal, Octal
spinner->setMinimumValue(-10.0f);
spinner->setMaximumValue(10.0f);
spinner->setStepSize(0.02f);
spinner->setCurrentValue(5.2f);

// Configure the character widgets
Editbox* characterValue = static_cast<Editbox*>(winMgr.getWindow("CharacterValue"));
characterValue->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onCharacterChanged, this));
Editbox* characterFormat = static_cast<Editbox*>(winMgr.getWindow("CharacterFormat"));
characterFormat->subscribeEvent(Editbox::EventTextChanged, Event::Subscriber(&DemoSample::onCharacterChanged, this));
PushButton* characterFormatButton = static_cast<PushButton*>(winMgr.getWindow("CharacterFormatButton"));
characterFormatButton->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::onCharacterFormatClicked, this));
EventArgs e;
onCharacterFormatClicked(e);

// Initialize the localise values
RefreshLocalisedValues();
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
CEGUI::FontManager::getSingleton().destroyAllFonts();
}
private:
ICU icu; // International Components for Unicode

void RefreshLocalisedValues()
{
// Trigger changes in localised widgets to refresh their values accordingly
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
EventArgs eventArgs;
static_cast<RadioButton*>(winMgr.getWindow("RadioCAD"))->fireEvent(RadioButton::EventSelectStateChanged, eventArgs);
static_cast<PushButton*>(winMgr.getWindow("NumericFormatButton"))->fireEvent(PushButton::EventClicked, eventArgs);
static_cast<PushButton*>(winMgr.getWindow("DateTimeFormatButton"))->fireEvent(PushButton::EventClicked, eventArgs);
static_cast<Spinner*>(winMgr.getWindow("Spinner"))->fireEvent(Spinner::EventValueChanged, eventArgs);
}

bool onLocaleChanged(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
String country = static_cast<Combobox*>(winMgr.getWindow("Countries"))->getText();
String language = static_cast<Combobox*>(winMgr.getWindow("Languages"))->getText();
if(icu.setLocale(language.c_str(), country.c_str()))
RefreshLocalisedValues();
else
MessageBox(NULL,
("Error with setLocale(" + language + ", " + country + ")").c_str(),
"Error",
MB_OK | MB_ICONERROR | MB_TASKMODAL);

return true;
}

bool onLoadEveryISO(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
ListboxTextItem* listboxTextItem;
int32_t count;

// Change the label of the button
PushButton* everyISO = static_cast<PushButton*>(winMgr.getWindow("EveryISO"));
everyISO->setText("This will take a few seconds...");

// Display every ISO countries in a combobox
Combobox* countries = static_cast<Combobox*>(winMgr.getWindow("Countries"));
const char * const * listCountries = Locale::getISOCountries();
for(count = 0; listCountries[count]; count++)
{
listboxTextItem = new ListboxTextItem(listCountries[count]);
listboxTextItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
countries->addItem(listboxTextItem);
}
countries->setText( Locale::getDefault().getCountry() );

// Display every ISO languages in a combobox
Combobox* languages = static_cast<Combobox*>(winMgr.getWindow("Languages"));
const char * const * listLanguages = Locale::getISOLanguages();
for(count = 0; listLanguages[count]; count++)
{
listboxTextItem = new ListboxTextItem(listLanguages[count]);
listboxTextItem->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
languages->addItem(listboxTextItem);
}
languages->setText( Locale::getDefault().getLanguage() );

// Remove this button since it is no longer useful
everyISO->setEnabled(false);
everyISO->setVisible(false);

return true;
}

bool onCurrencyChanged(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
EventArgs eventArgs;
static_cast<RadioButton*>(winMgr.getWindow("RadioCAD"))->fireEvent(RadioButton::EventSelectStateChanged, eventArgs);
return true;
}

bool onCurrencySelected(const CEGUI::EventArgs& e)
{
// Reformat the numeric value into a properly formatted currency
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

// Set the currency
CEGUI::uint id = static_cast<RadioButton*>(winMgr.getWindow("RadioCAD"))->getSelectedButtonInGroup()->getID();
switch(id)
{
case 1:
icu.setCurrency("CAD");
break;
case 2:
icu.setCurrency("USD");
break;
case 3:
icu.setCurrency("EUR");
break;
case 4:
// Mauritania does not use a decimal division of units
// and yet ICU still displays decimal units??
icu.setCurrency("MRO");
break;
}

CEGUI::String rawValue = static_cast<Editbox*>(winMgr.getWindow("CurrencyValue"))->getText();
double currency = atof(rawValue.c_str());
CEGUI::String formattedValue;
if( icu.formatCurrency(currency, formattedValue) )
static_cast<Editbox*>(winMgr.getWindow("CurrencyFormattedValue"))->setText(formattedValue);

return true;
}

bool onNumericChanged(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
EventArgs eventArgs;
static_cast<PushButton*>(winMgr.getWindow("NumericFormatButton"))->fireEvent(PushButton::EventClicked, eventArgs);

return true;
}

bool onNumericFormatClicked(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
String formattedText;
if( icu.formatNumber(static_cast<Editbox*>(winMgr.getWindow("NumericValue"))->getText(),
static_cast<Editbox*>(winMgr.getWindow("NumericFormat"))->getText(),
formattedText) )
static_cast<Editbox*>(winMgr.getWindow("NumericFormattedValue"))->setText(formattedText);

// Ordinal representation of an integer value
double doubleValue = atof(static_cast<Editbox*>(winMgr.getWindow("NumericValue"))->getText().c_str());
if( icu.numberToOrdinal((int) doubleValue, formattedText) )
static_cast<Editbox*>(winMgr.getWindow("NumericFormattedOrdinal"))->setText(formattedText);

// Textual representation of the numeric value
// Note that this value must be raw, containing only digits and a decimal point
// Since atof() is used to convert from a string to a double this numeric value is not localised
if( icu.numberToText(doubleValue, formattedText) )
static_cast<Editbox*>(winMgr.getWindow("NumericFormattedText"))->setText(formattedText);

return true;
}

bool onDateTimeChanged(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
EventArgs eventArgs;
static_cast<PushButton*>(winMgr.getWindow("DateTimeFormatButton"))->fireEvent(PushButton::EventClicked, eventArgs);

return true;
}

bool onDateTimeFormatClicked(const CEGUI::EventArgs& e)
{
// Format the date and time according to their specified values and formats
// In theory a format can include both the date and the time: yyyy/MM/dd HH:mm:ss
// However in practice the resulting time is not accurate (within 1 minute 47 seconds)
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
UDate localDate, localTime, gmtDate, gmtTime, gmtDateTime;
if(icu.CeguiStringToDateTime( static_cast<Editbox*>(winMgr.getWindow("DateValue"))->getText(),
"yyyy/MM/dd", // Internal format
localDate)
&& icu.CeguiStringToDateTime( static_cast<Editbox*>(winMgr.getWindow("TimeValue"))->getText(),
"HH:mm:ss", // Internal format
localTime) )
{
String formattedDate, formattedTime;
if(icu.formatDateTime( localDate,
static_cast<Editbox*>(winMgr.getWindow("DateFormat"))->getText(),
formattedDate)
&& icu.formatDateTime( localTime,
static_cast<Editbox*>(winMgr.getWindow("TimeFormat"))->getText(),
formattedTime)
)
static_cast<Editbox*>(winMgr.getWindow("LocalDateTimeFormattedValue"))->setText(formattedDate + " " + formattedTime);

// GMT time
if( icu.CeguiStringToDateTime(static_cast<Editbox*>(winMgr.getWindow("LocalDateTimeFormattedValue"))->getText(),
"yyyy/MM/dd HH:mm:ss",
gmtDateTime)
&& icu.localToGmt(localDate, localTime, gmtDate, gmtTime)
&& icu.formatDateTime(gmtDate, "yyyy/MM/dd", formattedDate)
&& icu.formatDateTime(gmtTime, "HH:mm:ss", formattedTime)
)
static_cast<Editbox*>(winMgr.getWindow("GmtDateTimeFormattedValue"))->setText(formattedDate + " " + formattedTime);
}

return true;
}

bool onSpinnerValueChanged(const CEGUI::EventArgs& e)
{
// Reformat the displayed value into a locale appropriate format
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));

String formattedValue;
if( icu.formatNumber(spinner->getCurrentValue(), "#0.00", formattedValue) )
{
// Disable the Editbox events, especially the EventTextChanged that
// triggers Spinner::handleEditTextChange, which attempts to convert
// the textual value into a non-localised numeric value
Editbox* editbox = static_cast<Editbox*>(winMgr.getWindow(spinner->getName() + "__auto_editbox__"));
bool muted = editbox->isMuted();
editbox->setMutedState(true);
spinner->setText(formattedValue);
editbox->setMutedState(muted);
}

return true;
}

bool onCharacterChanged(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
EventArgs eventArgs;
static_cast<PushButton*>(winMgr.getWindow("CharacterFormatButton"))->fireEvent(PushButton::EventClicked, eventArgs);

return true;
}

bool onCharacterFormatClicked(const CEGUI::EventArgs& e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
String formattedText;
if( icu.formatText(static_cast<Editbox*>(winMgr.getWindow("CharacterValue"))->getText(),
static_cast<Editbox*>(winMgr.getWindow("CharacterFormat"))->getText(),
"*",
formattedText) )
static_cast<Editbox*>(winMgr.getWindow("CharacterFormattedValue"))->setText(formattedText);

return true;
}

};

#endif // _FormattedData_h_
</pre>

===main.cpp===
<pre>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "FormattedNumericData.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</pre>

===FormattedData.layout===
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="FrameWindow" >
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.07125,0},{0.013335,0},{0.910001,0},{0.873733,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Spinner" Name="Spinner" >
<Property Name="Text" Value="10.00" />
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="10" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.8473,0},{0.731682,0},{0.951964,0},{0.790123,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="SpinnerLabel" >
<Property Name="Text" Value="Localised Spinner widget with 2 decimals:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.395457,0},{0.731682,0},{0.836346,0},{0.790123,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="CurrencyFormattedValue" >
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.616765,0},{0.203821,0},{0.954642,0},{0.262262,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioCAD" >
<Property Name="Text" Value="Canadian (CAD)" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.430655,0},{0.158378,0},{0.614153,0},{0.187144,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioMRO" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Mauritania (MRO)" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.430655,0},{0.26902,0},{0.614153,0},{0.297787,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioUSD" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="US (USD)" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.430655,0},{0.195183,0},{0.5605,0},{0.22395,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioEUR" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Euro (EUR)" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.430655,0},{0.232215,0},{0.5605,0},{0.260983,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="CountriesLabel" >
<Property Name="Text" Value="Countries:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.022504,0},{0.069049,0},{0.132414,0},{0.117804,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="LanguagesLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Languages:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.268405,0},{0.069049,0},{0.385766,0},{0.117804,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Countries" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.142027,0},{0.069049,0},{0.245976,0},{0.902039,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Languages" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.395379,0},{0.069049,0},{0.499329,0},{0.90204,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Separator1" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.013562,0},{0.141452,0},{0.995305,0},{0.150048,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Separator2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.013562,0},{0.309408,0},{0.995305,0},{0.318004,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Separator3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.013562,0},{0.553045,0},{0.995305,0},{0.561642,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Separator5" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.007601,0},{0.814139,0},{0.989344,0},{0.822736,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="NumericFormatLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Format:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.403136,0},{0.141946,0},{0.461576,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="NumericFormat" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="#,##0.03" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.403136,0},{0.421111,0},{0.461576,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="NumericFormatButton" >
<Property Name="Text" Value="Apply" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.473919,0},{0.370638,0},{0.603204,0},{0.429079,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="NumericFormattedValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.616765,0},{0.339418,0},{0.954642,0},{0.397859,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DateFormatLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Format:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.63711,0},{0.141946,0},{0.695551,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="DateFormat" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="yyyy/MM/dd" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.63711,0},{0.269099,0},{0.695551,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="DateValueLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Date:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.574987,0},{0.141946,0},{0.633428,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="DateValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="2006/05/14" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.574987,0},{0.267608,0},{0.633428,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DateTimeFormatButton" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Apply" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.473919,0},{0.610743,0},{0.603205,0},{0.669184,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="LocalDateTimeFormattedValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.724067,0},{0.578862,0},{0.954642,0},{0.637303,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="TimeValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="12:00:01" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.351492,0},{0.574987,0},{0.441976,0},{0.633428,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="TimeValueLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Time:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.280703,0},{0.574987,0},{0.347609,0},{0.633428,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="TimeFormat" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="HH:mm:ss" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.281446,0},{0.63711,0},{0.441976,0},{0.695551,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="NumericValueLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Numeric:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.339418,0},{0.141946,0},{0.397857,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="NumericValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="123456.78" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.339418,0},{0.421111,0},{0.397858,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="CurrencyValueLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Currency:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.203821,0},{0.141946,0},{0.26226,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="CurrencyValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="123456.78" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.203821,0},{0.421111,0},{0.262262,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Separator4" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.013562,0},{0.702202,0},{0.995305,0},{0.710798,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="EveryISO" >
<Property Name="Text" Value="Load every country and languages" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.559611,0},{0.069049,0},{0.94523,0},{0.12749,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="NumericFormattedText" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.153278,0},{0.482989,0},{0.954642,0},{0.54143,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="CharacterFormattedValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.616765,0},{0.883872,0},{0.954642,0},{0.942313,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="CharacterFormat" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="000 000 000" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.908716,0},{0.421111,0},{0.967156,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="CharacterFormatButton" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Apply" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.473919,0},{0.883872,0},{0.603205,0},{0.942313,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="CharacterValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="123456" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.150298,0},{0.844998,0},{0.421111,0},{0.903438,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="LocalDateTimeFormattedLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Local:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.641358,0},{0.578862,0},{0.718697,0},{0.637302,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="GmtDateTimeFormattedLabel" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="GMT:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.641358,0},{0.63711,0},{0.718697,0},{0.69555,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="GmtDateTimeFormattedValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.725558,0},{0.63711,0},{0.954642,0},{0.695551,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="NumericValueLabel1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Numeric:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.844998,0},{0.141946,0},{0.903437,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="NumericFormatLabel1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Format:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.036292,0},{0.908716,0},{0.141946,0},{0.967156,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="NumericFormattedOrdinal" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="ReadOnly" Value="True" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.616765,0},{0.403136,0},{0.954642,0},{0.461577,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Dialog Configurations

2008-02-01T13:09:13Z

Rackle: /* DialogConfigurationsDemo.h */

=== Introduction ===
Dialogs (frame windows) can be moved around, resized, hidden, and rolled up while the application is running. MultiColumnLists can have their columns rearranged, resized, and a column can sort its content in ascending or descending order. However closing and then restarting the application will reset these settings to their default values, those specified within a .layout file if one was use, or those specified in code.

This clases saves these attributes into an XML file. When the application restarts the contents of the XML file will be read and the dialogs and MultiColumnLists will be restored to their last states.

Please discuss this snippet in the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=8002#8002 Storing Dialog Configurations] thread on the message board.

=== Incorporating into Sample_Demo7 ===
This demo contains 3 dialogs. Let's store their configurations.

Add DialogConfigurations.cpp to the Sample_Demo7 project.

Edit Sample_Demo7.h:
* add '''#include "DialogConfigurations.h"'''
* add within the protected section: '''DialogConfigurations m_dialogConfigurations;'''

Edit Sample_Demo7.cpp to add the following at the end of the Demo7Sample::initialiseSample() function, between ''initDemoEventWiring();'' and ''return true;'':
m_dialogConfigurations.loadConfigurations("../datafiles/configs/Sample_Demo7.xml", "../datafiles/configs/DialogConfigurations.xsd");
m_dialogConfigurations.addDialog("Demo7/Window1");
m_dialogConfigurations.addDialog("Demo7/Window2");
m_dialogConfigurations.addDialog("Demo7/Window3");

Add the following to Demo7Sample::cleanupSample()
m_dialogConfigurations.saveConfigurations();

That's it! From now on the 3 windows within that demo will "remember" their previous configurations.

'''Warning:''' the Demo7Sample::cleanupSample() is never called when exiting the demo, despite what the comments might say. A solution is presented on the [http://www.cegui.org.uk/phpBB2/viewtopic.php?t=1550 message board].

=== Configuration Attributes ===
The XML configuration file is loaded by a call to loadConfigurations(). It silently ignores errors within that XML file. The worst that will happen is that some dialogs and MultiColumnLists will revert to their initial values.

Calling addDialog() and passing the window name as parameter will register that dialog to have its configuration written to the XML file. The next call to saveConfigurations() will write the configuration of that registered window such that the next time loadConfigurations() is called the window will be automatically registered.

The second parameter of addDialog() allows you to specify which attributes to monitor. By default every attribute is monitored. However you can specify to monitor one or many of the following, separated by spaces: Position, Visible, and RolledUp.

The addMultiColumnList() function behaves in a similar manner, allowing you to specify which MultiColumnLists and which of their attributes to monitor. Again the default is to monitor every attribute but you can also specify one or many of the following: ColumnSequence, ColumnWidths, SortedColumn, and AscendingSort.

=== Files ===

==== DialogConfigurations.h ====
<code><cpp/>
#ifndef _DialogConfigurations_h_
#define _DialogConfigurations_h_

#include "CEGUI.h"
#include "CEGUIXMLHandler.h"
#include "CEGUIXMLParser.h"
#include "CEGUIXMLAttributes.h"
#include <map>

class DialogConfigurations : public CEGUI::XMLHandler
{
public:
// Constructor.
// Sets various default values.
DialogConfigurations();

// Load the configuration of every stored dialog and multi column list.
// By default, also apply these configurations.
bool loadConfigurations(const CEGUI::String& xmlFile, const CEGUI::String& schema = "", const bool& applyConfigurations = true);

// Store the configuration of every dialog and multi column list.
bool saveConfigurations();

// Set default configurations for dialogs.
void setDialogDefaults(const CEGUI::URect& position, const bool& visible, const bool& rolledup);

// Specify which dialog attributes are monitored by default.
void setDefaultDialogAttributesMonitored(const CEGUI::String& attributesMonitored);

// Add a dialog to be monitored.
// Optionally specify which attributes this specific dialog monitors.
bool addDialog(const CEGUI::String& widget, const CEGUI::String& attributesMonitored = "");

// Return the position of the specified dialog.
const CEGUI::URect& getDialogSavedPosition(const CEGUI::String& dialog);

// Return the visible/hidden state of the specified dialog.
const bool& getDialogSavedVisible(const CEGUI::String& dialog);

// Return the expansion state of the specified dialog.
const bool& getDialogSavedRolledup(const CEGUI::String& dialog);

// Apply the saved configuration to the specified dialog.
bool applyDialogConfiguration(const CEGUI::String& dialog = "");

// Set default configurations for multi column lists.
void setMultiColumnListDefaults(const std::vector<CEGUI::String>& columnSequence, const CEGUI::uint& sortedColumn, const bool& sortAscending, const std::vector<CEGUI::String>& columnWidths);

// Specify which dialog attributes are monitored by default.
void setDefaultMultiColumnListAttributesMonitored(const CEGUI::String& attributesMonitored);

// Add a MultiColumnList to be monitored.
bool addMultiColumnList(const CEGUI::String& widget, const CEGUI::String& attributesMonitored = "");

// Apply the saved configuration to the specified multi column list.
bool applyMultiColumnListConfiguration(const CEGUI::String& multiColumnList = "");

private:
// Whether a particular attribute is monitored.
bool isMonitoringAttribute(const std::vector<CEGUI::String>& list, const CEGUI::String& attribute);

// Performs the actual load every stored configuration.
void elementStart(const CEGUI::String& element, const CEGUI::XMLAttributes& xmlAttributes);

// Tag name for dialog positions element.
static const CEGUI::String m_DialogConfigurationElement;

// Tag name for position elements.
static const CEGUI::String m_configurationElementDialog;

// Attribute name that stores the name of the window.
static const char windowNameAttribute[];

// Attribute name that stores the position of the window.
static const char windowPosAttribute[];

// Attribute name that stores the visible state of the window.
static const char windowVisibleAttribute[];

// Attribute name that stores the rolledUp state of the window.
static const char windowRolledupAttribute[];

// Tag name of MultiColumnList elements.
static const CEGUI::String m_configurationElementMultiColumnList;

// Attribute name that stores the sequence of the columns.
static const char mclColumnSequenceAttribute[];

// Attribute name that stores which column is sorted.
static const char mclSortedColumnAttribute[];

// Attribute name that stores the sort order direction.
static const char mclAscendingSortAttribute[];

// Attribute name that stores the widths of the columns.
static const char DialogConfigurations::mclColumnWidthAttribute[];

// Separator for the column sequences.
static const char DialogConfigurations::mclColumnSequenceSeparator;

// Separator for the column widths.
static const char DialogConfigurations::mclColumnWidthSeparator;

// Special attribute name to monitor every attribute.
static const char monitoredAttributeAll[];

// Special attribute name to monitor no attribute.
static const char monitoredAttributeNone[];

// The value of one dialog configuration.
struct DialogConfig {
CEGUI::URect position;
bool visible;
bool rolledup;
};

// List of the dialog configurations.
std::map<CEGUI::String, DialogConfig> m_dialogConfigurations;

// Default position.
CEGUI::URect m_defaultPosition;

// Default visible/hidden.
bool m_defaultVisible;

// Default rolled up/expanded.
bool m_defaultRolledup;

// Specify which attributes to monitor for this dialog.
void _setDialogAttributesMonitored(const CEGUI::String& dialog, const CEGUI::String& attributesMonitored);

// List of the attributes monitored per dialog.
std::map<CEGUI::String, std::vector<CEGUI::String>> m_attributesMonitoredDialog;

// The value of one multi column list configuration.
struct MultiColumnListConfig {
std::vector<CEGUI::String> columnSequence;
CEGUI::uint sortedColumn;
bool sortAscending;
std::vector<CEGUI::String> columnWidths;
};

// List of the multi column list configurations.
std::map<CEGUI::String, MultiColumnListConfig> m_multiColumnListConfigurations;

// Default column sequence.
std::vector<CEGUI::String> m_defaultColumnSequence;

// Default sorted column.
CEGUI::uint m_defaultSortedColumn;

// Default sort order.
bool m_defaultSortAscending;

// Default column widths.
std::vector<CEGUI::String> m_defaultColumnWidths;

// Specify which attributes to monitor for this multi column list.
void _setMultiColumnListAttributesMonitored(const CEGUI::String& multiColumnList, const CEGUI::String& attributesMonitored);

// List of the attributes monitored per MultiColumnList
std::map<CEGUI::String, std::vector<CEGUI::String>> m_attributesMonitoredMultiColumnList;

// File containing the positions.
CEGUI::String m_configFile;

// List of the supported attributes.
static std::vector<CEGUI::String> m_attributeList;
};

#endif // _DialogConfigurations_h_
</code>

==== DialogConfigurations.cpp ====
<code><cpp/>
#include "DialogConfigurations.h"
#include "CEGUIPropertyHelper.h"

//Definition of XML elements and attributes
const CEGUI::String DialogConfigurations::m_DialogConfigurationElement( "DialogConfigurations" );
const CEGUI::String DialogConfigurations::m_configurationElementDialog( "DialogConfiguration" );
const char DialogConfigurations::windowNameAttribute[] = "Name";
const char DialogConfigurations::windowPosAttribute[] = "Position";
const char DialogConfigurations::windowVisibleAttribute[] = "Visible";
const char DialogConfigurations::windowRolledupAttribute[] = "RolledUp";
const char DialogConfigurations::monitoredAttributeAll[] = "All";
const char DialogConfigurations::monitoredAttributeNone[] = "None";
const CEGUI::String DialogConfigurations::m_configurationElementMultiColumnList( "MultiColumnListConfiguration" );
const char DialogConfigurations::mclColumnSequenceAttribute[] = "ColumnSequence";
const char DialogConfigurations::mclColumnWidthAttribute[] = "ColumnWidths";
const char DialogConfigurations::mclSortedColumnAttribute[] = "SortedColumn";
const char DialogConfigurations::mclAscendingSortAttribute[]= "AscendingSort";
const char DialogConfigurations::mclColumnSequenceSeparator = ',';
const char DialogConfigurations::mclColumnWidthSeparator = ';';

// List of the supported attributes
// Each attribute is enclosed within spaces
//const CEGUI::String DialogConfigurations::m_attributeList = " All None Position Visible RolledUp MCLWidths MCLSequence MCLSort ";
std::vector<CEGUI::String> DialogConfigurations::m_attributeList;

void Tokenize(const CEGUI::String& str, std::vector<CEGUI::String>& tokens, const char delimiters = ' ')
{
// Break a sentence into multiple words separated by delimiters
// Does not handle words within double-quotes: One "2 &2" three, four

// Skip delimiters at beginning
CEGUI::String::size_type lastPos = str.find_first_not_of(delimiters, 0);

// Find first "non-delimiter"
CEGUI::String::size_type pos = str.find_first_of(delimiters, lastPos);

CEGUI::String::size_type length = str.length();
while (str.npos != pos || str.npos != lastPos)
{
// Cap the position to the length of the string
if(pos == str.npos)
pos = length;
if(lastPos == str.npos)
lastPos = length;

// Found a token, add it to the vector
tokens.push_back(str.substr(lastPos, pos - lastPos));

// Skip delimiters
lastPos = str.find_first_not_of(delimiters, pos);

// Find next "non-delimiter"
pos = str.find_first_of(delimiters, lastPos);
}
}

DialogConfigurations::DialogConfigurations()
{
setDialogDefaults(CEGUI::URect( CEGUI::UDim(0.0f, 0.0f),
CEGUI::UDim(0.0f, 0.0f),
CEGUI::UDim(0.5f, 0.0f),
CEGUI::UDim(0.5f, 0.0f)),
true,
true);

// setMultiColumnListDefaults()
m_defaultSortedColumn = 0;
m_defaultSortAscending = true;

if(m_attributeList.empty())
{
// This is a static variable, only initialize once
m_attributeList.push_back(monitoredAttributeAll);
m_attributeList.push_back(monitoredAttributeNone);
m_attributeList.push_back(windowPosAttribute);
m_attributeList.push_back(windowVisibleAttribute);
m_attributeList.push_back(windowRolledupAttribute);
m_attributeList.push_back(mclColumnSequenceAttribute);
m_attributeList.push_back(mclSortedColumnAttribute);
m_attributeList.push_back(mclAscendingSortAttribute);
m_attributeList.push_back(mclColumnWidthAttribute);
}

// The default is to monitor every attribute
_setDialogAttributesMonitored("", monitoredAttributeAll);
_setMultiColumnListAttributesMonitored("", monitoredAttributeAll);
}

bool DialogConfigurations::loadConfigurations(const CEGUI::String& xmlFile, const CEGUI::String& schema, const bool& applyConfigurations)
{
// Load the config of every stored dialog
assert(!xmlFile.empty() && "You must specify an xml file to loadConfigurations()");
m_configFile = xmlFile;
bool loadedOk = true;
try
{
CEGUI::System::getSingleton().getXMLParser()->parseXMLFile(*this, m_configFile, schema, "");
}
catch(const CEGUI::Exception&)
{
// File is empty or parse error
// Silently ignore; we'll create a new file when saving
loadedOk = false;
}

if(applyConfigurations)
{
applyDialogConfiguration();
applyMultiColumnListConfiguration();
}

return loadedOk;
}

bool DialogConfigurations::saveConfigurations()
{
// Store the configuration of every registered dialog, either within
// the loaded XML file or those manually registered via addDialog()
assert(!m_configFile.empty() && "You must specify an xml file by calling loadConfigurations() before saveConfigurations()");

// Try to open the XML file in writing mode
std::ofstream fileSave;
fileSave.open(m_configFile.c_str(), std::ios::out) ;
if( !fileSave.is_open() )
{
CEGUI::Logger::getSingleton().logEvent("Could not write to dialog configuration file ("
+ m_configFile
+ "). Is it read-only?",
CEGUI::Errors);
return false;
}

// Write the header
fileSave << "<?xml version=\"1.0\" ?>" << std::endl
<< "<" << m_DialogConfigurationElement << ">"
<< std::endl;

// Write each dialog's configuration
DialogConfig dialogConfig;
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, DialogConfig>::iterator itDialogConfig;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
std::vector<CEGUI::String> attributesMonitored;
CEGUI::Window* window;
for(itDialogConfig = m_dialogConfigurations.begin(); itDialogConfig != m_dialogConfigurations.end(); ++itDialogConfig)
{
if(!winMgr.isWindowPresent(itDialogConfig->first))
continue;

itAttributesMonitored = m_attributesMonitoredDialog.find(itDialogConfig->first);
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredDialog.find("");
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second;
}

window = winMgr.getWindow(itDialogConfig->first);
dialogConfig.position = window->getArea();
dialogConfig.visible = window->isVisible();
if( window->testClassName("FrameWindow") )
dialogConfig.rolledup = static_cast<CEGUI::FrameWindow*>(window)->isRolledup();
else
dialogConfig.rolledup = false;
fileSave << " <" << m_configurationElementDialog.c_str() << " "
<< windowNameAttribute << "=\"" << itDialogConfig->first << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowPosAttribute))
fileSave << windowPosAttribute << "=\"" << CEGUI::PropertyHelper::urectToString(dialogConfig.position) << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowVisibleAttribute))
fileSave << windowVisibleAttribute << "=\"" << dialogConfig.visible << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowRolledupAttribute))
fileSave << windowRolledupAttribute << "=\"" << dialogConfig.rolledup << "\" ";
fileSave << "/>" << std::endl;
}

// Write each MultiColumnList's configuration
std::map<CEGUI::String, MultiColumnListConfig>::iterator itMultiColumnListConfig;
attributesMonitored.clear();
CEGUI::MultiColumnList* multiColumnList;
for(itMultiColumnListConfig = m_multiColumnListConfigurations.begin(); itMultiColumnListConfig != m_multiColumnListConfigurations.end(); ++itMultiColumnListConfig)
{
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find(itMultiColumnListConfig->first);
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find("");
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second;
}

multiColumnList = static_cast<CEGUI::MultiColumnList*>(winMgr.getWindow(itMultiColumnListConfig->first));
fileSave << " <" << m_configurationElementMultiColumnList.c_str() << " "
<< windowNameAttribute << "=\"" << itMultiColumnListConfig->first << "\" ";
if(isMonitoringAttribute(attributesMonitored, mclColumnSequenceAttribute) && multiColumnList->getColumnCount())
{
fileSave << mclColumnSequenceAttribute << "=\"";
for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
if(columnIndex)
fileSave << mclColumnSequenceSeparator;
fileSave << multiColumnList->getColumnID(columnIndex);
}
fileSave << "\" ";
}
if(isMonitoringAttribute(attributesMonitored, mclColumnWidthAttribute) && multiColumnList->getColumnCount())
{
fileSave << mclColumnWidthAttribute << "=\"";
for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
if(columnIndex)
fileSave << mclColumnWidthSeparator;
fileSave << CEGUI::PropertyHelper::udimToString(multiColumnList->getColumnHeaderWidth(columnIndex));
}
fileSave << "\" ";
}
if(isMonitoringAttribute(attributesMonitored, mclSortedColumnAttribute))
fileSave << mclSortedColumnAttribute << "=\"" << multiColumnList->getColumnID(multiColumnList->getSortColumn()) << "\" ";
if(isMonitoringAttribute(attributesMonitored, mclAscendingSortAttribute))
fileSave << mclAscendingSortAttribute << "=\"" << (multiColumnList->getSortDirection() != CEGUI::ListHeaderSegment::Descending) << "\" ";
fileSave << "/>" << std::endl;
}

// Write the footer
fileSave << "</" << m_DialogConfigurationElement << ">" << std::endl;
fileSave.close();
return true;
}

void DialogConfigurations::setDialogDefaults(const CEGUI::URect& position, const bool& visible, const bool& rolledup)
{
// Set default values
// Should validate what's being passed as parameters
m_defaultPosition = position;
m_defaultVisible = visible;
m_defaultRolledup = rolledup;
}

void DialogConfigurations::setDefaultDialogAttributesMonitored(const CEGUI::String& attributesMonitored)
{
_setDialogAttributesMonitored("", attributesMonitored);
}

bool DialogConfigurations::addDialog(const CEGUI::String& widget, const CEGUI::String& attributesMonitored)
{
// Add a dialog to be monitored
// This can be used to automatically write the contents of the initial XML file
// rather than editing it by hand.
assert(!widget.empty() && "You must pass a dialog name to addDialog()");

if(!attributesMonitored.empty())
_setDialogAttributesMonitored(widget, attributesMonitored);

std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(widget);
if(itConfig != m_dialogConfigurations.end())
return false; // This dialog is already added

CEGUI::Window* window = CEGUI::WindowManager::getSingleton().getWindow(widget);
DialogConfig config;
config.position = window->getArea();
config.visible = window->isVisible();
if( window->testClassName("FrameWindow") )
config.rolledup = static_cast<CEGUI::FrameWindow*>(window)->isRolledup();
else
config.rolledup = m_defaultRolledup; // Not really needed, unless this window inherits from FrameWindow after being loaded

m_dialogConfigurations[widget] = config;
return true;
}

const CEGUI::URect& DialogConfigurations::getDialogSavedPosition(const CEGUI::String& dialog)
{
// Return the position of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultPosition : (*itConfig).second.position;
}

const bool& DialogConfigurations::getDialogSavedVisible(const CEGUI::String& dialog)
{
// Return the visible/hidden state of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultVisible : (*itConfig).second.visible;
}

const bool& DialogConfigurations::getDialogSavedRolledup(const CEGUI::String& dialog)
{
// Return the expansion state of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultRolledup : (*itConfig).second.rolledup;
}

bool DialogConfigurations::applyDialogConfiguration(const CEGUI::String& dialog)
{
// Apply the saved configuration to a dialog
if(dialog.length() == 0)
{
// Load every dialog configurations
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
for(itConfig = m_dialogConfigurations.begin(); itConfig != m_dialogConfigurations.end(); itConfig++)
{
applyDialogConfiguration((*itConfig).first);
}
}
else
{
// Find this dialog's configuration
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
if(itConfig == m_dialogConfigurations.end() || !winMgr.isWindowPresent(dialog))
return false;

// Determine which attributes are monitored
std::vector<CEGUI::String> attributesMonitored;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
itAttributesMonitored = m_attributesMonitoredDialog.find(dialog);
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredDialog.find("");
if(itAttributesMonitored == m_attributesMonitoredDialog.end())
return false; // Could not retrieve the default attributes (should never happen)
attributesMonitored = (*itAttributesMonitored).second;
}

// Apply the configuration to the dialog
CEGUI::Window* window = winMgr.getWindow(dialog);
if(isMonitoringAttribute(attributesMonitored, windowPosAttribute))
window->setArea((*itConfig).second.position);
if(isMonitoringAttribute(attributesMonitored, windowVisibleAttribute))
window->setVisible((*itConfig).second.visible);
if(isMonitoringAttribute(attributesMonitored, windowRolledupAttribute))
{
if( window->testClassName("FrameWindow") )
{
CEGUI::FrameWindow* frameWindow = static_cast<CEGUI::FrameWindow*>(window);
if(frameWindow->isRolledup() != (*itConfig).second.rolledup)
frameWindow->toggleRollup();
}
}
}
return true;
}

void DialogConfigurations::setMultiColumnListDefaults(const std::vector<CEGUI::String>& columnSequence, const CEGUI::uint& sortedColumn, const bool& sortAscending, const std::vector<CEGUI::String>& columnWidths)
{
// Set default values
// Should validate what's being passed as parameters
m_defaultColumnSequence = columnSequence;
m_defaultSortedColumn = sortedColumn;
m_defaultSortAscending = sortAscending;
m_defaultColumnWidths = columnWidths;
}

void DialogConfigurations::setDefaultMultiColumnListAttributesMonitored(const CEGUI::String& attributesMonitored)
{
_setMultiColumnListAttributesMonitored("", attributesMonitored);
}

bool DialogConfigurations::addMultiColumnList(const CEGUI::String& widget, const CEGUI::String& attributesMonitored)
{
// Add a MultiColumnList to be monitored
// This can be used to automatically write the contents of the initial XML file
// rather than editing it by hand.
assert(!widget.empty() && "You must pass a multiColumnList name to addMultiColumnList()");

if(!attributesMonitored.empty())
_setMultiColumnListAttributesMonitored(widget, attributesMonitored);

std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
itConfig = m_multiColumnListConfigurations.find(widget);
if(itConfig != m_multiColumnListConfigurations.end())
return false; // This MultiColumnList is already added

MultiColumnListConfig config;
CEGUI::MultiColumnList* multiColumnList = static_cast<CEGUI::MultiColumnList*>(CEGUI::WindowManager::getSingleton().getWindow(widget));
assert(multiColumnList->testClassName("MultiColumnList") && "This widget is not a MultiColumnList");

for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
config.columnSequence.push_back(CEGUI::PropertyHelper::uintToString(multiColumnList->getColumnID(columnIndex)));
config.columnWidths.push_back(CEGUI::PropertyHelper::udimToString(multiColumnList->getColumnHeaderWidth(columnIndex)));
}
config.sortedColumn = multiColumnList->getSortColumn();
config.sortAscending = multiColumnList->getSortDirection() != CEGUI::ListHeaderSegment::Descending;

m_multiColumnListConfigurations[widget] = config;
return true;
}

bool DialogConfigurations::applyMultiColumnListConfiguration(const CEGUI::String& multiColumnList)
{
// Apply the saved configuration to a multi column list
if(multiColumnList.length() == 0)
{
// Load every multi column list configurations
std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
for(itConfig = m_multiColumnListConfigurations.begin(); itConfig != m_multiColumnListConfigurations.end(); itConfig++)
{
applyMultiColumnListConfiguration((*itConfig).first);
}
}
else
{
// Find this multi column list's configuration
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
itConfig = m_multiColumnListConfigurations.find(multiColumnList);
if(itConfig == m_multiColumnListConfigurations.end() || !winMgr.isWindowPresent(multiColumnList))
return false;

// Determine which attributes are monitored
std::vector<CEGUI::String> attributesMonitored;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find(multiColumnList);
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second; // Multi column list has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find("");
if(itAttributesMonitored == m_attributesMonitoredMultiColumnList.end())
return false; // Could not retrieve the default attributes (should never happen)
attributesMonitored = (*itAttributesMonitored).second;
}

// Apply the configuration to the multi column list
CEGUI::MultiColumnList* window = static_cast<CEGUI::MultiColumnList*>(winMgr.getWindow(multiColumnList));
if(isMonitoringAttribute(attributesMonitored, mclColumnSequenceAttribute))
{
for(CEGUI::uint columnIndex = 0; columnIndex < window->getColumnCount() && columnIndex < (*itConfig).second.columnSequence.size(); ++columnIndex)
{
window->moveColumn(window->getColumnWithID(CEGUI::PropertyHelper::stringToUint((*itConfig).second.columnSequence.at(columnIndex))),
columnIndex);
}
}
if(isMonitoringAttribute(attributesMonitored, mclColumnWidthAttribute))
{
CEGUI::UDim width;
for(CEGUI::uint columnIndex = 0; columnIndex < window->getColumnCount() && columnIndex < (*itConfig).second.columnWidths.size(); ++columnIndex)
{
width = CEGUI::PropertyHelper::stringToUDim((*itConfig).second.columnWidths.at(columnIndex));
window->setColumnHeaderWidth(columnIndex, width);
}
}
if(isMonitoringAttribute(attributesMonitored, mclSortedColumnAttribute))
{
window->setSortColumn( window->getColumnWithID((*itConfig).second.sortedColumn) );
}
if(isMonitoringAttribute(attributesMonitored, mclAscendingSortAttribute))
{
window->setSortDirection( (*itConfig).second.sortAscending ? CEGUI::ListHeaderSegment::Ascending
: CEGUI::ListHeaderSegment::Descending);
}
}
return true;
}

bool DialogConfigurations::isMonitoringAttribute(const std::vector<CEGUI::String>& list, const CEGUI::String& attribute)
{
std::vector<CEGUI::String>::const_iterator itList;
for(itList = list.begin(); itList != list.end(); itList++)
{
if(!(*itList).compare(attribute))
return true;
}
return false;
}

void DialogConfigurations::elementStart(const CEGUI::String& element, const CEGUI::XMLAttributes& xmlAttributes)
{
// Performs the actual load every stored configuration
if (element == m_configurationElementDialog)
{
DialogConfig config;
config.position = m_defaultPosition;
config.visible = m_defaultVisible;
config.rolledup = m_defaultRolledup;
CEGUI::String name, monitoredAttributes;
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();

name = xmlAttributes.getValueAsString(windowNameAttribute);

if(xmlAttributes.exists(windowPosAttribute))
{
config.position = CEGUI::PropertyHelper::stringToURect(xmlAttributes.getValueAsString(windowPosAttribute));
monitoredAttributes.append(" ").append(windowPosAttribute);
}
if(xmlAttributes.exists(windowVisibleAttribute))
{
config.visible = xmlAttributes.getValueAsBool(windowVisibleAttribute);
monitoredAttributes.append(" ").append(windowVisibleAttribute);
}
if(xmlAttributes.exists(windowRolledupAttribute))
{
config.rolledup = xmlAttributes.getValueAsBool(windowRolledupAttribute);
monitoredAttributes.append(" ").append(windowRolledupAttribute);
}

_setDialogAttributesMonitored(name, monitoredAttributes);
m_dialogConfigurations[name] = config;
}
else if (element == m_configurationElementMultiColumnList)
{
MultiColumnListConfig config;
config.sortedColumn = m_defaultSortedColumn;
config.sortAscending = m_defaultSortAscending;
CEGUI::String name, monitoredAttributes;

name = xmlAttributes.getValueAsString(windowNameAttribute);

if(xmlAttributes.exists(mclColumnSequenceAttribute))
{
CEGUI::String columnSequence = xmlAttributes.getValueAsString(mclColumnSequenceAttribute);
Tokenize(columnSequence, config.columnSequence, mclColumnSequenceSeparator);
monitoredAttributes.append(" ").append(mclColumnSequenceAttribute);
}
if(xmlAttributes.exists(mclColumnWidthAttribute))
{
CEGUI::String columnWidths = xmlAttributes.getValueAsString(mclColumnWidthAttribute);
Tokenize(columnWidths, config.columnWidths, mclColumnWidthSeparator);
monitoredAttributes.append(" ").append(mclColumnWidthAttribute);
}
if(xmlAttributes.exists(mclSortedColumnAttribute))
{
config.sortedColumn = xmlAttributes.getValueAsInteger(mclSortedColumnAttribute);
monitoredAttributes.append(" ").append(mclSortedColumnAttribute);
}
if(xmlAttributes.exists(mclAscendingSortAttribute))
{
config.sortAscending = xmlAttributes.getValueAsBool(mclAscendingSortAttribute);
monitoredAttributes.append(" ").append(mclAscendingSortAttribute);
}

_setMultiColumnListAttributesMonitored(name, monitoredAttributes);
m_multiColumnListConfigurations[name] = config;
}
}

void DialogConfigurations::_setDialogAttributesMonitored(const CEGUI::String& dialog, const CEGUI::String& attributesMonitored)
{
// Validate the attributes to be monitored
std::vector<CEGUI::String> newAttributes;
std::vector<CEGUI::String> listAttributesMonitored;
Tokenize(attributesMonitored, listAttributesMonitored); // Convert attributesMonitored into a vector
std::vector<CEGUI::String>::iterator itToken;
for(itToken = listAttributesMonitored.begin(); itToken != listAttributesMonitored.end(); itToken++)
{
if(!(*itToken).compare(monitoredAttributeAll))
{
newAttributes.push_back(windowPosAttribute);
newAttributes.push_back(windowVisibleAttribute);
newAttributes.push_back(windowRolledupAttribute);
}
else if(!(*itToken).compare(monitoredAttributeNone))
{
newAttributes.clear();
}
else if(!(*itToken).compare(windowPosAttribute))
newAttributes.push_back(windowPosAttribute);
else if(!(*itToken).compare(windowVisibleAttribute))
newAttributes.push_back(windowVisibleAttribute);
else if(!(*itToken).compare(windowRolledupAttribute))
newAttributes.push_back(windowRolledupAttribute);
else
{
// Attribute is not supported
assert(false && "Unsupported attribute specified for a dialog");
CEGUI::Logger::getSingleton().logEvent("The attribute \""
+ (*itToken)
+ "\" is unsupported for dialogs.",
CEGUI::Errors);
}
}

// Store the attributes to be monitored
m_attributesMonitoredDialog[dialog] = newAttributes;
}

void DialogConfigurations::_setMultiColumnListAttributesMonitored(const CEGUI::String& multiColumnList, const CEGUI::String& attributesMonitored)
{
// Validate the attributes to be monitored
std::vector<CEGUI::String> newAttributes;
std::vector<CEGUI::String> listAttributesMonitored;
Tokenize(attributesMonitored, listAttributesMonitored); // Convert attributesMonitored into a vector
std::vector<CEGUI::String>::iterator itToken;
for(itToken = listAttributesMonitored.begin(); itToken != listAttributesMonitored.end(); itToken++)
{
if(!(*itToken).compare(monitoredAttributeAll))
{
newAttributes.push_back(mclColumnSequenceAttribute);
newAttributes.push_back(mclSortedColumnAttribute);
newAttributes.push_back(mclAscendingSortAttribute);
newAttributes.push_back(mclColumnWidthAttribute);
}
else if(!(*itToken).compare(monitoredAttributeNone))
{
newAttributes.clear();
}
else if(!(*itToken).compare(mclColumnSequenceAttribute))
newAttributes.push_back(mclColumnSequenceAttribute);
else if(!(*itToken).compare(mclSortedColumnAttribute))
newAttributes.push_back(mclSortedColumnAttribute);
else if(!(*itToken).compare(mclAscendingSortAttribute))
newAttributes.push_back(mclAscendingSortAttribute);
else if(!(*itToken).compare(mclColumnWidthAttribute))
newAttributes.push_back(mclColumnWidthAttribute);
else
{
// Attribute is not supported
assert(false && "Unsupported attribute specified for a MultiColumnList");
CEGUI::Logger::getSingleton().logEvent("The attribute \""
+ (*itToken)
+ "\" is unsupported for MultiColumnLists.",
CEGUI::Errors);
}
}

// Store the attributes to be monitored
m_attributesMonitoredMultiColumnList[multiColumnList] = newAttributes;
}
</code>

==== DialogConfigurationsDemo.h ====
<code><cpp/>
#ifndef _DialogConfigurationsDemo_h_
#define _DialogConfigurationsDemo_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "DialogConfigurations.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("DialogConfigurations.layout");
sheet->addChildWindow(guiLayout);

// Configure the toolbar
winMgr.getWindow("DialogConfigurations/Toolbar/ShowA")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showA, this));
winMgr.getWindow("DialogConfigurations/Toolbar/ShowC")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showC, this));
winMgr.getWindow("DialogConfigurations/Toolbar/ShowD")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showD, this));

// Activate the close buttons
winMgr.getWindow("DialogConfigurations/Window_A")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeA, this));
winMgr.getWindow("DialogConfigurations/Window_B")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeB, this));
winMgr.getWindow("DialogConfigurations/Window_C")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeC, this));
winMgr.getWindow("DialogConfigurations/Window_D")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeD, this));

// Add columns to the MultiColumnList
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("DialogConfigurations/Window_D/MultiColumnList"));
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));

// Add rows
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("1", 101), 0, 0); // ColumnID, RowID
multiColumnList->setItem(new ListboxTextItem("4", 102), 1, 0);
multiColumnList->setItem(new ListboxTextItem("7", 103), 2, 0);
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("4", 201), 0, 1);
multiColumnList->setItem(new ListboxTextItem("7", 202), 1, 1);
multiColumnList->setItem(new ListboxTextItem("1", 203), 2, 1);
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("7", 301), 0, 2);
multiColumnList->setItem(new ListboxTextItem("1", 302), 1, 2);
multiColumnList->setItem(new ListboxTextItem("4", 303), 2, 2);

// Activate dialog configurations
m_DialogConfigurations.loadConfigurations("DialogConfigurations.xml");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_A", "Position Visible");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_B", "Position RolledUp");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_C", "Visible RolledUp");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_D"); // Saves every attribute: Position, Visible, and RolledUp
m_DialogConfigurations.addMultiColumnList("DialogConfigurations/Window_D/MultiColumnList"); // Saves every attribute: ColumnSequence, ColumnWidths, SortedColumn, and AscendingSort
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
m_DialogConfigurations.saveConfigurations();
}

bool showA(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_A")->setVisible(true);
return true;
}

bool showC(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_C")->setVisible(true);
return true;
}

bool showD(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_D")->setVisible(true);
return true;
}

bool closeA(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_A")->setVisible(false);
return true;
}

bool closeB(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_B")->setVisible(false);
return true;
}

bool closeC(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_C")->setVisible(false);
return true;
}

bool closeD(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_D")->setVisible(false);
return true;
}
private:
DialogConfigurations m_DialogConfigurations;
};

#endif // _DialogConfigurationsDemo_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "DialogConfigurationsDemo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== DialogConfigurations.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="DialogConfigurations" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/StaticText" Name="DialogConfigurations/Toolbar" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.1875,0},{0.00833335,0},{0.8025,0},{0.111667,0}}" />
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowA" >
<Property Name="Text" Value="Show A" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.0581303,0},{0.156452,0},{0.30813,0},{0.858064,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowC" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Show C" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.388618,0},{0.156452,0},{0.638618,0},{0.858064,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowD" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Show D" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.704878,0},{0.156452,0},{0.954878,0},{0.858064,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_A" >
<Property Name="Text" Value="A - RolledUp not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.035,0},{0.123333,0},{0.325,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_B" >
<Property Name="Text" Value="B - Visible not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.35125,0},{0.123333,0},{0.64125,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_C" >
<Property Name="Text" Value="C - Position & Size not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.6675,0},{0.123333,0},{0.957501,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_D" >
<Property Name="Text" Value="D Saves MultiColumnList column width, sequence, and sort" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.10625,0},{0.53375,0},{0.86625,0},{0.962083,0}}" />
<Window Type="TaharezLook/MultiColumnList" Name="DialogConfigurations/Window_D/MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.031235,0},{0.140467,0},{0.968886,0},{0.950778,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Sample code for all Widgets

2008-02-01T13:08:23Z

Rackle: /* WidgetGalore.h */

This code goes through every widget and demonstrates how to retrieve and set their data as well as some of their particularities. Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=7967#7967 Widget Galore]

=== Widgets===

==== General ====
A widget can be enabled/disabled via setEnabled(). Disabling a widget prevents the user from activating it and manipulating its contents. A widget can be hidden/shown via setVisible().

==== Tooltip ====
A Tooltip widget displays text when the mouse has been hovering over a widget for a certain amount of time. This widget requires that time be injected within CEGUI via injectTimePulse().

The graphical aspect (the scheme) of the tooltip can be specified via setTooltip(). The amount of hovering time required to activate the tooltip can be specified via setHoverTime(). The amount of time the tooltip is displayed can be specified via setDisplayTime(). And the fade transition time can be specified via setFadeTime(); this affects both the fade in and the fade out times. The tooltip text of a widget can be specified via setTooltipText(). Please note that some complex widgets are composed of several widgets. In order to have a tooltip text displayed while hovering over any region of the complex widget then every component widget needs to have a tooltip text specified. For example a Spinner widget is composed of an Editbox widget and two Button widgets.

==== StaticText ====
There is no StaticText within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed text can be specified via setText(). The color of this text can be specified via the "TextColours" property. The value of this property contains 4 color definitions: top left, top right, bottom left, and bottom right. Each color is specified as a two-digit hexadecimal value of the format AARRGGBB (alpha, red, green, blue). The text is aligned vertically via the "VertFormatting" property with a value of TopAligned, BottomAligned, or VertCentred. The text is aligned horizontally via the "HorzFormatting" property with a value of LeftAligned, RightAligned, HorzCentred, HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, or WordWrapJustified.

==== StaticImage ====
There is no StaticImage within Cegui but type of widget can be obtained via the DefaultWindow class.

The currently displayed image can be specified via the "Image" property. This property takes two parameters, the imageset ("set") and the image name ("image").

==== ProgressBar ====
A ProgressBar widget displays a progression; it does not receive inputs from a user.

The current progress can be specified via setProgress(). Progress can be advanced through steps. The step size can be specified via setStepSize() and a step performed via step(). Progress can be adjusted by a delta value via adjustProgress(). The current progress value can be obtained via getProgress().

==== Button ====
A Button widget displays a text and receives an activation instruction from the user.

The text can be specified via setText().

==== ScrollablePane ====
A ScrollablePane widget displays contents that can be scrolled. Contents can be added via addChildWindow(). When that content exceeds the dimensions of the ScrollablePane then scrollbars appear to allow the use to view and interact with that hidden content.

==== Checkbox ====
A Checkbox widget controls a boolean value; true when checked and false when unchecked. This value can be obtained via isSelected() and specified via setSelected(true) to check or setSelected(false) to uncheck.

==== Spinner ====
A Spinner widget controls a numerical values (float) through an editbox or the use of the increment or decrement buttons.

This value is bounded within a minimum and a maximum by calling setMinimumValue() and setMaximumValue(). The arrow buttons increment or decrement the value by the amount specified with setStepSize(). The numerical value can be displayed in four formats: FloatingPoint, Integer, Hexadecimal, Octal.

The current value is obtained via getCurrentValue() and specified via setCurrentValue().

==== Editbox ====
An Editbox widget controls printable character values; letters, numbers, punctuations, and symbols.

The maximal number of characters that can be specified is bound by setMaxTextLength(). The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). The value can be masked via setTextMasked() and the default value of * can be modified via setMaskCodePoint().

The current value can be obtained via getText() and specified via setText().

==== Slider ====
A Slider widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setMaxValue(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setClickStep().

The current value can be obtained via getCurrentValue() and specified via setCurrentValue().

==== Scrollbar ====
A Scrollbar widget controls a numerical value (float) through the position of a "thumb".

This value is bounded within a maximum by setDocumentSize(); the minimum value is set to 0.0f. The thumb can be dragged to the desired position or moved by clicking on either side of the thumb. The increment or decrement value is set by setPageSize(). The arrow buttons increment or decrement the value by the amount specified with setStepSize().

The current value can be obtained via getScrollPosition() and specified via setScrollPosition(). Note that the actual maximum value that the scrollbar will return is set by the following formula: document_size - page_size. Thus, a document of size 100 and a page size of 10 will have a value from 0 to 90.

==== MultiLineEditbox ====
A MultiLineEditbox widget controls printable character values; letters, numbers, punctuations, and symbols.

Unlike the Editbox widget there is no maximal number of characters that can be specified. The value can be set to readable only (modifications by users are not allowed) via setReadOnly(true). Text can be automatically wrapped via a call to setWordWrapping(true).

The current value can be obtained via getText() and specified via setText().

==== RadioButton ====
A RadioButton widget controls a single selection among many choices.

The choices are grouped by calling setGroupID(). Only one RadioButton per group ID can be selected; this widget does not support multiple selection. However it is possible for a choice to possess no decision; initially every RadioButton of a group is unselected.

The currently selected RadioButton can be obtained via getSelectedButtonInGroup(). This RadioButton pointer can then be used to query the ID via getID(), the text (visible label of the RadioButton) via getText(), or user data via getUserData(). A RadioButton can be selected via setSelected(true). Passing false will deselect the RadioButton, potentially making every RadioButton of the group unselected.

==== Listbox ====
A Listbox widget controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setMultiselectEnabled().

The choices are listbox text items (ListboxTextItem) added to the listbox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage(). The call to ensureItemIsVisible() ensures that the item is visible; the listbox will automatically scroll down if necessary. The text of the ListboxTextItem can be changed via the setText() function. However this new text will not be displayed until you call the Listbox's handleUpdatedItemData() function.

The selected ListboxItem can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). A selection can be specified via setItemSelectState().

==== Combobox ====
A Combobox widget controls a single selection among many choices.

The choices are listbox text items (ListboxTextItem) added to the combobox via addItem(). These do not possess a selection indicator by default; one must be specified via setSelectionBrushImage().

The value of the text within the Editbox can be obtained via getText() and the last selected ListboxItem can be obtained via getSelectedItem(). However there is no guarantee that both are synchronized; typing text within the Editbox will not automatically select the corresponding ListboxItem. Fortunately the reverse is not true; selecting a ListboxItem will place that text within the Editbox. Placing the Editbox in read-only mode with setReadOnly(true) can avoid problems. The current value can be specified via listboxTextItem->setSelected(true) and a setText(itemCombobox->getText()).

==== MultiColumnList ====
A MultiColumnList widget controls controls either a single selection or multiple selections among many choices. Multiple selections are enabled via setSelectionMode(MultiColumnList::RowMultiple).

A MultiColumnList widget may contain a single column or multiple columns. Columns are added via addColumn(), specifying a label, a column ID, and a column width.

Three steps are required to add a row. The first step is to add a new row with addRow(). The second step is to create a ListboxTextItem for each cell of the row and specify the selection indicator via setSelectionBrushImage(). The third step is to add the newly created ListboxTextItem to the MultiColumnList via setItem(), specifying the ListboxTextItem, the column ID, and the row ID.

The selected row can be obtained via getFirstSelectedItem() and subsequent selections through getNextSelected(). This will iterate through every selected cell, returning each selected ListboxTextItem . A selection can be specified via setItemSelectState(); by setting the selection mode to rows (either RowSingle or RowMultiple) you actually only need to select the ListboxTextItem of the first column.

==== TabControl ====
A TabControl widget allows multiple windows to be displayed one at a time, via tab buttons.

Two objects must be created within the Layout Editor to generate a functional tab control. The first is a window of type "TabControl". This will be the parent window of the tab buttons as well as the pages. The second is a window of type "DefaultWindow". This window will be placed within the TabControl (in code via addTab(), not through the Layout Editor) and will specify the contents of a page. Widgets are to be placed within these TabPane via the Layout Editor. The "TabButton" windows are not to be specified via the Layout Editor since they will be automatically created when a TabPane is added to the TabControl.

In this demo the TabControl widget was placed within a FrameWindow. This is not a requirement. It could have just easily been placed alongside the widgets of the other window.

==== Menu & Popup Menu ====

See [[http://www.cegui.org.uk/wiki/index.php/MenuAndPopup Menu & Popup Menu]]

=== Files ===

==== WidgetGalore.h ====
<code><cpp/>
#ifndef _WidgetGalore_h_
#define _WidgetGalore_h_

#include "CEGuiSample.h"
#include "CEGUI.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("WidgetGalore.layout");
sheet->addChildWindow(guiLayout);

/* Tooltip */
System::getSingleton().setDefaultTooltip("TaharezLook/Tooltip"); // Set the name of the default tooltip
Tooltip* tooltip = System::getSingleton().getDefaultTooltip();
tooltip->setHoverTime(0.5f); // Display the tooltip after the mouse has been hovering over the widget for half a second
tooltip->setDisplayTime(10.0f); // Display for 15 seconds then disappear
tooltip->setFadeTime(1.0f); // Duration of the transition between fully visible and fully invisible
// To set the tooltip text for a window simply call setTooltipText() see staticText for an example

/* StaticText */
DefaultWindow* staticText = static_cast<DefaultWindow*>(winMgr.getWindow("StaticText"));
staticText->setText("Red Static Text");
staticText->setProperty("TextColours", "tl:FFFF0000 tr:FFFF0000 bl:FFFF0000 br:FFFF0000"); // aarrggbb in Hexadecimal
// tl: top left, tr: top right, bl: bottom left, br: bottom right
staticText->setProperty("VertFormatting", "VertCentred"); // TopAligned, BottomAligned, VertCentred
staticText->setProperty("HorzFormatting", "HorzCentred"); // LeftAligned, RightAligned, HorzCentred
// HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified
staticText->setTooltipText("This is a StaticText widget");

/* StaticImage */
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForStaticImage", "GPN-2000-001437.tga");
DefaultWindow* staticImage = static_cast<DefaultWindow*>(winMgr.getWindow("StaticImage"));
staticImage->setProperty("Image", "set:ImageForStaticImage image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()

/* ProgressBar */
ProgressBar* progressBar = static_cast<ProgressBar*>(winMgr.getWindow("ProgressBar"));
progressBar->setProgress(0.25f); // Initial progress of 25%
progressBar->setStepSize(0.10f); // Calling step() will increase the progress by 10%
progressBar->step(); // Advance the progress by the size specified in setStepSize()
progressBar->adjustProgress(-0.05f); // Adjust the progress by a delta value rather than setting a new value through setProgress
float valueProgressBar = progressBar->getProgress(); // initial 0.25f + step 0.10f - adjustment 0.05f = 0.30f

/* Button */
PushButton* btnClose = static_cast<PushButton*>(winMgr.getWindow("btnClose"));
btnClose->setText("Exit");

/* ScrollablePane */
ScrollablePane* scrollablePane = static_cast<ScrollablePane*>(winMgr.getWindow("ScrollablePane"));
ImagesetManager::getSingleton().createImagesetFromImageFile("ImageForScrollablePane", "GPN-2000-001437.tga");
DefaultWindow* staticImageInScrollablePane = static_cast<DefaultWindow*>(winMgr.createWindow("TaharezLook/StaticImage", "StaticImageInScrollablePane"));
staticImageInScrollablePane->setProperty("Image", "set:ImageForScrollablePane image:full_image"); // "full_image" is a default name from CEGUIImageset::Imageset()
staticImageInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Start in the upper left corner
staticImageInScrollablePane->setWidth(UDim(2.0f, 0.0f)); // Twice the width of the parent, the ScrollablePane
staticImageInScrollablePane->setHeight(UDim(2.0f, 0.0f)); // Twice the height of the parent, the ScrollablePane
scrollablePane->addChildWindow(staticImageInScrollablePane); // Add the image to the // Twice the width of the parent, the ScrollablePane
Editbox* editboxInScrollablePane = static_cast<Editbox*>(winMgr.createWindow("TaharezLook/Editbox", "EditboxInScrollablePane"));
editboxInScrollablePane->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(2.1f, 0.0f))); // Start below the image
editboxInScrollablePane->setWidth(UDim(2.0f, 0.0f));
editboxInScrollablePane->setHeight(UDim(0.3f, 0.0f));
scrollablePane->addChildWindow(editboxInScrollablePane);

/* Check box */
Checkbox* checkbox = static_cast<Checkbox*>(winMgr.getWindow("Checkbox"));
checkbox->setSelected( true );
bool valueCheckbox = checkbox->isSelected(); // Retrieve whether it is checked

/* Spinner */
Spinner* spinner = static_cast<Spinner*>(winMgr.getWindow("Spinner"));
spinner->setTextInputMode(Spinner::FloatingPoint); // FloatingPoint, Integer, Hexadecimal, Octal
spinner->setMinimumValue(-10.0f);
spinner->setMaximumValue(10.0f);
spinner->setStepSize(0.2f);
spinner->setCurrentValue(5.2f);
float valueSpinner = spinner->getCurrentValue(); // Retrieve the value

/* Editbox */
Editbox* editbox = static_cast<Editbox*>(winMgr.getWindow("Editbox"));
editbox->setText("Editbox values");
editbox->setMaxTextLength(13); // The trailing 's' will not be displayed
editbox->setReadOnly(false);
editbox->setTextMasked(false);
editbox->setMaskCodePoint(0x002A); // *
String valueEditbox = editbox->getText(); // Retrieve the text

/* Slider */
Slider* slider = static_cast<Slider*>(winMgr.getWindow("Slider"));
slider->setMaxValue(100.0f);
slider->setClickStep(10.0f);
slider->setCurrentValue(20.0f);
float valueSlider = slider->getCurrentValue(); // Retrieve the value

/* Scrollbar (Horizontal) */
Scrollbar* scrollbarHorizontal = static_cast<Scrollbar*>(winMgr.getWindow("HorizontalScrollbar"));
scrollbarHorizontal->setDocumentSize(100.0f);
scrollbarHorizontal->setPageSize(10.0f);
scrollbarHorizontal->setStepSize(1.0f);
scrollbarHorizontal->setScrollPosition(75.0f);
float valueScrollbarHorizontal = scrollbarHorizontal->getScrollPosition(); // Retrieve the scroll position

/* Scrollbar (Vertical) */
Scrollbar* scrollbarVertical = static_cast<Scrollbar*>(winMgr.getWindow("VerticalScrollbar"));
scrollbarVertical->setDocumentSize(100.0f);
scrollbarVertical->setPageSize(10.0f);
scrollbarVertical->setStepSize(1.0f);
scrollbarVertical->setScrollPosition(25.0f);
float valueScrollbarVertical = scrollbarVertical->getScrollPosition(); // Retrieve the scroll position

/* MultiLineEditbox */
MultiLineEditbox* multiLineEditbox = static_cast<MultiLineEditbox*>(winMgr.getWindow("MultiLineEditbox"));
multiLineEditbox->setText("MultiLineEditbox value");
multiLineEditbox->setReadOnly(false);
multiLineEditbox->setWordWrapping(true);
String valueMultiLineEditbox = multiLineEditbox->getText(); // Retrieve the text

/* RadioButton */
RadioButton* radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A"));
radioButton->setGroupID(1);
radioButton->setID(101);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_B"));
radioButton->setGroupID(1);
radioButton->setID(102);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_C"));
radioButton->setGroupID(1);
radioButton->setID(103);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_1"));
radioButton->setGroupID(2);
radioButton->setID(201);
radioButton->setSelected(true);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_2"));
radioButton->setGroupID(2);
radioButton->setID(202);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3"));
radioButton->setGroupID(2);
radioButton->setID(203);
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_A")); // Get handle of one radio button from the group
uint valueRadioButtonLetters = radioButton->getSelectedButtonInGroup()->getID(); // Get selected ID
radioButton = static_cast<RadioButton*>(winMgr.getWindow("RadioButton_3")); // Can obtain the handle of any radio button in the group
uint valueRadioButtonNumbers = radioButton->getSelectedButtonInGroup()->getID();
radioButton->setSelected(true); // Specify which button should appear selected by default

/* Listbox */
Listbox* listbox = static_cast<Listbox*>(winMgr.getWindow("Listbox"));
listbox->setMultiselectEnabled(false);
ListboxTextItem* itemListbox = new ListboxTextItem("Value A", 1);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value B", 2);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value C", 3);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
itemListbox = new ListboxTextItem("Value D", 4);
itemListbox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
listbox->addItem(itemListbox);
listbox->setItemSelectState(itemListbox, true);
listbox->ensureItemIsVisible(itemListbox);
uint valueListbox = listbox->getFirstSelectedItem()->getID(); // Retrieve the ID of the selected listbox item

/* Combobox */
Combobox* combobox = static_cast<Combobox*>(winMgr.getWindow("Combobox"));
combobox->setReadOnly(true);
ListboxTextItem* itemCombobox = new ListboxTextItem("Value 1", 1);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 2", 2);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox->setSelected(true); // Select this item
combobox->setText(itemCombobox->getText()); // Copy the item's text into the Editbox
itemCombobox = new ListboxTextItem("Value 3", 3);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
itemCombobox = new ListboxTextItem("Value 4", 4);
itemCombobox->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
combobox->addItem(itemCombobox);
String valueCombobox = combobox->getText(); // Retrieve the displayed text
uint idCombobox = combobox->getSelectedItem()->getID(); // Retrieve the ID of the selected combobox item

/* MultiColumnList */
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("MultiColumnList"));\
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));
multiColumnList->setSelectionMode(MultiColumnList::RowSingle); // MultiColumnList::RowMultiple
ListboxTextItem* itemMultiColumnList;
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A1", 101);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B1", 102);
//itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
// By commenting the line above a cell does not specify a selection indicator
// selecting that line will show a "gap" in the selection.
multiColumnList->setItem(itemMultiColumnList, 1, 0); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C1", 103);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 0); // ColumnID, RowID
multiColumnList->addRow();
itemMultiColumnList = new ListboxTextItem("A2", 201);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 0, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("B2", 202);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 1, 1); // ColumnID, RowID
itemMultiColumnList = new ListboxTextItem("C2", 203);
itemMultiColumnList->setSelectionBrushImage("TaharezLook", "MultiListSelectionBrush");
multiColumnList->setItem(itemMultiColumnList, 2, 1); // ColumnID, RowID
MCLGridRef grid_ref(1, 0); // Select according to a grid reference; second row
multiColumnList->setItemSelectState(grid_ref, true);
ListboxItem* listboxItem = multiColumnList->getFirstSelectedItem();
uint valueColumnA = listboxItem->getID(); // Retrieve the value of the selected item from column A
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnB = listboxItem->getID(); // Retrieve the value of the selected item from column B
listboxItem = multiColumnList->getNextSelected(listboxItem);
uint valueColumnC = listboxItem->getID(); // Retrieve the value of the selected item from column C

/* TabControl */
TabControl* winTabControl = static_cast<TabControl*>(winMgr.getWindow("TabControl"));
winTabControl->setTabHeight(UDim(0.15f, 0.0f)); // Make the tab buttons a little bigger
Window* tabPage = winMgr.getWindow("TabPane1");
tabPage->setText("Page 1");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f))); // Size to 100% of its parent, the TabControl
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f))); // Move to the upper left corner of its parent
winTabControl->addTab(tabPage);
tabPage = winMgr.getWindow("TabPane2");
tabPage->setText("Page 2");
tabPage->setSize(UVector2(UDim(1.0f, 0.0f), UDim(1.0f, 0.0f)));
tabPage->setPosition(UVector2(UDim(0.0f, 0.0f), UDim(0.0f, 0.0f)));
winTabControl->addTab(tabPage);

}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
}
};

#endif // _WidgetGalore_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "WidgetGalore.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== WidgetGalore.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="Text" >1</Property>
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="DefaultWindow" Name="TabPane2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.7185,0},{0.97875,0},{0.9685,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >In Page 2:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winTabControl" >
<Property Name="Text" >Tab Control Window</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.695627,0},{0.2725,0},{0.993122,0},{0.704167,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/TabControl" Name="TabControl" >
<Property Name="TabHeight" Value="{0,0}" />
<Property Name="TabTextPadding" Value="{0,0}" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.088566,0},{0.174378,0},{0.931404,0},{0.804637,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="btnOk" >
<Property Name="Text" >Ok</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.128412,0},{0.841464,0},{0.365583,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnCancel" >
<Property Name="Text" >Cancel</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.400429,0},{0.841464,0},{0.637601,0},{0.926003,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="btnApply" >
<Property Name="Text" >Apply</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.668224,0},{0.843977,0},{0.905394,0},{0.928516,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
</Window>
<Window Type="DefaultWindow" Name="TabPane1" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0.72875,0},{0.012178,0},{0.97875,0},{0.262178,0}}" />
<Window Type="TaharezLook/StaticText" Name="StaticTextPage1" >
<Property Name="Text" >In Page 1:</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.06,0},{0.226667,0},{0.415,0},{0.476667,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="EditBoxPage1" >
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.420001,0},{0.22,0},{0.99,0},{0.47,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winWidgets" >
<Property Name="Text" >Dave, it's full of widgets!</Property>
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00375,0},{0.143333,0},{0.751248,0},{0.806665,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="btnClose" >
<Property Name="Text" >Close</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.895137,0},{0.976465,0},{0.975697,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="Editbox" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.62442,0},{0.090471,0},{0.969776,0},{0.153443,0}}" />
</Window>
<Window Type="TaharezLook/Checkbox" Name="Checkbox" >
<Property Name="Text" >Check</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.396859,0},{0.944201,0},{0.453147,0}}" />
</Window>
<Window Type="TaharezLook/Combobox" Name="Combobox" >
<Property Name="Text" >Combo Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.090471,0},{0.613522,0},{0.413287,0}}" />
<Property Name="MaxEditTextLength" Value="1073741823" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_A" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >A</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.652856,0},{0.189876,0},{0.704964,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_B" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >B</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.707569,0},{0.189876,0},{0.759678,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_C" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >C</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.761542,0},{0.189876,0},{0.813651,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_1" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >1</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.189876,0},{0.897272,0},{0.246164,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_2" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >2</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.245152,0},{0.897272,0},{0.30144,0}}" />
</Window>
<Window Type="TaharezLook/RadioButton" Name="RadioButton_3" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" >3</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.300429,0},{0.897272,0},{0.356717,0}}" />
</Window>
<Window Type="TaharezLook/HorizontalScrollbar" Name="HorizontalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.185427,0},{0.613522,0},{0.26206,0}}" />
</Window>
<Window Type="TaharezLook/VerticalScrollbar" Name="VerticalScrollbar" >
<Property Name="PageSize" Value="0" />
<Property Name="StepSize" Value="1" />
<Property Name="OverlapSize" Value="0" />
<Property Name="DocumentSize" Value="1" />
<Property Name="ScrollPosition" Value="0" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.026087,0},{0.090471,0},{0.082106,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Listbox" Name="Listbox" >
<Property Name="Text" >List Box</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.626634,0},{0.427903,0},{0.876634,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiColumnList" Name="MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.271357,0},{0.816779,0},{0.551507,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
</Window>
<Window Type="TaharezLook/MultiLineEditbox" Name="MultiLineEditbox" >
<Property Name="Text" >
</Property>
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.626634,0},{0.706566,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/ProgressBar" Name="ProgressBar" >
<Property Name="StepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="CurrentProgress" Value="0" />
<Property Name="UnifiedAreaRect" Value="{{0.183835,0},{0.559296,0},{0.816779,0},{0.608291,0}}" />
</Window>
<Window Type="TaharezLook/Slider" Name="Slider" >
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="1" />
<Property Name="ClickStepSize" Value="0.01" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.099415,0},{0.090471,0},{0.155434,0},{0.606802,0}}" />
</Window>
<Window Type="TaharezLook/Spinner" Name="Spinner" >
<Property Name="StepSize" Value="1" />
<Property Name="CurrentValue" Value="0" />
<Property Name="MaximumValue" Value="32767" />
<Property Name="MinimumValue" Value="-32768" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.845164,0},{0.48995,0},{0.944201,0},{0.551507,0}}" />
</Window>
<Window Type="TaharezLook/StaticImage" Name="StaticImage" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.732397,0},{0.626634,0},{0.976465,0},{0.876634,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="StaticText" >
<Property Name="Text" >Static Text</Property>
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.462498,0},{0.895137,0},{0.706566,0},{0.975697,0}}" />
</Window>
<Window Type="TaharezLook/ScrollablePane" Name="ScrollablePane" >
<Property Name="ContentArea" Value="l:0 t:0 r:0 b:0" />
<Property Name="HorzStepSize" Value="0.1" />
<Property Name="VertStepSize" Value="0.1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="HorzOverlapSize" Value="0.01" />
<Property Name="UnifiedAreaRect" Value="{{0.019063,0},{0.629399,0},{0.157023,0},{0.879399,0}}" />
<Property Name="VertOverlapSize" Value="0.01" />
<Property Name="HorzScrollPosition" Value="0" />
<Property Name="VertScrollPosition" Value="0" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Dialog System

2008-02-01T12:26:30Z

Rackle: /* DialogSystemDemo.h */

The default CEGUI implementation stores the currently specified values of the widgets such that closing and then reopening a window will redisplay those values. Presented here is a different approach, to allow values to be saved or cancelled.

==== Explanation ====
The DemoSample class is the "main" application. It initializes CEGUI and loads a simple layout. It then initialises instances of the SimpleWindow and the SimpleDialog classes. These contain the specific code to handle the behavior of the Simple Window and the Simple Dialog. In turn they rely on the behaviors define within the DialogSystem class to activate higher level features.

The DialogSystem class implements the behavior of the 'Ok', 'Cancel', and 'Apply' buttons that we've become accustomed to in the world of Windows. The DialogSystem::DialogSystemEvents enumaration defines the high level events supported by the DialogSystem class:
open: display the window and its data
ok: save the data and close the window
cancel: close the window without saving the data
escape: close the window without saving the data
apply: save the data without closing the window
modified: enable the 'apply' button

These high level events accomplish their jobs through the use of four basic actions:
doOpen(): display the window
doLoad(): copy the value of variables into their associated widgets
doSave(): copy the value of the widgets into their associated variables
doClose(): hide the window

The SimpleWindow class will manage everything that has to do with the Simple Window. The initWindow() function initialises the DialogSystem by specifying the handle of the window/dialog (the name specified within the layout file) and whether it should initially be visible or not. Then it instructs the DialogSystem to handle four events as well as which action to initiate in response to these events:
1) Pressing the "Toolbar_btnSimpleWindow" button opens the SimpleWindow.
2) Pressing the "SimpleWindow_btnClose" button performs an 'Ok', saving the data and closing the window.
3) Clicking on the 'X' button closes the dialog without saving any modifications (cancel).
4) Pressing the 'escape' key closes the dialog without saving any modifications (cancel).

The SimpleWindow class then overrides the doLoad() virtual function to place the contents of a variable (dataString) into its associated Editbox. It also overrides the doSave() virtual function to place the contents of the Editbox back into the variable.

The SimpleDialog class replicates many of what the SimpleWindow performed. The first difference is that it specifies the handle of a parent window. This signals the DialogSystem class that when the Simple Dialog is opened it should disable its parent, making the Simple Dialog modal; inputs to the parent are blocked while this dialog is opened.

The second difference is the addition of an apply button. This apply button requires that two events be specified. The event of clicking on the apply button "SimpleDialog_btnApply" is bound to the high level event of DialogSystem::apply, which will call upon doSave() to move the widget data into the variables. Text changes within the edit box "SimpleDialog_edtValue" are also bound to the high level event of DialogSystem::modified, which will enable the apply button whenever the contents of the edit box are modified. If there were additional widgets within the window then their 'modified' events would also need to be specified.

CEGUI has more widgets than an Editbox. These can easily be incorporated within the logic presented here.

Please post comments or questions on the message board thread for the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=7966#7966 Dialog System]

==== DialogSystemDemo.h ====
<pre>
#ifndef _DialogSystemDemo_h_
#define _DialogSystemDemo_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "DemoUtils.h"
#include "DialogSystem.h"

class SimpleWindow : public DialogSystem
{
public:
void initWindow()
{
// Initialise the window
using namespace CEGUI;

// Initialise the windowing system
DialogSystem::initialise("winSimpleWindow", // The handle of this window
false); // Initially invisible
// A modeless window does not have a parent

// Subscribe to widget events
// Note that the "close" button is set to behave as an "ok" button
DialogSystem::bindEvent( "Toolbar_btnSimpleWindow", PushButton::EventClicked, DialogSystem::open);
DialogSystem::bindEvent( "SimpleWindow_btnClose", PushButton::EventClicked, DialogSystem::ok);

// Subscribe to window events
DialogSystem::bindEvent("winSimpleWindow", FrameWindow::EventCloseClicked, DialogSystem::cancel); // The 'X' button was clicked
DialogSystem::bindEvent("winSimpleWindow", FrameWindow::EventKeyDown, DialogSystem::escape); // The 'escape' key was pressed
}
protected:
bool doLoad()
{
// Handle the load action by placing data into widgets
CEGUI::WindowManager::getSingleton().getWindow("SimpleWindow_edtValue")->setText(dataString);
return DialogSystem::doLoad();
}
bool doSave()
{
// Handle the save action by moving widget data into variables
dataString = CEGUI::WindowManager::getSingleton().getWindow("SimpleWindow_edtValue")->getText();
return DialogSystem::doSave();
}
private:
CEGUI::String dataString; // Variable associated with the Editbox
};

//////////////////////////////////////////////

class SimpleDialog : public DialogSystem
{
public:
void initWindow()
{
// Initialise the dialog
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();

// Initialise the windowing system
DialogSystem::initialise("dlgSimpleDialog", // The handle of this window
false, // Initially invisible
"winToolbar"); // The handle of its parent, making it a modal dialog

// Subscribe to widget events
DialogSystem::bindEvent( "Toolbar_btnSimpleDialog", PushButton::EventClicked, DialogSystem::open);
DialogSystem::bindEvent( "SimpleDialog_btnOk", PushButton::EventClicked, DialogSystem::ok);
DialogSystem::bindEvent( "SimpleDialog_btnCancel", PushButton::EventClicked, DialogSystem::cancel);
DialogSystem::bindEvent( "SimpleDialog_btnApply", PushButton::EventClicked, DialogSystem::apply);

// These events trigger a 'modified' event, activating the 'apply' button
DialogSystem::bindEvent( "SimpleDialog_edtValue", Editbox::EventTextChanged, DialogSystem::modified);

// Subscribe to window events
// Pressing the 'X' button will behave as a cancel
DialogSystem::bindEvent( "dlgSimpleDialog", FrameWindow::EventCloseClicked, DialogSystem::cancel); // The 'X' button was clicked
DialogSystem::bindEvent( "dlgSimpleDialog", FrameWindow::EventKeyDown, DialogSystem::escape); // The 'escape' key was pressed
}
protected:
bool doLoad()
{
// Handle the load action by placing data into widgets
CEGUI::WindowManager::getSingleton().getWindow("SimpleDialog_edtValue")->setText(dataString);
return DialogSystem::doLoad();
}
bool doSave()
{
// Handle the save action by moving widget data into variables
dataString = CEGUI::WindowManager::getSingleton().getWindow("SimpleDialog_edtValue")->getText();
return DialogSystem::doSave();
}
private:
CEGUI::String dataString;
};

//////////////////////////////////////////

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("DialogSystem.layout");
sheet->addChildWindow(guiLayout);

// Initialise the Simple Window and the Simple Dialog
simpleWindow.initWindow();
simpleDialog.initWindow();
}
catch(Exception &e)
{
ErrorMessage(e.getMessage().c_str(), "Error initializing the demo");
}

return true;
}

void cleanupSample(void)
{
}
private:
SimpleWindow simpleWindow;
SimpleDialog simpleDialog;
};

#endif // _DialogSystemDemo_h_
</pre>

==== DialogSystem.h ====
<pre>
#ifndef _DialogSystem_h_
#define _DialogSystem_h_

#include "CEGUI.h"
#include "vector"

class DialogSystem
{
public:
DialogSystem();
enum DialogSystemEvents { open, ok, cancel, escape, apply, modified };
bool isModified(); // Return whether data within the window is modified

// Actions
virtual bool doOpen(); // Open the window
virtual bool doLoad(); // Assign the data into the widgets
virtual bool doSave(); // Assign the widgets into the data
virtual bool doClose(); // Close the window
void initialise(const CEGUI::String& window, bool visible, const CEGUI::String& parent = ""); // Initialise the window system
void bindEvent(const CEGUI::String& widget, const CEGUI::String& event, DialogSystem::DialogSystemEvents action); // Subscribe to window events
private:
// Events
bool onOpen(const CEGUI::EventArgs& e); // Open the window
bool onOk(const CEGUI::EventArgs& e); // Save the data and close the window
bool onCancel(const CEGUI::EventArgs& e); // Close the window
bool onEscape(const CEGUI::EventArgs& e); // Close the window
bool onApply(const CEGUI::EventArgs& e); // Save the data
bool onModified(const CEGUI::EventArgs& e); // A widget in the window has been modified

CEGUI::String m_parent; // Handle to the parent
CEGUI::String m_window; // Handle to the window
CEGUI::String m_apply; // Handle of the apply button
bool m_modal; // Whether the window is modal
};

#endif // _DialogSystem_h_
</pre>

==== DialogSystem.cpp ====
<pre>
#include "DialogSystem.h"
#include "assert.h"

DialogSystem::DialogSystem()
{
m_modal = false;
}

bool DialogSystem::isModified()
{
// Return whether data within the window is modified
assert(!m_apply.empty() && "The isModified() function requires that you specify an \"Apply\" button");
return !CEGUI::WindowManager::getSingleton().getWindow(m_apply)->isDisabled();
}

bool DialogSystem::doOpen()
{
// Open the window
assert(!m_window.empty() && "You have forgotten to call initialise()");
if(m_modal)
{
// Displaying a modal window disables its parent
assert(!m_parent.empty() && "The value of m_modal or m_parent has become corrupted");
CEGUI::WindowManager::getSingleton().getWindow(m_parent)->setEnabled(false);
}

// Display the window
CEGUI::WindowManager::getSingleton().getWindow(m_window)->setVisible(true);

// Load the data into the widgets
return doLoad();
}

bool DialogSystem::doLoad()
{
// Populate the window widgets with data
// Note that this can also be used to simulate an undo for every widget
// present in the window

// Disable the apply button since there are no modifications
if(!m_apply.empty())
CEGUI::WindowManager::getSingleton().getWindow(m_apply)->setEnabled(false);
return true;
}

bool DialogSystem::doSave()
{
// Update the data with the inputs from the widgets

// Disable the apply button since there are no modifications
if(!m_apply.empty())
CEGUI::WindowManager::getSingleton().getWindow(m_apply)->setEnabled(false);

return true;
}

bool DialogSystem::doClose()
{
// Close the window
assert(!m_window.empty() && "You have forgotten to call initialise()");

if(m_modal)
{
// Closing a modal window enables its parent
assert(!m_parent.empty() && "The value of m_modal or m_parent has become corrupted");
CEGUI::WindowManager::getSingleton().getWindow(m_parent)->setEnabled(true);
}

CEGUI::WindowManager::getSingleton().getWindow(m_window)->setVisible(false);
return true;
}

void DialogSystem::initialise(const CEGUI::String& window, bool visible, const CEGUI::String& parent)
{
// Initialise the window system
// Specifying a parent makes this window modal
m_window = window;
CEGUI::WindowManager::getSingleton().getWindow(m_window)->setVisible(visible);
m_parent = parent;
m_modal = !m_parent.empty();
}

void DialogSystem::bindEvent(const CEGUI::String& widget, const CEGUI::String& widgetEvent, DialogSystemEvents action)
{
// Subscribe to events
CEGUI::Window* widgetHandle = CEGUI::WindowManager::getSingleton().getWindow(widget);
switch(action)
{
case open:
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onOpen, this));
break;
case ok:
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onOk, this));
break;
case cancel:
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onCancel, this));
break;
case escape:
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onEscape, this));
break;
case apply:
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onApply, this));
m_apply = widget;
break;
case modified:
if(!m_apply.empty())
widgetHandle->subscribeEvent(widgetEvent, CEGUI::Event::Subscriber(&DialogSystem::onModified, this));
break;
}
}

bool DialogSystem::onOpen(const CEGUI::EventArgs& e)
{
// Open the window
return doOpen();
}

bool DialogSystem::onOk(const CEGUI::EventArgs& e)
{
// The 'ok' button was pressed
// Respond by saving the data and closing the window
return doSave() && doClose();
}

bool DialogSystem::onCancel(const CEGUI::EventArgs& e)
{
// The 'cancel' button was pressed
// Respond by closing the window without saving the data
return doClose();
}

bool DialogSystem::onEscape(const CEGUI::EventArgs& e)
{
// The 'escape' key was pressed
// Respond by closing the dialog without saving the data
// Note that Win32AppHelper::doDirectInputEvents() intercepts this key
// This means that the escape key will NOT reach here
const CEGUI::KeyEventArgs& keyArgs = static_cast<const CEGUI::KeyEventArgs&>(e);
if(keyArgs.scancode == CEGUI::Key::Escape)
{
return doClose();
}
else
return false;
}

bool DialogSystem::onApply(const CEGUI::EventArgs& e)
{
// The 'apply' button was pressed
// Respond by saving the data without closing the window
return doSave();
}

bool DialogSystem::onModified(const CEGUI::EventArgs& e)
{
// A widget within the window was modified
// Respond by enabling the 'apply' button
CEGUI::WindowManager::getSingleton().getWindow(m_apply)->setEnabled(true);
return true;
}
</pre>

==== DialogSystem.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="winToolbar" >
<Property Name="Text" Value="Toolbar" />
<Property Name="AlwaysOnTop" Value="True" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0.24875,0},{0.010001,0},{0.568749,0},{0.081667,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Property Name="CloseButtonEnabled" Value="False" />
<Window Type="TaharezLook/Button" Name="Toolbar_btnSimpleWindow" >
<Property Name="Text" Value="Simple Window" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.065103,0},{0.227595,0},{0.475554,0},{0.686899,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="Toolbar_btnSimpleDialog" >
<Property Name="Text" Value="Simple Dialog" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.538253,0},{0.227595,0},{0.948703,0},{0.686899,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="winSimpleWindow" >
<Property Name="Text" Value="Simple Window" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.005,0},{0.168333,0},{0.42,0},{0.511666,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="SimpleWindow_btnClose" >
<Property Name="Text" Value="Close" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.688554,0},{0.804855,0},{0.938554,0},{0.943204,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/StaticText" Name="SimpleWindow_lblValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Value:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.455591,0},{0.430746,0},{0.606068,0},{0.569095,0}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="SimpleWindow_edtValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.618241,0},{0.430746,0},{0.970525,0},{0.569095,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="dlgSimpleDialog" >
<Property Name="Text" Value="Simple Dialog" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="CaptionColour" Value="00FFFFFF" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.43625,0},{0.165,0},{0.916249,0},{0.508333,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseTarget" />
<Window Type="TaharezLook/Button" Name="SimpleDialog_btnOk" >
<Property Name="Text" Value="Ok" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.173754,0},{0.804855,0},{0.423754,0},{0.943204,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="SimpleDialog_btnCancel" >
<Property Name="Text" Value="Cancel" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.451828,0},{0.804855,0},{0.701828,0},{0.943204,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Button" Name="SimpleDialog_btnApply" >
<Property Name="Text" Value="Apply" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.73123,0},{0.804855,0},{0.98123,0},{0.943204,0}}" />
<Property Name="MouseCursorImage" Value="set:TaharezLook image:MouseArrow" />
</Window>
<Window Type="TaharezLook/Editbox" Name="SimpleDialog_edtValue" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="MaxTextLength" Value="1073741823" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.626093,0},{0.418446,0},{0.971449,0},{0.556795,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="SimpleDialog_lblValue" >
<Property Name="Text" Value="Value:" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.482291,0},{0.418446,0},{0.617709,0},{0.556795,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

==== main.cpp ====
<pre>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "DialogSystemDemo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</pre>

Menu and Popup

2008-02-01T12:25:47Z

Rackle: /* Menu_Demo.h */

=== Introduction ===
This code demonstrates the usage of a menu as well as popup menus, created from the Layout Editor.

Please discuss this snippet within the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=11724 Menu and Submenus] thread.

==== Menu ====
The Menubar widget creates a menu bar, an horizontal bar containing top-level popup menus. Traditionally menu bars are displayed just below the title bar however the Cegui menubar is not bound by this limitation; it could be placed at the bottom of a FrameWindow, or even outside of a FrameWindow.

The configureMenu() function recursively traverses a menu hierarchy and registers three events: EventMouseEnters, EventMouseLeaves, and EventClicked.

The most important event triggered by a menu is the selection of a menu item. This is accomplished by subscribing to the MenuItem::EventClicked event. This code is within the onMenuItemClicked() function.

Another noteworthy event is PopupMenu::EventPopupOpened, allowing you to modify the menuitems that are displayed, such as potentially (not presented here) enabling/disabling items or changing the displayed text. This is an approach to have menus query the application to determin the state of the menu items that will be presented to the user; for example disabling a "paste" menuitem when there is nothing to paste.

The demo subscribes to the MenuItem::EventMouseEnters event for two features. The first is to display a message when the mouse hovers over a menuitem. The text displayed is stored within the Tooltip property within the Layout Editor. The second is to automatically open a submenu. This code is within the onMouseEntersMenuItem() function.

The code to automatically close a menu (when the mouse leaves) is within the onMouseLeavesMenuItem() and onMouseLeavesPopupMenuItem() functions, called in response to a MenuItem::EventMouseLeaves event.

By subscribing to the Window::EventCharacterKey event it becomes possible to open the menu in response to a special key. The ALT key will not work in windowed mode (as opposed to fullscreen), since it is a system key. Try pressing ALT followed by SPACE; the system menu will open (the menu in the upper left corner of a Windows window). I've used the SLASH "/" key as an alternate. Note that for the slash key to open the menu the FrameWindow must possess the focus.

==== Popup Menu ====

Since the Layout Editor does not allow us to create popup menus directly, I opted to reuse the menubar. Traditionally a menu bar contains horizontal categories and within each category are sub-categories. Since an application may contain numerous popup menus we would rapidly run out of space. A better approach is to have a menu bar with a single top-level menu and popup menus defined as its sub-menus.

For example:
* Popup Menubar
** Popup Menu 1
*** Item 1.1
*** Item 1.2
** Popup Menu 2
*** Item 2.1
*** Item 2.2

Should you run out of room vertically then a second top-level menu could be created.

The configureMenu() is called for each popup menu, to automatically open and close their submenus. The Window::EventMouseButtonUp event is used to open the proper popup menu, based on which widget was right-clicked. This code is within the onPopupMenu() function.

The mouse cursor is traditionally displayed to the left of the popup menu. The problem with that is that the cursor hides the first menu item. The value of the mouseToLeftOfPopupMenu variable determines whether the traditional position is used or whether the popup menu is opened such that the mouse cursor appears to the right. The mouseOffset variable specifies the mouse offset from the upper-left or the upper-right corner. In addition the popup menu is moved to prevent it from opening offscreen.

To add menuitems runtime to a popupMenu you add a CEGUI::Window childWindow to the popupMenu. You don't create a new CEGUI::MenuItem as you might think:

<code><cpp/>
CEGUI::PopupMenu* popupMenu = (CEGUI::PopupMenu*)CEGUI::WindowManager::getSingleton().getWindow("Root/Popup/PopupMenus/FirstPopup/AutoPopup");
CEGUI::Window* menuitem = CEGUI::WindowManager::getSingleton().createWindow("TaharezLook/MenuItem");
menuitem->setText("Quit");
menuitem->subscribeEvent("Clicked", Event::Subscriber(&ScrollablePaneSample::fileQuit, this));
popupMenu->addChildWindow(menuitem);
</code>

==== Wishlist ====

These feature are not implemented but would be nice to have:

* A delay before automatically opening/closing a submenu.
* Closing the entire submenu tree when a parent submenu is closed. This way the next time the submenu is opened its children are in their default mode (i.e. closed).
* Displaying accelerator/shortcut keys to the right of the menuitems.
* Keyboard navigation through the menus (up, down, left, right). This requires access to the CeguiMenuItem::d_hover variable, which (I think) draws the menuitem as highlighted.
* Graphical menuitems
* Support for a separtor (horizontal line) menuitem.
* Support for a checkbox menuitem, to activate a feature
* Support for a radiobutton-like group of menuitems, to activate one feature among multiple choices.

=== Files ===
==== Menu_Demo.h ====
<code><cpp/>
#ifndef _Menu_h_
#define _Menu_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "CEGUIDefaultResourceProvider.h"

//-------------------------------------------------------------------
// Offset to ensure that the mouse cursor will be within the popup menu
// This will automatically close the popup menu whe the mouse is moved;
// without the offset the mouse is not really within the popup menu.
const float mouseOffset = 5.0f;

//-------------------------------------------------------------------
// Specifies whether the popup menu will open to the right (default) or
// to the left of the mouse. Opening to the left gives better results
// with the Taharez scheme since the mouse cursor is not covering the
// menu item.
const bool mouseToLeftOfPopupMenu = false;

//-------------------------------------------------------------------
class DemoSample : public CEGuiSample
{
public:
//-------------------------------------------------------------------
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
if(!FontManager::getSingleton().isFontPresent("Commonwealth-10"))
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("Menu.layout");
sheet->addChildWindow(guiLayout);

// Subscribe to the keyboard events to control the menu
winMgr.getWindow("Root/FrameWindow")->subscribeEvent(CEGUI::Window::EventCharacterKey, CEGUI::Event::Subscriber(&DemoSample::onMenuKey, this));

// Configure the menu bar
configureMenu( winMgr.getWindow("Root/FrameWindow/Menubar"), true );

// Hide the menubar of the popup menus
winMgr.getWindow("Root/Popup")->hide();

// Configure the popup menus
configureMenu( winMgr.getWindow("Root/Popup/PopupMenus"), false );

// These "widgets" will display a contextual popup menu when right-clicked
winMgr.getWindow("Root/FrameWindow/FirstPopup")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root/FrameWindow/SecondPopup")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root/FrameWindow")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
winMgr.getWindow("Root")->subscribeEvent(CEGUI::Window::EventMouseButtonUp, CEGUI::Event::Subscriber(&DemoSample::onPopupMenu, this));
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

//-------------------------------------------------------------------
void cleanupSample(void)
{
}

//-------------------------------------------------------------------
void configureMenu(CEGUI::Window* pParent, const bool& pMenubar)
{
// Recursively subscribe every menu item to the mouse enters/leaves/clicked events
size_t childCount = pParent->getChildCount();
for(size_t childIdx = 0; childIdx < childCount; childIdx++)
{
if(pParent->getChildAtIdx(childIdx)->testClassName("MenuItem")
|| pParent->getChildAtIdx(childIdx)->testClassName("PopupMenu") )
{
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventMouseEnters, CEGUI::Event::Subscriber(&DemoSample::onMouseEntersMenuItem, this));
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventMouseLeaves, pMenubar ? CEGUI::Event::Subscriber(&DemoSample::onMouseLeavesMenuItem, this)
: CEGUI::Event::Subscriber(&DemoSample::onMouseLeavesPopupMenuItem, this));
if(pParent->getChildAtIdx(childIdx)->testClassName("MenuItem"))
{
pParent->getChildAtIdx(childIdx)->subscribeEvent(CEGUI::MenuItem::EventClicked, CEGUI::Event::Subscriber(&DemoSample::onMenuItemClicked, this));
}
}
configureMenu(pParent->getChildAtIdx(childIdx), pMenubar);
}
}

//-------------------------------------------------------------------
bool onMouseEntersMenuItem(const CEGUI::EventArgs& e)
{
// Open or close a submenu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
CEGUI::MenuItem* menuItem = static_cast<CEGUI::MenuItem*>(we.window);
if(menuItem)
{
setStatusText( menuItem->getTooltipText() );
if( menuItem->getPopupMenu() )
{
if( menuItem->isOpened() )
{
if(menuItem->testClassName("MenuItem"))
{
menuItem->closePopupMenu();
}
}
else
{
menuItem->openPopupMenu();
}
}
}
else
{
setStatusText( "" );
}
return true;
}

//-------------------------------------------------------------------
bool onMouseLeavesMenuItem(const CEGUI::EventArgs& e)
{
// Close a menu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "" );

CEGUI::Window* menubar = we.window;
while(menubar)
{
if( menubar->testClassName("Menubar") )
{
// We found the root; a menu bar
CEGUI::Vector2 childPosition = CEGUI::MouseCursor::getSingleton().getPosition();
CEGUI::Window* windowUnderTheCursor = menubar->getTargetChildAtPosition(childPosition);
if(!windowUnderTheCursor)
{
CEGUI::MenuItem* popupMenu = static_cast<CEGUI::Menubar*>(menubar)->getPopupMenuItem();
if(popupMenu)
{
// This does not close sub-popup menus, only the current one
popupMenu->closePopupMenu();
}
}
break;
}
menubar = menubar->getParent();
}

return true;
}

//-------------------------------------------------------------------
bool onMouseLeavesPopupMenuItem(const CEGUI::EventArgs& e)
{
// Close a popup menu
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "" );

CEGUI::Window* menubar = we.window;
CEGUI::Window* popupParent;
while(menubar)
{
popupParent = menubar->getParent();
if( popupParent
&& !popupParent->testClassName("Menubar")
&& !popupParent->testClassName("PopupMenu")
&& !popupParent->testClassName("MenuItem")
)
{
// We found the root; a popup menu
CEGUI::Window* popupMenu = menubar;
menubar = menubar->getParent();
CEGUI::Vector2 childPosition = CEGUI::MouseCursor::getSingleton().getPosition();
CEGUI::Window* windowUnderTheCursor = menubar->getTargetChildAtPosition(childPosition);
if(!windowUnderTheCursor)
{
popupMenu->hide();
}
break;
}
menubar = menubar->getParent();
}

return true;
}

//-------------------------------------------------------------------
bool onMenuItemClicked(const CEGUI::EventArgs& e)
{
const CEGUI::WindowEventArgs& we = static_cast<const CEGUI::WindowEventArgs&>(e);
setStatusText( "Clicked " + we.window->getName() );
return true;
}

//-------------------------------------------------------------------
bool onMenuKey(const CEGUI::EventArgs& e)
{
// Open or close a menu
const CEGUI::KeyEventArgs& ke = static_cast<const CEGUI::KeyEventArgs&>(e);
if(ke.sysKeys == CEGUI::Key::LeftAlt
|| ke.sysKeys == CEGUI::Key::RightAlt
|| ke.sysKeys == CEGUI::Key::Slash
|| ke.codepoint == 47) // Slash
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
CEGUI::Menubar* menuBar = static_cast<CEGUI::Menubar*>(winMgr.getWindow("Root/FrameWindow/Menubar"));
CEGUI::MenuItem* menuItem = menuBar->getPopupMenuItem();
if(menuItem)
{
// There's a menu opened, let's close it
menuBar->changePopupMenuItem(0);
}
else
{
// The menu is closed, let's open the first menu
menuItem = static_cast<CEGUI::MenuItem*>(winMgr.getWindow("Root/FrameWindow/Menubar/File"));
menuBar->changePopupMenuItem(menuItem);

// Select the first item from this menu ??
}
}

return true;
}

//-------------------------------------------------------------------
bool onPopupMenu(const CEGUI::EventArgs& e)
{
// Open a context-sensitive menu
const CEGUI::MouseEventArgs& me = static_cast<const CEGUI::MouseEventArgs&>(e);
if(me.button == CEGUI::RightButton)
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
CEGUI::PopupMenu* popupMenu = 0;
if(me.window->getName().compare("Root/FrameWindow/FirstPopup") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/FirstPopup/AutoPopup"));
}
else if(me.window->getName().compare("Root/FrameWindow/SecondPopup") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/SecondPopup/AutoPopup"));
}
else if(me.window->getName().compare("Root/FrameWindow") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/FramePopup/AutoPopup"));
}
else if(me.window->getName().compare("Root") == 0)
{
popupMenu = static_cast<CEGUI::PopupMenu*>(winMgr.getWindow("Root/Popup/PopupMenus/SheetPopup/AutoPopup"));
}

if(popupMenu)
{
// Make the window the popup's parent
me.window->addChildWindow(popupMenu);

// Position of the popup menu
CEGUI::UVector2 popupPosition;

// Ensure the popup menu will be fully displayed horizontally on the screen
float screenWidth = CEGUI::System::getSingleton().getRenderer()->getWidth();
float popupMenuWidth = popupMenu->getWidth().d_offset;
if(popupMenuWidth < screenWidth)
{
// The x coordinate is either the mouse position or the right side of the
// screen minus the width of the popup menu. This ensures that the popup
// menu is fully displayed rather than clipped.
float x;
if(mouseToLeftOfPopupMenu)
{
x = me.position.d_x + popupMenuWidth > screenWidth ? screenWidth - popupMenuWidth
: me.position.d_x - mouseOffset;
}
else
{
x = me.position.d_x < popupMenuWidth ? 0.0f
: me.position.d_x - popupMenuWidth + mouseOffset;
}
popupPosition.d_x = cegui_absdim(CEGUI::CoordConverter::screenToWindowX(*me.window, x));
}
else
{
// The popup menu is too wide to fit within the screen
popupPosition.d_x = CEGUI::UDim(0.0f, 0.0f);
}

// Ensure the popup menu will be fully displayed vertically on the screen
float screenHeight = CEGUI::System::getSingleton().getRenderer()->getHeight();
float popupMenuHeight = popupMenu->getHeight().d_offset;
if(popupMenuHeight < screenHeight)
{
// The y coordinate is either the mouse position or the bottom side of the
// screen minus the height of the popup menu. This ensures that the popup
// menu is fully displayed rather than clipped.
float y = me.position.d_y + popupMenuHeight > screenHeight ? screenHeight - popupMenuHeight
: me.position.d_y - mouseOffset;
popupPosition.d_y = cegui_absdim(CEGUI::CoordConverter::screenToWindowY(*me.window, y));
}
else
{
// The popup menu is too tall to fit within the screen
popupPosition.d_y = CEGUI::UDim(0.0f, 0.0f);
}

// Position the context menu
popupMenu->setPosition(popupPosition);

// Show the popup menu
popupMenu->show();

// Ensure it appears on top of the other widgets
popupMenu->moveToFront();
}
}
return true;
}

//-------------------------------------------------------------------
void setStatusText(const CEGUI::String& pText)
{
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
winMgr.getWindow("Root/FrameWindow/Status")->setText(pText);
}

private:

};

#endif // _Menu_h_
</code>

==== Main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "Menu_demo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
int i = app.run();
return i;
}
</code>

==== Menu.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="Root" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/FrameWindow" Name="Root/FrameWindow" >
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.00952756,0},{0.0104167,0},{0.51085,0},{0.585417,0}}" />
<Window Type="TaharezLook/Menubar" Name="Root/FrameWindow/Menubar" >
<Property Name="ItemSpacing" Value="10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0.09,0},{0.997727,0},{0.191014,0}}" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File" >
<Property Name="Text" Value="File" />
<Property Name="Tooltip" Value="Yes, primary menuitems can have a tooltip" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,7},{0,0},{0,30},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/File/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,42},{0,119.174}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/New" >
<Property Name="Text" Value="New" />
<Property Name="Tooltip" Value="Creates a new document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,39},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Open" >
<Property Name="Text" Value="Open..." />
<Property Name="Tooltip" Value="Opens an existing document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,39},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Close" >
<Property Name="Text" Value="Close" />
<Property Name="Tooltip" Value="Closes the active document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,39},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Save" >
<Property Name="Text" Value="Save" />
<Property Name="Tooltip" Value="Saves the active document." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,39},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/File/Exit" >
<Property Name="Text" Value="Exit" />
<Property Name="Tooltip" Value="Quits the application; prompts you to save documents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,39},{0,115}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit" >
<Property Name="Text" Value="Edit" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,40},{0,0},{0,64},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Edit/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,65},{0,118.661}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Cut" >
<Property Name="Text" Value="Cut" />
<Property Name="Tooltip" Value="Cuts the selection and puts it on the Clipboard." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,62},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Copy" >
<Property Name="Text" Value="Copy" />
<Property Name="Tooltip" Value="Copies the selection and puts it on the Clipboard." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,62},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Paste" >
<Property Name="Text" Value="Paste" />
<Property Name="Tooltip" Value="Inserts the Clipboard contents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,62},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/Delete" >
<Property Name="Text" Value="Delete" />
<Property Name="Tooltip" Value="Erases the selection." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,62},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu" >
<Property Name="Text" Value="SubMenu" />
<Property Name="Tooltip" Value="This menuitem has a submenu" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,62},{0,115}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Edit/SubMenu/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,43},{0,49.5221}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu/Item1" >
<Property Name="Text" Value="Item 1" />
<Property Name="Tooltip" Value="This is sub-menu #1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,40},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Edit/SubMenu/Item2" >
<Property Name="Text" Value="Item 2" />
<Property Name="Tooltip" Value="This is sub-menu #2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,40},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help" >
<Property Name="Text" Value="Help" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,74},{0,0},{0,100},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/FrameWindow/Menubar/Help/AutoPopup" >
<Property Name="Visible" Value="False" />
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,64},{0,49.1331}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help/Contents" >
<Property Name="Text" Value="Contents..." />
<Property Name="Tooltip" Value="Displays the help contents." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,61},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/FrameWindow/Menubar/Help/About" >
<Property Name="Text" Value="About..." />
<Property Name="Tooltip" Value="Displays program information, version number, and copyright." />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,61},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/Status" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.031818,0},{0.873954,0},{0.972728,0},{0.967087,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/FirstPopup" >
<Property Name="Text" Value="First Popup" />
<Property Name="HorzFormatting" Value="HorzCentred" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.131194,0},{0.701449,0},{0.431194,0},{0.795652,0}}" />
</Window>
<Window Type="TaharezLook/StaticText" Name="Root/FrameWindow/SecondPopup" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Second Popup" />
<Property Name="HorzFormatting" Value="HorzCentred" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.572904,0},{0.701449,0},{0.872903,0},{0.795652,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/Menubar" Name="Root/Popup" >
<Property Name="ItemSpacing" Value="10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.565585,0},{0.07,0},{0.684029,0},{0.140833,0}}" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus" >
<Property Name="Text" Value="PopupMenus" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,7},{0,0},{0,73},{0,21}}" />
<Property Name="VerticalAlignment" Value="Centre" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,21},{0,57},{0,116.749}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup" >
<Property Name="Text" Value="First" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,54},{0,23}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/FirstPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,97},{0,119.266}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-1" >
<Property Name="Text" Value="First-1" />
<Property Name="Tooltip" Value="First-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,42},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-2" >
<Property Name="Text" Value="First-2" />
<Property Name="Tooltip" Value="First-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,42},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-3" >
<Property Name="Text" Value="First-3" />
<Property Name="Tooltip" Value="First-3" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,42},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-4" >
<Property Name="Text" Value="First-4" />
<Property Name="Tooltip" Value="First-4" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,42},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FirstPopup/First-5" >
<Property Name="Text" Value="First-5" />
<Property Name="Tooltip" Value="First-5" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,42},{0,115}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup" >
<Property Name="Text" Value="Second" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,54},{0,46}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SecondPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,117},{0,119.11}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-1" >
<Property Name="Text" Value="Second-1" />
<Property Name="Tooltip" Value="Second-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,62},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-2" >
<Property Name="Text" Value="Second-2" />
<Property Name="Tooltip" Value="Second-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,62},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-3" >
<Property Name="Text" Value="Second-3" />
<Property Name="Tooltip" Value="Second-3" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,62},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/Second-4" >
<Property Name="Text" Value="Second-4" />
<Property Name="Tooltip" Value="Second-4" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,62},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu" >
<Property Name="Text" Value="SubMenu" />
<Property Name="Tooltip" Value="SubMenu" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,62},{0,115}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,60},{0,0},{0,118},{0,49.3892}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/SubItem1" >
<Property Name="Text" Value="SubItem1" />
<Property Name="Tooltip" Value="SubItem1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,55},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SecondPopup/SubMenu/SubItem2" >
<Property Name="Text" Value="SubItem2" />
<Property Name="Tooltip" Value="SubItem2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,55},{0,46}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup" >
<Property Name="Text" Value="Frame" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,54},{0,69}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/FramePopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,104},{0,49.3892}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup/Frame-1" >
<Property Name="Text" Value="Frame-1" />
<Property Name="Tooltip" Value="Frame-1" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,49},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/FramePopup/Frame-2" >
<Property Name="Text" Value="Frame-2" />
<Property Name="Tooltip" Value="Frame-2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,49},{0,46}}" />
</Window>
</Window>
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup" >
<Property Name="Text" Value="Sheet" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,54},{0,92}}" />
<Window Type="TaharezLook/PopupMenu" Name="Root/Popup/PopupMenus/SheetPopup/AutoPopup" >
<Property Name="FadeInTime" Value="0" />
<Property Name="FadeOutTime" Value="0" />
<Property Name="ItemSpacing" Value="2" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="ClippedByParent" Value="False" />
<Property Name="UnifiedAreaRect" Value="{{0,52},{0,0},{0,87},{0,119.243}}" />
<Property Name="AutoResizeEnabled" Value="True" />
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Allo" >
<Property Name="Text" Value="Allo" />
<Property Name="Tooltip" Value="FranÃ§ais" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,2},{0,32},{0,23}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hello" >
<Property Name="Text" Value="Hello" />
<Property Name="Tooltip" Value="English" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,25},{0,32},{0,46}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hallo" >
<Property Name="Text" Value="Hallo" />
<Property Name="Tooltip" Value="Deutsch" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,48},{0,32},{0,69}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Ciao" >
<Property Name="Text" Value="Ciao" />
<Property Name="Tooltip" Value="Italiano" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,71},{0,32},{0,92}}" />
</Window>
<Window Type="TaharezLook/MenuItem" Name="Root/Popup/PopupMenus/SheetPopup/Hola" >
<Property Name="Text" Value="Hola" />
<Property Name="Tooltip" Value="EspaÃ±ol" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,2},{0,94},{0,32},{0,115}}" />
</Window>
</Window>
</Window>
</Window>
</Window>
</Window>
</Window>
</GUILayout>
</pre>

The Main Menu

2008-02-01T12:23:54Z

Rackle: /* Wrapping It all up */

So, you've probably read all the Beginner Guide to X tutorials (if not then go back and read them !), your sitting there still feeling lost, and you can't find exactly how to bring all the stuff you've read together to make a simple GUI. I too found it specially hard to wrap everything together when starting out and hopefully this article should help address this problem for others, I'm still a beginner so there might be a few errors, but for the most part the code has been tested. This tutorial will be rather Ogre oriented since thats what I use, I'll try to keep things a little generic though.

This tutorial was last updated on: 7th January 2008 by CrazyEddie

== Getting started ==
For tutorial purposes, we will quickly run over the Initialisation part (as this has been addressed in other tutorials more thoroughly and is usually engine specific). I will not litter the tutorial with unlrelated code like framelisteners, includes and other stuff. We will be making a main menu which is basicly just a collection of buttons and a StaticImage for background, but it is cruical that you have read the following tutorials and understood them, specially the file types.
[[http://www.cegui.org.uk/wiki/index.php/Tutorials#CrazyEddie.27s_Beginner_Guides CrazyEddie's Beginner Guides ]]
[[http://www.ogre3d.org/wiki/index.php/Basic_Tutorial_6 Ogre's Basic Tutorial 6]]

== Creating the Menu: A plan of action ==
There are 3 ways to go about this, one way is to hardcode the menu (which is a bad idea unless you don't want your menu to be customisable), the 2nd way is to use although uses an xml based approach by writing layout files, imageset files..etc. The 3rd way is to use the falagard system which is subset of the 2nd approach, but expands even more on the functionality by offering the .looknfeel files which allow you to skin any existing scheme or even create your own.

=== Prerequisites ===
Ok, before we get started we need to have a few things initialised first, other then Ogre root, scene manager, framelistener....etc. If you've read [[http://www.ogre3d.org/wiki/index.php/Basic_Tutorial_6 basic tutorial 6]] you'll see that we need to have the following defiendone of the looks loaded as well as a font. I'll be using TaharezLook and tahoma-12 for this tutorial, but I'll load the font at a later stage in the tutorial. I'll only use CEGUI:: in this area, but I'll drop using it since it'll be obvious where to use it after a while. Just assume I've used using namespace CEGUI;

<code><cpp/>
// Initialisation Area
CEGUI::OgreCEGUIRenderer* mGUIRenderer = new CEGUI::OgreCEGUIRenderer(Root::getSingletonPtr()->getAutoCreatedWindow(), Ogre::RENDER_QUEUE_OVERLAY, false, 3000);
CEGUI::System* mGUISystem = new CEGUI::System(mGUIRenderer);
CEGUI::Logger::getSingleton().setLoggingLevel(CEGUI::Informative); // this is recommended to help with debugging, but not neccessary

CEGUI::SchemeManager::getSingleton().loadScheme((CEGUI::utf8*)"TaharezLook.scheme");
mGUISystem->setDefaultMouseCursor((CEGUI::utf8*)"TaharezLook", (CEGUI::utf8*)"MouseArrow");
CEGUI::Window* mRootWindow= CEGUI::WindowManager::getSingleton().createWindow((CEGUI::utf8*)"DefaultWindow", (CEGUI::utf8*)"RootWindow");
mGUISystem->setGUISheet(mRootWindow); // set active Window
</code>

*Note 1: Casting string params to UTF8* isn't neccessary, if your application will only use english (latin based languages), it shouldn't be of any use. But if you want to use other languages which are not covered by the ascii chart, you can use the utf8 cast. I won't be using it for this tutorial, but it should be obvious where you can use it
*Note 2: While its totally legal to use different windows and have children assigned to them, I prefer to have a single root window in which all other windows are childs to it. I initialise it as DefaultWindow* to set it apart from other window types
*Note 3: You can start your app without initialising a font, so long as you use a Window that doesn't use fonts (e.g: StaticImages)

==== Includes ====
As I said earlier, I won't be adding #include lines to the tutorial's code to make it smaller. But here is a helpful tip that should spare you wasted time looking for which header to include.
Unless you #included "CEGUI.h", you'll need to #include a header when you use a CEGUI class. Since the naming convention of CEGUI is rather helpful. You can almost always count on that class being in "CEGUI'''ClassName'''.h". Make sure to make the first letter of the word upper case. If the class is 2 words, then each first letter is upper case. Like so
<code><cpp/>
#include "CEGUISchemeManager.h"
#include "CEGUIFontManager.h"
</code>
....etc :)

=== The Code Approach ===

There are a few things you'll constantly need when writing a menu, assuming your gui code is in a different class, we'll attempt to get pointers to them at the beginning of the code.

<code><cpp/>
WindowManager* Wmgr = WindowManager::getSingletonPtr();
System* mGUISystem = System::getSingletonPtr();
Window* myRoot = Wmgr->getWindow("RootWindow"); // get default window
</code>

==== The Menu code ====
Anyways, now that we got that out of the way, lets get started. I'll write code, then explain it below

<code><cpp/>
// Menu Background
Window* MenuBackground = Wmgr->createWindow("TaharezLook/StaticImage", "Background");
myRoot->addChildWindow( MenuBackground );
MenuBackground->setPosition( UVector2( UDim( 0.0f, 0.0f ), UDim( 0.0f, 0.0f) ) );
MenuBackground->setSize( UVector2( UDim( 1.0f, 0.0f ), UDim( 1.0f, 0.0f ) ) ); // full screen

// New game Button
PushButton* NewGame = (PushButton*)Wmgr->createWindow("TaharezLook/Button", "NewGame");
MenuBackground->addChildWindow( NewGame );
NewGame->setPosition( UVector2( UDim( 0.2f, 0.0f), UDim( 0.2f, 0.0f ) ) );
NewGame->setSize( UVector2( UDim( 0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );

// Load game Button
PushButton* LoadGame= (PushButton*)Wmgr->createWindow("TaharezLook/Button", "LoadGame");
MenuBackground->addChildWindow( LoadGame );
LoadGame->setPosition( UVector2( UDim( 0.2f, 0.0f ), UDim( 0.45f, 0.0f ) ) );
LoadGame->setSize( UVector2( UDim( 0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );

// Quit game Button
PushButton* QuitGame= (PushButton*)Wmgr->createWindow("TaharezLook/Button", "QuitGame");
MenuBackground->addChildWindow( QuitGame );
QuitGame->setPosition( UVector2( UDim( 0.2f, 0.0f ), UDim( 0.7f, 0.0f ) ) );
QuitGame->setSize( UVector2( UDim( 0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );

mGUISystem->setGUISheet(myRoot); // this line is redundant since you didn't change gui sheets, but its here to make sure
</code>

This will create a menu with 3 empty buttons positioned below each other with an empty background. You always need to define the starting position of the window (the top left edge) and how big the window will be. If you don't you'll never see the window.
You'll see that the 3 buttons are childs of the Background Menu window, which is a child of the RootWindow.

==== Changing the look ====
But this is no fun, we want to set Images to the buttons, display text on them, perhaps even use tooltips. The menu isn't really usable this way. But before we start jumping into things, we must do a few things first.

===== Using Fonts =====
Before we use text, we'll need to define a font. If you've already done that then skip forward. If not then please add this line to your initialisation code in Prerequisites area.
<code><cpp/>
if(!FontManager::getSingleton().isFontPresent("Tahoma-12"))
FontManager::getSingleton().createFont("Tahoma-12.font");
</code>

To add a text line for a button you use:
<code><cpp/>
ButtonPtr->setText("foo");
</code>

===== Using Tooltips =====
Now that we've defined a font, we should define tooltips as well in initialisation area.
<code><cpp/>
myGUISystem->setDefaultTooltip("TaharezLook/Tooltip");
</code>

You should usually just leave this with initialisation along with initialisation. You'll need to inject time pulses each frame though, that was explained here already [[ToolTips]].
To add a tooltip for a button you use:
<code><cpp/>
ButtonPtr->setTooltipText("foo");
</code>

===== Using Images =====
Before using images, we need to define an imageset. You can skip forward to the [[http://www.cegui.org.uk/wiki/index.php/The_Main_Menu#Imagesets imageset explanation in the XML area]] to understand what it means.

Note that you could easily create a full image from a texture using the line below, the auto-created image will be called "full_image"
<code><cpp/>
Imageset* foo = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("NameOfImageset", "Image.jpg");
</code>

But if you want to split it up it'll be alittle harder. You'll need to define a texture
<code><cpp/>
Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("ImageFile.jpg", "");
Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImageset("ImageName", texturePtr);
</code>

Since I'm no artist, we'll just assume we have 2 image files, one with the background image and the other with the different button states (make sure they're loaded in resources.cfg). While there are 4 different states( Normal, Hover, pushed & Disabled) we'll just use 2 different looks (to avoid writing more similar code), one for normal & the other will be shared amongst Hover, Pushed & disabled. The 2nd image will contain the different looks for the button, indicating Up or Down states, check the illustration figure below. Each of the 2 images will have its own imageset.

{| cellpadding="15" border="1"
|+ MenuButtons.jpg
| align="center" | Button Up
|-
| align="center" | Button Down
|}

<code><cpp/>
Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("Background","MenuBackground.jpg");
Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("MenuButtons.jpg", "");
Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImageset("Buttons", texturePtr);
</code>

Now we have our imagesets, we'll need define images in each. The first we'll need to define an the Background image, which will be full size. For the 2nd imageset we'll need to split it up and define 2 images inside of it. One for Button Up, and one for Button Down.
<code><cpp/>
MenuImageset->defineImage("Background", Point(0.0f,0.0f), Size( 1.0f, 1.0f ), Point(0.0f,0.0f)); // Whole Image
ButtonsImageset->defineImage("ButtonUp", Point(0.0f,0.0f), Size( 1.0f, 0.5f ), Point(0.0f,0.0f)); // Top half of image
ButtonsImageset->defineImage("ButtonDown", Point(0.0f,0.5f), Size( 1.0f, 0.5f ), Point(0.0f,0.0f)); // Bottom Half
</code>

now that we have images defined, we can easily apply them to a window that supports images. Note the value (second) string used here - is is of the format "set:<imageset name> image:<image name>"

<code><cpp/>
Window->setProperty( "Image", "set:ImagesetName image:ImageName" );
</code>

==== Wrapping It all up ====
Now lets write the code above again with the new adjustments

<code><cpp/>
/*** Stuff you need to do in the initialisation phase ***/
if(!FontManager::getSingleton().isFontPresent("Tahoma-12"))
FontManager::getSingleton().createFont("Tahoma-12.font");
mGUISystem->setDefaultTooltip("TaharezLook/Tooltip");

// Creating Imagesets and defining images
Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("Background","MenuBackground.jpg");
Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("MenuButtons.jpg", ""); // default resource group
Imageset* ButtonsImageset = ImagesetManager::getSingletonPtr()->createImageset("Buttons", texturePtr);
ButtonsImageset->defineImage("ButtonUp", Point(0.0f,0.0f), Size( 0.5f, 0.5f ), Point(0.0f,0.0f));
ButtonsImageset->defineImage("ButtonDown", Point(0.0f,0.5f), Size( 0.5f, 0.5f ), Point(0.0f,0.0f));

/*** the menu code ***/
Window* MenuBackground = Wmgr->createWindow("TaharezLook/StaticImage", "Background");
myRoot->addChildWindow( MenuBackground );
MenuBackground->setPosition( UVector2( UDim( 0.0f, 0.0f), UDim( 0.0f, 0.0f ) ) );
MenuBackground->setSize( UVector2( UDim( 1.0f, 0.0f), UDim( 1.0f, 0.0f ) ) ); // full screen
// this is the preferred way to set the image.
MenuBackground->setProperty( "Image", "set:Background image:full_image" );

PushButton* NewGame = (PushButton*)Wmgr->createWindow("TaharezLook/Button", "NewGame");
MenuBackground->addChildWindow( NewGame );
NewGame->setPosition( UVector2( UDim( 0.2f, 0.0f ), UDim( 0.2f, 0.0f ) ) );
NewGame->setSize( UVector2( UDim( 0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );
NewGame->setText("New Game");
NewGame->setProperty( "NormalImage", "set:Buttons image:ButtonUp" );
NewGame->setProperty( "HoverImage", "set:Buttons image:ButtonDown" );
NewGame->setProperty( "PushedImage", "set:Buttons image:ButtonDown" );

PushButton* LoadGame = (PushButton*)Wmgr->createWindow("TaharezLook/Button", "LoadGame");
MenuBackground->addChildWindow( LoadGame );
LoadGame->setPosition( UVector2( UDim(0.2f, 0.0f ), UDim( 0.45f, 0.0f ) ) );
LoadGame->setSize( UVector2( UDim(0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );
LoadGame->setText("Load Game");
LoadGame->setTooltipText("Disabled, not implemented yet");
LoadGame->disable();
LoadGame->setProperty( "NormalImage", "set:Buttons image:ButtonUp" );
LoadGame->setProperty( "HoverImage", "set:Buttons image:ButtonDown" );
LoadGame->setProperty( "PushedImage", "set:Buttons image:ButtonDown" );
LoadGame->setProperty( "DisabledImage", "set:Buttons image:ButtonDown" );

PushButton* QuitGame= (PushButton*)Wmgr->createWindow("TaharezLook/Button", "QuitGame");
MenuBackground->addChildWindow( QuitGame );
QuitGame->setPosition( UVector2( UDim( 0.2f, 0.0f ), UDim( 0.7f, 0.0f ) ) );
QuitGame->setSize( UVector2( UDim( 0.4f, 0.0f ), UDim( 0.2f, 0.0f ) ) );
QuitGame->setText("Quit Game");
QuitGame->setProperty( "NormalImage", "set:Buttons image:ButtonUp" );
QuitGame->setProperty( "HoverImage", "set:Buttons image:ButtonDown" );
QuitGame->setProperty( "PushedImage", "set:Buttons image:ButtonDown" );
</code>

Now go ahead and test, doesn't that look much better ? It looks more like a proper menu now. You could start handling events from here on (explained later).
But this way isn't really very good. Should you want to change anything in the menu, you'll have to edit several lines of code & recompile your application. Besides, just making a menu as simple as that took about 50 lines of code, there must be a simpler way.

=== XML based approach (non-falagard way) ===

This way is much more efficient then hard-coding the menu. Its less code, easier to edit and use as well. I personally think this way is even better then using the falagard system if you're just after doing small and simple menu's, despite the fact falagard is supposed to be better performance wise and more flexible.
Before we start we need

*Note 1: The .xsd files included in the cegui datafiles aren't needed if you're using Ogre. Ogre uses a different XML parser (tinyXML) which doesn't use these files so feel free to remove them, but if you're not using ogre and you didn't specify a different xml parser, you'll need those files.

==== XML Crash Course ====

If you're familiar with xml, feel free to skip this area (or better yet, rewrite it to make it more helpful).

A code line is usually encapsulated in < >. To start a declare a new type you can use <Type/> or <Type> </Type>. The first way should be used to declare objects that don't have too many settings. e.g:
<Image Name="Background" XPos="0.0" YPos="0.0" Width="800" Height="600" />
As you've probably noticed, you can set its settings in the same line. As for the second way, it should be used to open up bigger types. e.g:
<Window Type="TaharezLook/Button" Name="NewGame">
<Property Name="UnifiedAreaRect" Value="{{0.2,0.0},{0.45,0.0},{0.6,0.0},{0.65,0.0}}" />
</Window>

You can start nesting types in other types, you should be able to pickup the rest of the basics from xml files included with CEGUI and the ones in this tutorial.

*Note 1: Please use a proper text editor and not notepad or wordpad, there are many available for free online, using google would be a good time here :).

==== XML File types ====
Now I'll explain the filetypes (copied from the beginner tutorial to loading data) and thier uses, there are 3 types. .layout .imageset .scheme ( there is a 4th one .looknfeel used with falagard)
While you can just call them .xml and be done with it, this way makes it more clearer.

===== Imagesets =====

Effectively, an Imageset is just a collection of defined regions upon the source image / texture file (which is also specified in the Imageset definition). Each of these defined regions has a unique name and is known within the system as an Image. An Image as defined in an Imageset is the basic level of imagery used by CEGUI. By modifying the source image / texture file and also the position and size of the defined regions within the Imageset files you can easily change the appearance of what gets drawn by CEGUI.

Since each imageset cannot contain more then one Image file. We'll have to make 2 imageset files. For both images, we'll assume the width and hieght are 512x512. But for the second image, we'll assume it has 4 different button images inside instead of just 2 like the code part of tutorial, each button image is 1/4 the size of the full image. The only reason behind this is its much easier to assign & define images now. Here is an illustration figure for the 2nd image

{| cellpadding="10" border="1"
|+ MenuButtons.jpg
| align="center" | Button Up
|-
| align="center" | Button Down
|-
| align="center" | Button Highlighted
|-
| align="center" | Button Greyed Out
|}

* MenuBackground.imageset
<?xml version="1.0" ?>
<Imageset Name="Background" Imagefile="MenuBackground.jpg" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true" ResourceGroup="General">
<Image Name="Background" XPos="0.0" YPos="0.0" Width="512" Height="512" />
</Imageset>
* MenuButtons.imageset
<?xml version="1.0" ?>
<Imageset Name="Buttons" Imagefile="MenuButtons.jpg" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true">
<Image Name="ButtonUp" XPos="0.0" YPos="0.0" Width="512" Height="128" />
<Image Name="ButtonDown" XPos="0.0" YPos="128.0" Width="512" Height="128" />
<Image Name="ButtonDisabled" XPos="0.0" YPos="256.0" Width="512" Height="128" />
<Image Name="ButtonHighlighted" XPos="0.0" YPos="384.14" Width="512" Height="128" />
</Imageset>

While the ResourceGroup="" line isn't necessary, I just added it so you can see where to use it.
To load Imagesets by code you do
ImagesetManager::getSingletonPtr()->createImageset( "MenuBackground.imageset");

===== Layouts =====

A layout file contains an XML representation of a window layout. Each nested 'Window' element defines a window or widget to be created, the 'Property' elements define the desired settings and property values for each window defined.

* Menu.layout
<?xml version="1.0" ?>
<GUILayout>
<Window Type="WindowsLook/StaticImage" Name="Menu/Background">
<Property Name="UnifiedSize" Value="{{1.0,0},{1.0,0}}" />
<Property Name="Image" Value="set:Background image:Background" />

<Window Type="WindowsLook/Button" Name="Menu/NewGame">
<Property Name="UnifiedAreaRect" Value="{{0.2,0.0},{0.2,0.0},{0.6,0.0},{0.4,0.0}}" />
<Property Name="NormalImage" Value="set:Buttons image:ButtonUp" />
<Property Name="HoverImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="PushedImage" Value="set:Buttons image:ButtonHighlighted" />
<Property Name="DisabledImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="Tooltip" Value="Start a new game"/>
</Window>

<Window Type="WindowsLook/Button" Name="Menu/LoadGame">
<Property Name="UnifiedAreaRect" Value="{{0.2,0.0},{0.45,0.0},{0.6,0.0},{0.65,0.0}}" />
<Property Name="NormalImage" Value="set:Buttons image:ButtonUp" />
<Property Name="HoverImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="PushedImage" Value="set:Buttons image:ButtonHighlighted" />
<Property Name="DisabledImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="Tooltip" Value="Not implemented yet"/>
</Window>

<Window Type="WindowsLook/Button" Name="Menu/QuitGame">
<Property Name="UnifiedAreaRect" Value="{{0.2,0.0},{0.7,0.0},{0.6,0.0},{0.9,0.0}}" />
<Property Name="NormalImage" Value="set:Buttons image:ButtonUp" />
<Property Name="HoverImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="PushedImage" Value="set:Buttons image:ButtonHighlighted" />
<Property Name="DisabledImage" Value="set:Buttons image:ButtonDisabled" />
<Property Name="Tooltip" Value="Exit To Desktop"/>
</Window>
</Window>
</GUILayout>

This does basicly all the stuff we did in the code portion of the tutorial. The only new term here is UnifiedAreaRect, the first pair defines where the XPos starts, the 3rd defines where it ends. Same goes for 2nd & 4th but for YPos

To load a .layout file in code you do
Window* Menu = WindowManager::getSingletonPtr()->loadWindowLayout("Menu.layout");

*Note 1: There is an editor file for layouts written by scriptkid, its preferable if you get it from CVS and build it, but its possible to get the binaries from the downloads area in the cegui website. While its rather limited atm, it allows you to create and place the various widgets and export into a .layout file. It doesn't support custom images as of yet (8/12/2005).
*Note 2: Since the layout file is usually the most error prone, I usually encase it in a try catch statement to catch any parsing exceptions and pause on them. If you don't do that you won't get informed of errors when they happen, which could lead to other errors happening and crashing ultimatley.

<code><cpp/>
try
{
Window* Menu = WindowManager::getSingletonPtr()->loadWindowLayout("Menu.layout");
}
catch(CEGUI::Exception &e)
{
OGRE_EXCEPT(Ogre::Exception::ERR_INTERNAL_ERROR, string(e.getMessage().c_str()), "Error Parsing Menu");
}
</code>

===== Schemes =====

A Scheme is a means to group other data files together, it's also the most convenient way to load and register widget types. A Scheme can contain one or more of the following (which will be loaded and initialised when the scheme is loaded):
Imageset
Window Set
Window Alias
A 'Window Set' basically specifies the name of a loadable module or skin(.dll , .so, .looknfeel), and a set of widgets contained within that modules that you wish to register with the system. A 'Window Alias' provides a means to refer to a window / widget type by alternative names, it can also be used to 'hide' an already registered widget type with another widget type (so that other widget type gets used instead).

This file isn't totally needed in the current approach, we're just using it here as a means of grouping imagesets for loading. However this file will be used in greater detail in the Falagard system.

* GameGUI.scheme
<?xml version="1.0" ?>
<GUIScheme Name="GameGUI">
<Imageset Name="Background" Filename="MenuButtons.imageset" ResourceGroup="General"/>
<Imageset Name="Buttons" Filename="MenuButtons.imageset"/>
</GUIScheme>

This simply just loads the 2 imagesets. To load the scheme by code you use
<code><cpp/>
SchemeManager::getSingleton().loadScheme("GameGUI.scheme);
</code>

==== Wrapping It all up ====

Save the xml files above and add them somewhere in your Resource hierarchy (which should be your media folder unless you changed it).

Now for the code portion, the initialisation area will remain the same. However, you'll need to have this line before your menu code
<code><cpp/>
SchemeManager::getSingleton().loadScheme("GameGUI.scheme);
// Or you could do this if you skip the scheme part
//ImagesetManager::getSingletonPtr()->createImageset( "MenuBackground.imageset");
//ImagesetManager::getSingletonPtr()->createImageset( "MenuButtons.imageset");
</code>

Now its time to write the menu code

<code><cpp/>
WindowManager* Wmgr = WindowManager::getSingletonPtr();
System* mGUISystem = System::getSingletonPtr();
Window* myRoot = Wmgr->getWindow("RootWindow"); // get default window

try
{
Window* Menu = Wmgr->loadWindowLayout("Menu.layout");
}
catch(CEGUI::Exception &e)
{
OGRE_EXCEPT(Ogre::Exception::ERR_INTERNAL_ERROR, string(e.getMessage().c_str()), "Error Parsing Menu");
}
myRoot->addChildWindow(Menu);
GUISys->setGUISheet(myRoot); // this line is redundant since you didn't change gui sheets, but its here to make sure
</code>

And thats it ! 50 lines of code are now alittle less then 10 lines. The menu is now easily editable by editing the xml files without the need of recompiling. Should any errors occur, checking the cegui.log should be very handy.

=== Falagard Way & the looknfeel system ===
TO DO

== Handling events for the menu ==
Ok, so we've seen how to make our menu. But so far we can only look at it, we can't use it. Here we'll learn how to start subscribing events and handle them. To start handling events we need to have pointers for each menu button you want handled (even the background if you want to do anything special). If you've followed the code approach, you should already have them. Otherwise, we'll need to start getting them. Simply do this for each button

<code><cpp/>
PushButton* Button1 = (PushButton*)wmgr->getWindow("Widget Reference Name");
</code>

Now that we have pointers to the buttons we wan't to handle. You need to subscribe it to a function that will do the "handling". If you're function is a global function (or not part of a class). you do this

<code><cpp/>
Button1 ->subscribeEvent(PushButton::EventClicked, HandleButton1);
</code>

if it is part of a class you do this

<code><cpp/>
Button1->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&ClassName::HandleButton1, this));
</code>

What this does is tell the Window to trigger function HandleButton1() should EventClicked happen. There are much more events which you can find out about them from the API reference.

Now here is a typical action
<code><cpp/>
bool HandleButton1(const EventArgs& e)
{
//Code you want Button1 to do
return true;
}
</code>

Once the event is triggered, HandleButton1 is called and an EventArgs is passed to it. This has some useful info you might need to operate on,

*Note 1 : the function needs to be of type bool and return true. it also needs to take one parameter only and thats const CEGUI::EventArgs&

=== What you need in your Frame Listener ===

But wait a minute, CEGUI doesn't detect keyboard & mouse input itself. This means none of the code above will work just yet, we'll need to inject Input as we get it. So you'll have to modify your framelistener to do so. This part is based in portion from [[http://www.ogre3d.org/wiki/index.php/Basic_Tutorial_6 basic tutorial 6]]. This area is heavily ogre specific btw for those who didn't notice

First you'll need to subclass your framelistener (or whatever class handles your input) from KeyListener, MouseMotionListener & MouseListener then overload the pure virtual functions(check the ogre api to see which functions you'll need to overload)
Here is a list off all of them (might be some more), some of them you don't need to inject so provide empty

<code><cpp/>
// Helper function
ConvertOgreButtonToCegui(int ButtonID);

//key listener
void keyPressed(KeyEvent *e);
void keyClicked(KeyEvent *e);
void keyReleased(KeyEvent *e);

//mouse motion listener
void mouseMoved(MouseEvent *e);
void mouseDragMoved(MouseEvent *e){}
void mouseDragged(MouseEvent *e);

// mouse listener
void mouseReleased (MouseEvent *e);
void mousePressed (MouseEvent *e);
void mouseClicked (MouseEvent *e){};
void mouseEntered (MouseEvent *e){};
void mouseExited (MouseEvent *e){};
</code>

here is thier implementations
<code><cpp/>
MouseButton YourInputListenerClass::ConvertOgreButtonToCegui(int ButtonID)
{
switch (ButtonID)
{
case MouseEvent::BUTTON0_MASK:
return CEGUI::LeftButton;
case MouseEvent::BUTTON1_MASK:
return CEGUI::RightButton;
case MouseEvent::BUTTON2_MASK:
return CEGUI::MiddleButton;
case MouseEvent::BUTTON3_MASK:
return CEGUI::X1Button;
default:
return CEGUI::LeftButton;
}
}
void YourInputListenerClass::keyPressed(KeyEvent *e)
{
mGUISystem->injectKeyDown(e->getKey()); // I'm not totally sure about this area, can someone confirm ?
mGUISystem->injectChar(e->getKeyChar());
e->consume();
}
void YourInputListenerClass::keyReleased(KeyEvent *e)
{
mGUISystem->injectKeyUp(e->getKey());
e->consume();
}
void YourInputListenerClass::mouseMoved (MouseEvent *e)
{
mGUISystem->injectMouseMove(e->getRelX() * mGUIRenderer ->getWidth(),e->getRelY() * GuiRenderer->getHeight());
e->consume();
}
void YourInputListenerClass::mousePressed (MouseEvent *e)
{
mGUISystem->injectMouseButtonDown(ConvertOgreButtonToCegui(e->getButtonID()));
e->consume();
}
void YourInputListenerClass::mouseReleased(MouseEvent *e)
{
mGUISystem->injectMouseButtonUp(ConvertOgreButtonToCegui(e->getButtonID()));
e->consume();
}
void YourInputListenerClass::mouseDragged (MouseEvent *e)
{
mouseMoved(e);
}

=== Handling events for the layout approach ===
I'll show an example based on the layout approach, you could easily adapt it to any of the other approaches.

<code><cpp/>
// handler functions declarations
bool handleNewGame(const EventArgs& e);
bool handleQuit(const EventArgs& e);
bool handleHover(const EventArgs& e);

WindowManager* Wmgr = WindowManager::getSingletonPtr();
System* mGUISystem = System::getSingletonPtr();
Window* myRoot = Wmgr->getWindow("RootWindow"); // get default window

try
{
Window* Menu = Wmgr->loadWindowLayout("Menu.layout");
}
catch(CEGUI::Exception &e)
{
OGRE_EXCEPT(Ogre::Exception::ERR_INTERNAL_ERROR, string(e.getMessage().c_str()), "Error Parsing Menu");
}
myRoot->addChildWindow(Menu);
mGUISystem->setGUISheet(myRoot);

bool handleNewGame(const EventArgs& e)
{
// your project specific code to start game
return true;
}

bool handleHover(const EventArgs& e)
{
// Play a beep sound
return true;
}

bool handleQuit(const EventArgs& e)
{
// your engine specific code to shut down
Root::getSingletonPtr()->queueEndRendering(); // ogre specific
return true;
}
</code>

Thats it. Theoritically it should work. Now go ahead and try :)

== Conclusion ==

Now it should be easy to and clear to beginner users how to begin making use of CEGUI, you can easily extend what you've learnt here to start making more complex GUIs.
If you find that something isn't clear or you want help with it you can post on the forums or join the #cegui channel on IRC (freenode server). I usually idle on IRC often, nick MandM.

2007-07-03T17:57:29Z

Rackle: /* Configuration Attributes */

=== Introduction ===
Dialogs (frame windows) can be moved around, resized, hidden, and rolled up while the application is running. MultiColumnLists can have their columns rearranged, resized, and a column can sort its content in ascending or descending order. However closing and then restarting the application will reset these settings to their default values, those specified within a .layout file if one was use, or those specified in code.

This clases saves these attributes into an XML file. When the application restarts the contents of the XML file will be read and the dialogs and MultiColumnLists will be restored to their last states.

Please discuss this snippet in the [http://www.cegui.org.uk/phpBB2/viewtopic.php?p=8002#8002 Storing Dialog Configurations] thread on the message board.

=== Incorporating into Sample_Demo7 ===
This demo contains 3 dialogs. Let's store their configurations.

Add DialogConfigurations.cpp to the Sample_Demo7 project.

Edit Sample_Demo7.h:
* add '''#include "DialogConfigurations.h"'''
* add within the protected section: '''DialogConfigurations m_dialogConfigurations;'''

Edit Sample_Demo7.cpp to add the following at the end of the Demo7Sample::initialiseSample() function, between ''initDemoEventWiring();'' and ''return true;'':
m_dialogConfigurations.loadConfigurations("../datafiles/configs/Sample_Demo7.xml", "../datafiles/configs/DialogConfigurations.xsd");
m_dialogConfigurations.addDialog("Demo7/Window1");
m_dialogConfigurations.addDialog("Demo7/Window2");
m_dialogConfigurations.addDialog("Demo7/Window3");

Add the following to Demo7Sample::cleanupSample()
m_dialogConfigurations.saveConfigurations();

That's it! From now on the 3 windows within that demo will "remember" their previous configurations.

'''Warning:''' the Demo7Sample::cleanupSample() is never called when exiting the demo, despite what the comments might say. A solution is presented on the [http://www.cegui.org.uk/phpBB2/viewtopic.php?t=1550 message board].

=== Configuration Attributes ===
The XML configuration file is loaded by a call to loadConfigurations(). It silently ignores errors within that XML file. The worst that will happen is that some dialogs and MultiColumnLists will revert to their initial values.

Calling addDialog() and passing the window name as parameter will register that dialog to have its configuration written to the XML file. The next call to saveConfigurations() will write the configuration of that registered window such that the next time loadConfigurations() is called the window will be automatically registered.

The second parameter of addDialog() allows you to specify which attributes to monitor. By default every attribute is monitored. However you can specify to monitor one or many of the following, separated by spaces: Position, Visible, and RolledUp.

The addMultiColumnList() function behaves in a similar manner, allowing you to specify which MultiColumnLists and which of their attributes to monitor. Again the default is to monitor every attribute but you can also specify one or many of the following: ColumnSequence, ColumnWidths, SortedColumn, and AscendingSort.

=== Files ===

==== DialogConfigurations.h ====
<code><cpp/>
#ifndef _DialogConfigurations_h_
#define _DialogConfigurations_h_

#include "CEGUI.h"
#include "CEGUIXMLHandler.h"
#include "CEGUIXMLParser.h"
#include "CEGUIXMLAttributes.h"
#include <map>

class DialogConfigurations : public CEGUI::XMLHandler
{
public:
// Constructor.
// Sets various default values.
DialogConfigurations();

// Load the configuration of every stored dialog and multi column list.
// By default, also apply these configurations.
bool loadConfigurations(const CEGUI::String& xmlFile, const CEGUI::String& schema = "", const bool& applyConfigurations = true);

// Store the configuration of every dialog and multi column list.
bool saveConfigurations();

// Set default configurations for dialogs.
void setDialogDefaults(const CEGUI::URect& position, const bool& visible, const bool& rolledup);

// Specify which dialog attributes are monitored by default.
void setDefaultDialogAttributesMonitored(const CEGUI::String& attributesMonitored);

// Add a dialog to be monitored.
// Optionally specify which attributes this specific dialog monitors.
bool addDialog(const CEGUI::String& widget, const CEGUI::String& attributesMonitored = "");

// Return the position of the specified dialog.
const CEGUI::URect& getDialogSavedPosition(const CEGUI::String& dialog);

// Return the visible/hidden state of the specified dialog.
const bool& getDialogSavedVisible(const CEGUI::String& dialog);

// Return the expansion state of the specified dialog.
const bool& getDialogSavedRolledup(const CEGUI::String& dialog);

// Apply the saved configuration to the specified dialog.
bool applyDialogConfiguration(const CEGUI::String& dialog = "");

// Set default configurations for multi column lists.
void setMultiColumnListDefaults(const std::vector<CEGUI::String>& columnSequence, const CEGUI::uint& sortedColumn, const bool& sortAscending, const std::vector<CEGUI::String>& columnWidths);

// Specify which dialog attributes are monitored by default.
void setDefaultMultiColumnListAttributesMonitored(const CEGUI::String& attributesMonitored);

// Add a MultiColumnList to be monitored.
bool addMultiColumnList(const CEGUI::String& widget, const CEGUI::String& attributesMonitored = "");

// Apply the saved configuration to the specified multi column list.
bool applyMultiColumnListConfiguration(const CEGUI::String& multiColumnList = "");

private:
// Whether a particular attribute is monitored.
bool isMonitoringAttribute(const std::vector<CEGUI::String>& list, const CEGUI::String& attribute);

// Performs the actual load every stored configuration.
void elementStart(const CEGUI::String& element, const CEGUI::XMLAttributes& xmlAttributes);

// Tag name for dialog positions element.
static const CEGUI::String m_DialogConfigurationElement;

// Tag name for position elements.
static const CEGUI::String m_configurationElementDialog;

// Attribute name that stores the name of the window.
static const char windowNameAttribute[];

// Attribute name that stores the position of the window.
static const char windowPosAttribute[];

// Attribute name that stores the visible state of the window.
static const char windowVisibleAttribute[];

// Attribute name that stores the rolledUp state of the window.
static const char windowRolledupAttribute[];

// Tag name of MultiColumnList elements.
static const CEGUI::String m_configurationElementMultiColumnList;

// Attribute name that stores the sequence of the columns.
static const char mclColumnSequenceAttribute[];

// Attribute name that stores which column is sorted.
static const char mclSortedColumnAttribute[];

// Attribute name that stores the sort order direction.
static const char mclAscendingSortAttribute[];

// Attribute name that stores the widths of the columns.
static const char DialogConfigurations::mclColumnWidthAttribute[];

// Separator for the column sequences.
static const char DialogConfigurations::mclColumnSequenceSeparator;

// Separator for the column widths.
static const char DialogConfigurations::mclColumnWidthSeparator;

// Special attribute name to monitor every attribute.
static const char monitoredAttributeAll[];

// Special attribute name to monitor no attribute.
static const char monitoredAttributeNone[];

// The value of one dialog configuration.
struct DialogConfig {
CEGUI::URect position;
bool visible;
bool rolledup;
};

// List of the dialog configurations.
std::map<CEGUI::String, DialogConfig> m_dialogConfigurations;

// Default position.
CEGUI::URect m_defaultPosition;

// Default visible/hidden.
bool m_defaultVisible;

// Default rolled up/expanded.
bool m_defaultRolledup;

// Specify which attributes to monitor for this dialog.
void _setDialogAttributesMonitored(const CEGUI::String& dialog, const CEGUI::String& attributesMonitored);

// List of the attributes monitored per dialog.
std::map<CEGUI::String, std::vector<CEGUI::String>> m_attributesMonitoredDialog;

// The value of one multi column list configuration.
struct MultiColumnListConfig {
std::vector<CEGUI::String> columnSequence;
CEGUI::uint sortedColumn;
bool sortAscending;
std::vector<CEGUI::String> columnWidths;
};

// List of the multi column list configurations.
std::map<CEGUI::String, MultiColumnListConfig> m_multiColumnListConfigurations;

// Default column sequence.
std::vector<CEGUI::String> m_defaultColumnSequence;

// Default sorted column.
CEGUI::uint m_defaultSortedColumn;

// Default sort order.
bool m_defaultSortAscending;

// Default column widths.
std::vector<CEGUI::String> m_defaultColumnWidths;

// Specify which attributes to monitor for this multi column list.
void _setMultiColumnListAttributesMonitored(const CEGUI::String& multiColumnList, const CEGUI::String& attributesMonitored);

// List of the attributes monitored per MultiColumnList
std::map<CEGUI::String, std::vector<CEGUI::String>> m_attributesMonitoredMultiColumnList;

// File containing the positions.
CEGUI::String m_configFile;

// List of the supported attributes.
static std::vector<CEGUI::String> m_attributeList;
};

#endif // _DialogConfigurations_h_
</code>

==== DialogConfigurations.cpp ====
<code><cpp/>
#include "DialogConfigurations.h"
#include "CEGUIPropertyHelper.h"

//Definition of XML elements and attributes
const CEGUI::String DialogConfigurations::m_DialogConfigurationElement( "DialogConfigurations" );
const CEGUI::String DialogConfigurations::m_configurationElementDialog( "DialogConfiguration" );
const char DialogConfigurations::windowNameAttribute[] = "Name";
const char DialogConfigurations::windowPosAttribute[] = "Position";
const char DialogConfigurations::windowVisibleAttribute[] = "Visible";
const char DialogConfigurations::windowRolledupAttribute[] = "RolledUp";
const char DialogConfigurations::monitoredAttributeAll[] = "All";
const char DialogConfigurations::monitoredAttributeNone[] = "None";
const CEGUI::String DialogConfigurations::m_configurationElementMultiColumnList( "MultiColumnListConfiguration" );
const char DialogConfigurations::mclColumnSequenceAttribute[] = "ColumnSequence";
const char DialogConfigurations::mclColumnWidthAttribute[] = "ColumnWidths";
const char DialogConfigurations::mclSortedColumnAttribute[] = "SortedColumn";
const char DialogConfigurations::mclAscendingSortAttribute[]= "AscendingSort";
const char DialogConfigurations::mclColumnSequenceSeparator = ',';
const char DialogConfigurations::mclColumnWidthSeparator = ';';

// List of the supported attributes
// Each attribute is enclosed within spaces
//const CEGUI::String DialogConfigurations::m_attributeList = " All None Position Visible RolledUp MCLWidths MCLSequence MCLSort ";
std::vector<CEGUI::String> DialogConfigurations::m_attributeList;

void Tokenize(const CEGUI::String& str, std::vector<CEGUI::String>& tokens, const char delimiters = ' ')
{
// Break a sentence into multiple words separated by delimiters
// Does not handle words within double-quotes: One "2 &2" three, four

// Skip delimiters at beginning
CEGUI::String::size_type lastPos = str.find_first_not_of(delimiters, 0);

// Find first "non-delimiter"
CEGUI::String::size_type pos = str.find_first_of(delimiters, lastPos);

CEGUI::String::size_type length = str.length();
while (str.npos != pos || str.npos != lastPos)
{
// Cap the position to the length of the string
if(pos == str.npos)
pos = length;
if(lastPos == str.npos)
lastPos = length;

// Found a token, add it to the vector
tokens.push_back(str.substr(lastPos, pos - lastPos));

// Skip delimiters
lastPos = str.find_first_not_of(delimiters, pos);

// Find next "non-delimiter"
pos = str.find_first_of(delimiters, lastPos);
}
}

DialogConfigurations::DialogConfigurations()
{
setDialogDefaults(CEGUI::URect( CEGUI::UDim(0.0f, 0.0f),
CEGUI::UDim(0.0f, 0.0f),
CEGUI::UDim(0.5f, 0.0f),
CEGUI::UDim(0.5f, 0.0f)),
true,
true);

// setMultiColumnListDefaults()
m_defaultSortedColumn = 0;
m_defaultSortAscending = true;

if(m_attributeList.empty())
{
// This is a static variable, only initialize once
m_attributeList.push_back(monitoredAttributeAll);
m_attributeList.push_back(monitoredAttributeNone);
m_attributeList.push_back(windowPosAttribute);
m_attributeList.push_back(windowVisibleAttribute);
m_attributeList.push_back(windowRolledupAttribute);
m_attributeList.push_back(mclColumnSequenceAttribute);
m_attributeList.push_back(mclSortedColumnAttribute);
m_attributeList.push_back(mclAscendingSortAttribute);
m_attributeList.push_back(mclColumnWidthAttribute);
}

// The default is to monitor every attribute
_setDialogAttributesMonitored("", monitoredAttributeAll);
_setMultiColumnListAttributesMonitored("", monitoredAttributeAll);
}

bool DialogConfigurations::loadConfigurations(const CEGUI::String& xmlFile, const CEGUI::String& schema, const bool& applyConfigurations)
{
// Load the config of every stored dialog
assert(!xmlFile.empty() && "You must specify an xml file to loadConfigurations()");
m_configFile = xmlFile;
bool loadedOk = true;
try
{
CEGUI::System::getSingleton().getXMLParser()->parseXMLFile(*this, m_configFile, schema, "");
}
catch(const CEGUI::Exception&)
{
// File is empty or parse error
// Silently ignore; we'll create a new file when saving
loadedOk = false;
}

if(applyConfigurations)
{
applyDialogConfiguration();
applyMultiColumnListConfiguration();
}

return loadedOk;
}

bool DialogConfigurations::saveConfigurations()
{
// Store the configuration of every registered dialog, either within
// the loaded XML file or those manually registered via addDialog()
assert(!m_configFile.empty() && "You must specify an xml file by calling loadConfigurations() before saveConfigurations()");

// Try to open the XML file in writing mode
std::ofstream fileSave;
fileSave.open(m_configFile.c_str(), std::ios::out) ;
if( !fileSave.is_open() )
{
CEGUI::Logger::getSingleton().logEvent("Could not write to dialog configuration file ("
+ m_configFile
+ "). Is it read-only?",
CEGUI::Errors);
return false;
}

// Write the header
fileSave << "<?xml version=\"1.0\" ?>" << std::endl
<< "<" << m_DialogConfigurationElement << ">"
<< std::endl;

// Write each dialog's configuration
DialogConfig dialogConfig;
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, DialogConfig>::iterator itDialogConfig;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
std::vector<CEGUI::String> attributesMonitored;
CEGUI::Window* window;
for(itDialogConfig = m_dialogConfigurations.begin(); itDialogConfig != m_dialogConfigurations.end(); ++itDialogConfig)
{
if(!winMgr.isWindowPresent(itDialogConfig->first))
continue;

itAttributesMonitored = m_attributesMonitoredDialog.find(itDialogConfig->first);
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredDialog.find("");
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second;
}

window = winMgr.getWindow(itDialogConfig->first);
dialogConfig.position = window->getArea();
dialogConfig.visible = window->isVisible();
if( window->testClassName("FrameWindow") )
dialogConfig.rolledup = static_cast<CEGUI::FrameWindow*>(window)->isRolledup();
else
dialogConfig.rolledup = false;
fileSave << " <" << m_configurationElementDialog.c_str() << " "
<< windowNameAttribute << "=\"" << itDialogConfig->first << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowPosAttribute))
fileSave << windowPosAttribute << "=\"" << CEGUI::PropertyHelper::urectToString(dialogConfig.position) << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowVisibleAttribute))
fileSave << windowVisibleAttribute << "=\"" << dialogConfig.visible << "\" ";
if(isMonitoringAttribute(attributesMonitored, windowRolledupAttribute))
fileSave << windowRolledupAttribute << "=\"" << dialogConfig.rolledup << "\" ";
fileSave << "/>" << std::endl;
}

// Write each MultiColumnList's configuration
std::map<CEGUI::String, MultiColumnListConfig>::iterator itMultiColumnListConfig;
attributesMonitored.clear();
CEGUI::MultiColumnList* multiColumnList;
for(itMultiColumnListConfig = m_multiColumnListConfigurations.begin(); itMultiColumnListConfig != m_multiColumnListConfigurations.end(); ++itMultiColumnListConfig)
{
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find(itMultiColumnListConfig->first);
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find("");
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second;
}

multiColumnList = static_cast<CEGUI::MultiColumnList*>(winMgr.getWindow(itMultiColumnListConfig->first));
fileSave << " <" << m_configurationElementMultiColumnList.c_str() << " "
<< windowNameAttribute << "=\"" << itMultiColumnListConfig->first << "\" ";
if(isMonitoringAttribute(attributesMonitored, mclColumnSequenceAttribute) && multiColumnList->getColumnCount())
{
fileSave << mclColumnSequenceAttribute << "=\"";
for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
if(columnIndex)
fileSave << mclColumnSequenceSeparator;
fileSave << multiColumnList->getColumnID(columnIndex);
}
fileSave << "\" ";
}
if(isMonitoringAttribute(attributesMonitored, mclColumnWidthAttribute) && multiColumnList->getColumnCount())
{
fileSave << mclColumnWidthAttribute << "=\"";
for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
if(columnIndex)
fileSave << mclColumnWidthSeparator;
fileSave << CEGUI::PropertyHelper::udimToString(multiColumnList->getColumnHeaderWidth(columnIndex));
}
fileSave << "\" ";
}
if(isMonitoringAttribute(attributesMonitored, mclSortedColumnAttribute))
fileSave << mclSortedColumnAttribute << "=\"" << multiColumnList->getColumnID(multiColumnList->getSortColumn()) << "\" ";
if(isMonitoringAttribute(attributesMonitored, mclAscendingSortAttribute))
fileSave << mclAscendingSortAttribute << "=\"" << (multiColumnList->getSortDirection() != CEGUI::ListHeaderSegment::Descending) << "\" ";
fileSave << "/>" << std::endl;
}

// Write the footer
fileSave << "</" << m_DialogConfigurationElement << ">" << std::endl;
fileSave.close();
return true;
}

void DialogConfigurations::setDialogDefaults(const CEGUI::URect& position, const bool& visible, const bool& rolledup)
{
// Set default values
// Should validate what's being passed as parameters
m_defaultPosition = position;
m_defaultVisible = visible;
m_defaultRolledup = rolledup;
}

void DialogConfigurations::setDefaultDialogAttributesMonitored(const CEGUI::String& attributesMonitored)
{
_setDialogAttributesMonitored("", attributesMonitored);
}

bool DialogConfigurations::addDialog(const CEGUI::String& widget, const CEGUI::String& attributesMonitored)
{
// Add a dialog to be monitored
// This can be used to automatically write the contents of the initial XML file
// rather than editing it by hand.
assert(!widget.empty() && "You must pass a dialog name to addDialog()");

if(!attributesMonitored.empty())
_setDialogAttributesMonitored(widget, attributesMonitored);

std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(widget);
if(itConfig != m_dialogConfigurations.end())
return false; // This dialog is already added

CEGUI::Window* window = CEGUI::WindowManager::getSingleton().getWindow(widget);
DialogConfig config;
config.position = window->getArea();
config.visible = window->isVisible();
if( window->testClassName("FrameWindow") )
config.rolledup = static_cast<CEGUI::FrameWindow*>(window)->isRolledup();
else
config.rolledup = m_defaultRolledup; // Not really needed, unless this window inherits from FrameWindow after being loaded

m_dialogConfigurations[widget] = config;
return true;
}

const CEGUI::URect& DialogConfigurations::getDialogSavedPosition(const CEGUI::String& dialog)
{
// Return the position of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultPosition : (*itConfig).second.position;
}

const bool& DialogConfigurations::getDialogSavedVisible(const CEGUI::String& dialog)
{
// Return the visible/hidden state of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultVisible : (*itConfig).second.visible;
}

const bool& DialogConfigurations::getDialogSavedRolledup(const CEGUI::String& dialog)
{
// Return the expansion state of the specified dialog
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
return itConfig == m_dialogConfigurations.end() ? m_defaultRolledup : (*itConfig).second.rolledup;
}

bool DialogConfigurations::applyDialogConfiguration(const CEGUI::String& dialog)
{
// Apply the saved configuration to a dialog
if(dialog.length() == 0)
{
// Load every dialog configurations
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
for(itConfig = m_dialogConfigurations.begin(); itConfig != m_dialogConfigurations.end(); itConfig++)
{
applyDialogConfiguration((*itConfig).first);
}
}
else
{
// Find this dialog's configuration
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, DialogConfig>::iterator itConfig;
itConfig = m_dialogConfigurations.find(dialog);
if(itConfig == m_dialogConfigurations.end() || !winMgr.isWindowPresent(dialog))
return false;

// Determine which attributes are monitored
std::vector<CEGUI::String> attributesMonitored;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
itAttributesMonitored = m_attributesMonitoredDialog.find(dialog);
if(itAttributesMonitored != m_attributesMonitoredDialog.end())
attributesMonitored = (*itAttributesMonitored).second; // Dialog has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredDialog.find("");
if(itAttributesMonitored == m_attributesMonitoredDialog.end())
return false; // Could not retrieve the default attributes (should never happen)
attributesMonitored = (*itAttributesMonitored).second;
}

// Apply the configuration to the dialog
CEGUI::Window* window = winMgr.getWindow(dialog);
if(isMonitoringAttribute(attributesMonitored, windowPosAttribute))
window->setArea((*itConfig).second.position);
if(isMonitoringAttribute(attributesMonitored, windowVisibleAttribute))
window->setVisible((*itConfig).second.visible);
if(isMonitoringAttribute(attributesMonitored, windowRolledupAttribute))
{
if( window->testClassName("FrameWindow") )
{
CEGUI::FrameWindow* frameWindow = static_cast<CEGUI::FrameWindow*>(window);
if(frameWindow->isRolledup() != (*itConfig).second.rolledup)
frameWindow->toggleRollup();
}
}
}
return true;
}

void DialogConfigurations::setMultiColumnListDefaults(const std::vector<CEGUI::String>& columnSequence, const CEGUI::uint& sortedColumn, const bool& sortAscending, const std::vector<CEGUI::String>& columnWidths)
{
// Set default values
// Should validate what's being passed as parameters
m_defaultColumnSequence = columnSequence;
m_defaultSortedColumn = sortedColumn;
m_defaultSortAscending = sortAscending;
m_defaultColumnWidths = columnWidths;
}

void DialogConfigurations::setDefaultMultiColumnListAttributesMonitored(const CEGUI::String& attributesMonitored)
{
_setMultiColumnListAttributesMonitored("", attributesMonitored);
}

bool DialogConfigurations::addMultiColumnList(const CEGUI::String& widget, const CEGUI::String& attributesMonitored)
{
// Add a MultiColumnList to be monitored
// This can be used to automatically write the contents of the initial XML file
// rather than editing it by hand.
assert(!widget.empty() && "You must pass a multiColumnList name to addMultiColumnList()");

if(!attributesMonitored.empty())
_setMultiColumnListAttributesMonitored(widget, attributesMonitored);

std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
itConfig = m_multiColumnListConfigurations.find(widget);
if(itConfig != m_multiColumnListConfigurations.end())
return false; // This MultiColumnList is already added

MultiColumnListConfig config;
CEGUI::MultiColumnList* multiColumnList = static_cast<CEGUI::MultiColumnList*>(CEGUI::WindowManager::getSingleton().getWindow(widget));
assert(multiColumnList->testClassName("MultiColumnList") && "This widget is not a MultiColumnList");

for(CEGUI::uint columnIndex = 0; columnIndex < multiColumnList->getColumnCount(); ++columnIndex)
{
config.columnSequence.push_back(CEGUI::PropertyHelper::uintToString(multiColumnList->getColumnID(columnIndex)));
config.columnWidths.push_back(CEGUI::PropertyHelper::udimToString(multiColumnList->getColumnHeaderWidth(columnIndex)));
}
config.sortedColumn = multiColumnList->getSortColumn();
config.sortAscending = multiColumnList->getSortDirection() != CEGUI::ListHeaderSegment::Descending;

m_multiColumnListConfigurations[widget] = config;
return true;
}

bool DialogConfigurations::applyMultiColumnListConfiguration(const CEGUI::String& multiColumnList)
{
// Apply the saved configuration to a multi column list
if(multiColumnList.length() == 0)
{
// Load every multi column list configurations
std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
for(itConfig = m_multiColumnListConfigurations.begin(); itConfig != m_multiColumnListConfigurations.end(); itConfig++)
{
applyMultiColumnListConfiguration((*itConfig).first);
}
}
else
{
// Find this multi column list's configuration
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();
std::map<CEGUI::String, MultiColumnListConfig>::iterator itConfig;
itConfig = m_multiColumnListConfigurations.find(multiColumnList);
if(itConfig == m_multiColumnListConfigurations.end() || !winMgr.isWindowPresent(multiColumnList))
return false;

// Determine which attributes are monitored
std::vector<CEGUI::String> attributesMonitored;
std::map<CEGUI::String, std::vector<CEGUI::String>>::iterator itAttributesMonitored;
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find(multiColumnList);
if(itAttributesMonitored != m_attributesMonitoredMultiColumnList.end())
attributesMonitored = (*itAttributesMonitored).second; // Multi column list has specified attributes
else
{
// Use default attributes
itAttributesMonitored = m_attributesMonitoredMultiColumnList.find("");
if(itAttributesMonitored == m_attributesMonitoredMultiColumnList.end())
return false; // Could not retrieve the default attributes (should never happen)
attributesMonitored = (*itAttributesMonitored).second;
}

// Apply the configuration to the multi column list
CEGUI::MultiColumnList* window = static_cast<CEGUI::MultiColumnList*>(winMgr.getWindow(multiColumnList));
if(isMonitoringAttribute(attributesMonitored, mclColumnSequenceAttribute))
{
for(CEGUI::uint columnIndex = 0; columnIndex < window->getColumnCount() && columnIndex < (*itConfig).second.columnSequence.size(); ++columnIndex)
{
window->moveColumn(window->getColumnWithID(CEGUI::PropertyHelper::stringToUint((*itConfig).second.columnSequence.at(columnIndex))),
columnIndex);
}
}
if(isMonitoringAttribute(attributesMonitored, mclColumnWidthAttribute))
{
CEGUI::UDim width;
for(CEGUI::uint columnIndex = 0; columnIndex < window->getColumnCount() && columnIndex < (*itConfig).second.columnWidths.size(); ++columnIndex)
{
width = CEGUI::PropertyHelper::stringToUDim((*itConfig).second.columnWidths.at(columnIndex));
window->setColumnHeaderWidth(columnIndex, width);
}
}
if(isMonitoringAttribute(attributesMonitored, mclSortedColumnAttribute))
{
window->setSortColumn( window->getColumnWithID((*itConfig).second.sortedColumn) );
}
if(isMonitoringAttribute(attributesMonitored, mclAscendingSortAttribute))
{
window->setSortDirection( (*itConfig).second.sortAscending ? CEGUI::ListHeaderSegment::Ascending
: CEGUI::ListHeaderSegment::Descending);
}
}
return true;
}

bool DialogConfigurations::isMonitoringAttribute(const std::vector<CEGUI::String>& list, const CEGUI::String& attribute)
{
std::vector<CEGUI::String>::const_iterator itList;
for(itList = list.begin(); itList != list.end(); itList++)
{
if(!(*itList).compare(attribute))
return true;
}
return false;
}

void DialogConfigurations::elementStart(const CEGUI::String& element, const CEGUI::XMLAttributes& xmlAttributes)
{
// Performs the actual load every stored configuration
if (element == m_configurationElementDialog)
{
DialogConfig config;
config.position = m_defaultPosition;
config.visible = m_defaultVisible;
config.rolledup = m_defaultRolledup;
CEGUI::String name, monitoredAttributes;
CEGUI::WindowManager& winMgr = CEGUI::WindowManager::getSingleton();

name = xmlAttributes.getValueAsString(windowNameAttribute);

if(xmlAttributes.exists(windowPosAttribute))
{
config.position = CEGUI::PropertyHelper::stringToURect(xmlAttributes.getValueAsString(windowPosAttribute));
monitoredAttributes.append(" ").append(windowPosAttribute);
}
if(xmlAttributes.exists(windowVisibleAttribute))
{
config.visible = xmlAttributes.getValueAsBool(windowVisibleAttribute);
monitoredAttributes.append(" ").append(windowVisibleAttribute);
}
if(xmlAttributes.exists(windowRolledupAttribute))
{
config.rolledup = xmlAttributes.getValueAsBool(windowRolledupAttribute);
monitoredAttributes.append(" ").append(windowRolledupAttribute);
}

_setDialogAttributesMonitored(name, monitoredAttributes);
m_dialogConfigurations[name] = config;
}
else if (element == m_configurationElementMultiColumnList)
{
MultiColumnListConfig config;
config.sortedColumn = m_defaultSortedColumn;
config.sortAscending = m_defaultSortAscending;
CEGUI::String name, monitoredAttributes;

name = xmlAttributes.getValueAsString(windowNameAttribute);

if(xmlAttributes.exists(mclColumnSequenceAttribute))
{
CEGUI::String columnSequence = xmlAttributes.getValueAsString(mclColumnSequenceAttribute);
Tokenize(columnSequence, config.columnSequence, mclColumnSequenceSeparator);
monitoredAttributes.append(" ").append(mclColumnSequenceAttribute);
}
if(xmlAttributes.exists(mclColumnWidthAttribute))
{
CEGUI::String columnWidths = xmlAttributes.getValueAsString(mclColumnWidthAttribute);
Tokenize(columnWidths, config.columnWidths, mclColumnWidthSeparator);
monitoredAttributes.append(" ").append(mclColumnWidthAttribute);
}
if(xmlAttributes.exists(mclSortedColumnAttribute))
{
config.sortedColumn = xmlAttributes.getValueAsInteger(mclSortedColumnAttribute);
monitoredAttributes.append(" ").append(mclSortedColumnAttribute);
}
if(xmlAttributes.exists(mclAscendingSortAttribute))
{
config.sortAscending = xmlAttributes.getValueAsBool(mclAscendingSortAttribute);
monitoredAttributes.append(" ").append(mclAscendingSortAttribute);
}

_setMultiColumnListAttributesMonitored(name, monitoredAttributes);
m_multiColumnListConfigurations[name] = config;
}
}

void DialogConfigurations::_setDialogAttributesMonitored(const CEGUI::String& dialog, const CEGUI::String& attributesMonitored)
{
// Validate the attributes to be monitored
std::vector<CEGUI::String> newAttributes;
std::vector<CEGUI::String> listAttributesMonitored;
Tokenize(attributesMonitored, listAttributesMonitored); // Convert attributesMonitored into a vector
std::vector<CEGUI::String>::iterator itToken;
for(itToken = listAttributesMonitored.begin(); itToken != listAttributesMonitored.end(); itToken++)
{
if(!(*itToken).compare(monitoredAttributeAll))
{
newAttributes.push_back(windowPosAttribute);
newAttributes.push_back(windowVisibleAttribute);
newAttributes.push_back(windowRolledupAttribute);
}
else if(!(*itToken).compare(monitoredAttributeNone))
{
newAttributes.clear();
}
else if(!(*itToken).compare(windowPosAttribute))
newAttributes.push_back(windowPosAttribute);
else if(!(*itToken).compare(windowVisibleAttribute))
newAttributes.push_back(windowVisibleAttribute);
else if(!(*itToken).compare(windowRolledupAttribute))
newAttributes.push_back(windowRolledupAttribute);
else
{
// Attribute is not supported
assert(false && "Unsupported attribute specified for a dialog");
CEGUI::Logger::getSingleton().logEvent("The attribute \""
+ (*itToken)
+ "\" is unsupported for dialogs.",
CEGUI::Errors);
}
}

// Store the attributes to be monitored
m_attributesMonitoredDialog[dialog] = newAttributes;
}

void DialogConfigurations::_setMultiColumnListAttributesMonitored(const CEGUI::String& multiColumnList, const CEGUI::String& attributesMonitored)
{
// Validate the attributes to be monitored
std::vector<CEGUI::String> newAttributes;
std::vector<CEGUI::String> listAttributesMonitored;
Tokenize(attributesMonitored, listAttributesMonitored); // Convert attributesMonitored into a vector
std::vector<CEGUI::String>::iterator itToken;
for(itToken = listAttributesMonitored.begin(); itToken != listAttributesMonitored.end(); itToken++)
{
if(!(*itToken).compare(monitoredAttributeAll))
{
newAttributes.push_back(mclColumnSequenceAttribute);
newAttributes.push_back(mclSortedColumnAttribute);
newAttributes.push_back(mclAscendingSortAttribute);
newAttributes.push_back(mclColumnWidthAttribute);
}
else if(!(*itToken).compare(monitoredAttributeNone))
{
newAttributes.clear();
}
else if(!(*itToken).compare(mclColumnSequenceAttribute))
newAttributes.push_back(mclColumnSequenceAttribute);
else if(!(*itToken).compare(mclSortedColumnAttribute))
newAttributes.push_back(mclSortedColumnAttribute);
else if(!(*itToken).compare(mclAscendingSortAttribute))
newAttributes.push_back(mclAscendingSortAttribute);
else if(!(*itToken).compare(mclColumnWidthAttribute))
newAttributes.push_back(mclColumnWidthAttribute);
else
{
// Attribute is not supported
assert(false && "Unsupported attribute specified for a MultiColumnList");
CEGUI::Logger::getSingleton().logEvent("The attribute \""
+ (*itToken)
+ "\" is unsupported for MultiColumnLists.",
CEGUI::Errors);
}
}

// Store the attributes to be monitored
m_attributesMonitoredMultiColumnList[multiColumnList] = newAttributes;
}
</code>

==== DialogConfigurationsDemo.h ====
<code><cpp/>
#ifndef _DialogConfigurationsDemo_h_
#define _DialogConfigurationsDemo_h_

#include "CEGuiSample.h"
#include "CEGUI.h"
#include "DialogConfigurations.h"

class DemoSample : public CEGuiSample
{
public:
bool initialiseSample()
{
using namespace CEGUI;
try
{
// Retrieve the window manager
WindowManager& winMgr = WindowManager::getSingleton();

// Load the TaharezLook scheme and set up the default mouse cursor and font
SchemeManager::getSingleton().loadScheme("TaharezLook.scheme");
System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow");
FontManager::getSingleton().createFont("Commonwealth-10.font");

// Set the GUI Sheet
Window* sheet = winMgr.createWindow("DefaultWindow", "root_wnd");
System::getSingleton().setGUISheet(sheet);

// Load a layout
Window* guiLayout = winMgr.loadWindowLayout("DialogConfigurations.layout");
sheet->addChildWindow(guiLayout);

// Configure the toolbar
winMgr.getWindow("DialogConfigurations/Toolbar/ShowA")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showA, this));
winMgr.getWindow("DialogConfigurations/Toolbar/ShowC")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showC, this));
winMgr.getWindow("DialogConfigurations/Toolbar/ShowD")->subscribeEvent(PushButton::EventClicked, Event::Subscriber(&DemoSample::showD, this));

// Activate the close buttons
winMgr.getWindow("DialogConfigurations/Window_A")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeA, this));
winMgr.getWindow("DialogConfigurations/Window_B")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeB, this));
winMgr.getWindow("DialogConfigurations/Window_C")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeC, this));
winMgr.getWindow("DialogConfigurations/Window_D")->subscribeEvent(FrameWindow::EventCloseClicked, Event::Subscriber(&DemoSample::closeD, this));

// Add columns to the MultiColumnList
MultiColumnList* multiColumnList = static_cast<MultiColumnList*>(winMgr.getWindow("DialogConfigurations/Window_D/MultiColumnList"));
multiColumnList->addColumn("Col A", 0, UDim(0.32f, 0));
multiColumnList->addColumn("Col B", 1, UDim(0.32f, 0));
multiColumnList->addColumn("Col C", 2, UDim(0.32f, 0));

// Add rows
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("1", 101), 0, 0); // ColumnID, RowID
multiColumnList->setItem(new ListboxTextItem("4", 102), 1, 0);
multiColumnList->setItem(new ListboxTextItem("7", 103), 2, 0);
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("4", 201), 0, 1);
multiColumnList->setItem(new ListboxTextItem("7", 202), 1, 1);
multiColumnList->setItem(new ListboxTextItem("1", 203), 2, 1);
multiColumnList->addRow();
multiColumnList->setItem(new ListboxTextItem("7", 301), 0, 2);
multiColumnList->setItem(new ListboxTextItem("1", 302), 1, 2);
multiColumnList->setItem(new ListboxTextItem("4", 303), 2, 2);

// Activate dialog configurations
m_DialogConfigurations.loadConfigurations("DialogConfigurations.xml");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_A", "Position Visible");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_B", "Position RolledUp");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_C", "Visible RolledUp");
m_DialogConfigurations.addDialog("DialogConfigurations/Window_D"); // Saves every attribute: Position, Visible, and RolledUp
m_DialogConfigurations.addMultiColumnList("DialogConfigurations/Window_D/MultiColumnList"); // Saves every attribute: ColumnSequence, ColumnWidths, SortedColumn, and AscendingSort
}
catch(Exception &e)
{
#if defined( __WIN32__ ) || defined( _WIN32 )
MessageBox(NULL, e.getMessage().c_str(), "Error initializing the demo", MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << "Error initializing the demo:" << e.getMessage().c_str() << "\n";
#endif
}

return true;
}

void cleanupSample(void)
{
m_DialogConfigurations.saveConfigurations();
}

bool showA(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_A")->setVisible(true);
return true;
}

bool showC(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_C")->setVisible(true);
return true;
}

bool showD(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_D")->setVisible(true);
return true;
}

bool closeA(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_A")->setVisible(false);
return true;
}

bool closeB(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_B")->setVisible(false);
return true;
}

bool closeC(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_C")->setVisible(false);
return true;
}

bool closeD(const CEGUI::EventArgs& e)
{
CEGUI::WindowManager::getSingleton().getWindow("DialogConfigurations/Window_D")->setVisible(false);
return true;
}
private:
DialogConfigurations m_DialogConfigurations;
};

#endif // _DialogConfigurationsDemo_h_
</code>

==== main.cpp ====
<code><cpp/>
#if defined( __WIN32__ ) || defined( _WIN32 )
#define WIN32_LEAN_AND_MEAN
#define NOMINMAX
#include "windows.h"
#endif

#include "DialogConfigurationsDemo.h"

#if defined( __WIN32__ ) || defined( _WIN32 )
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine,int nCmdShow)
#else
int main(int argc, char *argv[])
#endif
{
DemoSample app;
return app.run();
}
</code>

==== DialogConfigurations.layout ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout >
<Window Type="DefaultWindow" Name="DialogConfigurations" >
<Property Name="InheritsAlpha" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
<Window Type="TaharezLook/StaticText" Name="DialogConfigurations/Toolbar" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.1875,0},{0.00833335,0},{0.8025,0},{0.111667,0}}" />
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowA" >
<Property Name="Text" Value="Show A" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.0581303,0},{0.156452,0},{0.30813,0},{0.858064,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowC" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Show C" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.388618,0},{0.156452,0},{0.638618,0},{0.858064,0}}" />
</Window>
<Window Type="TaharezLook/Button" Name="DialogConfigurations/Toolbar/ShowD" >
<Property Name="Font" Value="Commonwealth-10" />
<Property Name="Text" Value="Show D" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.704878,0},{0.156452,0},{0.954878,0},{0.858064,0}}" />
</Window>
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_A" >
<Property Name="Text" Value="A - RolledUp not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.035,0},{0.123333,0},{0.325,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_B" >
<Property Name="Text" Value="B - Visible not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.35125,0},{0.123333,0},{0.64125,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_C" >
<Property Name="Text" Value="C - Position & Size not saved" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.6675,0},{0.123333,0},{0.957501,0},{0.47,0}}" />
</Window>
<Window Type="TaharezLook/FrameWindow" Name="DialogConfigurations/Window_D" >
<Property Name="Text" Value="D Saves MultiColumnList column width, sequence, and sort" />
<Property Name="TitlebarFont" Value="Commonwealth-10" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="TitlebarEnabled" Value="True" />
<Property Name="UnifiedAreaRect" Value="{{0.10625,0},{0.53375,0},{0.86625,0},{0.962083,0}}" />
<Window Type="TaharezLook/MultiColumnList" Name="DialogConfigurations/Window_D/MultiColumnList" >
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.031235,0},{0.140467,0},{0.968886,0},{0.950778,0}}" />
</Window>
</Window>
</Window>
</GUILayout>
</pre>

Property reference for WindowsLook

2007-06-29T17:34:36Z

Rackle:

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. The properties for the [http://www.cegui.org.uk/wiki/index.php/SetProperty TaharezLook] are also available.

=== WindowsLook ===
==== Button ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverTextColour]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| bgcolor="#FFBF00" | [[#PushedTextColour]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
|-
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
|-
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Checkbox ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverTextColour]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| bgcolor="#FFBF00" | [[#PushedTextColour]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Selected]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== ComboDropList ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#ForceHorzScrollbar]]
| [[#ForceVertScrollbar]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#ItemTooltips]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#MultiSelect]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Sort]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== Combobox ====
{| class="wikitable" border="1"
| bgcolor="#FFBF00" | [[#ActiveEditSelectionColour]]
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
|-
| [[#CaratIndex]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#EditSelectionLength]]
| [[#EditSelectionStart]]
| [[#Font]]
| [[#ForceHorzScrollbar]]
|-
| [[#ForceVertScrollbar]]
| [[#HorizontalAlignment]]
| [[#ID]]
| bgcolor="#FFBF00" | [[#InactiveEditSelectionColour]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MaxEditTextLength]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| bgcolor="#FFBF00" | [[#NormalEditTextColour]]
| [[#ReadOnly]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| bgcolor="#FFBF00" | [[#SelectedEditTextColour]]
| [[#SingleClickMode]]
| [[#SortList]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#ValidationString]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Editbox ====
{| class="wikitable" border="1"
| bgcolor="#FFBF00" | [[#ActiveSelectionColour]]
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
|-
| [[#CaratIndex]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| bgcolor="#FFBF00" | [[#InactiveSelectionColour]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MaskCodepoint]]
| [[#MaskText]]
|-
| [[#MaxTextLength]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| bgcolor="#FFBF00" | [[#NormalTextColour]]
|-
| [[#ReadOnly]]
| bgcolor="#FFBF00" | [[#ReadOnlyBGColour]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
|-
| [[#SelectionLength]]
| [[#SelectionStart]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#ValidationString]]
| [[#VerticalAlignment]]
|-
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== FrameWindow ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| bgcolor="#FFBF00" | [[#CaptionColour]]
|-
| [[#ClippedByParent]]
| [[#CloseButtonEnabled]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#DragMovingEnabled]]
| [[#EWSizingCursorImage]]
| [[#Font]]
| [[#FrameEnabled]]
|-
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#NESWSizingCursorImage]]
| [[#NSSizingCursorImage]]
|-
| [[#NWSESizingCursorImage]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#RollUpEnabled]]
| [[#RollUpState]]
|-
| [[#SizingBorderThickness]]
| [[#SizingEnabled]]
| [[#Text]]
| [[#TitlebarEnabled]]
| bgcolor="#FFBF00" | [[#TitlebarFont]]
|-
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
|-
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== HorizontalScrollbar ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#DocumentSize]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#OverlapSize]]
|-
| [[#PageSize]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#ScrollPosition]]
| [[#StepSize]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#VerticalScrollbar]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== HorizontalScrollbarThumb ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#HorzFree]]
| [[#HorzRange]]
| [[#HotTracked]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VertFree]]
|-
| [[#VertRange]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== IconButton ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#ID]]
| bgcolor="#FFBF00" | [[#IconColours]]
| bgcolor="#FFBF00" | [[#IconImage]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== ItemListbox ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#AutoResizeEnabled]]
|-
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#ForceHorzScrollbar]]
| [[#ForceVertScrollbar]]
| [[#HorizontalAlignment]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#MultiSelect]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#SortEnabled]]
|-
| [[#SortMode]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== ListHeader ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#ColumnsMovable]]
| [[#ColumnsSizable]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#SegmentWidgetType]]
| [[#SortColumnID]]
| [[#SortDirection]]
|-
| [[#SortSettingEnabled]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== ListHeaderSegment ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#Clickable]]
|-
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
|-
| [[#Dragable]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#MovingCursorImage]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Sizable]]
| [[#SizingCursorImage]]
|-
| [[#SortDirection]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Listbox ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#ForceHorzScrollbar]]
| [[#ForceVertScrollbar]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#ItemTooltips]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#MultiSelect]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Sort]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== ListboxItem ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| [[#Selectable]]
| [[#Selected]]
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
| bgcolor="#FFBF00" | [[#SelectionBrush]]
| bgcolor="#FFBF00" | [[#SelectionColour]]
|-
| [[#Text]]
| bgcolor="#FFBF00" | [[#TextColour]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== MenuItem ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverColour]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| bgcolor="#FFBF00" | [[#OpenedColour]]
| bgcolor="#FFBF00" | [[#PushedColour]]
| bgcolor="#FFBF00" | [[#PushedOffColour]]
| [[#RestoreOldCapture]]
|-
| [[#RiseOnClick]]
| [[#Selectable]]
| [[#Selected]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
|-
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Menubar ====
{| class="wikitable" border="1"
| [[#AllowMultiplePopups]]
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
|-
| [[#AutoResizeEnabled]]
| bgcolor="#FFBF00" | [[#BackgroundColours]]
| bgcolor="#FFBF00" | [[#BorderWidth]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
|-
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#HorizontalAlignment]]
|-
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#ItemSpacing]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| [[#SortEnabled]]
| [[#SortMode]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== MultiColumnList ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#ColumnHeader]]
| [[#ColumnsMovable]]
| [[#ColumnsSizable]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
|-
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#ForceHorzScrollbar]]
| [[#ForceVertScrollbar]]
|-
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#NominatedSelectionColumnID]]
| [[#NominatedSelectionRow]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#RowCount]]
| [[#SelectionMode]]
| [[#SortColumnID]]
|-
| [[#SortDirection]]
| [[#SortSettingEnabled]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== MultiLineEditbox ====
{| class="wikitable" border="1"
| bgcolor="#FFBF00" | [[#ActiveSelectionColour]]
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
|-
| [[#CaratIndex]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| bgcolor="#FFBF00" | [[#InactiveSelectionColour]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MaxTextLength]]
| [[#MouseButtonDownAutoRepeat]]
|-
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| [[#ReadOnly]]
| bgcolor="#FFBF00" | [[#ReadOnlyBGColour]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
| [[#SelectionBrushImage]]
| [[#SelectionLength]]
|-
| [[#SelectionStart]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#WordWrap]]
| [[#ZOrderChangeEnabled]]
|}

==== PopupMenu ====
{| class="wikitable" border="1"
| [[#AllowMultiplePopups]]
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
|-
| [[#AutoResizeEnabled]]
| bgcolor="#FFBF00" | [[#BackgroundColours]]
| bgcolor="#FFBF00" | [[#BorderWidth]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
|-
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#FadeInTime]]
| [[#FadeOutTime]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#ItemSpacing]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#SortEnabled]]
| [[#SortMode]]
| [[#Text]]
|-
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
|-
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== ProgressBar ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CurrentProgress]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
|-
| [[#ReversedProgress]]
| [[#RiseOnClick]]
| [[#StepSize]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
|-
| [[#VerticalProgress]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== RadioButton ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#GroupID]]
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverTextColour]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| bgcolor="#FFBF00" | [[#PushedTextColour]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| [[#Selected]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== ScrollablePane ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#ContentArea]]
| [[#ContentPaneAutoSized]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#ForceHorzScrollbar]]
| [[#ForceVertScrollbar]]
| [[#HorizontalAlignment]]
|-
| [[#HorzOverlapSize]]
| [[#HorzScrollPosition]]
| [[#HorzStepSize]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VertOverlapSize]]
| [[#VertScrollPosition]]
|-
| [[#VertStepSize]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== Slider ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClickStepSize]]
|-
| [[#ClippedByParent]]
| [[#CurrentValue]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MaximumValue]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#ReversedDirection]]
| [[#RiseOnClick]]
| [[#Text]]
|-
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
|-
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
|-
| [[#VerticalAlignment]]
| [[#VerticalSlider]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== SliderThumb ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#HorzFree]]
| [[#HorzRange]]
| [[#HotTracked]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VertFree]]
|-
| [[#VertRange]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== Spinner ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CurrentValue]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MaximumValue]]
| [[#MinimumValue]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#StepSize]]
| [[#Text]]
|-
| [[#TextInputMode]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== Static ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| bgcolor="#FFBF00" | [[#BackgroundColours]]
|-
| bgcolor="#FFBF00" | [[#BackgroundEnabled]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| bgcolor="#FFBF00" | [[#FrameColours]]
| bgcolor="#FFBF00" | [[#FrameEnabled]]
| [[#HorizontalAlignment]]
|-
| bgcolor="#FFBF00" | [[#HorzFormatting]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| [[#Text]]
| bgcolor="#FFBF00" | [[#TextPadding]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
|-
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
|-
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| bgcolor="#FFBF00" | [[#VertFormatting]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== StaticImage ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| bgcolor="#FFBF00" | [[#BackgroundColours]]
|-
| bgcolor="#FFBF00" | [[#BackgroundEnabled]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| bgcolor="#FFBF00" | [[#FrameColours]]
| bgcolor="#FFBF00" | [[#FrameEnabled]]
| [[#HorizontalAlignment]]
|-
| bgcolor="#FFBF00" | [[#HorzFormatting]]
| [[#ID]]
| bgcolor="#FFBF00" | [[#Image]]
| bgcolor="#FFBF00" | [[#ImageColours]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| bgcolor="#FFBF00" | [[#VertFormatting]]
| [[#VerticalAlignment]]
|-
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== StaticText ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| bgcolor="#FFBF00" | [[#BackgroundColours]]
|-
| bgcolor="#FFBF00" | [[#BackgroundEnabled]]
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
|-
| [[#DistributeCapturedInputs]]
| [[#Font]]
| bgcolor="#FFBF00" | [[#FrameColours]]
| bgcolor="#FFBF00" | [[#FrameEnabled]]
| [[#HorizontalAlignment]]
|-
| [[#HorzFormatting]]
| [[#HorzScrollbar]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
|-
| [[#RiseOnClick]]
| [[#Text]]
| bgcolor="#FFBF00" | [[#TextColours]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VertFormatting]]
| [[#VertScrollbar]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== SystemButton ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverImage]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| bgcolor="#FFBF00" | [[#NormalImage]]
|-
| bgcolor="#FFBF00" | [[#PushedImage]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
|-
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== TabButton ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| bgcolor="#FFBF00" | [[#DisabledTextColour]]
| [[#DistributeCapturedInputs]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| bgcolor="#FFBF00" | [[#HoverTextColour]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| bgcolor="#FFBF00" | [[#NormalTextColour]]
| bgcolor="#FFBF00" | [[#PushedTextColour]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| bgcolor="#FFBF00" | [[#SelectedTextColour]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

==== TabButtonPane ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| bgcolor="#FFBF00" | [[#EnableBottom]]
|-
| bgcolor="#FFBF00" | [[#EnableTop]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== TabContentPane ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| bgcolor="#FFBF00" | [[#EnableBottom]]
|-
| bgcolor="#FFBF00" | [[#EnableTop]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== TabControl ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
|-
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
|-
| [[#TabButtonType]]
| [[#TabHeight]]
| [[#TabPanePosition]]
| [[#TabTextPadding]]
| [[#Text]]
|-
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
|-
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
|-
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Titlebar ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| bgcolor="#FFBF00" | [[#CaptionColour]]
|-
| [[#ClippedByParent]]
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
|-
| [[#DraggingEnabled]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
|-
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
|-
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
|-
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
|-
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#Visible]]
|-
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== Tooltip ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DisplayTime]]
| [[#DistributeCapturedInputs]]
|-
| [[#FadeTime]]
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#HoverTime]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
|-
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== VerticalScrollbar ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#DocumentSize]]
|-
| [[#Font]]
| [[#HorizontalAlignment]]
| [[#ID]]
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
|-
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
| [[#MousePassThroughEnabled]]
| [[#OverlapSize]]
|-
| [[#PageSize]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#ScrollPosition]]
| [[#StepSize]]
|-
| [[#Text]]
| [[#Tooltip]]
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
|-
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
|-
| [[#UnifiedYPosition]]
| [[#VerticalAlignment]]
| [[#VerticalScrollbar]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
|-
| [[#WindowRenderer]]
| [[#ZOrderChangeEnabled]]
|}

==== VerticalScrollbarThumb ====
{| class="wikitable" border="1"
| [[#Alpha]]
| [[#AlwaysOnTop]]
| [[#AutoRepeatDelay]]
| [[#AutoRepeatRate]]
| [[#ClippedByParent]]
|-
| [[#CustomTooltipType]]
| [[#DestroyedByParent]]
| [[#Disabled]]
| [[#DistributeCapturedInputs]]
| [[#Font]]
|-
| [[#HorizontalAlignment]]
| [[#HorzFree]]
| [[#HorzRange]]
| [[#HotTracked]]
| [[#ID]]
|-
| [[#InheritsAlpha]]
| [[#InheritsTooltipText]]
| [[#LookNFeel]]
| [[#MouseButtonDownAutoRepeat]]
| [[#MouseCursorImage]]
|-
| [[#MousePassThroughEnabled]]
| [[#RestoreOldCapture]]
| [[#RiseOnClick]]
| [[#Text]]
| [[#Tooltip]]
|-
| [[#UnifiedAreaRect]]
| [[#UnifiedHeight]]
| [[#UnifiedMaxSize]]
| [[#UnifiedMinSize]]
| [[#UnifiedPosition]]
|-
| [[#UnifiedSize]]
| [[#UnifiedWidth]]
| [[#UnifiedXPosition]]
| [[#UnifiedYPosition]]
| [[#VertFree]]
|-
| [[#VertRange]]
| [[#VerticalAlignment]]
| [[#Visible]]
| [[#WantsMultiClickEvents]]
| [[#WindowRenderer]]
|-
| [[#ZOrderChangeEnabled]]
|}

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