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

Tutorials

2007-04-05T20:58:18Z

Dalfy:

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.

=== Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModule to Sample_FirstWindow]] - Experience adding scripting to an existing sample.
* [http://www.gpwiki.org/index.php/Crazy_Eddies_GUI_System:Tutorials:Creating_a_scriptable_interface_using_CEGUI Creating a scriptable interface using CEGUI]

=== Window System Examples ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.
* [[Using CEGUI with Producer and OpenGL]] - Guidelines on how to render and inject input to CEGUI from the Producer API.
* [http://artis.imag.fr/Membres/Xavier.Decoret/resources/CEGUI/ Using CEGUI with Qt/QGLViewer]
* [[Using CEGUI with GLUT]] - Some tips on using OpenGL's GLUT with CEGUI.

=== Extending CEGUI ===

* [[Using Expat XML parser within CEGUI]] - How to add support for another XML parser.

=== Skins - Tutorial For Artists ===
* [[Creating Skins]] - Extra notes for artists on how to create skins.
* [[The Beginners Guide to Falagard skinning - Part I]] - Learn by doing a Button.
* [[The Beginners Guide to Falagard skinning - Part II]] - More Falagard fun, this time with the Editbox.

=== Overviews ===
* [[Overview of GUI files]] - A quick introduction to all the XML files used by CEGUI.
* [[Overview of resource system enhancements in 0.5.0]] - Introduction to enhancements made for the 0.5.0 release.

=== Miscellaneous HOW-TOs ===
* [[Create ImageButtons]] - A few different ways to create image buttons.
* [[Create a CheckListboxItem]] - Create a CheckListBoxItem that you can use with ItemListbox.

Tutorials

2007-04-05T19:58:12Z

Dalfy:

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.

=== Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModule to Sample_FirstWindow]] - Experience adding scripting to an existing sample.
* [http://www.gpwiki.org/index.php/Crazy_Eddies_GUI_System:Tutorials:Creating_a_scriptable_interface_using_CEGUI Creating a scriptable interface using CEGUI]

=== Window System Examples ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.
* [[Using CEGUI with Producer and OpenGL]] - Guidelines on how to render and inject input to CEGUI from the Producer API.
* [http://artis.imag.fr/Membres/Xavier.Decoret/resources/CEGUI/ Using CEGUI with Qt/QGLViewer]
* [[Using CEGUI with GLUT]] - Some tips on using OpenGL's GLUT with CEGUI.

=== Extending CEGUI ===
* [[Create a CheckListboxItem]] - How to create a check box item to use with the listbox Item.
* [[Using Expat XML parser within CEGUI]] - How to add support for another XML parser.

=== Skins - Tutorial For Artists ===
* [[Creating Skins]] - Extra notes for artists on how to create skins.
* [[The Beginners Guide to Falagard skinning - Part I]] - Learn by doing a Button.
* [[The Beginners Guide to Falagard skinning - Part II]] - More Falagard fun, this time with the Editbox.

=== Overviews ===
* [[Overview of GUI files]] - A quick introduction to all the XML files used by CEGUI.
* [[Overview of resource system enhancements in 0.5.0]] - Introduction to enhancements made for the 0.5.0 release.

=== Miscellaneous HOW-TOs ===
* [[Create ImageButtons]] - A few different ways to create image buttons.
* [[Create a CheckListboxItem]] - Create a CheckListBoxItem that you can use with ItemListbox.

Features

2007-03-29T08:47:28Z

Dalfy:

(draft)
CEGUI's main features are:

*Multi-platform compiling and running. Includes Windows and Linux as a stable release. Mac OS project files are in the making;
*Heavily data-driven by using XML files, a generic property system and powerful skinning possibilities;
*UNICODE support (check the fonts sample);
*Renderers for OpenGL, Directx9, Irrlicht, Ogre3D (provided by the Ogre team), Crystal Space (provided by the Crystal Space team) and Open Scene Graph (provided by the Open Scene Graph team);
*Clear interface in case you want to write your own renderer;
*At least two mature tools;
*Many wiki pages and usefull sample projects;

Main Page

2007-03-29T06:35:28Z

Dalfy:

{{Section|1=Welcome to Crazy Eddie's GUI System|2=
<table><td>Crazy Eddie's GUI System is a free library providing windowing and widgets for graphics APIs / engines where such functionality is not natively available, or severely lacking. The library is object orientated, written in C++, and targeted at games developers who should be spending their time creating great games, not building GUI sub-systems!</td><td><galrand></galrand></td></table>
<div style="text-align:center; color:#884400; border:1px dashed #888888; margin-top:0.9em">
'''To edit this wiki or to contribute to this site, you must be a registered on our [http://www.cegui.org.uk/phpBB2/index.php forums]'''
</div>
}}
{{Section|1= Forum Registration, New comers read me first please !!! |2=
The mail sender script seems not to work lately. So new user please try to register wait for some time for the activation mail, if you don't get it in a day, please send a mail to mailto:dalfy@users.sourceforge.net with your login in the mail !!! Without the login I am not able to activate an account. Please also add CEGUI in the subject.}}
{| width="100%" background-color="transparent"
|valign="top"|


{{Section|1=Learning about CEGUI|2=
* [[FAQ|Everything About CEGUI (FAQ)]]
* [[Features]]
* [[Developer Team]]
* [[Developer meetings]]
}}


{{Section|1=Downloading and Installing|2=
* [[Downloads]]
* [[Community Downloads|Community Downloads page]]
* Installing from source [[Build from Source for Win32|win32]], [[Build from source for Linux|linux]], [[Build from source for OSX|OSX]]
}}


{{Section|1=Working with CEGUI|2=
* [[Tutorials]]: All tutorials to help you getting started with CEGUI
* [[HOW-TO_series|HOW-TO Series]]: How to deal with a specific feature of CEGUI
* [[Articles]]: Some more advanced material on using CEGUI
* [[CodeSnippets]]: chunk of code collection
}}


{{Section|1=CEGUI for Content Creators|2=
* [[Assembling a Toolset|Tools]]: Gather the tools that can help you with the creation of your GUI
* [["Falagard" Skinning System Documentation]]: All you ever wanted to know on falagard skinning system (and more)
* [[XML File formats]]: Description of all XML file format used in CEGUI
* [[External resources]]: Find some material for your gui
* [http://skins.cegui.org.uk Skins]: Find some existing skins
}}


{{Section|1=Community Projects|2=
* [[Projects Using CEGUI]]: Games and other software using CEGUI
* [[User Contributed Material]]: You have a lot of talents lets share it here
* [[CEGUI Addons]]: All addons available in the CVS repository at SF
}}


{{Section|1=Official References|2=
* [[Manual TOC|Manual]]: Official CEGUI Manual (We are going to create it after 0.5 release)
* [http://www.cegui.org.uk/wiki/index.php/The_%22official%22_layout_editor CELayoutEditor documentation]: Installation instructions and manual for the layout editor
* [http://www.cegui.org.uk/api_reference API Reference]: Online doxygen manual for the lastest stable release (0.5.0)
* [http://dalfy.dyndns.org/~ode/cegui/RC2/silly_api_reference SILLY 0.1.0-RC2]: Online doxygen manual for SILLY 0.1 second release candidate (0.1.0-RC2)
* [http://www.cegui.org.uk/FalDocs Falagard Skinning Manual]: Tutorial and reference for the skining system.
}}


| valign="top" width="25%" |

{{CEGUINews}}

{{Section|1=Project|2=
CEGUI Release, roadmap and porting notes
* 0.5 (stable) CEGUI MK2-0.5.0 [[CEGUI Downloads 0.5.0 | downloads]], [[Porting to the 0.5.0 Release|Porting]]
* 0.4 (stable) CEGUI MK2-0.4.1 [[Downloads 0.4.1 | downloads]]
}}

{{CurrentCEGUI}}
|}
{{CEGUIWikiWhatsNew}}

SILLY Downloads 0.1.0

2006-11-04T20:03:27Z

Dalfy:

{{SILLY_download_header|version=0.1.0}}
{{SILLY_download_source|version=0.1.0}}
{{SILLY_download_binary_win32|version=0.1.0|target=vc71|targetlabel=Microsoft Visual C++ 7.1}}
{{SILLY_download_binary_win32|version=0.1.0|target=vc8|targetlabel=Microsoft Visual C++ 8}}
{{SILLY_download_footer|version=0.1.0}}

Template:SILLY download header

2006-11-04T20:02:03Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''SILLY {{{version}}} Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
The files available on this page have been released as a stable release.
</div>
</div>

SILLY Downloads 0.1.0

2006-11-04T19:58:06Z

Dalfy:

{{silly_download_header|version=0.1.0}}
{{silly_download_source|version=0.1.0}}
{{silly_download_binary_win32|version=0.1.0|target=vc71|targetlabel=Microsoft Visual C++ 7.1}}
{{silly_download_binary_win32|version=0.1.0|target=vc8|targetlabel=Microsoft Visual C++ 8}}
{{silly_download_footer|version=0.1.0}}

Template:SILLY download source

2006-11-04T19:55:17Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''SILLY {{{version}}} Library Source Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains the source code supplied as a compressed tarball. It is intended for linux and Apple Mac users. [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-{{{version}}}.tar.gz?download Download Now!]
* This package contains the source code supplied as a compressed zip archive. It is intended for Microsoft Windows users. [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-{{{version}}}.zip?download Download Now!]
</div>
</div>

Template:SILLY download binary win32

2006-11-04T19:53:20Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''SILLY {{{version}}} Binary Downloads for {{{targetlabel}}}'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains a precompiled SDK supplied as an installer. [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-SDK-{{{version}}}-{{{target}}}.exe?download Download Now!]
* This package contains a precompiled SDK supplied as a compressed zip archive. [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-SDK-{{{version}}}-{{{target}}}.zip?download Download Now!]
* This package contains a precompiled list of all external libraries used by SILLY. It is supplied as a compressed zip archive. The dependencies package is usefull to build SILLY from source. [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-DEPS-{{{version}}}-{{{target}}}.zip?download Download Now!]
</div>
</div>

Template:SILLY download footer

2006-11-04T19:51:27Z

Dalfy:

The CEGUI Team is pleased to provide you with all this files. Please report all bugs on [http://cegui.org.uk/mantis/index.php Mantis Tracker]. Make sure to set the version field in all reports.

Template:Cegui download binary win32

2006-11-04T19:48:37Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''CEGUI {{{version}}} Binary Downloads for {{{targetlabel}}}'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains a precompiled SDK supplied as an installer. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-SDK-{{{version}}}-{{{target}}}.exe?download Download Now!]
* This package contains a precompiled SDK supplied as a compressed zip archive. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-SDK-{{{version}}}-{{{target}}}.zip?download Download Now!]
* This package contains a precompiled list of all external libraries used by CEGUI. It is supplied as a compressed zip archive. The dependencies package is usefull to build CEGUI from source. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-DEPS-{{{version}}}-{{{target}}}.zip?download Download Now!]
</div>
</div>

Template:Cegui download binary win32

2006-11-04T19:43:34Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''CEGUI {{{version}}} Binary Downloads for {{{targetlabel}}}'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains a precompiled SDK supplied as an installer. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-SDK-{{{version}}}-{{{target}}}.exe?download Download Now!]
* This package contains a precompiled SDK supplied as a compressed zip archive. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-SDK-{{{version}}}-{{{target}}}.zip?download Download Now!]
* This package contains precompiled dependencies of all external libraries used by CEGUI supplied as a compressed zip archive. The dependencies package is usefull to build CEGUI from source mainly. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-DEPS-{{{version}}}-{{{target}}}.zip?download Download Now!]
</div>
</div>

CEGUI Downloads 0.5.0

2006-11-04T19:35:52Z

Dalfy:

{{cegui_download_header|version=0.5.0}}
{{cegui_download_source|version=0.5.0}}
{{cegui_download_binary_win32|version=0.5.0|target=vc71|targetlabel=Microsoft Visual C++ 7.1}}
{{cegui_download_binary_win32|version=0.5.0|target=vc8|targetlabel=Microsoft Visual C++ 8}}
{{cegui_download_footer|version=0.5.0}}

CEGUI Downloads 0.5.0

2006-11-04T19:32:43Z

Dalfy:

Template:Cegui download footer

2006-11-04T19:28:22Z

Dalfy:

The CEGUI Team is pleased to provide you with all this files. Please report all bugs on [http://cegui.org.uk/mantis/index.php Mantis Tracker]. Make sure to set the version field in all reports.

Template:Cegui download header

2006-11-04T19:24:48Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''CEGUI {{{version}}} Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
The files available on this page have been released as a stable release.
</div>
</div>

Template:Silly download source

2006-11-04T19:21:06Z

Dalfy:

Template:Cegui download source

2006-11-04T19:20:06Z

Dalfy:

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''CEGUI {{{version}}} Library Source Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains the source code supplied as a compressed tarball. It is intended for linux and Apple Mac users. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{version}}}.tar.gz?download Download Now!]
* This package contains the source code supplied as a compressed zip archive. It is intended for Microsoft Windows users. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{version}}}.zip?download Download Now!]
</div>
</div>

Template:Cegui download source

2006-11-04T19:18:07Z

Dalfy: Termplate for CEGUI source package download (var: version)

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''CEGUI Library Source Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
* This package contains the source code supplied as a compressed tarball. It is intended for linux and Apple Mac users. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{version}}}.tar.gz?download Download Now!]
* This package contains the source code supplied as a compressed zip archive. It is intended for Microsoft Windows users. [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{version}}}.zip?download Download Now!]
</div>
</div>

Template:CEGUIDownloadsRC

2006-08-13T17:12:35Z

Dalfy:

Main Page

2006-08-13T17:07:20Z

Dalfy:

{{Section|1=Welcome to Crazy Eddie's GUI System|2=
<table><td>Crazy Eddie's GUI System is a free library providing windowing and widgets for graphics APIs / engines where such functionality is not natively available, or severely lacking. The library is object orientated, written in C++, and targeted at games developers who should be spending their time creating great games, not building GUI sub-systems!</td><td><galrand></galrand></td></table>
<div style="text-align:center; color:#884400; border:1px dashed #888888; margin-top:0.9em">
'''To edit this wiki or to contribute to this site, you must be a registered on our [http://www.cegui.org.uk/phpBB2/index.php forums]'''
</div>
}}

{| width="100%" background-color="transparent"
|valign="top"|


{{Section|1=Learning about CEGUI|2=
* [[FAQ|Everything About CEGUI (FAQ)]]
* [[Features]]
* [[Developer Team]]
* [[Developer meetings]]
}}


{{Section|1=Downloading and Installing|2=
* [[Downloads]]
* [[Community Downloads|Community Downloads page]]
* Installing from source [[Build from Source for Win32|win32]], [[Build from source for Linux|linux]], [[Build from source for OSX|OSX]]
}}


{{Section|1=Working with CEGUI|2=
* [[Tutorials]]: All tutorials to help you getting started with CEGUI
* [[HOW-TO_series|HOW-TO Series]]: How to deal with a specific feature of CEGUI
* [[Articles]]: Some more advanced material on using CEGUI
* [[CodeSnippets]]: chunk of code collection
}}


{{Section|1=CEGUI for Content Creators|2=
* [[Assembling a Toolset|Tools]]: Gather the tools that can help you with the creation of your GUI
* [["Falagard" Skinning System Documentation]]: All you ever wanted to know on falagard skinning system (and more)
* [[XML File formats]]: Description of all XML file format used in CEGUI
* [[External resources]]: Find some material for your gui
* [http://skins.cegui.org.uk Skins]: Find some existing skins
}}


{{Section|1=Community Projects|2=
* [[Projects Using CEGUI]]: Games and other software using CEGUI
* [[User Contributed Material]]: You have a lot of talents lets share it here
* [[CEGUI Addons]]: All addons available in the CVS repository at SF
}}


{{Section|1=Official References|2=
* [[Manual TOC|Manual]]: Official CEGUI Manual (We are going to create it after 0.5 release)
* [http://www.cegui.org.uk/wiki/index.php/The_%22official%22_layout_editor CELayoutEditor documentation]: Installation instructions and manual for the layout editor
* [http://www.cegui.org.uk/api_reference API Reference]: Online doxygen manual for the lastest stable release (0.4.1)
* [http://dalfy.dyndns.org/~ode/cegui/RC2/cegui_api_reference CEGUI 0.5.0-RC2]: Online doxygen manual for CEGUI 0.5 second release candidate (0.5.0-RC2)
* [http://dalfy.dyndns.org/~ode/cegui/RC2/silly_api_reference SILLY 0.1.0-RC2]: Online doxygen manual for SILLY 0.1 second release candidate (0.1.0-RC2)
* []: Falagard skining documentation
}}


| valign="top" width="25%" |

{{CEGUINews}}

{{Section|1=Project|2=
CEGUI Release, roadmap and porting notes
* 0.4 (stable) CEGUI MK2-0.4.1 [[Downloads 0.4.1 | downloads]]
* 0.5 (devel) CEGUI MK2-0.5.0 RC2 [[Downloads 0.5.0-RC2 | downloads]], [[Porting to the 0.5.0 Release|release notes]]
}}

{{CurrentCEGUI}}
|}
{{CEGUIWikiWhatsNew}}

Downloads 0.5.0-RC2

2006-08-13T17:04:19Z

Dalfy:

{{CEGUIDownloadsRC|cegui=0.5.0-RC2|editor=0.5.0-RC2|silly=0.1.0-RC2|dependency=0.5.0-RC2}}

Changes and Porting Tips for 0.5.0

2006-08-13T17:00:44Z

Dalfy: /* ChangeLog */

Note that this is incomplete, work in progress, documentation.

=Release=

* 0.5.0 RC1 Released on June the 20th 2006: [[Downloads 0.5.0-RC1|goto download page]]
* 0.5.0 RC1 Released on August the 13th 2006: [[Downloads 0.5.0-RC2|goto download page]]

=ChangeLog=
<pre>
== Release 0.5.0-RC2 ==
Added: single colour support to PropertyHelper::stringToColourRect
Added: missing support to Irrlicht renderer for creating a texture with a given size.
Added: Updates to renderers for D3D8.1 and D3D9 to report correct values for 'original' size and actual texture size. (Related to Mantis ticket #45).
Added: Support for using user defined image codec by name (using dso) or directly throught a pointer to an existing image codec.
Added: Long property export (allows for properties containing multiple lines).
Added: Helper methods to Window to return EventSet::Iterator and PropertySet::Iterator objects.
Added: Reworked TabControl by zap. Mantis #82.
Added: TabControlDemo sample. Mantis #82.
Added: Danish language in the FontDemo sample.
Added: Output of summary of configure results (for configure based builds)
Added: Texture extra size information to CEGUI::Texture in order to be able to handle scaled/stretched textures within Imageset.
Added: Texture Scaling support in IrrlichRenderer

Removed: Empty source file CEGUIVector.cpp
Removed: TabPane files.

Modified: Behaviour of Editbox so that EventCharacterKey events are only marked as handled if the key press actually resulted in a change to the Editbox text string. (Related to Mantis #59)
Modified: Replaced all getWindow<something> with get<something>
Modified: Replaced all setWindow<something> with set<something>
Modified: EventSet::EventIterator now known as EventSet::Iterator
Modified: PropertySet::PropertyIterator now known as PropertySet::Iterator
Modified: ImageCodec modules are now DynamicModule
Modified: Falagard PropertyDim now supports a type attribute for UDim properties. Mantis #82.
Modified: Improved TabControl imagery. Mantis #82.
Modified: autotools makefiles now symlink the sample binaries (to avoid having to do 'make install'). Mantis #82.
Modified: PropertyHelper now uses snprintf instead of std::ostringstream again. Mantis #82.
Modified: Removed static Makefile for tolua++cegui generator tool and switched to autotools style build, with enable/disable configure option, for tolua++cegui generator tool
Modified: Moved tolua++ into it's own dir, removed lua_and_tolua++
Modified: Externalised our use of the Lua library
Modified: premake updates
Modified: Updated AUTHORS file.
Modified: Remove exec file attribute on Falagard.xsd
Modified: XMLRefSchema/Font.xsd for font rewrite
Modified: LuaScriptModule public headers no longer need include lua.h included.
Modified: Made a bunch of warnings go away in MSVC in the new font code.
Modified: Deleted the remaining old msvc project files.

Bug Fix: Clean the XMLSerialization code: remove empty autowindow
Bug Fix: Added missing glDisable(GL_FOG); in gl renderer
Bug Fix: Irrlicht and D3D8.1 renderer modules would keep live pointers to Texture objects that failed to fully initialise (file or size errors for example) Mantis #43.
Bug Fix: Disable texture stages we do not use in Direct3D renderers. (Mantis #95)
Bug Fix: Mouse cursor z value. Mantis #49
Bug Fix: Imagset XML attribute for image file name is 'Imagefile' and not 'Filename'.
Bug Fix: normal attributes use 'true', only properties sometimes use 'True'.
Bug Fix: Global default resource group was not being used by DefaultResourceProvider.
Bug Fix: XML output from CEGUI::Image class.
Bug Fix: Imageset scaling issue when renderer automatically scales the image #45 (this is currently a partial fix)
Bug Fix: IrrlichtRenderer - Mouse event error. Mantis #98.
Bug Fix: IrrlichtRenderer - size error in addQuad. Mantis #99.
Bug Fix: IrrlichtRenderer - Sample driver had linker lib name wrong for renderer module. Mantis #100.
Bug Fix: TinyXMLParser bug. Mantis Tracker #57
Bug Fix: a bug in the openglrenderer cleanup related to image codec.
Bug Fix: Install renderer module includes at the same place as in Win32 (linux / mac autotools)
Bug Fix: OpenGL sample driver did not inject middle mouse up (injected it as down). Mantis #82.
Bug Fix: Corrected some mistakes in the Falagard Lua bindings
Bug Fix: Apparently in some cases OpenGLRenderer needs NOMINMAX in Win32 (Mantis #63)
Bug Fix: FreeTypeFont did not free the font data properly, also fixes a potential infinite loop in FreeTypeFont (Mantis #60)
Bug Fix: FairChar font texture was not power of 2 (Mantis #64)
Bug Fix: SliderThumb incorrectly mapped in some schemes (mantis #88)
Bug Fix: Updated Irrlicht renderer to work with 0.5.0 codebase.
Bug Fix: some missing data
Bug Fix: DirectX 8.1 sample driver
Bug Fix: some missing files in the make dist command (Mantis #89)
Bug Fix: Change the name of an enumeration value in schema Font.xsd.
Bug Fix: Memory leak in Font.
Bug Fix: Lua bindings was missing ImagesetManager::createImagesetFromImageFile + some missing tolua_throws modifiers
== Release 0.5.0-RC1 ==
Various internal code cleanups:
- Removal of unrequired utf8* casts on string literals.
- Removed use of NULL macro from the library code.
- Code refactorings to Font class. Removes some instances of repeated code, and makes
some methods shorter / cleaner.
- Split large methods in Scheme into smaller, more managable, chunks.
- Removed all the System constructor overloads and replaced with a single method.
- Removed string literals for component widget names which were scattered throughout t
he widget code.
- Replaced virtually all member fields holding pointers to component widgets with gett
er methods (which basically allows those widgets to be replaced without the parent kno
wing or caring).
- Refactoring of XML handler to remove huge if/else if/else construct.
- Refectored large if / else if / else constructs in all non-falagard XML handlers to
use a member function for each element type (rather than having all code in one huge f
unction).
- Event system has been rewritten from scratch.
- Font system has been rewritten.

Added "PushedOff" rendering state for button based widgets and MenuItem.
Added: Ability to rename windows.
Added: CEGUISamplesConfig.h file to allow configuration of samples framework independe
ntly of the main config (saves recompiling everything just to change some sample setti
ng).
Added: FPS readout to OpenGL base app in the samples framework.
Added: "PropertyLinkDefinition" element for Falagard system.
Added: "controlPropery" attribute to SectionSpecififations under falagard to enable re
nering of section imagery to be controled via a named boolean property.
Added: mouse pass through feature in Window, to ignore mouse events. Nice for making a
DefaultWindow transparent to the mouse regarding picking windows behind it.
Added: MSVC++ auto-linking for Ogre base app in samples framework.
Added: grab/restoreTextures in the OpenGL renderer to cache texture image data, and la
ter restore it.
Added: Abstracted Logger interface to support user created custom loggers. (SF patch #
1414121 by zap)
Added: DefaultLogger implementation (SF patch #1414121 by zap)
Added: page up/down key functionality to MultiLineEditbox (SF patch #1347376 by Dalfy)
Added: small script to recreate the binding generator for tolua++
Added: customized tolua++ binary. For exception handling support in generated binding
code.
Added: missing exception definitions file needed to generate the bindings.
Added: README with instructions on how to generate the bindings.
Added: Documentation for some of the new features in the bundled tolua++ generator.
Added: When subscribing to events from "inside" Lua a self object can be registered as
well to be passed along with the EventArgs.
Added: New WindowRenderer system, replacing previous system where the Window sub-class
controlled the rendering process.
Added: Major update of the LuaScriptModule to support anonymous functions.
Added: Exception handling has been added for some functions.
Added: Falagard derivatives of DefaultWindow, DragContainer and ItemEntry with minimal
StateImagery.
Added: executeEventHandler now accepts functions that are table fields.
Added: Text node support to both parser (Xerces and TinyXML)
Added: AutoWindow tag to xml layouts to fetch a window created by the look'n'feel or t
he base widget itself.
Added: Window::isAutoWindow member that returns true if the window has "__auto_" in it
s name. (a flag is set in the constructor). It's faster than checking the actual strin
g.
Added: A setting to Window to specify that it should never write XML no matter what if
activated. Tooltips get this set by default by System.
Added: A property ban list to provide a system for mapping which properties should (no
t) be written to XML. In the respective addProperties member functions checks have bee
n added and some properties are banned if we are an auto window.
Added: Default resource group support to Xerces for use when loading schema files.
Added: Default resource group support to ScriptingModule, and implemented it's use in
the CEGUILua module.
Added: DynamicModule class to wrap access to a dynamically linked / loaded module.
Added: New dynamic libraries for Xerces, Expat TinyXMLParser, and libxml Parsers.
Added: TextProperty and FontProperty elements for Falagard text components.
Added: New ItemListBase based ItemListbox widget. For Window based listbox items.
Added: XML Serialization class for all XML writing.
Added: Recursive versions of Window::getChild and isChild by ID. They are called getCh
ildRecursive and isChildRecursive. Reason for the explicit naming is that it's a prett
y expensive operation and should not be used unless necessary.
Added: Lots of missing members in the Lua bindings.
Added: setlocale(LC_NUMERIC, "C"); to the System constructor as we depend on this beha
viour.
Added: setVisible member to CEGUI::MouseCursor.
Added: bat files to make it easier for Windows users to regenerate the Lua bindings an
d tolua++cegui.
Added: ImageCodec support to the OpenGL renderer. This allows users to easily write a
custom image loader. TGA, SILLY, DevIL, Corona and FreeImage codecs are supplied.
Added: const version of getDataPtr in RawDataContainer.
Added: premake scripts to generate MSVC solutions.
Added: ClippedContainer for situations where more specialized clipping is required.

Modified: Placed the integrated TinyXML into its own namespace (CEGUITinyXML) to preve
nt clashes in projects using another copy of TinyXML. (Patch #1294002).
Modified: Changed EventSet to operate without needing events to be pre-added, much lik
e GlabalEventSet always did.
Modified: Removal of mass pre-specification of events for all classes using events.
Modified: Cflags to add include dir for CEGUI in CEGUI.pc.in (allows use of <CEGUI/...
> form of include statement).
Modified: The "Lua and tolua++" module has been made a DLL on Windows machines.
Modified: Renamed System::setTooltip to System::setDefaultTooltip (Mantis #1Cool.
Modified: In the lua module, updated Window with casting helpers as member functions.
eg. w:toFrameWindow()
Modified: Removed the Static,StaticText and StaticImage from CEGUIBase and implemented
them in FalagardBase instead.
Modified: Updated to tolua++ 1.0.92
Modified: Moved LuaFunctor into its own files
Modified: Reimplemented the "late binding" effect from the v04 Lua module. In v04 the
function is always looked up by name. In CVS HEAD the actual Lua function is reference
d, but now this will only occur the first time the event is triggered. This means that
it's no longer necessary to have a function defined to subscribe it to an event. As l
ong as the function has been created before the event occurs everything will be good S
mile
Modified: Moved subscribeScriptedEvent into ScriptModule to allow more customized scri
pt subscription functionality.
Modified: Made the layout XML handler use subscribeScriptedEvent for Event tags instea
d of subscribeEvent with ScriptFunctor
Modified: Removal of "tolua_outside" stuff that was no longer needed.
Modified: Moved the declaration/definition of base window factories into its own files
.
Modified: Removal of WidgetSets folder, and it's contents.
Modified: Removed unnecessary getSingleton and getSingletonPtr from manager classes.
Modified: The script module now throws ScriptException.
Modified: Removal of TextItem as falagard now handles that exclusively.
Modified: Moved all rendering member functions out of base classes an into Falagard re
ndering classes.
Modified: Removal of virtually all rendering and layout related Window properties from
CEGUIBase - a few are moved to FalagardBase, the rest must be implemented via XML.
Modified: Removal of TaharezLook and WindowsLook modules from the system.
Modified: Removal of MetricsMode system, and all non-unified interface and properties
from Window (and related fixes to other classes).
Modified: Elimination of RenderableElement and derived classes.
Modified: Moved to a C preprocessor macro system for widget module creation.
Modified: Removal of abstract createXXX methods from widget base classes - the looknfe
el system now auto-creates these widgets when specified within the XML.
Modified: Updated to TinyXML 2.4.3 in order to allow CDATA section in XML text node (v
erbatim text)
Modified: GUILayout handler in order to support long value in properties.
Modified: Made the XML writing system aware of falagard when determining property defa
ult values.
Modified: Switched PropertyHelper to use std::ostringstream as the output is much nice
r. Changed property default values to the new format where needed.
Modified: Better error reporting for dynamic module load failures.
Modified: Switched to using external pcre library. Removed embedded copy of pcre.
Modified: Switched system to use dynamic libs for XML parsers with programatically con
figurable default.
Modified: FactoryModule to use DynamicModule.
Modified: Resolved issue with unneeded member qualification (Patch #1454773).
Modified: Made String::ptr a public member.
Modified: The bundled tolua++cegui binding generator will now generate a lua_CEGUI.cpp
that compiles out-of-the-box on Windows
Modified: Removed the DataContainer template class, and made it into just RawDataConta
iner, non templated.
Modified: Optimized FalagardMultiLineEditbox to only cache visible lines when renderin
g.
Modified: Optimized ButtonBase and MenuItem updateInternalState. Mantis #44
Modified: Moved the renderers to their own folder named RendererModules.
Modified: Optimized picking and rendering by caching screen space rectangles.
Modified: Applied zap's rewrite of the Font system. Patch #1508321
Modified: Texture::loadFromMemory now takes a Texture::PixelFormat parameter. RGB and
RGBA are currently required. Fixes Patch #1455523 as well. 3rd party renderer modules
needs to be updated.

Bug fix: OpenGLRenderer was producing errors and not cleaning up state changes properl
y (thanx muhkuh25)
Bug fix: OpenGLRenderer was broken when compiled for x86-64.
Bug Fix: ListboxItem::getOwnerWindow should be const
Bug Fix: ListboxItem::getOwnerWindow should not take a Window* argument.
Bug Fix: Scheme::resourcesLoaded was always returning true.
Bug Fix: PropertyHelper::stringToImage was not handling empty string case.
Bug Fix: Editbox::onCharacter was setting the event as handled even if nothing was don
e.
Bug Fix: Added shift/ctrl/alt support to the OpenGL sample driver (injects LeftXXX)
Bug Fix: The command line renderer selector does no longer ask if there is only one re
nderer available.
Bug Fix: Fixed window resizing for the OpenGL Sample driver.
Bug Fix: fixed const correctness for "String::utf8_stream_len" SF patch #1367423
Bug Fix: Detect "window->addChildWindow(window);" and do nothing instead of actually t
rying.
Bug Fix: Added missing performChildWindowLayout to Scrollbar::onScrollConfigChanged to
allow making a look'n'feel with a thumb that sizes to indicate document size.
Bug fix: const correctness for Window::getLookNFeel
Bug fix: FrameWindow, isTitlebarEnabled and isCloseButtonEnabled were return the oppos
ite of what they should.
Bug Fix: FrameWindow should do relayout if text changes to allow using a fontdim in th
e titlebar dimensions.
Bug Fix: Changing the default mouse cursor in the System object will now update the cu
rsor immediately where appropriate. (Ticket #17).
Bug Fix: Fixed case in StaticText where default text area was always used if frame was
disabled.
Bug Fix: Image offsets were'nt being properly handled for the corners in FrameComponen
t.
Bug Fix: MultiColumnList would always use item string when sorting, instead of vitual
operators on users custom items.
Bug Fix: System::getWindowContainingMouse would return incorrect Window if called from
within Window::EventMouseLeaves handlers.
Bug Fix: Order of static data creation in C++ is unspecified; we can't have globally d
efined static data that relies on other such static data within the same module.
Bug Fix: Falagard/ProgressBar was broken when vertical or reversed-horizontal.
Bug Fix: Corruption of window registry when rename failed (Patch #1450623).
Bug Fix: Initialisation issue with TabControl trying to access child widgets before th
ey are created. (Patch #1391727).
Buf Fix: CEGUI::Window::setModalState(true) removes the modal state from a modal windo
w. Mantis #42
Bug Fix: MultiColumnList getNextSelection bug. Mantis #47
Bug Fix: System subscriber to renderer event but does not unsubscribe on destruction.
Mantis #48
Bug Fix: OpenGL and DirectX9 renderers were not handling error correctly when creating
textures.
Bug Fix: Bug in LuaScriptModule where executeScriptFile did not unload the file data b
uffer correctly in case of an exception (thanks gcarlton).
Bug Fix: A bug in ItemListBase::resetList_impl where calling resetList would crash (th
anks Turtle).
Bug Fix: Typo in TabPane::testClassName_impl ("Tabpane" instead of "TabPane").
Bug Fix: Big Endian inconsistency in CEGUI::colour.
Bug Fix: CEGUI::Window was not detaching the tooltip during destruction. Mantis #38
Bug Fix: FrameWindow was consuming all LeftButton up events. Down events were affected
as well, and now only consume if the event started drag sizing.
Bug Fix: DragContainer would overwrite any new position applied to the DragContainer d
uring the DragDropItemDropped event. Mantis #53
Bug Fix: The OpenGL sample driver could cause a stack overflow. Patch #1507826
</pre>

=Porting Notes=

==Introduction==
The 0.5.0 release of Crazy Eddie's GUI System is the first of what will likely be a series of releases containing breaking changes for client code and data files. We feel these breaking changes are required as we move closer to the 1.0 release of CEGUI, and also as the design and usage patterns for CEGUI change; the results are a generally more streamlined system as we move from one idiom to another, as opposed to becoming more and more bloated due to retaining vast amounts of code and kludges for backward compatibility reasons.

This document is a general overview and guide to the breaking changes between the 0.4.x series of releases and the 0.5.0 release. As and when other breaking releases are made, additional documentation will be provided as necessary.

==CELayoutUpgrader==

[[CELayoutUpgrader]] is a python script that can upgrade XML layout files to the Unified Coordinate System. It should help to ease the porting process.

==Changes and Porting==
This section is intended as a general overview of the breaking changes made. Blah, blah, blah.

===Code Changes===
This sub-section details changes made to the CEGUI system code and API which will affect client code.

====The new WindowRenderer system====
One of the main issues with the previous widget module approach, was that it became exceptionally difficult to sub-class a widget type where some custom behavioural changes or additions were required.
*** TODO ***

====CEGUI::System Constructor====
The overloaded constructors for the main CEGUI::System object have been removed and replaced with a single, unified, constructor. Using the new constructor it is still possible to do all the things that used to be possible, while making the whole system construction process a little more uniform.

The new constructor has the form:
System(Renderer* renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");

As can be seen, the Renderer module is, of course, still mandatory, though you are free to provide all or none of the other optional arguments and passing in 0 where no object, or no custom object, is required.

For the most basic uses of the system, where only the Renderer is passed in, no changes will be required.

====System::setTooltip changed to System::setDefaultTooltip====
The member function
System::setTooltip
has been renamed as
System::setDefaultTooltip
this was a change for API consistency. Update your code to use the new name for this member.

====Window MetricsMode removed====
The concept of a singular 'MetricsMode' for a window is now obsolete and is replaced with the 'Unified' metrics system (which comprises of both a relative 'scale' value and an absolute 'offset' value).

The class members, properties and all associated items affecting MetricsMode have been removed from the system and the use of the Unified metrics system is now mandatory.

====Window Metrics and other conversion members removed====
Member functions in the Window class that were concerned with converting values between the various metric modes have all been removed.
There may still be the need to perform some conversions of co-ordinates, so this functionality is now provided by the external utility class CEGUI::CoordConverter.
Window Size and Positioning

Due to the removal of the MetricsMode concept, and the now mandatory use of 'Unified' co-ordinate values, the means by which you specify size and position is now by using the unified co-ordinate types: UDim, UVector2 and URect.

{| cellpadding=2px cellspacing=0
| style="color: #ffffff; background-color: #ff5555; border: solid 1px #000000;" | '''The information in the following section has been updated again since RC1 was issued - early adopters will need to update their code again to use SVN trunk code and the upcoming RC2.'''
|}

*getXPosition, getWindowXPosition, getRelativeXPosition and getAbsoluteXPosition members are replaced with a single getXPosition member returning a UDim.
*getYPosition, getWindowYPosition, getRelativeYPosition and getAbsoluteYPosition members are replaced with a single getYPosition member returning a UDim.
*getPosition, getWindowPosition, getRelativePosition and getAbsolutePosition members are replaced with a single getPosition member returning a UVector2.
*getWidth, getWindowWidth, getRelativeWidth and getAbsoluteWidth members are replaced with a single getWidth member returning a Udim.
*getHeight, getWindowHeight, getRelativeHeight and getAbsoluteHeight members are replaced with a single getHeight member returning a UDim.
*getSize, getWindowSize, getRelativeSize and getAbsoluteSize members are replaced with a single getSize member returning a UVector2
*getRect, getWindowArea, getRelativeRect and getAbsoluteRect members are replaced with a single getArea member returning a URect.
*getMaximumSize and getWindowMaxSize members are replaced with a single getMaxSize member returning a UVector2.
*getMinimumSize and getWindowMinSize members are replaced with a single getMinSize member returnung a UVector2.

*setWidth and setWindowWidth members are replaced with a single setWidth member taking a UDim.
*setHeight and setWindowHeight members are replaced with a single setHeight member taking a UDim.
*setSize and setWindowSize members are replaced with a single setSize member taking a UVector2.
*setXPosition and setWindowXPosition members are replaced with a single setXPosition member taking a UDim.
*setYPosition and setWindowYPosition members are replaced with a single setYPosition member taking a UDim.
*setPosition and setWindowPosition members are replaced with a single setPosition member taking a UVector2.
*setAreaRect, setRect and setWindowArea members are replaced with setArea members accepting the following options:
**Four UDims; specifying x position, y position, width and height.
**Two UVector2s; specifying position and size.
**A single URect defining the area.
*setMaximumSize and setWindowMaxSize members are replaced with a single setMaxSize member taking a UVector2.
*setMinimumSize and setWindowMinSize members are replaced with a single setMinSize member taking a UVector2.

====Component Widget creation abstract members====
If you have sub-classed any Window types in order to create a new “Widget Module”, part of your responsibility was to provide implementations for various abstract member functions whose job it was to create the various component widgets required by the container window. These members were typically named createXXX (for example, Combobox::createEditbox).

These abstract member functions and the internal calls to them have all been removed from the system. The component widgets are now specified within the looknfeel xml files are are automatically created by the Falagard looknfeel system as and when required.
You should remove any code that creates these component widgets and add appropriate <Child> tags to your looknfeel xml files instead.

====Component Widget member fields====
If you had sub-classed any of the Window types, either to provide some modified behaviour or perhaps for a “Widget Module” as part of creating a custom look, you would previously have had access to some member variables that held pointers to component widgets of the more complicated widget types (for example, the Scrollbar widget would have held pointers to the two PushButton widgets and the Thumb widget that it was composed of). These members have now been removed and replaced with 'getter' member functions; this is important because in the future the actual Window objects used for these component parts may not be valid for the entire life of the containing Window. That is, the component Windows may get destroyed and re-created, thus invalidating any cached pointers.

The old member variables and the getter function that replaces them are listed here:
*** TODO ***

====RenderableElement, RenderableImage and RenderableFrame classes====
These classes have all been removed from the system entirely. Everything that these classes achieved with regards to rendering for window and widget types can now be done via the Falagard looknfeel system.

For window based rendering, you should remove your use of Renderable* classes in favour of ImageryComponent and FrameComponent elements in your looknfeel xml files.
If you were using the Renderable* classes to perform rendering outside of the window rendering systems, you will now need to find alternative, custom, means to do this.

====Static, StaticImage and StaticText classes====
These classes are now removed from the base system and have been implemented as WindowRenderer classes. Generally, your interface to these widget types should now use a simple default window and the properties system.

The look'n'feel spec for these two widgets have changed as well.

StaticImage:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
- WithFrameImage - image rendering when frame is enabled
- NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present)
</pre>

StaticText:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Named Areas (missing areas will default to 'WithFrameTextRenderArea'):
WithFrameTextRenderArea
WithFrameTextRenderAreaHScroll
WithFrameTextRenderAreaVScroll
WithFrameTextRenderAreaHVScroll
NoFrameTextRenderArea
NoFrameTextRenderAreaHScroll
NoFrameTextRenderAreaVScroll
NoFrameTextRenderAreaHVScroll

</pre>

====Dynamic addition of Events to Windows and other EventSet based objects====
It used to be that all available Event objects would be pre-added to an EventSet when it was constructed. When an Event was accessed which had not been added to the EventSet an appropriate exception was thrown.

This behaviour has now changed. Events are only added to an EventSet when a handler for that event is first subscribed. A side effect of this is that EventSet does now not throw exceptions, either when firing a non-existing Event (now reclassified as simply an event which has no subscribers), or when subscribing to an Event that does not yet exist, since the Event is now automatically created and added to the EventSet.

If your code currently relies on exceptions being thrown by the events system, you will need to change this to a more pro-active approach (by manually checking if an event exists yet), instead of reactive (catching exceptions).

====TinyXML moved to CEGUITinyXML namespace====
If you were for some reason using our integrated copy of TinyXML directly in your application, we have moved this module into the namespace 'CEGUITinyXML'. This was done to avoid clashes and conflicts where the client contained it's own copy of TinyXML.

To continue to directly use the integrated TinyXML, just add the namespace qualifier where appropriate.

If you are just using the TinyXML based implementation of CEGUI::XMLParser, you do not need to change anything.

===Data File Changes===
This sub-section details changes that will affect the xml data files used with CEGUI.

====Updated XSD files for Xerces====
Even the most rudimentary changes to the xml formats we use mean that if you're using the Xerces-C, or other, validating XML parser, then you will need to update you projects to use the new .xsd files. These are collected together for convenience in the XMLRefSchema subdirectory.

=== Falagard Additions ===
From lack of a better place to put this I'll list the additions that have been made to Falagard here.

'''PropertyLinkDefinition'''
New element that will create a property that is a link to another property of a child window.

Attributes:
* type (type, optional and not currently used for anything)
* name (name of the property link)
* widget (name suffix of the child widget to link to)
* targetProperty (the target property to link to. Optional, will default to ''name'' if not given)
* initialValue (starting value for the property. Optional, will default to empty)
* layoutOnWrite (will make the widget redo the child layout when the property is written. Optional, defaults to ''false'')
* redrawOnWrite (will make the widget redraw when the property is written. Optional, default to ''false'')

'''controlProperty'''

New attribute added to ''Section''. Value is the name of a property, and if specified the Section will only render when the property has a value of ''True''.

'''TextComponent'''

Two new sub-elements are now valid for ''TextComponent''.

''TextProperty'', and ''FontProperty''. Must be specified in that order after the (optional) ''Text'' element.
Both have one required attribute ''name'' which takes the name of a property which will contain the text to draw, or the name of the font to use for rendering.

In case these new elements are used along with the ''Text'' element, the string and font specified in the ''Text'' element will be used as defaults if the ''TextProperty'' or ''FontProperty'' evaluates to empty strings.

=== Font system changes ===

* There's no notion of '''StartCodepoint''' and '''EndCodepoint''', or '''glyph set''' anymore. Font render glyphs on the fly as required: if you ask to display "A" it renders a small subset of glyphs (256 codepoints surrounding the missing glyph usually, but can render extra glyphs out of the range to conserve texture space).
* The Font class is now an abstract class and there are two implementations: FreeTypeFont and PixmapFont.
** FreeTypeFont uses the FreeType library and can display TTF, FON, PCF/BDF, PS fonts (and possibly others). I have ensured that bitmap fonts work, since bitmap fonts should be handled a little different from outline fonts.
** PixmapFont uses an Imageset with the glyphs and can display colorful glyphs (which FreeType cannot due to it's grayscale nature). However, it's more primitive, but can be useful for things like logos, loading messages etc.
* The Font class is now a PropertySet, so specialized classes derived from Font can add their own properties (such as PointSize for FreeType fonts which don't have sense for Imageset-based fonts). Here's a list of available properties:
** All font classes: Name, FileName, NativeRes, ResourceGroup, AutoScaled
** FreeTypeFont: PointSize, Antialiased
** PixmapFont: Imageset, Mapping
* Fixed a number of (vertical) font positioning errors: the font wasn't properly centered within it's LineAdvance range.
* Added several new fonts: DejaVuSans (taken from the DejaVu project, http://dejavu.sf.net), fkp (a X11 bitmap font from http://artwizaleczapka.sf.net), FairChar (a Imageset-based font which I made from some old GIF file I found on my HD :-).
* A FontDemo sample which shows several properties of the new Font class.

The above changes resulted in some slight changes to the format of the XML .font files:

* GlyphSet, GlyphRange, Glyph sections of the Font are gone
* The possible values of the Type attribute are now:
** FreeType (instead of Dynamic)
** Pixmap (instead of Static)
* The FirstCodepoint and LastCodepoint attributes of the Font section were removed

After you change your .font files as mentioned above, they should work without problems.

=== Iterator Changes ===
* EventSet::EventIterator is changed to EventSet::Iterator
* PropertySet::PropertyIterator is changed to PropertySet::Iterator

To be continued...

Changes and Porting Tips for 0.5.0

2006-08-13T16:55:52Z

Dalfy: /* Release */

Note that this is incomplete, work in progress, documentation.

=Release=

* 0.5.0 RC1 Released on June the 20th 2006: [[Downloads 0.5.0-RC1|goto download page]]
* 0.5.0 RC1 Released on August the 13th 2006: [[Downloads 0.5.0-RC2|goto download page]]

=ChangeLog=
<pre>
Various internal code cleanups:
- Removal of unrequired utf8* casts on string literals.
- Removed use of NULL macro from the library code.
- Code refactorings to Font class. Removes some instances of repeated code, and makes
some methods shorter / cleaner.
- Split large methods in Scheme into smaller, more managable, chunks.
- Removed all the System constructor overloads and replaced with a single method.
- Removed string literals for component widget names which were scattered throughout t
he widget code.
- Replaced virtually all member fields holding pointers to component widgets with gett
er methods (which basically allows those widgets to be replaced without the parent kno
wing or caring).
- Refactoring of XML handler to remove huge if/else if/else construct.
- Refectored large if / else if / else constructs in all non-falagard XML handlers to
use a member function for each element type (rather than having all code in one huge f
unction).
- Event system has been rewritten from scratch.
- Font system has been rewritten.

Added "PushedOff" rendering state for button based widgets and MenuItem.
Added: Ability to rename windows.
Added: CEGUISamplesConfig.h file to allow configuration of samples framework independe
ntly of the main config (saves recompiling everything just to change some sample setti
ng).
Added: FPS readout to OpenGL base app in the samples framework.
Added: "PropertyLinkDefinition" element for Falagard system.
Added: "controlPropery" attribute to SectionSpecififations under falagard to enable re
nering of section imagery to be controled via a named boolean property.
Added: mouse pass through feature in Window, to ignore mouse events. Nice for making a
DefaultWindow transparent to the mouse regarding picking windows behind it.
Added: MSVC++ auto-linking for Ogre base app in samples framework.
Added: grab/restoreTextures in the OpenGL renderer to cache texture image data, and la
ter restore it.
Added: Abstracted Logger interface to support user created custom loggers. (SF patch #
1414121 by zap)
Added: DefaultLogger implementation (SF patch #1414121 by zap)
Added: page up/down key functionality to MultiLineEditbox (SF patch #1347376 by Dalfy)
Added: small script to recreate the binding generator for tolua++
Added: customized tolua++ binary. For exception handling support in generated binding
code.
Added: missing exception definitions file needed to generate the bindings.
Added: README with instructions on how to generate the bindings.
Added: Documentation for some of the new features in the bundled tolua++ generator.
Added: When subscribing to events from "inside" Lua a self object can be registered as
well to be passed along with the EventArgs.
Added: New WindowRenderer system, replacing previous system where the Window sub-class
controlled the rendering process.
Added: Major update of the LuaScriptModule to support anonymous functions.
Added: Exception handling has been added for some functions.
Added: Falagard derivatives of DefaultWindow, DragContainer and ItemEntry with minimal
StateImagery.
Added: executeEventHandler now accepts functions that are table fields.
Added: Text node support to both parser (Xerces and TinyXML)
Added: AutoWindow tag to xml layouts to fetch a window created by the look'n'feel or t
he base widget itself.
Added: Window::isAutoWindow member that returns true if the window has "__auto_" in it
s name. (a flag is set in the constructor). It's faster than checking the actual strin
g.
Added: A setting to Window to specify that it should never write XML no matter what if
activated. Tooltips get this set by default by System.
Added: A property ban list to provide a system for mapping which properties should (no
t) be written to XML. In the respective addProperties member functions checks have bee
n added and some properties are banned if we are an auto window.
Added: Default resource group support to Xerces for use when loading schema files.
Added: Default resource group support to ScriptingModule, and implemented it's use in
the CEGUILua module.
Added: DynamicModule class to wrap access to a dynamically linked / loaded module.
Added: New dynamic libraries for Xerces, Expat TinyXMLParser, and libxml Parsers.
Added: TextProperty and FontProperty elements for Falagard text components.
Added: New ItemListBase based ItemListbox widget. For Window based listbox items.
Added: XML Serialization class for all XML writing.
Added: Recursive versions of Window::getChild and isChild by ID. They are called getCh
ildRecursive and isChildRecursive. Reason for the explicit naming is that it's a prett
y expensive operation and should not be used unless necessary.
Added: Lots of missing members in the Lua bindings.
Added: setlocale(LC_NUMERIC, "C"); to the System constructor as we depend on this beha
viour.
Added: setVisible member to CEGUI::MouseCursor.
Added: bat files to make it easier for Windows users to regenerate the Lua bindings an
d tolua++cegui.
Added: ImageCodec support to the OpenGL renderer. This allows users to easily write a
custom image loader. TGA, SILLY, DevIL, Corona and FreeImage codecs are supplied.
Added: const version of getDataPtr in RawDataContainer.
Added: premake scripts to generate MSVC solutions.
Added: ClippedContainer for situations where more specialized clipping is required.

Modified: Placed the integrated TinyXML into its own namespace (CEGUITinyXML) to preve
nt clashes in projects using another copy of TinyXML. (Patch #1294002).
Modified: Changed EventSet to operate without needing events to be pre-added, much lik
e GlabalEventSet always did.
Modified: Removal of mass pre-specification of events for all classes using events.
Modified: Cflags to add include dir for CEGUI in CEGUI.pc.in (allows use of <CEGUI/...
> form of include statement).
Modified: The "Lua and tolua++" module has been made a DLL on Windows machines.
Modified: Renamed System::setTooltip to System::setDefaultTooltip (Mantis #1Cool.
Modified: In the lua module, updated Window with casting helpers as member functions.
eg. w:toFrameWindow()
Modified: Removed the Static,StaticText and StaticImage from CEGUIBase and implemented
them in FalagardBase instead.
Modified: Updated to tolua++ 1.0.92
Modified: Moved LuaFunctor into its own files
Modified: Reimplemented the "late binding" effect from the v04 Lua module. In v04 the
function is always looked up by name. In CVS HEAD the actual Lua function is reference
d, but now this will only occur the first time the event is triggered. This means that
it's no longer necessary to have a function defined to subscribe it to an event. As l
ong as the function has been created before the event occurs everything will be good S
mile
Modified: Moved subscribeScriptedEvent into ScriptModule to allow more customized scri
pt subscription functionality.
Modified: Made the layout XML handler use subscribeScriptedEvent for Event tags instea
d of subscribeEvent with ScriptFunctor
Modified: Removal of "tolua_outside" stuff that was no longer needed.
Modified: Moved the declaration/definition of base window factories into its own files
.
Modified: Removal of WidgetSets folder, and it's contents.
Modified: Removed unnecessary getSingleton and getSingletonPtr from manager classes.
Modified: The script module now throws ScriptException.
Modified: Removal of TextItem as falagard now handles that exclusively.
Modified: Moved all rendering member functions out of base classes an into Falagard re
ndering classes.
Modified: Removal of virtually all rendering and layout related Window properties from
CEGUIBase - a few are moved to FalagardBase, the rest must be implemented via XML.
Modified: Removal of TaharezLook and WindowsLook modules from the system.
Modified: Removal of MetricsMode system, and all non-unified interface and properties
from Window (and related fixes to other classes).
Modified: Elimination of RenderableElement and derived classes.
Modified: Moved to a C preprocessor macro system for widget module creation.
Modified: Removal of abstract createXXX methods from widget base classes - the looknfe
el system now auto-creates these widgets when specified within the XML.
Modified: Updated to TinyXML 2.4.3 in order to allow CDATA section in XML text node (v
erbatim text)
Modified: GUILayout handler in order to support long value in properties.
Modified: Made the XML writing system aware of falagard when determining property defa
ult values.
Modified: Switched PropertyHelper to use std::ostringstream as the output is much nice
r. Changed property default values to the new format where needed.
Modified: Better error reporting for dynamic module load failures.
Modified: Switched to using external pcre library. Removed embedded copy of pcre.
Modified: Switched system to use dynamic libs for XML parsers with programatically con
figurable default.
Modified: FactoryModule to use DynamicModule.
Modified: Resolved issue with unneeded member qualification (Patch #1454773).
Modified: Made String::ptr a public member.
Modified: The bundled tolua++cegui binding generator will now generate a lua_CEGUI.cpp
that compiles out-of-the-box on Windows
Modified: Removed the DataContainer template class, and made it into just RawDataConta
iner, non templated.
Modified: Optimized FalagardMultiLineEditbox to only cache visible lines when renderin
g.
Modified: Optimized ButtonBase and MenuItem updateInternalState. Mantis #44
Modified: Moved the renderers to their own folder named RendererModules.
Modified: Optimized picking and rendering by caching screen space rectangles.
Modified: Applied zap's rewrite of the Font system. Patch #1508321
Modified: Texture::loadFromMemory now takes a Texture::PixelFormat parameter. RGB and
RGBA are currently required. Fixes Patch #1455523 as well. 3rd party renderer modules
needs to be updated.

Bug fix: OpenGLRenderer was producing errors and not cleaning up state changes properl
y (thanx muhkuh25)
Bug fix: OpenGLRenderer was broken when compiled for x86-64.
Bug Fix: ListboxItem::getOwnerWindow should be const
Bug Fix: ListboxItem::getOwnerWindow should not take a Window* argument.
Bug Fix: Scheme::resourcesLoaded was always returning true.
Bug Fix: PropertyHelper::stringToImage was not handling empty string case.
Bug Fix: Editbox::onCharacter was setting the event as handled even if nothing was don
e.
Bug Fix: Added shift/ctrl/alt support to the OpenGL sample driver (injects LeftXXX)
Bug Fix: The command line renderer selector does no longer ask if there is only one re
nderer available.
Bug Fix: Fixed window resizing for the OpenGL Sample driver.
Bug Fix: fixed const correctness for "String::utf8_stream_len" SF patch #1367423
Bug Fix: Detect "window->addChildWindow(window);" and do nothing instead of actually t
rying.
Bug Fix: Added missing performChildWindowLayout to Scrollbar::onScrollConfigChanged to
allow making a look'n'feel with a thumb that sizes to indicate document size.
Bug fix: const correctness for Window::getLookNFeel
Bug fix: FrameWindow, isTitlebarEnabled and isCloseButtonEnabled were return the oppos
ite of what they should.
Bug Fix: FrameWindow should do relayout if text changes to allow using a fontdim in th
e titlebar dimensions.
Bug Fix: Changing the default mouse cursor in the System object will now update the cu
rsor immediately where appropriate. (Ticket #17).
Bug Fix: Fixed case in StaticText where default text area was always used if frame was
disabled.
Bug Fix: Image offsets were'nt being properly handled for the corners in FrameComponen
t.
Bug Fix: MultiColumnList would always use item string when sorting, instead of vitual
operators on users custom items.
Bug Fix: System::getWindowContainingMouse would return incorrect Window if called from
within Window::EventMouseLeaves handlers.
Bug Fix: Order of static data creation in C++ is unspecified; we can't have globally d
efined static data that relies on other such static data within the same module.
Bug Fix: Falagard/ProgressBar was broken when vertical or reversed-horizontal.
Bug Fix: Corruption of window registry when rename failed (Patch #1450623).
Bug Fix: Initialisation issue with TabControl trying to access child widgets before th
ey are created. (Patch #1391727).
Buf Fix: CEGUI::Window::setModalState(true) removes the modal state from a modal windo
w. Mantis #42
Bug Fix: MultiColumnList getNextSelection bug. Mantis #47
Bug Fix: System subscriber to renderer event but does not unsubscribe on destruction.
Mantis #48
Bug Fix: OpenGL and DirectX9 renderers were not handling error correctly when creating
textures.
Bug Fix: Bug in LuaScriptModule where executeScriptFile did not unload the file data b
uffer correctly in case of an exception (thanks gcarlton).
Bug Fix: A bug in ItemListBase::resetList_impl where calling resetList would crash (th
anks Turtle).
Bug Fix: Typo in TabPane::testClassName_impl ("Tabpane" instead of "TabPane").
Bug Fix: Big Endian inconsistency in CEGUI::colour.
Bug Fix: CEGUI::Window was not detaching the tooltip during destruction. Mantis #38
Bug Fix: FrameWindow was consuming all LeftButton up events. Down events were affected
as well, and now only consume if the event started drag sizing.
Bug Fix: DragContainer would overwrite any new position applied to the DragContainer d
uring the DragDropItemDropped event. Mantis #53
Bug Fix: The OpenGL sample driver could cause a stack overflow. Patch #1507826
</pre>

=Porting Notes=

==Introduction==
The 0.5.0 release of Crazy Eddie's GUI System is the first of what will likely be a series of releases containing breaking changes for client code and data files. We feel these breaking changes are required as we move closer to the 1.0 release of CEGUI, and also as the design and usage patterns for CEGUI change; the results are a generally more streamlined system as we move from one idiom to another, as opposed to becoming more and more bloated due to retaining vast amounts of code and kludges for backward compatibility reasons.

This document is a general overview and guide to the breaking changes between the 0.4.x series of releases and the 0.5.0 release. As and when other breaking releases are made, additional documentation will be provided as necessary.

==CELayoutUpgrader==

[[CELayoutUpgrader]] is a python script that can upgrade XML layout files to the Unified Coordinate System. It should help to ease the porting process.

==Changes and Porting==
This section is intended as a general overview of the breaking changes made. Blah, blah, blah.

===Code Changes===
This sub-section details changes made to the CEGUI system code and API which will affect client code.

====The new WindowRenderer system====
One of the main issues with the previous widget module approach, was that it became exceptionally difficult to sub-class a widget type where some custom behavioural changes or additions were required.
*** TODO ***

====CEGUI::System Constructor====
The overloaded constructors for the main CEGUI::System object have been removed and replaced with a single, unified, constructor. Using the new constructor it is still possible to do all the things that used to be possible, while making the whole system construction process a little more uniform.

The new constructor has the form:
System(Renderer* renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");

As can be seen, the Renderer module is, of course, still mandatory, though you are free to provide all or none of the other optional arguments and passing in 0 where no object, or no custom object, is required.

For the most basic uses of the system, where only the Renderer is passed in, no changes will be required.

====System::setTooltip changed to System::setDefaultTooltip====
The member function
System::setTooltip
has been renamed as
System::setDefaultTooltip
this was a change for API consistency. Update your code to use the new name for this member.

====Window MetricsMode removed====
The concept of a singular 'MetricsMode' for a window is now obsolete and is replaced with the 'Unified' metrics system (which comprises of both a relative 'scale' value and an absolute 'offset' value).

The class members, properties and all associated items affecting MetricsMode have been removed from the system and the use of the Unified metrics system is now mandatory.

====Window Metrics and other conversion members removed====
Member functions in the Window class that were concerned with converting values between the various metric modes have all been removed.
There may still be the need to perform some conversions of co-ordinates, so this functionality is now provided by the external utility class CEGUI::CoordConverter.
Window Size and Positioning

Due to the removal of the MetricsMode concept, and the now mandatory use of 'Unified' co-ordinate values, the means by which you specify size and position is now by using the unified co-ordinate types: UDim, UVector2 and URect.

{| cellpadding=2px cellspacing=0
| style="color: #ffffff; background-color: #ff5555; border: solid 1px #000000;" | '''The information in the following section has been updated again since RC1 was issued - early adopters will need to update their code again to use SVN trunk code and the upcoming RC2.'''
|}

*getXPosition, getWindowXPosition, getRelativeXPosition and getAbsoluteXPosition members are replaced with a single getXPosition member returning a UDim.
*getYPosition, getWindowYPosition, getRelativeYPosition and getAbsoluteYPosition members are replaced with a single getYPosition member returning a UDim.
*getPosition, getWindowPosition, getRelativePosition and getAbsolutePosition members are replaced with a single getPosition member returning a UVector2.
*getWidth, getWindowWidth, getRelativeWidth and getAbsoluteWidth members are replaced with a single getWidth member returning a Udim.
*getHeight, getWindowHeight, getRelativeHeight and getAbsoluteHeight members are replaced with a single getHeight member returning a UDim.
*getSize, getWindowSize, getRelativeSize and getAbsoluteSize members are replaced with a single getSize member returning a UVector2
*getRect, getWindowArea, getRelativeRect and getAbsoluteRect members are replaced with a single getArea member returning a URect.
*getMaximumSize and getWindowMaxSize members are replaced with a single getMaxSize member returning a UVector2.
*getMinimumSize and getWindowMinSize members are replaced with a single getMinSize member returnung a UVector2.

*setWidth and setWindowWidth members are replaced with a single setWidth member taking a UDim.
*setHeight and setWindowHeight members are replaced with a single setHeight member taking a UDim.
*setSize and setWindowSize members are replaced with a single setSize member taking a UVector2.
*setXPosition and setWindowXPosition members are replaced with a single setXPosition member taking a UDim.
*setYPosition and setWindowYPosition members are replaced with a single setYPosition member taking a UDim.
*setPosition and setWindowPosition members are replaced with a single setPosition member taking a UVector2.
*setAreaRect, setRect and setWindowArea members are replaced with setArea members accepting the following options:
**Four UDims; specifying x position, y position, width and height.
**Two UVector2s; specifying position and size.
**A single URect defining the area.
*setMaximumSize and setWindowMaxSize members are replaced with a single setMaxSize member taking a UVector2.
*setMinimumSize and setWindowMinSize members are replaced with a single setMinSize member taking a UVector2.

====Component Widget creation abstract members====
If you have sub-classed any Window types in order to create a new “Widget Module”, part of your responsibility was to provide implementations for various abstract member functions whose job it was to create the various component widgets required by the container window. These members were typically named createXXX (for example, Combobox::createEditbox).

These abstract member functions and the internal calls to them have all been removed from the system. The component widgets are now specified within the looknfeel xml files are are automatically created by the Falagard looknfeel system as and when required.
You should remove any code that creates these component widgets and add appropriate <Child> tags to your looknfeel xml files instead.

====Component Widget member fields====
If you had sub-classed any of the Window types, either to provide some modified behaviour or perhaps for a “Widget Module” as part of creating a custom look, you would previously have had access to some member variables that held pointers to component widgets of the more complicated widget types (for example, the Scrollbar widget would have held pointers to the two PushButton widgets and the Thumb widget that it was composed of). These members have now been removed and replaced with 'getter' member functions; this is important because in the future the actual Window objects used for these component parts may not be valid for the entire life of the containing Window. That is, the component Windows may get destroyed and re-created, thus invalidating any cached pointers.

The old member variables and the getter function that replaces them are listed here:
*** TODO ***

====RenderableElement, RenderableImage and RenderableFrame classes====
These classes have all been removed from the system entirely. Everything that these classes achieved with regards to rendering for window and widget types can now be done via the Falagard looknfeel system.

For window based rendering, you should remove your use of Renderable* classes in favour of ImageryComponent and FrameComponent elements in your looknfeel xml files.
If you were using the Renderable* classes to perform rendering outside of the window rendering systems, you will now need to find alternative, custom, means to do this.

====Static, StaticImage and StaticText classes====
These classes are now removed from the base system and have been implemented as WindowRenderer classes. Generally, your interface to these widget types should now use a simple default window and the properties system.

The look'n'feel spec for these two widgets have changed as well.

StaticImage:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
- WithFrameImage - image rendering when frame is enabled
- NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present)
</pre>

StaticText:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Named Areas (missing areas will default to 'WithFrameTextRenderArea'):
WithFrameTextRenderArea
WithFrameTextRenderAreaHScroll
WithFrameTextRenderAreaVScroll
WithFrameTextRenderAreaHVScroll
NoFrameTextRenderArea
NoFrameTextRenderAreaHScroll
NoFrameTextRenderAreaVScroll
NoFrameTextRenderAreaHVScroll

</pre>

====Dynamic addition of Events to Windows and other EventSet based objects====
It used to be that all available Event objects would be pre-added to an EventSet when it was constructed. When an Event was accessed which had not been added to the EventSet an appropriate exception was thrown.

This behaviour has now changed. Events are only added to an EventSet when a handler for that event is first subscribed. A side effect of this is that EventSet does now not throw exceptions, either when firing a non-existing Event (now reclassified as simply an event which has no subscribers), or when subscribing to an Event that does not yet exist, since the Event is now automatically created and added to the EventSet.

If your code currently relies on exceptions being thrown by the events system, you will need to change this to a more pro-active approach (by manually checking if an event exists yet), instead of reactive (catching exceptions).

====TinyXML moved to CEGUITinyXML namespace====
If you were for some reason using our integrated copy of TinyXML directly in your application, we have moved this module into the namespace 'CEGUITinyXML'. This was done to avoid clashes and conflicts where the client contained it's own copy of TinyXML.

To continue to directly use the integrated TinyXML, just add the namespace qualifier where appropriate.

If you are just using the TinyXML based implementation of CEGUI::XMLParser, you do not need to change anything.

===Data File Changes===
This sub-section details changes that will affect the xml data files used with CEGUI.

====Updated XSD files for Xerces====
Even the most rudimentary changes to the xml formats we use mean that if you're using the Xerces-C, or other, validating XML parser, then you will need to update you projects to use the new .xsd files. These are collected together for convenience in the XMLRefSchema subdirectory.

=== Falagard Additions ===
From lack of a better place to put this I'll list the additions that have been made to Falagard here.

'''PropertyLinkDefinition'''
New element that will create a property that is a link to another property of a child window.

Attributes:
* type (type, optional and not currently used for anything)
* name (name of the property link)
* widget (name suffix of the child widget to link to)
* targetProperty (the target property to link to. Optional, will default to ''name'' if not given)
* initialValue (starting value for the property. Optional, will default to empty)
* layoutOnWrite (will make the widget redo the child layout when the property is written. Optional, defaults to ''false'')
* redrawOnWrite (will make the widget redraw when the property is written. Optional, default to ''false'')

'''controlProperty'''

New attribute added to ''Section''. Value is the name of a property, and if specified the Section will only render when the property has a value of ''True''.

'''TextComponent'''

Two new sub-elements are now valid for ''TextComponent''.

''TextProperty'', and ''FontProperty''. Must be specified in that order after the (optional) ''Text'' element.
Both have one required attribute ''name'' which takes the name of a property which will contain the text to draw, or the name of the font to use for rendering.

In case these new elements are used along with the ''Text'' element, the string and font specified in the ''Text'' element will be used as defaults if the ''TextProperty'' or ''FontProperty'' evaluates to empty strings.

=== Font system changes ===

* There's no notion of '''StartCodepoint''' and '''EndCodepoint''', or '''glyph set''' anymore. Font render glyphs on the fly as required: if you ask to display "A" it renders a small subset of glyphs (256 codepoints surrounding the missing glyph usually, but can render extra glyphs out of the range to conserve texture space).
* The Font class is now an abstract class and there are two implementations: FreeTypeFont and PixmapFont.
** FreeTypeFont uses the FreeType library and can display TTF, FON, PCF/BDF, PS fonts (and possibly others). I have ensured that bitmap fonts work, since bitmap fonts should be handled a little different from outline fonts.
** PixmapFont uses an Imageset with the glyphs and can display colorful glyphs (which FreeType cannot due to it's grayscale nature). However, it's more primitive, but can be useful for things like logos, loading messages etc.
* The Font class is now a PropertySet, so specialized classes derived from Font can add their own properties (such as PointSize for FreeType fonts which don't have sense for Imageset-based fonts). Here's a list of available properties:
** All font classes: Name, FileName, NativeRes, ResourceGroup, AutoScaled
** FreeTypeFont: PointSize, Antialiased
** PixmapFont: Imageset, Mapping
* Fixed a number of (vertical) font positioning errors: the font wasn't properly centered within it's LineAdvance range.
* Added several new fonts: DejaVuSans (taken from the DejaVu project, http://dejavu.sf.net), fkp (a X11 bitmap font from http://artwizaleczapka.sf.net), FairChar (a Imageset-based font which I made from some old GIF file I found on my HD :-).
* A FontDemo sample which shows several properties of the new Font class.

The above changes resulted in some slight changes to the format of the XML .font files:

* GlyphSet, GlyphRange, Glyph sections of the Font are gone
* The possible values of the Type attribute are now:
** FreeType (instead of Dynamic)
** Pixmap (instead of Static)
* The FirstCodepoint and LastCodepoint attributes of the Font section were removed

After you change your .font files as mentioned above, they should work without problems.

=== Iterator Changes ===
* EventSet::EventIterator is changed to EventSet::Iterator
* PropertySet::PropertyIterator is changed to PropertySet::Iterator

To be continued...

Template:CEGUINews

2006-08-13T16:52:40Z

Dalfy:

{{Section|1=Latest News|2=
* '''0.5.0 Release Candidate 2''' 13 august 2006
[[User:Dalfy|Dalfy]]
* '''0.5.0 Release Candidate 1''' 20 june 2006
[[User:Dalfy|Dalfy]]
* '''Migration to Subversion''' 11:13, 3 April 2006 (PDT)
[[User:CrazyEddie|CrazyEddie]]
* '''Site Moved (again)'''
[[User:CrazyEddie|CrazyEddie]]

[[News|View all news and details...]]
}}

News Archive

2006-08-13T16:45:26Z

Dalfy:

=== CEGUI 0.5.0 Release Candidate 2 by [[User:Dalfy|Dalfy]] 13 august 2006 ===
We are pleased to announce the second release candidate of the 0.5 branches of CEGUI. There has been a lot of changes between 0.4.1 and 0.5.0. They are listed in [[Release Notes 0.5.X]]. Please have a try at it and help us get a final release soon. Check the download page.

=== CEGUI 0.5.0 Release Candidate 1 by [[User:Dalfy|Dalfy]] 20 June 2006===
We are pleased to announce the first release candidate of the 0.5 branches of CEGUI. There has been a lot of changes between 0.4.1 and 0.5.0. They are listed in [[Release Notes 0.5.X]]. Please have a try at it and help us get a final release soon by sending a lot of bug report in Mantis bug tracker. The download page for CEGUI-0.5.0-RC1 contains some typos but most link are already valid and mirrored on sourceforge. The link on the download page are going to be fixed during the day.

For any question regarding this release you can use either the forum either irc.

=== Migration to Subversion by [[User:CrazyEddie|CrazyEddie]] 11:13, 3 April 2006 (PDT) ===
We have taken the decision to migrate the code for main CEGUI Mk-2 library and the CELayoutEditor tool from using the CVS revision control system, over to Subversion (SVN). If you're using the stable releases, this will not affect you at all. If you're using code out of some branch of CVS, then you will need to switch to SVN instead - we will not be maintaining both repositories. You will find that for general usage, CVS and SVN are similar, and have similar commands. For Windows users, we heartily recommend the use of [http://tortoisesvn.tigris.org/ TortoiseSVN].

For full details of how to obtain the source code from the subversion repository, please see the page [[HOWTO: Obtain the library source from subversion]]

All 'ceguiaddons' projects will continue to use CVS for revision control.

=== Site Moved (again) ===
We have now moved the site back to the sourceforge servers, and made a few changes as to the way the site is handled in general - as you have probably noticed!

Basically the main 'content' areas of the site are now entirely wiki based, and we also have a few other bits installed to handle certain requirements where the wiki is less suited to the task.

The features of the new site are:
* Wiki based system for all main site content
* phpBB2 being used for community forums
* Coppermine based gallery
* Mantis for all bug and feature tracking
* Single, unified, log-in for all site areas

SILLY

2006-08-09T09:23:21Z

Dalfy:

== Introduction ==
SILLY means Simple Image Loading LibrarY. The aim of this library is to provide a simple library for loading image in the context of CEGUI. The library supports only the most common image format. The project was initialy launch in order to provide an MIT based replacement of DevIL with less image format supported and focused on loading image only.

{| width="100%"
|width="50%" valign="top"|
== Features ==
* '''Image loading from'''
** File
** Memory
* '''Supported image format'''
** TGA
** PNG
** JPG
* '''Cross platform'''
** Win32
** Linux
** OSX (not tested)
* '''Image conversion while loading'''
** Pixel origine conversion top/bottom left
** multiple pixel formats
* '''License''': MIT
|width="50%" valign="top"|
== Roadmap ==
=== 0.1.X ===
* Initial release
=== 0.2.X ===
* Support for more pixel format
* Better error reporting
* Debug mode
* Support all TGA format (even palettized one)
* Support all PNG format (grayscale and palettized one)
* Gif support
|}
== User Manual ==
This is a quick manual for using SILLY it is not an intent to replace the API documentation provided by doxygen. This paragraph list some generalities on SILLY and its usage. First all symbol object defined in SILLY are contained in the SILLY namespace. I recommand the use of the complete name each time its needed instead of the ''using namespace'' construction. SILLY design make heavly used of the RAII concept and thus you will probably never need to explicitly allocate or release any memory when using SILLY. In order to use SILLY simply #include <SILLY.h>

=== Installation notes ===
==== Windows ====
When using windows you should use [http://premake.sourceforge.net/ premake] to create the solution for MSVC.
==== Linux ====
Under linux premake could probably be used as but the prefered method is configure script.
./configure
make
make install (as root)

=== Initialisation===
In order to use SILLY one must initialise the library. This is required in order to load all image loader object in memory. You also have to do some cleanup once you finished using SILLY. You can call several time SILLYInit / SILLYCleanup.

<code>
<cpp/>
SILLY::SILLYInit();
// Code using SILLY library

SILLY::SILLYCleanup();
</code>

=== DataSource ===
To load an image you need to tell SILLY where the image data is located. This is the role of the DataSource abstract class. SILLY comes with two implementation of this abstraction. FileDataSource class load an image from a file on disk. The content of the file is loaded in memory in the constructor. You have to check wether the operation succeded using the isValid methode.
<code>
<cpp/>
// Example using SILLY::FileDataSource object
SILLY::SILLYInit();
SILLY::FileDataSource source("filename");
if (source.isValid())
{
// Load the image
}
SILLY::SILLYCleanup();
</code>

The second DataSource concrete class is called MemoryDataSource. It provides a wrapper around a previously allocated chunk of memory that is supposed to contain a valid image. A MemoryDataSource object does not need validation because the constructor of the DataSource can't failed. SILLY does not take the ownership of the memory and does not modify this memory. You are responsible of allocating and freeing the memory.
<code>
<cpp/>
// Example using SILLY::MemoryDataSource object
SILLY::SILLYInit();
SILLY::MemoryDataSource source(buffer, bufferSize);
// Load the image
SILLY::SILLYCleanup();
</code>
==== Image class ====
==== Extending SILLY ====
===== ImageLoader and ImageContext =====
===== ImageLoaderManager =====

SILLY

2006-08-09T09:18:30Z

Dalfy: /* Initialisation */

== Introduction ==
SILLY means Simple Image Loading LibrarY. The aim of this library is to provide a simple library for loading image in the context of CEGUI. The library supports only the most common image format. The project was initialy launch in order to provide an MIT based replacement of DevIL with less image format supported and focused on loading image only.

{| width="100%"
|width="50%" valign="top"|
== Features ==
* '''Image loading from'''
** File
** Memory
* '''Supported image format'''
** TGA
** PNG
** JPG
* '''Cross platform'''
** Win32
** Linux
** OSX (not tested)
* '''Image conversion while loading'''
** Pixel origine conversion top/bottom left
** multiple pixel formats
* '''License''': MIT
|width="50%" valign="top"|
== Roadmap ==
=== 0.1.X ===
* Initial release
=== 0.2.X ===
* Support for more pixel format
* Better error reporting
* Debug mode
* Support all TGA format (even palettized one)
* Support all PNG format (grayscale and palettized one)
* Gif support
|}
== User Manual ==
This is a quick manual for using SILLY it is not an intent to replace the API documentation provided by doxygen. This paragraph list some generalities on SILLY and its usage. First all symbol object defined in SILLY are contained in the SILLY namespace. I recommand the use of the complete name each time its needed instead of the ''using namespace'' construction. SILLY design make heavly used of the RAII concept and thus you will probably never need to explicitly allocate or release any memory when using SILLY. In order to use SILLY simply #include <SILLY.h>

=== Installation notes ===
==== Windows ====
When using windows you should use [http://premake.sourceforge.net/ premake] to create the solution for MSVC.
==== Linux ====
Under linux premake could probably be used as but the prefered method is configure script.
./configure
make
make install (as root)

=== Initialisation===
In order to use SILLY one must initialise the library. This is required in order to load all image loader object in memory. You also have to do some cleanup once you finished using SILLY. You can call several time SILLYInit / SILLYCleanup.

<code>
<cpp />
SILLY::SILLYInit();
// Code using SILLY library

SILLY::SILLYCleanup();
</code>

=== DataSource ===
To load an image you need to tell SILLY where the image data is located. This is the role of the DataSource abstract class. SILLY comes with two implementation of this abstraction. FileDataSource class load an image from a file on disk. The content of the file is loaded in memory in the constructor. You have to check wether the operation succeded using the isValid methode.
<code>
<cpp />
// Example using SILLY::FileDataSource object
SILLY::SILLYInit();
SILLY::FileDataSource source("filename");
if (source.isValid())
{
// Load the image
}
SILLY::SILLYCleanup();
</code>

The second DataSource concrete class is called MemoryDataSource. It provides a wrapper around a previously allocated chunk of memory that is supposed to contain a valid image. A MemoryDataSource object does not need validation because the constructor of the DataSource can't failed. SILLY does not take the ownership of the memory and does not modify this memory. You are responsible of allocating and freeing the memory.
<code>
<cpp />
// Example using SILLY::MemoryDataSource object
SILLY::SILLYInit();
SILLY::MemoryDataSource source(buffer, bufferSize);
// Load the image
SILLY::SILLYCleanup();
</code>
==== Image class ====
==== Extending SILLY ====
===== ImageLoader and ImageContext =====
===== ImageLoaderManager =====

SILLY

2006-08-01T14:07:07Z

Dalfy:

== Introduction ==
SILLY means Simple Image Loading LibrarY. The aim of this library is to provide a simple library for loading image in the context of CEGUI. The library supports only the most common image format. The project was initialy launch in order to provide an MIT based replacement of DevIL with less image format supported and focused on loading image only.

{| width="100%"
|width="50%" valign="top"|
== Features ==
* '''Image loading from'''
** File
** Memory
* '''Supported image format'''
** TGA
** PNG
** JPG
* '''Cross platform'''
** Win32
** Linux
** OSX (not tested)
* '''Image conversion while loading'''
** Pixel origine conversion top/bottom left
** multiple pixel formats
* '''License''': MIT
|width="50%" valign="top"|
== Roadmap ==
=== 0.1.X ===
* Initial release
=== 0.2.X ===
* Support for more pixel format
* Better error reporting
* Debug mode
* Support all TGA format (even palettized one)
* Support all PNG format (grayscale and palettized one)
* Gif support
|}
== User Manual ==
This is a quick manual for using SILLY it is not an intent to replace the API documentation provided by doxygen. This paragraph list some generalities on SILLY and its usage. First all symbol object defined in SILLY are contained in the SILLY namespace. I recommand the use of the complete name each time its needed instead of the ''using namespace'' construction. SILLY design make heavly used of the RAII concept and thus you will probably never need to explicitly allocate or release any memory when using SILLY. In order to use SILLY simply #include <SILLY.h>

=== Installation notes ===
==== Windows ====
When using windows you should use [http://premake.sourceforge.net/ premake] to create the solution for MSVC.
==== Linux ====
Under linux premake could probably be used as but the prefered method is configure script.
./configure
make
make install (as root)

=== Initialisation===
In order to use SILLY one must initialise the library. This is required in order to load all image loader object in memory. You also have to do some cleanup once you finished using SILLY. You can call several time SILLYInit / SILLYCleanup.

<code>
<cpp />
SILLY::SILLYInit();
// Code using SILLY library

SILLY::SILLYCleanup();
</code>

=== DataSource ===
To load an image you need to tell SILLY where the image data is located. This is the role of the DataSource abstract class. SILLY comes with two implementation of this abstraction. FileDataSource class load an image from a file on disk. The content of the file is loaded in memory in the constructor. You have to check wether the operation succeded using the isValid methode.
<code>
<cpp />
// Example using SILLY::FileDataSource object
SILLY::SILLYInit();
SILLY::FileDataSource source("filename");
if (source.isValid())
{
// Load the image
}
SILLY::SILLYCleanup();
</code>

The second DataSource concrete class is called MemoryDataSource. It provides a wrapper around a previously allocated chunk of memory that is supposed to contain a valid image. A MemoryDataSource object does not need validation because the constructor of the DataSource can't failed. SILLY does not take the ownership of the memory and does not modify this memory. You are responsible of allocating and freeing the memory.
<code>
<cpp />
// Example using SILLY::MemoryDataSource object
SILLY::SILLYInit();
SILLY::MemoryDataSource source(buffer, bufferSize);
// Load the image
SILLY::SILLYCleanup();
</code>
==== Image class ====
==== Extending SILLY ====
===== ImageLoader and ImageContext =====
===== ImageLoaderManager =====

SILLY

2006-08-01T14:05:03Z

Dalfy:

== Introduction ==
SILLY means Simple Image Loading LibrarY. The aim of this library is to provide a simple library for loading image in the context of CEGUI. The library supports only the most common image format. The project was initialy launch in order to provide an MIT based replacement of DevIL with less image format supported and focused on loading image only.

{| width="100%"
|width="50%" valign="top"|
== Features ==
* '''Image loading from'''
** File
** Memory
* '''Supported image format'''
** TGA
** PNG
** JPG
* '''Cross platform'''
** Win32
** Linux
** OSX (not tested)
* '''Image conversion while loading'''
** Pixel origine conversion top/bottom left
** multiple pixel formats
* '''License''': MIT
|width="50%" valign="top"|
== Roadmap ==
=== 0.1.X ===
* Initial release
=== 0.2.X ===
* Support for more pixel format
* Better error reporting
* Debug mode
* Support all TGA format (even palettized one)
* Support all PNG format (grayscale and palettized one)
* Gif support
|}
== User Manual ==
This is a quick manual for using SILLY it is not an intent to replace the API documentation provided by doxygen. This paragraph list some generalities on SILLY and its usage. First all symbol object defined in SILLY are contained in the SILLY namespace. I recommand the use of the complete name each time its needed instead of the ''using namespace'' construction. SILLY design make heavly used of the RAII concept and thus you will probably never need to explicitly allocate or release any memory when using SILLY. In order to use SILLY simply #include <SILLY.h>

=== Installation notes ===
==== Windows ====
When using windows you should use [http://premake.sourceforge.net/ premake] to create the solution for MSVC.
==== Linux ====
Under linux premake could probably be used as but the prefered method is configure script.
./configure
make
make install (as root)

=== Initialisation===
In order to use SILLY one must initialise the library. This is required in order to load all image loader object in memory. You also have to do some cleanup once you finished using SILLY. You can call several time SILLYInit / SILLYCleanup.

<code>
<cpp />
SILLY::SILLYInit();
// Code using SILLY library

SILLY::SILLYCleanup();
</code>

=== DataSource ===
To load an image you need to tell SILLY where the image data is located. This is the role of the DataSource abstract class. SILLY comes with two implementation of this abstraction. FileDataSource class load an image from a file on disk. The content of the file is loaded in memory in the constructor. You have to check wether the operation succeded using the isValid methode.
<code>
<cpp />
// Example using SILLY::FileDataSource object
SILLY::SILLYInit();
SILLY::FileDataSource source("filename");
if (source.isValid())
{
// Load the image
}
SILLY::SILLYCleanup();
</code>

The second DataSource concrete class is called MemoryDataSource. It provides a wrapper around a previously allocated chunk of memory that is supposed to contain a valid image. A MemoryDataSource object does not need validation because the constructor of the DataSource can't failed. SILLY does not take the ownership of the memory and does not modify this memory. You are responsible of allocating and freeing the memory.
<code>
<cpp />
// Example using SILLY::MemoryDataSource object
SILLY::SILLYInit();
SILLY::MemoryDataSource source(buffer, bufferSize);
// Load the image
SILLY::SILLYCleanup();
</code>

Developer meetings

2006-07-26T09:13:53Z

Dalfy:

This page is used to list all the logs of the developer team mettings. Refer to the corresponding forum thread for comment.

== List of meetings ==

* [http://www.cegui.org.uk/meetings/meeting_2006-07-16.html Meeting 2006 07 16]: This was the first official metting of CEGUI developers. We have been discussing for four hour all the aspect of the CEGUI project.

Developer meetings

2006-07-26T08:55:59Z

Dalfy:

This page is used to list all the logs of the developer team mettings. The meetings logs are locked but you can use the discussion page to comment the metting. Each meetings have its own page. In order to allow you to have your opinion on CEGUI future release we put all logs here.

== List of meetings ==

* [http://www.cegui.org.uk/meetings/meeting_2006-07-16.html Meeting 2006 07 16]: This was the first official metting of CEGUI developers. We have been discussing for four hour all the aspect of the CEGUI project.

Developer meetings

2006-07-25T18:46:38Z

Dalfy:

This page is used to list all the logs of the developer team mettings. The meetings logs are locked but you can use the discussion page to comment the metting. Each meetings have its own page. In order to allow you to have your opinion on CEGUI future release we put all logs here.

== List of meetings ==

* [[meeting 2006-07-16]]: This was the first official metting of CEGUI developers. We have been discussing for four hour all the aspect of the CEGUI project.

Main Page

2006-07-25T18:34:25Z

Dalfy:

{{Section|1=Welcome to Crazy Eddie's GUI System|2=
<table><td>Crazy Eddie's GUI System is a free library providing windowing and widgets for graphics APIs / engines where such functionality is not natively available, or severely lacking. The library is object orientated, written in C++, and targeted at games developers who should be spending their time creating great games, not building GUI sub-systems!</td><td><galrand></galrand></td></table>
<div style="text-align:center; color:#884400; border:1px dashed #888888; margin-top:0.9em">
'''To edit this wiki or to contribute to this site, you must be a registered on our [http://www.cegui.org.uk/phpBB2/index.php forums]'''
</div>
}}

{| width="100%" background-color="transparent"
|valign="top"|


{{Section|1=Learning about CEGUI|2=
* [[FAQ|Everything About CEGUI (FAQ)]]
* [[Features]]
* [[Developer Team]]
* [[Developer meetings]]
}}


{{Section|1=Downloading and Installing|2=
* [[Downloads]]
* [[Community Downloads|Community Downloads page]]
* Installing from source [[Build from Source for Win32|win32]], [[Build from source for Linux|linux]], [[Build from source for OSX|OSX]]
}}


{{Section|1=Working with CEGUI|2=
* [[Tutorials]]: All tutorials to help you getting started with CEGUI
* [[HOW-TO_series|HOW-TO Series]]: How to deal with a specific feature of CEGUI
* [[Articles]]: Some more advanced material on using CEGUI
* [[CodeSnippets]]: chunk of code collection
}}


{{Section|1=CEGUI for Content Creators|2=
* [[Assembling a Toolset|Tools]]: Gather the tools that can help you with the creation of your GUI
* [["Falagard" Skinning System Documentation]]: All you ever wanted to know on falagard skinning system (and more)
* [[XML File formats]]: Description of all XML file format used in CEGUI
* [[External resources]]: Find some material for your gui
* [http://skins.cegui.org.uk Skins]: Find some existing skins
}}


{{Section|1=Community Projects|2=
* [[Projects Using CEGUI]]: Games and other software using CEGUI
* [[User Contributed Material]]: You have a lot of talents lets share it here
* [[CEGUI Addons]]: All addons available in the CVS repository at SF
}}


{{Section|1=Official References|2=
* [[Manual TOC|Manual]]: Official CEGUI Manual (We are going to create it after 0.5 release)
* [http://www.cegui.org.uk/api_reference API Reference]: Online doxygen manual for the lastest stable release (0.4.1)
* [http://dalfy.dyndns.org/~ode/cegui/RC1/cegui_api_reference CEGUI 0.5.0-RC1]: Online doxygen manual for CEGUI 0.5 first release candidate (0.5.0-RC1)
* [http://dalfy.dyndns.org/~ode/cegui/RC1/silly_api_reference SILLY 0.1.0-RC1]: Online doxygen manual for SILLY 0.1 first release candidate (0.1.0-RC1)
* []: Falagard skining documentation
}}


| valign="top" width="25%" |

{{CEGUINews}}

{{Section|1=Project|2=
CEGUI Release, roadmap and porting notes
* 0.4 (stable) CEGUI MK2-0.4.1 [[Downloads 0.4.1 | downloads]]
* 0.5 (devel) CEGUI MK2-0.5.0 RC1 [[Downloads 0.5.0-RC1 | downloads]], [[Porting to the 0.5.0 Release|release notes]]
}}

{{CurrentCEGUI}}
|}
{{CEGUIWikiWhatsNew}}

Main Page

2006-06-21T18:09:58Z

Dalfy:

{{CEGUIWelcome}}

{| width="100%" background-color="transparent"
|valign="top"|


{{Section|1=Learning about CEGUI|2=
* [[FAQ|Everything About CEGUI (FAQ)]]
* [[Features]]
* [[Developer Team]]
}}


{{Section|1=Downloading and Installing|2=
* [[Downloads]]
* [[Community Downloads|Community Downloads page]]
* Installing from source [[Build from Source for Win32|win32]], [[Build from source for Linux|linux]], [[Build from source for OSX|OSX]]
}}


{{Section|1=Working with CEGUI|2=
* [[Tutorials]]: All tutorials to help you getting started with CEGUI
* [[HOW-TO_series|HOW-TO Series]]: How to deal with a specific feature of CEGUI
* [[Articles]]: Some more advanced material on using CEGUI
* [[CodeSnippets]]: chunk of code collection
}}


{{Section|1=CEGUI for Content Creators|2=
* [[Assembling a Toolset|Tools]]: Gather the tools that can help you with the creation of your GUI
* [["Falagard" Skinning System Documentation]]: All you ever wanted to know on falagard skinning system (and more)
* [[XML File formats]]: Description of all XML file format used in CEGUI
* [[External resources]]: Find some material for your gui
* [http://skins.cegui.org.uk Skins]: Find some existing skins
}}


{{Section|1=Community Projects|2=
* [[User Contributed Material]]: You have a lot of talents lets share it here
* [[CEGUI Addons]]: All addons available in the CVS repository at SF
}}


{{Section|1=Official References|2=
* [[Manual TOC|Manual]]: Official CEGUI Manual (We are going to create it after 0.5 release)
* [http://www.cegui.org.uk/api_reference API Reference]: Online doxygen manual for the lastest stable release (0.4.1)
* [http://dalfy.dyndns.org/~ode/cegui/RC1/cegui_api_reference CEGUI 0.5.0-RC1]: Online doxygen manual for CEGUI 0.5 first release candidate (0.5.0-RC1)
* [http://dalfy.dyndns.org/~ode/cegui/RC1/silly_api_reference SILLY 0.1.0-RC1]: Online doxygen manual for SILLY 0.1 first release candidate (0.1.0-RC1)
* []: Falagard skining documentation
}}


| valign="top" width="25%" |

{{CEGUINews}}

{{Section|1=Project|2=
CEGUI Release, roadmap and porting notes
* 0.4 (stable) CEGUI MK2-0.4.1 [[Downloads 0.4.1 | downloads]]
* 0.5 (devel) CEGUI MK2-0.5.0 RC1 [[Downloads 0.5.0-RC1 | downloads]], [[Porting to the 0.5.0 Release|release notes]]
}}

{{CurrentCEGUI}}
|}
{{CEGUIWikiWhatsNew}}

News Archive

2006-06-20T06:07:12Z

Dalfy:

=== CEGUI 0.5.0 Release Candidate 1 by [[User:Dalfy|Dalfy]] 20 June 2006===
We are pleased to announce the first release candidate of the 0.5 branches of CEGUI. There has been a lot of changes between 0.4.1 and 0.5.0. They are listed in [[Release Notes 0.5.X]]. Please have a try at it and help us get a final release soon by sending a lot of bug report in Mantis bug tracker. The download page for CEGUI-0.5.0-RC1 contains some typos but most link are already valid and mirrored on sourceforge. The link on the download page are going to be fixed during the day.

For any question regarding this release you can use either the forum either irc.

=== Migration to Subversion by [[User:CrazyEddie|CrazyEddie]] 11:13, 3 April 2006 (PDT) ===
We have taken the decision to migrate the code for main CEGUI Mk-2 library and the CELayoutEditor tool from using the CVS revision control system, over to Subversion (SVN). If you're using the stable releases, this will not affect you at all. If you're using code out of some branch of CVS, then you will need to switch to SVN instead - we will not be maintaining both repositories. You will find that for general usage, CVS and SVN are similar, and have similar commands. For Windows users, we heartily recommend the use of [http://tortoisesvn.tigris.org/ TortoiseSVN].

For full details of how to obtain the source code from the subversion repository, please see the page [[HOWTO: Obtain the library source from subversion]]

All 'ceguiaddons' projects will continue to use CVS for revision control.

=== Site Moved (again) ===
We have now moved the site back to the sourceforge servers, and made a few changes as to the way the site is handled in general - as you have probably noticed!

Basically the main 'content' areas of the site are now entirely wiki based, and we also have a few other bits installed to handle certain requirements where the wiki is less suited to the task.

The features of the new site are:
* Wiki based system for all main site content
* phpBB2 being used for community forums
* Coppermine based gallery
* Mantis for all bug and feature tracking
* Single, unified, log-in for all site areas

News Archive

2006-06-20T06:05:15Z

Dalfy:

=== CEGUI 0.5.0 Release Candidate 1 by [[User:Dalfy|Dalfy]] 20 June 2006===
We are pleased to announce the first release candidate of the 0.5 branches of CEGUI. There has been a lot of changes between 0.4.1 and 0.5.0. Those change are listed in [[Release Notes 0.5.X]]. Please have a try at it and help us get a final release soon with a lot of bug report in Mantis bug tracker. The Download page for CEGUI-0.5.0-RC1 contains some typos but most link are already valid and mirrored on sourceforge.

For any question regarding this release you can use either the forum either irc.

=== Migration to Subversion by [[User:CrazyEddie|CrazyEddie]] 11:13, 3 April 2006 (PDT) ===
We have taken the decision to migrate the code for main CEGUI Mk-2 library and the CELayoutEditor tool from using the CVS revision control system, over to Subversion (SVN). If you're using the stable releases, this will not affect you at all. If you're using code out of some branch of CVS, then you will need to switch to SVN instead - we will not be maintaining both repositories. You will find that for general usage, CVS and SVN are similar, and have similar commands. For Windows users, we heartily recommend the use of [http://tortoisesvn.tigris.org/ TortoiseSVN].

For full details of how to obtain the source code from the subversion repository, please see the page [[HOWTO: Obtain the library source from subversion]]

All 'ceguiaddons' projects will continue to use CVS for revision control.

=== Site Moved (again) ===
We have now moved the site back to the sourceforge servers, and made a few changes as to the way the site is handled in general - as you have probably noticed!

Basically the main 'content' areas of the site are now entirely wiki based, and we also have a few other bits installed to handle certain requirements where the wiki is less suited to the task.

The features of the new site are:
* Wiki based system for all main site content
* phpBB2 being used for community forums
* Coppermine based gallery
* Mantis for all bug and feature tracking
* Single, unified, log-in for all site areas

Template:CEGUINews

2006-06-20T05:58:36Z

Dalfy:

{{Section|1=Latest News|2=
* '''0.5.0 Release Candidate 1''' 20 june 2006
[[User:Dalfy|Dalfy]]
* '''Migration to Subversion''' 11:13, 3 April 2006 (PDT)
[[User:CrazyEddie|CrazyEddie]]
* '''Site Moved (again)'''
[[User:CrazyEddie|CrazyEddie]]

[[News|View all news and details...]]
}}

Template:CEGUINews

2006-06-20T05:57:56Z

Dalfy:

{{Section|1=Latest News|2=
* '''0.5.0 Release Candidate 1 is out''' 20 june 2006
[[User:Dalfy|Dalfy]]
* '''Migration to Subversion''' 11:13, 3 April 2006 (PDT)
[[User:CrazyEddie|CrazyEddie]]
* '''Site Moved (again)'''
[[User:CrazyEddie|CrazyEddie]]

[[News|View all news and details...]]
}}

Template:CEGUIDownloadsRC

2006-06-19T23:00:12Z

Dalfy:

Template:CEGUIDownloadsRC

2006-06-19T22:55:34Z

Dalfy:

Template:CEGUIDownloadsRC

2006-06-19T22:53:36Z

Dalfy:

Template:CEGUIDownloadsRC

2006-06-19T22:52:09Z

Dalfy:

Template:CEGUIDownloadsRC

2006-06-19T22:50:15Z

Dalfy:

Main Page

2006-06-19T22:35:00Z

Dalfy:

{{CEGUIWelcome}}

{| width="100%" background-color="transparent"
|valign="top"|


{{Section|1=Learning about CEGUI|2=
* [[FAQ|Everything About CEGUI (FAQ)]]
* [[Features]]
* [[Developer Team]]
}}


{{Section|1=Downloading and Installing|2=
* [[Downloads]]
* [[Community Downloads|Community Downloads page]]
* Installing from source [[Build from Source for Win32|win32]], [[Build from source for Linux|linux]], [[Build from source for OSX|OSX]]
}}


{{Section|1=Working with CEGUI|2=
* [[Tutorials]]: All tutorials to help you getting started with CEGUI
* [[HOW-TO_series|HOW-TO Series]]: How to deal with a specific feature of CEGUI
* [[Articles]]: Some more advanced material on using CEGUI
* [[CodeSnippets]]: chunk of code collection
}}


{{Section|1=CEGUI for Content Creators|2=
* [[Assembling a Toolset|Tools]]: Gather the tools that can help you with the creation of your GUI
* [["Falagard" Skinning System Documentation]]: All you ever wanted to know on falagard skinning system (and more)
* [[XML File formats]]: Description of all XML file format used in CEGUI
* [[External resources]]: Find some material for your gui
* [http://skins.cegui.org.uk Skins]: Find some existing skins
}}


{{Section|1=Community Projects|2=
* [[User Contributed Material]]: You have a lot of talents lets share it here
* [[CEGUI Addons]]: All addons available in the CVS repository at SF
}}


{{Section|1=Official References|2=
* [[Manual TOC|Manual]]: Official CEGUI Manual (We are going to create it after 0.5 release)
* [http://www.cegui.org.uk/api_reference API Reference]: Online doxygen manual for the lastest stable release (0.4.1)
* []: Online doxygen manula for the development release (trunk)
* []: Falagard skining documentation
}}


| valign="top" width="25%" |

{{CEGUINews}}

{{Section|1=Project|2=
CEGUI Release, roadmap and porting notes
* 0.4 (stable) CEGUI MK2-0.4.1 [[Downloads 0.4.1 | downloads]]
* 0.5 (devel) CEGUI MK2-0.5.0 RC1 [[Downloads 0.5.0-RC1 | downloads]], [[Porting to the 0.5.0 Release|release notes]]
}}

{{CurrentCEGUI}}
|}
{{CEGUIWikiWhatsNew}}

Template:CEGUIDownloadsRC

2006-06-19T22:33:03Z

Dalfy:

<div style="text-align:center; color:#884400; border:1px dashed #888888; margin:0.9em">
'''Note that the downloads on this page are the official file releases from the CEGUI Team. The downloads on this page corresponds to Release Candidate version of CEGUI. Please test this version and report all bugs on the Mantis bug tracker. For additional, community provided downloads, please visit the [[Community Downloads|Community Downloads page]]'''
</div>
{| cellspacing="0" cellpadding="0" width="100%" background-color="transparent"
| style="width:50%; border:none; margin:none; padding:none;" valign="top" | 
<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''Core Library Source Downloads'''</span>
</div>

<div style="background:#ffffff; padding:0.5em">
<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''Crazy Eddie's GUI System Mk-2 Source Code (tar.gz archive)'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* Version {{{cegui}}} of the source code for Crazy Eddie's GUI System Mk-2, supplied as a bz2 compressed tarball.
* This is a bug-fix release of the code. See the ChangeLog for full details.
* This package is intended for linux and Apple Mac users.
* [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{cegui}}}.tar.gz?download Download Now!]
</div>
</div>

<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''Crazy Eddie's GUI System Mk-2 Source Code (zip archive)'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* Version {{{cegui}}} of the source code for Crazy Eddie's GUI System Mk-2, supplied as a compressed zip archive.
* This is a bug-fix release of the code. See the ChangeLog for full details.
* This package is intended for Microsoft Windows users.
* [http://prdownloads.sourceforge.net/crayzedsgui/CEGUI-{{{cegui}}}.zip?download Download Now!]
</div>
</div>
</div>
</div>

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-right:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''Core Library Win32 Dependency Downloads'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">

<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''Common dependencies for CEGUI Mk-2 v0.4.x'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* Common dependency headers and libraries for Microsoft Visual C++ users.
* This package contains all the dependencies, except the Xerces-C++ XML parser library - which is available seperately depending on which compiler you use.
* This package is for use with CEGUI 0.4.x series of releases.
* [http://prdownloads.sourceforge.net/crayzedsgui/cegui_mk-0.4.0-deps-common.zip?download Download Now!]
</div>
</div>

<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''MSVC++ 8 Xerces-C dependency package for CEGUI Mk-2 {{{cegui}}}'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* This package contains the Xerces-C XML parser library for use by MSVC++ 8 (MSVC++ 2005) users.
* This package is for use with CEGUI {{{cegui}}} series of releases.
* [http://prdownloads.sourceforge.net/crayzedsgui/cegui_mk2-{{{dependency}}}-deps-vc8-xerces.zip?download Download Now!]
</div>
</div>

<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''MSVC++ 7.1 Xerces-C dependency package for CEGUI Mk-2 {{{cegui}}}'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* This package contains the Xerces-C XML parser library for use by MSVC++ 7.1 (MSVC++>Net 2003) users.
* This package is for use with CEGUI {{{dependency}}} series of releases.
* [http://prdownloads.sourceforge.net/crayzedsgui/cegui_mk-{{{dependency}}}-deps-vc71-xerces.zip?download Download Now!]
</div>
</div>
</div>
</div>


| style="border:none; margin:none; padding:none;" valign="top" | 
<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-left:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''Crazy Eddie's GUI System Layout Editor'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''CELayoutEditor Windows Installer'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* Out-of-the-box installer, which is built against the stable CEGUI {{{cegui}}} release. Includes sample layout(s).
* Version {{{editor}}} (version renamed to match the corresponding cegui library)
* [http://www.2dgame-tutorial.com/downloads/CELayoutEditorSetup_{{{editor}}}.exe Download Now!]
</div>
</div>

<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''CELayoutEditor Source Package'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* This zip-package contains the exact sources from which the installer is build. It's for those who don't have access to Subversion or are not familiar with the hussle.
* It at least compiles to the CEGUI {{{cegui}}} source release with gcc, VC7.1, VC8.
<br>
* The installer is above this download link, so make sure you pick the one you feel most comfortable with.
<br>
* [http://www.2dgame-tutorial.com/downloads/CELayoutEditor.zip Download Now!]
</div>
</div>
{{CEGUILayoutEditorDownloads}}
</div>
</div>

<div style="background:#2f1fef; padding:0px; border:1px solid #888888; margin-left:5px; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.2em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#339933; font-size:100%">'''Crazy Eddie's GUI Simple Image Loading Library (SILLY)'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
<div style="background:#ffffff; padding:0px; border:1px dashed #888888; margin-bottom:10px">
<div style="text-align:center; line-height:100%; padding:0.1em; background-color:#eeeeee; border-bottom:1px dashed #888888;">
<span style="color:#3349dd; font-size:100%">'''SILLY Source packages'''</span>
</div>
<div style="background:#ffffff; padding:0.5em">
* Version {{{silly}}} of the source code for Crazy Eddie's GUI Simple Image Loading Library, supplied as a tar.gz compressed tarball.
* This package is intended for linux and Apple Mac users.
* [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-{{{silly}}}.tar.gz?download Download Now!]
</div>
<div style="background:#ffffff; padding:0.5em">
* Version {{{silly}}} of the source code for Crazy Eddie's GUI Simple Image Loading Library, supplied as a zip compressed archive.
* This package is intended for Win32 users.
* [http://prdownloads.sourceforge.net/crayzedsgui/SILLY-{{{silly}}}.zip?download Download Now!]
</div>
</div>

</div>
</div>
|}

Downloads 0.5.0-RC1

2006-06-19T21:54:10Z

Dalfy:

{{CEGUIDownloadsRC|cegui=0.5.0-RC1|editor=0.5.0-RC1|silly=0.1.0-RC1|dependency=0.5.0-RC1}}

Changes and Porting Tips for 0.5.0

2006-06-19T21:50:18Z

Dalfy:

Note that this is incomplete, work in progress, documentation.

=Release=

* 0.5.0 RC1 Released on June the 20th: [[Downloads 0.5.0-RC1|goto download page]]
=ChangeLog=
<pre>
Various internal code cleanups:
- Removal of unrequired utf8* casts on string literals.
- Removed use of NULL macro from the library code.
- Code refactorings to Font class. Removes some instances of repeated code, and makes
some methods shorter / cleaner.
- Split large methods in Scheme into smaller, more managable, chunks.
- Removed all the System constructor overloads and replaced with a single method.
- Removed string literals for component widget names which were scattered throughout t
he widget code.
- Replaced virtually all member fields holding pointers to component widgets with gett
er methods (which basically allows those widgets to be replaced without the parent kno
wing or caring).
- Refactoring of XML handler to remove huge if/else if/else construct.
- Refectored large if / else if / else constructs in all non-falagard XML handlers to
use a member function for each element type (rather than having all code in one huge f
unction).
- Event system has been rewritten from scratch.
- Font system has been rewritten.

Added "PushedOff" rendering state for button based widgets and MenuItem.
Added: Ability to rename windows.
Added: CEGUISamplesConfig.h file to allow configuration of samples framework independe
ntly of the main config (saves recompiling everything just to change some sample setti
ng).
Added: FPS readout to OpenGL base app in the samples framework.
Added: "PropertyLinkDefinition" element for Falagard system.
Added: "controlPropery" attribute to SectionSpecififations under falagard to enable re
nering of section imagery to be controled via a named boolean property.
Added: mouse pass through feature in Window, to ignore mouse events. Nice for making a
DefaultWindow transparent to the mouse regarding picking windows behind it.
Added: MSVC++ auto-linking for Ogre base app in samples framework.
Added: grab/restoreTextures in the OpenGL renderer to cache texture image data, and la
ter restore it.
Added: Abstracted Logger interface to support user created custom loggers. (SF patch #
1414121 by zap)
Added: DefaultLogger implementation (SF patch #1414121 by zap)
Added: page up/down key functionality to MultiLineEditbox (SF patch #1347376 by Dalfy)
Added: small script to recreate the binding generator for tolua++
Added: customized tolua++ binary. For exception handling support in generated binding
code.
Added: missing exception definitions file needed to generate the bindings.
Added: README with instructions on how to generate the bindings.
Added: Documentation for some of the new features in the bundled tolua++ generator.
Added: When subscribing to events from "inside" Lua a self object can be registered as
well to be passed along with the EventArgs.
Added: New WindowRenderer system, replacing previous system where the Window sub-class
controlled the rendering process.
Added: Major update of the LuaScriptModule to support anonymous functions.
Added: Exception handling has been added for some functions.
Added: Falagard derivatives of DefaultWindow, DragContainer and ItemEntry with minimal
StateImagery.
Added: executeEventHandler now accepts functions that are table fields.
Added: Text node support to both parser (Xerces and TinyXML)
Added: AutoWindow tag to xml layouts to fetch a window created by the look'n'feel or t
he base widget itself.
Added: Window::isAutoWindow member that returns true if the window has "__auto_" in it
s name. (a flag is set in the constructor). It's faster than checking the actual strin
g.
Added: A setting to Window to specify that it should never write XML no matter what if
activated. Tooltips get this set by default by System.
Added: A property ban list to provide a system for mapping which properties should (no
t) be written to XML. In the respective addProperties member functions checks have bee
n added and some properties are banned if we are an auto window.
Added: Default resource group support to Xerces for use when loading schema files.
Added: Default resource group support to ScriptingModule, and implemented it's use in
the CEGUILua module.
Added: DynamicModule class to wrap access to a dynamically linked / loaded module.
Added: New dynamic libraries for Xerces, Expat TinyXMLParser, and libxml Parsers.
Added: TextProperty and FontProperty elements for Falagard text components.
Added: New ItemListBase based ItemListbox widget. For Window based listbox items.
Added: XML Serialization class for all XML writing.
Added: Recursive versions of Window::getChild and isChild by ID. They are called getCh
ildRecursive and isChildRecursive. Reason for the explicit naming is that it's a prett
y expensive operation and should not be used unless necessary.
Added: Lots of missing members in the Lua bindings.
Added: setlocale(LC_NUMERIC, "C"); to the System constructor as we depend on this beha
viour.
Added: setVisible member to CEGUI::MouseCursor.
Added: bat files to make it easier for Windows users to regenerate the Lua bindings an
d tolua++cegui.
Added: ImageCodec support to the OpenGL renderer. This allows users to easily write a
custom image loader. TGA, SILLY, DevIL, Corona and FreeImage codecs are supplied.
Added: const version of getDataPtr in RawDataContainer.
Added: premake scripts to generate MSVC solutions.
Added: ClippedContainer for situations where more specialized clipping is required.

Modified: Placed the integrated TinyXML into its own namespace (CEGUITinyXML) to preve
nt clashes in projects using another copy of TinyXML. (Patch #1294002).
Modified: Changed EventSet to operate without needing events to be pre-added, much lik
e GlabalEventSet always did.
Modified: Removal of mass pre-specification of events for all classes using events.
Modified: Cflags to add include dir for CEGUI in CEGUI.pc.in (allows use of <CEGUI/...
> form of include statement).
Modified: The "Lua and tolua++" module has been made a DLL on Windows machines.
Modified: Renamed System::setTooltip to System::setDefaultTooltip (Mantis #1Cool.
Modified: In the lua module, updated Window with casting helpers as member functions.
eg. w:toFrameWindow()
Modified: Removed the Static,StaticText and StaticImage from CEGUIBase and implemented
them in FalagardBase instead.
Modified: Updated to tolua++ 1.0.92
Modified: Moved LuaFunctor into its own files
Modified: Reimplemented the "late binding" effect from the v04 Lua module. In v04 the
function is always looked up by name. In CVS HEAD the actual Lua function is reference
d, but now this will only occur the first time the event is triggered. This means that
it's no longer necessary to have a function defined to subscribe it to an event. As l
ong as the function has been created before the event occurs everything will be good S
mile
Modified: Moved subscribeScriptedEvent into ScriptModule to allow more customized scri
pt subscription functionality.
Modified: Made the layout XML handler use subscribeScriptedEvent for Event tags instea
d of subscribeEvent with ScriptFunctor
Modified: Removal of "tolua_outside" stuff that was no longer needed.
Modified: Moved the declaration/definition of base window factories into its own files
.
Modified: Removal of WidgetSets folder, and it's contents.
Modified: Removed unnecessary getSingleton and getSingletonPtr from manager classes.
Modified: The script module now throws ScriptException.
Modified: Removal of TextItem as falagard now handles that exclusively.
Modified: Moved all rendering member functions out of base classes an into Falagard re
ndering classes.
Modified: Removal of virtually all rendering and layout related Window properties from
CEGUIBase - a few are moved to FalagardBase, the rest must be implemented via XML.
Modified: Removal of TaharezLook and WindowsLook modules from the system.
Modified: Removal of MetricsMode system, and all non-unified interface and properties
from Window (and related fixes to other classes).
Modified: Elimination of RenderableElement and derived classes.
Modified: Moved to a C preprocessor macro system for widget module creation.
Modified: Removal of abstract createXXX methods from widget base classes - the looknfe
el system now auto-creates these widgets when specified within the XML.
Modified: Updated to TinyXML 2.4.3 in order to allow CDATA section in XML text node (v
erbatim text)
Modified: GUILayout handler in order to support long value in properties.
Modified: Made the XML writing system aware of falagard when determining property defa
ult values.
Modified: Switched PropertyHelper to use std::ostringstream as the output is much nice
r. Changed property default values to the new format where needed.
Modified: Better error reporting for dynamic module load failures.
Modified: Switched to using external pcre library. Removed embedded copy of pcre.
Modified: Switched system to use dynamic libs for XML parsers with programatically con
figurable default.
Modified: FactoryModule to use DynamicModule.
Modified: Resolved issue with unneeded member qualification (Patch #1454773).
Modified: Made String::ptr a public member.
Modified: The bundled tolua++cegui binding generator will now generate a lua_CEGUI.cpp
that compiles out-of-the-box on Windows
Modified: Removed the DataContainer template class, and made it into just RawDataConta
iner, non templated.
Modified: Optimized FalagardMultiLineEditbox to only cache visible lines when renderin
g.
Modified: Optimized ButtonBase and MenuItem updateInternalState. Mantis #44
Modified: Moved the renderers to their own folder named RendererModules.
Modified: Optimized picking and rendering by caching screen space rectangles.
Modified: Applied zap's rewrite of the Font system. Patch #1508321
Modified: Texture::loadFromMemory now takes a Texture::PixelFormat parameter. RGB and
RGBA are currently required. Fixes Patch #1455523 as well. 3rd party renderer modules
needs to be updated.

Bug fix: OpenGLRenderer was producing errors and not cleaning up state changes properl
y (thanx muhkuh25)
Bug fix: OpenGLRenderer was broken when compiled for x86-64.
Bug Fix: ListboxItem::getOwnerWindow should be const
Bug Fix: ListboxItem::getOwnerWindow should not take a Window* argument.
Bug Fix: Scheme::resourcesLoaded was always returning true.
Bug Fix: PropertyHelper::stringToImage was not handling empty string case.
Bug Fix: Editbox::onCharacter was setting the event as handled even if nothing was don
e.
Bug Fix: Added shift/ctrl/alt support to the OpenGL sample driver (injects LeftXXX)
Bug Fix: The command line renderer selector does no longer ask if there is only one re
nderer available.
Bug Fix: Fixed window resizing for the OpenGL Sample driver.
Bug Fix: fixed const correctness for "String::utf8_stream_len" SF patch #1367423
Bug Fix: Detect "window->addChildWindow(window);" and do nothing instead of actually t
rying.
Bug Fix: Added missing performChildWindowLayout to Scrollbar::onScrollConfigChanged to
allow making a look'n'feel with a thumb that sizes to indicate document size.
Bug fix: const correctness for Window::getLookNFeel
Bug fix: FrameWindow, isTitlebarEnabled and isCloseButtonEnabled were return the oppos
ite of what they should.
Bug Fix: FrameWindow should do relayout if text changes to allow using a fontdim in th
e titlebar dimensions.
Bug Fix: Changing the default mouse cursor in the System object will now update the cu
rsor immediately where appropriate. (Ticket #17).
Bug Fix: Fixed case in StaticText where default text area was always used if frame was
disabled.
Bug Fix: Image offsets were'nt being properly handled for the corners in FrameComponen
t.
Bug Fix: MultiColumnList would always use item string when sorting, instead of vitual
operators on users custom items.
Bug Fix: System::getWindowContainingMouse would return incorrect Window if called from
within Window::EventMouseLeaves handlers.
Bug Fix: Order of static data creation in C++ is unspecified; we can't have globally d
efined static data that relies on other such static data within the same module.
Bug Fix: Falagard/ProgressBar was broken when vertical or reversed-horizontal.
Bug Fix: Corruption of window registry when rename failed (Patch #1450623).
Bug Fix: Initialisation issue with TabControl trying to access child widgets before th
ey are created. (Patch #1391727).
Buf Fix: CEGUI::Window::setModalState(true) removes the modal state from a modal windo
w. Mantis #42
Bug Fix: MultiColumnList getNextSelection bug. Mantis #47
Bug Fix: System subscriber to renderer event but does not unsubscribe on destruction.
Mantis #48
Bug Fix: OpenGL and DirectX9 renderers were not handling error correctly when creating
textures.
Bug Fix: Bug in LuaScriptModule where executeScriptFile did not unload the file data b
uffer correctly in case of an exception (thanks gcarlton).
Bug Fix: A bug in ItemListBase::resetList_impl where calling resetList would crash (th
anks Turtle).
Bug Fix: Typo in TabPane::testClassName_impl ("Tabpane" instead of "TabPane").
Bug Fix: Big Endian inconsistency in CEGUI::colour.
Bug Fix: CEGUI::Window was not detaching the tooltip during destruction. Mantis #38
Bug Fix: FrameWindow was consuming all LeftButton up events. Down events were affected
as well, and now only consume if the event started drag sizing.
Bug Fix: DragContainer would overwrite any new position applied to the DragContainer d
uring the DragDropItemDropped event. Mantis #53
Bug Fix: The OpenGL sample driver could cause a stack overflow. Patch #1507826
</pre>

=Porting Notes=

==Introduction==
The 0.5.0 release of Crazy Eddie's GUI System is the first of what will likely be a series of releases containing breaking changes for client code and data files. We feel these breaking changes are required as we move closer to the 1.0 release of CEGUI, and also as the design and usage patterns for CEGUI change; the results are a generally more streamlined system as we move from one idiom to another, as opposed to becoming more and more bloated due to retaining vast amounts of code and kludges for backward compatibility reasons.

This document is a general overview and guide to the breaking changes between the 0.4.x series of releases and the 0.5.0 release. As and when other breaking releases are made, additional documentation will be provided as necessary.

==Changes and Porting==
This section is intended as a general overview of the breaking changes made. Blah, blah, blah.

===Code Changes===
This sub-section details changes made to the CEGUI system code and API which will affect client code.

====The new WindowRenderer system====
One of the main issues with the previous widget module approach, was that it became exceptionally difficult to sub-class a widget type where some custom behavioural changes or additions were required.
*** TODO ***

====CEGUI::System Constructor====
The overloaded constructors for the main CEGUI::System object have been removed and replaced with a single, unified, constructor. Using the new constructor it is still possible to do all the things that used to be possible, while making the whole system construction process a little more uniform.

The new constructor has the form:
System(Renderer* renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");

As can be seen, the Renderer module is, of course, still mandatory, though you are free to provide all or none of the other optional arguments and passing in 0 where no object, or no custom object, is required.

For the most basic uses of the system, where only the Renderer is passed in, no changes will be required.

====System::setTooltip changed to System::setDefaultTooltip====
The member function
System::setTooltip
has been renamed as
System::setDefaultTooltip
this was a change for API consistency. Update your code to use the new name for this member.

====Window MetricsMode removed====
The concept of a singular 'MetricsMode' for a window is now obsolete and is replaced with the 'Unified' metrics system (which comprises of both a relative 'scale' value and an absolute 'offset' value).

The class members, properties and all associated items affecting MetricsMode have been removed from the system and the use of the Unified metrics system is now mandatory.

====Window Metrics and other conversion members removed====
Member functions in the Window class that were concerned with converting values between the various metric modes have all been removed.
There may still be the need to perform some conversions of co-ordinates, so this functionality is now provided by the external utility class CEGUI::CoordConverter.
Window Size and Positioning

Due to the removal of the MetricsMode concept, and the now mandatory use of 'Unified' co-ordinate values, the means by which you specify size and position is now by using the unified type members.

*getXPosition, getRelativeXPosition and getAbsoluteXPosition members are replaced with getWindowXPosition.
*getYPosition, getRelativeYPosition and getAbsoluteYPosition members are replaced with getWindowYPosition.
*getPosition, getRelativePosition and getAbsolutePosition members are replaced with getWindowPosition.
*getWidth, getRelativeWidth and getAbsoluteWidth members are replaced with getWindowWidth
*getHeight, getRelativeHeight and getAbsoluteHeight members are replaced with getWindowHeight
*getSize, getRelativeSize and getAbsoluteSize members are replaced with getWindowSize
*getRect, getRelativeRect and getAbsoluteRect members are replaced with getWindowArea
*getMaximumSize member is replaced with getWindowMaxSize
*getMinimumSize member is replaced with getWindowMinSize
*setWidth members are replaced with setWindowWidth
*setHeight members are replaced with setWindowHeight
*setSize members are replaced with setWindowSize
*setXPosition members are replaced with setWindowXPosition.
*setYPosition members are replaced with setWindowYPosition.
*setPosition members are replaced with setWindowPosition.
*setAreaRect and setRect members are replaced with setWindowArea
*setMaximumSize member is replaced with setWindowMaxSize
*setMinimumSize member is replaced with setWindowMinSize

====Component Widget creation abstract members====
If you have sub-classed any Window types in order to create a new “Widget Module”, part of your responsibility was to provide implementations for various abstract member functions whose job it was to create the various component widgets required by the container window. These members were typically named createXXX (for example, Combobox::createEditbox).

These abstract member functions and the internal calls to them have all been removed from the system. The component widgets are now specified within the looknfeel xml files are are automatically created by the Falagard looknfeel system as and when required.
You should remove any code that creates these component widgets and add appropriate <Child> tags to your looknfeel xml files instead.

====Component Widget member fields====
If you had sub-classed any of the Window types, either to provide some modified behaviour or perhaps for a “Widget Module” as part of creating a custom look, you would previously have had access to some member variables that held pointers to component widgets of the more complicated widget types (for example, the Scrollbar widget would have held pointers to the two PushButton widgets and the Thumb widget that it was composed of). These members have now been removed and replaced with 'getter' member functions; this is important because in the future the actual Window objects used for these component parts may not be valid for the entire life of the containing Window. That is, the component Windows may get destroyed and re-created, thus invalidating any cached pointers.

The old member variables and the getter function that replaces them are listed here:
*** TODO ***

====RenderableElement, RenderableImage and RenderableFrame classes====
These classes have all been removed from the system entirely. Everything that these classes achieved with regards to rendering for window and widget types can now be done via the Falagard looknfeel system.

For window based rendering, you should remove your use of Renderable* classes in favour of ImageryComponent and FrameComponent elements in your looknfeel xml files.
If you were using the Renderable* classes to perform rendering outside of the window rendering systems, you will now need to find alternative, custom, means to do this.

====Static, StaticImage and StaticText classes====
These classes are now removed from the base system and have been implemented as WindowRenderer classes. Generally, your interface to these widget types should now use a simple default window and the properties system.

The look'n'feel spec for these two widgets have changed as well.

StaticImage:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
- WithFrameImage - image rendering when frame is enabled
- NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present)
</pre>

StaticText:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Named Areas (missing areas will default to 'WithFrameTextRenderArea'):
WithFrameTextRenderArea
WithFrameTextRenderAreaHScroll
WithFrameTextRenderAreaVScroll
WithFrameTextRenderAreaHVScroll
NoFrameTextRenderArea
NoFrameTextRenderAreaHScroll
NoFrameTextRenderAreaVScroll
NoFrameTextRenderAreaHVScroll

</pre>

====Dynamic addition of Events to Windows and other EventSet based objects====
It used to be that all available Event objects would be pre-added to an EventSet when it was constructed. When an Event was accessed which had not been added to the EventSet an appropriate exception was thrown.

This behaviour has now changed. Events are only added to an EventSet when a handler for that event is first subscribed. A side effect of this is that EventSet does now not throw exceptions, either when firing a non-existing Event (now reclassified as simply an event which has no subscribers), or when subscribing to an Event that does not yet exist, since the Event is now automatically created and added to the EventSet.

If your code currently relies on exceptions being thrown by the events system, you will need to change this to a more pro-active approach (by manually checking if an event exists yet), instead of reactive (catching exceptions).

====TinyXML moved to CEGUITinyXML namespace====
If you were for some reason using our integrated copy of TinyXML directly in your application, we have moved this module into the namespace 'CEGUITinyXML'. This was done to avoid clashes and conflicts where the client contained it's own copy of TinyXML.

To continue to directly use the integrated TinyXML, just add the namespace qualifier where appropriate.

If you are just using the TinyXML based implementation of CEGUI::XMLParser, you do not need to change anything.

===Data File Changes===
This sub-section details changes that will affect the xml data files used with CEGUI.

====Updated XSD files for Xerces====
Even the most rudimentary changes to the xml formats we use mean that if you're using the Xerces-C, or other, validating XML parser, then you will need to update you projects to use the new .xsd files. These are collected together for convenience in the XMLRefSchema subdirectory.

=== Falagard Additions ===
From lack of a better place to put this I'll list the additions that have been made to Falagard here.

'''PropertyLinkDefinition'''
New element that will create a property that is a link to another property of a child window.

Attributes:
* type (type, optional and not currently used for anything)
* name (name of the property link)
* widget (name suffix of the child widget to link to)
* targetProperty (the target property to link to. Optional, will default to ''name'' if not given)
* initialValue (starting value for the property. Optional, will default to empty)
* layoutOnWrite (will make the widget redo the child layout when the property is written. Optional, defaults to ''false'')
* redrawOnWrite (will make the widget redraw when the property is written. Optional, default to ''false'')

'''controlProperty'''

New attribute added to ''Section''. Value is the name of a property, and if specified the Section will only render when the property has a value of ''True''.

'''TextComponent'''

Two new sub-elements are now valid for ''TextComponent''.

''TextProperty'', and ''FontProperty''. Must be specified in that order after the (optional) ''Text'' element.
Both have one required attribute ''name'' which takes the name of a property which will contain the text to draw, or the name of the font to use for rendering.

In case these new elements are used along with the ''Text'' element, the string and font specified in the ''Text'' element will be used as defaults if the ''TextProperty'' or ''FontProperty'' evaluates to empty strings.

To be continued...

Changes and Porting Tips for 0.5.0

2006-06-19T21:46:09Z

Dalfy: /* ChangeLog */

Note that this is incomplete, work in progress, documentation.

=Release=

=ChangeLog=
<pre>
Various internal code cleanups:
- Removal of unrequired utf8* casts on string literals.
- Removed use of NULL macro from the library code.
- Code refactorings to Font class. Removes some instances of repeated code, and makes
some methods shorter / cleaner.
- Split large methods in Scheme into smaller, more managable, chunks.
- Removed all the System constructor overloads and replaced with a single method.
- Removed string literals for component widget names which were scattered throughout t
he widget code.
- Replaced virtually all member fields holding pointers to component widgets with gett
er methods (which basically allows those widgets to be replaced without the parent kno
wing or caring).
- Refactoring of XML handler to remove huge if/else if/else construct.
- Refectored large if / else if / else constructs in all non-falagard XML handlers to
use a member function for each element type (rather than having all code in one huge f
unction).
- Event system has been rewritten from scratch.
- Font system has been rewritten.

Added "PushedOff" rendering state for button based widgets and MenuItem.
Added: Ability to rename windows.
Added: CEGUISamplesConfig.h file to allow configuration of samples framework independe
ntly of the main config (saves recompiling everything just to change some sample setti
ng).
Added: FPS readout to OpenGL base app in the samples framework.
Added: "PropertyLinkDefinition" element for Falagard system.
Added: "controlPropery" attribute to SectionSpecififations under falagard to enable re
nering of section imagery to be controled via a named boolean property.
Added: mouse pass through feature in Window, to ignore mouse events. Nice for making a
DefaultWindow transparent to the mouse regarding picking windows behind it.
Added: MSVC++ auto-linking for Ogre base app in samples framework.
Added: grab/restoreTextures in the OpenGL renderer to cache texture image data, and la
ter restore it.
Added: Abstracted Logger interface to support user created custom loggers. (SF patch #
1414121 by zap)
Added: DefaultLogger implementation (SF patch #1414121 by zap)
Added: page up/down key functionality to MultiLineEditbox (SF patch #1347376 by Dalfy)
Added: small script to recreate the binding generator for tolua++
Added: customized tolua++ binary. For exception handling support in generated binding
code.
Added: missing exception definitions file needed to generate the bindings.
Added: README with instructions on how to generate the bindings.
Added: Documentation for some of the new features in the bundled tolua++ generator.
Added: When subscribing to events from "inside" Lua a self object can be registered as
well to be passed along with the EventArgs.
Added: New WindowRenderer system, replacing previous system where the Window sub-class
controlled the rendering process.
Added: Major update of the LuaScriptModule to support anonymous functions.
Added: Exception handling has been added for some functions.
Added: Falagard derivatives of DefaultWindow, DragContainer and ItemEntry with minimal
StateImagery.
Added: executeEventHandler now accepts functions that are table fields.
Added: Text node support to both parser (Xerces and TinyXML)
Added: AutoWindow tag to xml layouts to fetch a window created by the look'n'feel or t
he base widget itself.
Added: Window::isAutoWindow member that returns true if the window has "__auto_" in it
s name. (a flag is set in the constructor). It's faster than checking the actual strin
g.
Added: A setting to Window to specify that it should never write XML no matter what if
activated. Tooltips get this set by default by System.
Added: A property ban list to provide a system for mapping which properties should (no
t) be written to XML. In the respective addProperties member functions checks have bee
n added and some properties are banned if we are an auto window.
Added: Default resource group support to Xerces for use when loading schema files.
Added: Default resource group support to ScriptingModule, and implemented it's use in
the CEGUILua module.
Added: DynamicModule class to wrap access to a dynamically linked / loaded module.
Added: New dynamic libraries for Xerces, Expat TinyXMLParser, and libxml Parsers.
Added: TextProperty and FontProperty elements for Falagard text components.
Added: New ItemListBase based ItemListbox widget. For Window based listbox items.
Added: XML Serialization class for all XML writing.
Added: Recursive versions of Window::getChild and isChild by ID. They are called getCh
ildRecursive and isChildRecursive. Reason for the explicit naming is that it's a prett
y expensive operation and should not be used unless necessary.
Added: Lots of missing members in the Lua bindings.
Added: setlocale(LC_NUMERIC, "C"); to the System constructor as we depend on this beha
viour.
Added: setVisible member to CEGUI::MouseCursor.
Added: bat files to make it easier for Windows users to regenerate the Lua bindings an
d tolua++cegui.
Added: ImageCodec support to the OpenGL renderer. This allows users to easily write a
custom image loader. TGA, SILLY, DevIL, Corona and FreeImage codecs are supplied.
Added: const version of getDataPtr in RawDataContainer.
Added: premake scripts to generate MSVC solutions.
Added: ClippedContainer for situations where more specialized clipping is required.

Modified: Placed the integrated TinyXML into its own namespace (CEGUITinyXML) to preve
nt clashes in projects using another copy of TinyXML. (Patch #1294002).
Modified: Changed EventSet to operate without needing events to be pre-added, much lik
e GlabalEventSet always did.
Modified: Removal of mass pre-specification of events for all classes using events.
Modified: Cflags to add include dir for CEGUI in CEGUI.pc.in (allows use of <CEGUI/...
> form of include statement).
Modified: The "Lua and tolua++" module has been made a DLL on Windows machines.
Modified: Renamed System::setTooltip to System::setDefaultTooltip (Mantis #1Cool.
Modified: In the lua module, updated Window with casting helpers as member functions.
eg. w:toFrameWindow()
Modified: Removed the Static,StaticText and StaticImage from CEGUIBase and implemented
them in FalagardBase instead.
Modified: Updated to tolua++ 1.0.92
Modified: Moved LuaFunctor into its own files
Modified: Reimplemented the "late binding" effect from the v04 Lua module. In v04 the
function is always looked up by name. In CVS HEAD the actual Lua function is reference
d, but now this will only occur the first time the event is triggered. This means that
it's no longer necessary to have a function defined to subscribe it to an event. As l
ong as the function has been created before the event occurs everything will be good S
mile
Modified: Moved subscribeScriptedEvent into ScriptModule to allow more customized scri
pt subscription functionality.
Modified: Made the layout XML handler use subscribeScriptedEvent for Event tags instea
d of subscribeEvent with ScriptFunctor
Modified: Removal of "tolua_outside" stuff that was no longer needed.
Modified: Moved the declaration/definition of base window factories into its own files
.
Modified: Removal of WidgetSets folder, and it's contents.
Modified: Removed unnecessary getSingleton and getSingletonPtr from manager classes.
Modified: The script module now throws ScriptException.
Modified: Removal of TextItem as falagard now handles that exclusively.
Modified: Moved all rendering member functions out of base classes an into Falagard re
ndering classes.
Modified: Removal of virtually all rendering and layout related Window properties from
CEGUIBase - a few are moved to FalagardBase, the rest must be implemented via XML.
Modified: Removal of TaharezLook and WindowsLook modules from the system.
Modified: Removal of MetricsMode system, and all non-unified interface and properties
from Window (and related fixes to other classes).
Modified: Elimination of RenderableElement and derived classes.
Modified: Moved to a C preprocessor macro system for widget module creation.
Modified: Removal of abstract createXXX methods from widget base classes - the looknfe
el system now auto-creates these widgets when specified within the XML.
Modified: Updated to TinyXML 2.4.3 in order to allow CDATA section in XML text node (v
erbatim text)
Modified: GUILayout handler in order to support long value in properties.
Modified: Made the XML writing system aware of falagard when determining property defa
ult values.
Modified: Switched PropertyHelper to use std::ostringstream as the output is much nice
r. Changed property default values to the new format where needed.
Modified: Better error reporting for dynamic module load failures.
Modified: Switched to using external pcre library. Removed embedded copy of pcre.
Modified: Switched system to use dynamic libs for XML parsers with programatically con
figurable default.
Modified: FactoryModule to use DynamicModule.
Modified: Resolved issue with unneeded member qualification (Patch #1454773).
Modified: Made String::ptr a public member.
Modified: The bundled tolua++cegui binding generator will now generate a lua_CEGUI.cpp
that compiles out-of-the-box on Windows
Modified: Removed the DataContainer template class, and made it into just RawDataConta
iner, non templated.
Modified: Optimized FalagardMultiLineEditbox to only cache visible lines when renderin
g.
Modified: Optimized ButtonBase and MenuItem updateInternalState. Mantis #44
Modified: Moved the renderers to their own folder named RendererModules.
Modified: Optimized picking and rendering by caching screen space rectangles.
Modified: Applied zap's rewrite of the Font system. Patch #1508321
Modified: Texture::loadFromMemory now takes a Texture::PixelFormat parameter. RGB and
RGBA are currently required. Fixes Patch #1455523 as well. 3rd party renderer modules
needs to be updated.

Bug fix: OpenGLRenderer was producing errors and not cleaning up state changes properl
y (thanx muhkuh25)
Bug fix: OpenGLRenderer was broken when compiled for x86-64.
Bug Fix: ListboxItem::getOwnerWindow should be const
Bug Fix: ListboxItem::getOwnerWindow should not take a Window* argument.
Bug Fix: Scheme::resourcesLoaded was always returning true.
Bug Fix: PropertyHelper::stringToImage was not handling empty string case.
Bug Fix: Editbox::onCharacter was setting the event as handled even if nothing was don
e.
Bug Fix: Added shift/ctrl/alt support to the OpenGL sample driver (injects LeftXXX)
Bug Fix: The command line renderer selector does no longer ask if there is only one re
nderer available.
Bug Fix: Fixed window resizing for the OpenGL Sample driver.
Bug Fix: fixed const correctness for "String::utf8_stream_len" SF patch #1367423
Bug Fix: Detect "window->addChildWindow(window);" and do nothing instead of actually t
rying.
Bug Fix: Added missing performChildWindowLayout to Scrollbar::onScrollConfigChanged to
allow making a look'n'feel with a thumb that sizes to indicate document size.
Bug fix: const correctness for Window::getLookNFeel
Bug fix: FrameWindow, isTitlebarEnabled and isCloseButtonEnabled were return the oppos
ite of what they should.
Bug Fix: FrameWindow should do relayout if text changes to allow using a fontdim in th
e titlebar dimensions.
Bug Fix: Changing the default mouse cursor in the System object will now update the cu
rsor immediately where appropriate. (Ticket #17).
Bug Fix: Fixed case in StaticText where default text area was always used if frame was
disabled.
Bug Fix: Image offsets were'nt being properly handled for the corners in FrameComponen
t.
Bug Fix: MultiColumnList would always use item string when sorting, instead of vitual
operators on users custom items.
Bug Fix: System::getWindowContainingMouse would return incorrect Window if called from
within Window::EventMouseLeaves handlers.
Bug Fix: Order of static data creation in C++ is unspecified; we can't have globally d
efined static data that relies on other such static data within the same module.
Bug Fix: Falagard/ProgressBar was broken when vertical or reversed-horizontal.
Bug Fix: Corruption of window registry when rename failed (Patch #1450623).
Bug Fix: Initialisation issue with TabControl trying to access child widgets before th
ey are created. (Patch #1391727).
Buf Fix: CEGUI::Window::setModalState(true) removes the modal state from a modal windo
w. Mantis #42
Bug Fix: MultiColumnList getNextSelection bug. Mantis #47
Bug Fix: System subscriber to renderer event but does not unsubscribe on destruction.
Mantis #48
Bug Fix: OpenGL and DirectX9 renderers were not handling error correctly when creating
textures.
Bug Fix: Bug in LuaScriptModule where executeScriptFile did not unload the file data b
uffer correctly in case of an exception (thanks gcarlton).
Bug Fix: A bug in ItemListBase::resetList_impl where calling resetList would crash (th
anks Turtle).
Bug Fix: Typo in TabPane::testClassName_impl ("Tabpane" instead of "TabPane").
Bug Fix: Big Endian inconsistency in CEGUI::colour.
Bug Fix: CEGUI::Window was not detaching the tooltip during destruction. Mantis #38
Bug Fix: FrameWindow was consuming all LeftButton up events. Down events were affected
as well, and now only consume if the event started drag sizing.
Bug Fix: DragContainer would overwrite any new position applied to the DragContainer d
uring the DragDropItemDropped event. Mantis #53
Bug Fix: The OpenGL sample driver could cause a stack overflow. Patch #1507826
</pre>

=Porting Notes=

==Introduction==
The 0.5.0 release of Crazy Eddie's GUI System is the first of what will likely be a series of releases containing breaking changes for client code and data files. We feel these breaking changes are required as we move closer to the 1.0 release of CEGUI, and also as the design and usage patterns for CEGUI change; the results are a generally more streamlined system as we move from one idiom to another, as opposed to becoming more and more bloated due to retaining vast amounts of code and kludges for backward compatibility reasons.

This document is a general overview and guide to the breaking changes between the 0.4.x series of releases and the 0.5.0 release. As and when other breaking releases are made, additional documentation will be provided as necessary.

==Changes and Porting==
This section is intended as a general overview of the breaking changes made. Blah, blah, blah.

===Code Changes===
This sub-section details changes made to the CEGUI system code and API which will affect client code.

====The new WindowRenderer system====
One of the main issues with the previous widget module approach, was that it became exceptionally difficult to sub-class a widget type where some custom behavioural changes or additions were required.
*** TODO ***

====CEGUI::System Constructor====
The overloaded constructors for the main CEGUI::System object have been removed and replaced with a single, unified, constructor. Using the new constructor it is still possible to do all the things that used to be possible, while making the whole system construction process a little more uniform.

The new constructor has the form:
System(Renderer* renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");

As can be seen, the Renderer module is, of course, still mandatory, though you are free to provide all or none of the other optional arguments and passing in 0 where no object, or no custom object, is required.

For the most basic uses of the system, where only the Renderer is passed in, no changes will be required.

====System::setTooltip changed to System::setDefaultTooltip====
The member function
System::setTooltip
has been renamed as
System::setDefaultTooltip
this was a change for API consistency. Update your code to use the new name for this member.

====Window MetricsMode removed====
The concept of a singular 'MetricsMode' for a window is now obsolete and is replaced with the 'Unified' metrics system (which comprises of both a relative 'scale' value and an absolute 'offset' value).

The class members, properties and all associated items affecting MetricsMode have been removed from the system and the use of the Unified metrics system is now mandatory.

====Window Metrics and other conversion members removed====
Member functions in the Window class that were concerned with converting values between the various metric modes have all been removed.
There may still be the need to perform some conversions of co-ordinates, so this functionality is now provided by the external utility class CEGUI::CoordConverter.
Window Size and Positioning

Due to the removal of the MetricsMode concept, and the now mandatory use of 'Unified' co-ordinate values, the means by which you specify size and position is now by using the unified type members.

*getXPosition, getRelativeXPosition and getAbsoluteXPosition members are replaced with getWindowXPosition.
*getYPosition, getRelativeYPosition and getAbsoluteYPosition members are replaced with getWindowYPosition.
*getPosition, getRelativePosition and getAbsolutePosition members are replaced with getWindowPosition.
*getWidth, getRelativeWidth and getAbsoluteWidth members are replaced with getWindowWidth
*getHeight, getRelativeHeight and getAbsoluteHeight members are replaced with getWindowHeight
*getSize, getRelativeSize and getAbsoluteSize members are replaced with getWindowSize
*getRect, getRelativeRect and getAbsoluteRect members are replaced with getWindowArea
*getMaximumSize member is replaced with getWindowMaxSize
*getMinimumSize member is replaced with getWindowMinSize
*setWidth members are replaced with setWindowWidth
*setHeight members are replaced with setWindowHeight
*setSize members are replaced with setWindowSize
*setXPosition members are replaced with setWindowXPosition.
*setYPosition members are replaced with setWindowYPosition.
*setPosition members are replaced with setWindowPosition.
*setAreaRect and setRect members are replaced with setWindowArea
*setMaximumSize member is replaced with setWindowMaxSize
*setMinimumSize member is replaced with setWindowMinSize

====Component Widget creation abstract members====
If you have sub-classed any Window types in order to create a new “Widget Module”, part of your responsibility was to provide implementations for various abstract member functions whose job it was to create the various component widgets required by the container window. These members were typically named createXXX (for example, Combobox::createEditbox).

These abstract member functions and the internal calls to them have all been removed from the system. The component widgets are now specified within the looknfeel xml files are are automatically created by the Falagard looknfeel system as and when required.
You should remove any code that creates these component widgets and add appropriate <Child> tags to your looknfeel xml files instead.

====Component Widget member fields====
If you had sub-classed any of the Window types, either to provide some modified behaviour or perhaps for a “Widget Module” as part of creating a custom look, you would previously have had access to some member variables that held pointers to component widgets of the more complicated widget types (for example, the Scrollbar widget would have held pointers to the two PushButton widgets and the Thumb widget that it was composed of). These members have now been removed and replaced with 'getter' member functions; this is important because in the future the actual Window objects used for these component parts may not be valid for the entire life of the containing Window. That is, the component Windows may get destroyed and re-created, thus invalidating any cached pointers.

The old member variables and the getter function that replaces them are listed here:
*** TODO ***

====RenderableElement, RenderableImage and RenderableFrame classes====
These classes have all been removed from the system entirely. Everything that these classes achieved with regards to rendering for window and widget types can now be done via the Falagard looknfeel system.

For window based rendering, you should remove your use of Renderable* classes in favour of ImageryComponent and FrameComponent elements in your looknfeel xml files.
If you were using the Renderable* classes to perform rendering outside of the window rendering systems, you will now need to find alternative, custom, means to do this.

====Static, StaticImage and StaticText classes====
These classes are now removed from the base system and have been implemented as WindowRenderer classes. Generally, your interface to these widget types should now use a simple default window and the properties system.

The look'n'feel spec for these two widgets have changed as well.

StaticImage:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
- WithFrameImage - image rendering when frame is enabled
- NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present)
</pre>

StaticText:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Named Areas (missing areas will default to 'WithFrameTextRenderArea'):
WithFrameTextRenderArea
WithFrameTextRenderAreaHScroll
WithFrameTextRenderAreaVScroll
WithFrameTextRenderAreaHVScroll
NoFrameTextRenderArea
NoFrameTextRenderAreaHScroll
NoFrameTextRenderAreaVScroll
NoFrameTextRenderAreaHVScroll

</pre>

====Dynamic addition of Events to Windows and other EventSet based objects====
It used to be that all available Event objects would be pre-added to an EventSet when it was constructed. When an Event was accessed which had not been added to the EventSet an appropriate exception was thrown.

This behaviour has now changed. Events are only added to an EventSet when a handler for that event is first subscribed. A side effect of this is that EventSet does now not throw exceptions, either when firing a non-existing Event (now reclassified as simply an event which has no subscribers), or when subscribing to an Event that does not yet exist, since the Event is now automatically created and added to the EventSet.

If your code currently relies on exceptions being thrown by the events system, you will need to change this to a more pro-active approach (by manually checking if an event exists yet), instead of reactive (catching exceptions).

====TinyXML moved to CEGUITinyXML namespace====
If you were for some reason using our integrated copy of TinyXML directly in your application, we have moved this module into the namespace 'CEGUITinyXML'. This was done to avoid clashes and conflicts where the client contained it's own copy of TinyXML.

To continue to directly use the integrated TinyXML, just add the namespace qualifier where appropriate.

If you are just using the TinyXML based implementation of CEGUI::XMLParser, you do not need to change anything.

===Data File Changes===
This sub-section details changes that will affect the xml data files used with CEGUI.

====Updated XSD files for Xerces====
Even the most rudimentary changes to the xml formats we use mean that if you're using the Xerces-C, or other, validating XML parser, then you will need to update you projects to use the new .xsd files. These are collected together for convenience in the XMLRefSchema subdirectory.

=== Falagard Additions ===
From lack of a better place to put this I'll list the additions that have been made to Falagard here.

'''PropertyLinkDefinition'''
New element that will create a property that is a link to another property of a child window.

Attributes:
* type (type, optional and not currently used for anything)
* name (name of the property link)
* widget (name suffix of the child widget to link to)
* targetProperty (the target property to link to. Optional, will default to ''name'' if not given)
* initialValue (starting value for the property. Optional, will default to empty)
* layoutOnWrite (will make the widget redo the child layout when the property is written. Optional, defaults to ''false'')
* redrawOnWrite (will make the widget redraw when the property is written. Optional, default to ''false'')

'''controlProperty'''

New attribute added to ''Section''. Value is the name of a property, and if specified the Section will only render when the property has a value of ''True''.

'''TextComponent'''

Two new sub-elements are now valid for ''TextComponent''.

''TextProperty'', and ''FontProperty''. Must be specified in that order after the (optional) ''Text'' element.
Both have one required attribute ''name'' which takes the name of a property which will contain the text to draw, or the name of the font to use for rendering.

In case these new elements are used along with the ''Text'' element, the string and font specified in the ''Text'' element will be used as defaults if the ''TextProperty'' or ''FontProperty'' evaluates to empty strings.

To be continued...

Changes and Porting Tips for 0.5.0

2006-06-19T21:45:18Z

Dalfy:

Note that this is incomplete, work in progress, documentation.

=Release=

=ChangeLog=

Various internal code cleanups:
- Removal of unrequired utf8* casts on string literals.
- Removed use of NULL macro from the library code.
- Code refactorings to Font class. Removes some instances of repeated code, and makes
some methods shorter / cleaner.
- Split large methods in Scheme into smaller, more managable, chunks.
- Removed all the System constructor overloads and replaced with a single method.
- Removed string literals for component widget names which were scattered throughout t
he widget code.
- Replaced virtually all member fields holding pointers to component widgets with gett
er methods (which basically allows those widgets to be replaced without the parent kno
wing or caring).
- Refactoring of XML handler to remove huge if/else if/else construct.
- Refectored large if / else if / else constructs in all non-falagard XML handlers to
use a member function for each element type (rather than having all code in one huge f
unction).
- Event system has been rewritten from scratch.
- Font system has been rewritten.

Added "PushedOff" rendering state for button based widgets and MenuItem.
Added: Ability to rename windows.
Added: CEGUISamplesConfig.h file to allow configuration of samples framework independe
ntly of the main config (saves recompiling everything just to change some sample setti
ng).
Added: FPS readout to OpenGL base app in the samples framework.
Added: "PropertyLinkDefinition" element for Falagard system.
Added: "controlPropery" attribute to SectionSpecififations under falagard to enable re
nering of section imagery to be controled via a named boolean property.
Added: mouse pass through feature in Window, to ignore mouse events. Nice for making a
DefaultWindow transparent to the mouse regarding picking windows behind it.
Added: MSVC++ auto-linking for Ogre base app in samples framework.
Added: grab/restoreTextures in the OpenGL renderer to cache texture image data, and la
ter restore it.
Added: Abstracted Logger interface to support user created custom loggers. (SF patch #
1414121 by zap)
Added: DefaultLogger implementation (SF patch #1414121 by zap)
Added: page up/down key functionality to MultiLineEditbox (SF patch #1347376 by Dalfy)
Added: small script to recreate the binding generator for tolua++
Added: customized tolua++ binary. For exception handling support in generated binding
code.
Added: missing exception definitions file needed to generate the bindings.
Added: README with instructions on how to generate the bindings.
Added: Documentation for some of the new features in the bundled tolua++ generator.
Added: When subscribing to events from "inside" Lua a self object can be registered as
well to be passed along with the EventArgs.
Added: New WindowRenderer system, replacing previous system where the Window sub-class
controlled the rendering process.
Added: Major update of the LuaScriptModule to support anonymous functions.
Added: Exception handling has been added for some functions.
Added: Falagard derivatives of DefaultWindow, DragContainer and ItemEntry with minimal
StateImagery.
Added: executeEventHandler now accepts functions that are table fields.
Added: Text node support to both parser (Xerces and TinyXML)
Added: AutoWindow tag to xml layouts to fetch a window created by the look'n'feel or t
he base widget itself.
Added: Window::isAutoWindow member that returns true if the window has "__auto_" in it
s name. (a flag is set in the constructor). It's faster than checking the actual strin
g.
Added: A setting to Window to specify that it should never write XML no matter what if
activated. Tooltips get this set by default by System.
Added: A property ban list to provide a system for mapping which properties should (no
t) be written to XML. In the respective addProperties member functions checks have bee
n added and some properties are banned if we are an auto window.
Added: Default resource group support to Xerces for use when loading schema files.
Added: Default resource group support to ScriptingModule, and implemented it's use in
the CEGUILua module.
Added: DynamicModule class to wrap access to a dynamically linked / loaded module.
Added: New dynamic libraries for Xerces, Expat TinyXMLParser, and libxml Parsers.
Added: TextProperty and FontProperty elements for Falagard text components.
Added: New ItemListBase based ItemListbox widget. For Window based listbox items.
Added: XML Serialization class for all XML writing.
Added: Recursive versions of Window::getChild and isChild by ID. They are called getCh
ildRecursive and isChildRecursive. Reason for the explicit naming is that it's a prett
y expensive operation and should not be used unless necessary.
Added: Lots of missing members in the Lua bindings.
Added: setlocale(LC_NUMERIC, "C"); to the System constructor as we depend on this beha
viour.
Added: setVisible member to CEGUI::MouseCursor.
Added: bat files to make it easier for Windows users to regenerate the Lua bindings an
d tolua++cegui.
Added: ImageCodec support to the OpenGL renderer. This allows users to easily write a
custom image loader. TGA, SILLY, DevIL, Corona and FreeImage codecs are supplied.
Added: const version of getDataPtr in RawDataContainer.
Added: premake scripts to generate MSVC solutions.
Added: ClippedContainer for situations where more specialized clipping is required.

Modified: Placed the integrated TinyXML into its own namespace (CEGUITinyXML) to preve
nt clashes in projects using another copy of TinyXML. (Patch #1294002).
Modified: Changed EventSet to operate without needing events to be pre-added, much lik
e GlabalEventSet always did.
Modified: Removal of mass pre-specification of events for all classes using events.
Modified: Cflags to add include dir for CEGUI in CEGUI.pc.in (allows use of <CEGUI/...
> form of include statement).
Modified: The "Lua and tolua++" module has been made a DLL on Windows machines.
Modified: Renamed System::setTooltip to System::setDefaultTooltip (Mantis #1Cool.
Modified: In the lua module, updated Window with casting helpers as member functions.
eg. w:toFrameWindow()
Modified: Removed the Static,StaticText and StaticImage from CEGUIBase and implemented
them in FalagardBase instead.
Modified: Updated to tolua++ 1.0.92
Modified: Moved LuaFunctor into its own files
Modified: Reimplemented the "late binding" effect from the v04 Lua module. In v04 the
function is always looked up by name. In CVS HEAD the actual Lua function is reference
d, but now this will only occur the first time the event is triggered. This means that
it's no longer necessary to have a function defined to subscribe it to an event. As l
ong as the function has been created before the event occurs everything will be good S
mile
Modified: Moved subscribeScriptedEvent into ScriptModule to allow more customized scri
pt subscription functionality.
Modified: Made the layout XML handler use subscribeScriptedEvent for Event tags instea
d of subscribeEvent with ScriptFunctor
Modified: Removal of "tolua_outside" stuff that was no longer needed.
Modified: Moved the declaration/definition of base window factories into its own files
.
Modified: Removal of WidgetSets folder, and it's contents.
Modified: Removed unnecessary getSingleton and getSingletonPtr from manager classes.
Modified: The script module now throws ScriptException.
Modified: Removal of TextItem as falagard now handles that exclusively.
Modified: Moved all rendering member functions out of base classes an into Falagard re
ndering classes.
Modified: Removal of virtually all rendering and layout related Window properties from
CEGUIBase - a few are moved to FalagardBase, the rest must be implemented via XML.
Modified: Removal of TaharezLook and WindowsLook modules from the system.
Modified: Removal of MetricsMode system, and all non-unified interface and properties
from Window (and related fixes to other classes).
Modified: Elimination of RenderableElement and derived classes.
Modified: Moved to a C preprocessor macro system for widget module creation.
Modified: Removal of abstract createXXX methods from widget base classes - the looknfe
el system now auto-creates these widgets when specified within the XML.
Modified: Updated to TinyXML 2.4.3 in order to allow CDATA section in XML text node (v
erbatim text)
Modified: GUILayout handler in order to support long value in properties.
Modified: Made the XML writing system aware of falagard when determining property defa
ult values.
Modified: Switched PropertyHelper to use std::ostringstream as the output is much nice
r. Changed property default values to the new format where needed.
Modified: Better error reporting for dynamic module load failures.
Modified: Switched to using external pcre library. Removed embedded copy of pcre.
Modified: Switched system to use dynamic libs for XML parsers with programatically con
figurable default.
Modified: FactoryModule to use DynamicModule.
Modified: Resolved issue with unneeded member qualification (Patch #1454773).
Modified: Made String::ptr a public member.
Modified: The bundled tolua++cegui binding generator will now generate a lua_CEGUI.cpp
that compiles out-of-the-box on Windows
Modified: Removed the DataContainer template class, and made it into just RawDataConta
iner, non templated.
Modified: Optimized FalagardMultiLineEditbox to only cache visible lines when renderin
g.
Modified: Optimized ButtonBase and MenuItem updateInternalState. Mantis #44
Modified: Moved the renderers to their own folder named RendererModules.
Modified: Optimized picking and rendering by caching screen space rectangles.
Modified: Applied zap's rewrite of the Font system. Patch #1508321
Modified: Texture::loadFromMemory now takes a Texture::PixelFormat parameter. RGB and
RGBA are currently required. Fixes Patch #1455523 as well. 3rd party renderer modules
needs to be updated.

Bug fix: OpenGLRenderer was producing errors and not cleaning up state changes properl
y (thanx muhkuh25)
Bug fix: OpenGLRenderer was broken when compiled for x86-64.
Bug Fix: ListboxItem::getOwnerWindow should be const
Bug Fix: ListboxItem::getOwnerWindow should not take a Window* argument.
Bug Fix: Scheme::resourcesLoaded was always returning true.
Bug Fix: PropertyHelper::stringToImage was not handling empty string case.
Bug Fix: Editbox::onCharacter was setting the event as handled even if nothing was don
e.
Bug Fix: Added shift/ctrl/alt support to the OpenGL sample driver (injects LeftXXX)
Bug Fix: The command line renderer selector does no longer ask if there is only one re
nderer available.
Bug Fix: Fixed window resizing for the OpenGL Sample driver.
Bug Fix: fixed const correctness for "String::utf8_stream_len" SF patch #1367423
Bug Fix: Detect "window->addChildWindow(window);" and do nothing instead of actually t
rying.
Bug Fix: Added missing performChildWindowLayout to Scrollbar::onScrollConfigChanged to
allow making a look'n'feel with a thumb that sizes to indicate document size.
Bug fix: const correctness for Window::getLookNFeel
Bug fix: FrameWindow, isTitlebarEnabled and isCloseButtonEnabled were return the oppos
ite of what they should.
Bug Fix: FrameWindow should do relayout if text changes to allow using a fontdim in th
e titlebar dimensions.
Bug Fix: Changing the default mouse cursor in the System object will now update the cu
rsor immediately where appropriate. (Ticket #17).
Bug Fix: Fixed case in StaticText where default text area was always used if frame was
disabled.
Bug Fix: Image offsets were'nt being properly handled for the corners in FrameComponen
t.
Bug Fix: MultiColumnList would always use item string when sorting, instead of vitual
operators on users custom items.
Bug Fix: System::getWindowContainingMouse would return incorrect Window if called from
within Window::EventMouseLeaves handlers.
Bug Fix: Order of static data creation in C++ is unspecified; we can't have globally d
efined static data that relies on other such static data within the same module.
Bug Fix: Falagard/ProgressBar was broken when vertical or reversed-horizontal.
Bug Fix: Corruption of window registry when rename failed (Patch #1450623).
Bug Fix: Initialisation issue with TabControl trying to access child widgets before th
ey are created. (Patch #1391727).
Buf Fix: CEGUI::Window::setModalState(true) removes the modal state from a modal windo
w. Mantis #42
Bug Fix: MultiColumnList getNextSelection bug. Mantis #47
Bug Fix: System subscriber to renderer event but does not unsubscribe on destruction.
Mantis #48
Bug Fix: OpenGL and DirectX9 renderers were not handling error correctly when creating
textures.
Bug Fix: Bug in LuaScriptModule where executeScriptFile did not unload the file data b
uffer correctly in case of an exception (thanks gcarlton).
Bug Fix: A bug in ItemListBase::resetList_impl where calling resetList would crash (th
anks Turtle).
Bug Fix: Typo in TabPane::testClassName_impl ("Tabpane" instead of "TabPane").
Bug Fix: Big Endian inconsistency in CEGUI::colour.
Bug Fix: CEGUI::Window was not detaching the tooltip during destruction. Mantis #38
Bug Fix: FrameWindow was consuming all LeftButton up events. Down events were affected
as well, and now only consume if the event started drag sizing.
Bug Fix: DragContainer would overwrite any new position applied to the DragContainer d
uring the DragDropItemDropped event. Mantis #53
Bug Fix: The OpenGL sample driver could cause a stack overflow. Patch #1507826

=Porting Notes=

==Introduction==
The 0.5.0 release of Crazy Eddie's GUI System is the first of what will likely be a series of releases containing breaking changes for client code and data files. We feel these breaking changes are required as we move closer to the 1.0 release of CEGUI, and also as the design and usage patterns for CEGUI change; the results are a generally more streamlined system as we move from one idiom to another, as opposed to becoming more and more bloated due to retaining vast amounts of code and kludges for backward compatibility reasons.

This document is a general overview and guide to the breaking changes between the 0.4.x series of releases and the 0.5.0 release. As and when other breaking releases are made, additional documentation will be provided as necessary.

==Changes and Porting==
This section is intended as a general overview of the breaking changes made. Blah, blah, blah.

===Code Changes===
This sub-section details changes made to the CEGUI system code and API which will affect client code.

====The new WindowRenderer system====
One of the main issues with the previous widget module approach, was that it became exceptionally difficult to sub-class a widget type where some custom behavioural changes or additions were required.
*** TODO ***

====CEGUI::System Constructor====
The overloaded constructors for the main CEGUI::System object have been removed and replaced with a single, unified, constructor. Using the new constructor it is still possible to do all the things that used to be possible, while making the whole system construction process a little more uniform.

The new constructor has the form:
System(Renderer* renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");

As can be seen, the Renderer module is, of course, still mandatory, though you are free to provide all or none of the other optional arguments and passing in 0 where no object, or no custom object, is required.

For the most basic uses of the system, where only the Renderer is passed in, no changes will be required.

====System::setTooltip changed to System::setDefaultTooltip====
The member function
System::setTooltip
has been renamed as
System::setDefaultTooltip
this was a change for API consistency. Update your code to use the new name for this member.

====Window MetricsMode removed====
The concept of a singular 'MetricsMode' for a window is now obsolete and is replaced with the 'Unified' metrics system (which comprises of both a relative 'scale' value and an absolute 'offset' value).

The class members, properties and all associated items affecting MetricsMode have been removed from the system and the use of the Unified metrics system is now mandatory.

====Window Metrics and other conversion members removed====
Member functions in the Window class that were concerned with converting values between the various metric modes have all been removed.
There may still be the need to perform some conversions of co-ordinates, so this functionality is now provided by the external utility class CEGUI::CoordConverter.
Window Size and Positioning

Due to the removal of the MetricsMode concept, and the now mandatory use of 'Unified' co-ordinate values, the means by which you specify size and position is now by using the unified type members.

*getXPosition, getRelativeXPosition and getAbsoluteXPosition members are replaced with getWindowXPosition.
*getYPosition, getRelativeYPosition and getAbsoluteYPosition members are replaced with getWindowYPosition.
*getPosition, getRelativePosition and getAbsolutePosition members are replaced with getWindowPosition.
*getWidth, getRelativeWidth and getAbsoluteWidth members are replaced with getWindowWidth
*getHeight, getRelativeHeight and getAbsoluteHeight members are replaced with getWindowHeight
*getSize, getRelativeSize and getAbsoluteSize members are replaced with getWindowSize
*getRect, getRelativeRect and getAbsoluteRect members are replaced with getWindowArea
*getMaximumSize member is replaced with getWindowMaxSize
*getMinimumSize member is replaced with getWindowMinSize
*setWidth members are replaced with setWindowWidth
*setHeight members are replaced with setWindowHeight
*setSize members are replaced with setWindowSize
*setXPosition members are replaced with setWindowXPosition.
*setYPosition members are replaced with setWindowYPosition.
*setPosition members are replaced with setWindowPosition.
*setAreaRect and setRect members are replaced with setWindowArea
*setMaximumSize member is replaced with setWindowMaxSize
*setMinimumSize member is replaced with setWindowMinSize

====Component Widget creation abstract members====
If you have sub-classed any Window types in order to create a new “Widget Module”, part of your responsibility was to provide implementations for various abstract member functions whose job it was to create the various component widgets required by the container window. These members were typically named createXXX (for example, Combobox::createEditbox).

These abstract member functions and the internal calls to them have all been removed from the system. The component widgets are now specified within the looknfeel xml files are are automatically created by the Falagard looknfeel system as and when required.
You should remove any code that creates these component widgets and add appropriate <Child> tags to your looknfeel xml files instead.

====Component Widget member fields====
If you had sub-classed any of the Window types, either to provide some modified behaviour or perhaps for a “Widget Module” as part of creating a custom look, you would previously have had access to some member variables that held pointers to component widgets of the more complicated widget types (for example, the Scrollbar widget would have held pointers to the two PushButton widgets and the Thumb widget that it was composed of). These members have now been removed and replaced with 'getter' member functions; this is important because in the future the actual Window objects used for these component parts may not be valid for the entire life of the containing Window. That is, the component Windows may get destroyed and re-created, thus invalidating any cached pointers.

The old member variables and the getter function that replaces them are listed here:
*** TODO ***

====RenderableElement, RenderableImage and RenderableFrame classes====
These classes have all been removed from the system entirely. Everything that these classes achieved with regards to rendering for window and widget types can now be done via the Falagard looknfeel system.

For window based rendering, you should remove your use of Renderable* classes in favour of ImageryComponent and FrameComponent elements in your looknfeel xml files.
If you were using the Renderable* classes to perform rendering outside of the window rendering systems, you will now need to find alternative, custom, means to do this.

====Static, StaticImage and StaticText classes====
These classes are now removed from the base system and have been implemented as WindowRenderer classes. Generally, your interface to these widget types should now use a simple default window and the properties system.

The look'n'feel spec for these two widgets have changed as well.

StaticImage:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
- WithFrameImage - image rendering when frame is enabled
- NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present)
</pre>

StaticText:
<pre>
The LookNFeel should provide the following:

States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Named Areas (missing areas will default to 'WithFrameTextRenderArea'):
WithFrameTextRenderArea
WithFrameTextRenderAreaHScroll
WithFrameTextRenderAreaVScroll
WithFrameTextRenderAreaHVScroll
NoFrameTextRenderArea
NoFrameTextRenderAreaHScroll
NoFrameTextRenderAreaVScroll
NoFrameTextRenderAreaHVScroll

</pre>

====Dynamic addition of Events to Windows and other EventSet based objects====
It used to be that all available Event objects would be pre-added to an EventSet when it was constructed. When an Event was accessed which had not been added to the EventSet an appropriate exception was thrown.

This behaviour has now changed. Events are only added to an EventSet when a handler for that event is first subscribed. A side effect of this is that EventSet does now not throw exceptions, either when firing a non-existing Event (now reclassified as simply an event which has no subscribers), or when subscribing to an Event that does not yet exist, since the Event is now automatically created and added to the EventSet.

If your code currently relies on exceptions being thrown by the events system, you will need to change this to a more pro-active approach (by manually checking if an event exists yet), instead of reactive (catching exceptions).

====TinyXML moved to CEGUITinyXML namespace====
If you were for some reason using our integrated copy of TinyXML directly in your application, we have moved this module into the namespace 'CEGUITinyXML'. This was done to avoid clashes and conflicts where the client contained it's own copy of TinyXML.

To continue to directly use the integrated TinyXML, just add the namespace qualifier where appropriate.

If you are just using the TinyXML based implementation of CEGUI::XMLParser, you do not need to change anything.

===Data File Changes===
This sub-section details changes that will affect the xml data files used with CEGUI.

====Updated XSD files for Xerces====
Even the most rudimentary changes to the xml formats we use mean that if you're using the Xerces-C, or other, validating XML parser, then you will need to update you projects to use the new .xsd files. These are collected together for convenience in the XMLRefSchema subdirectory.

=== Falagard Additions ===
From lack of a better place to put this I'll list the additions that have been made to Falagard here.

'''PropertyLinkDefinition'''
New element that will create a property that is a link to another property of a child window.

Attributes:
* type (type, optional and not currently used for anything)
* name (name of the property link)
* widget (name suffix of the child widget to link to)
* targetProperty (the target property to link to. Optional, will default to ''name'' if not given)
* initialValue (starting value for the property. Optional, will default to empty)
* layoutOnWrite (will make the widget redo the child layout when the property is written. Optional, defaults to ''false'')
* redrawOnWrite (will make the widget redraw when the property is written. Optional, default to ''false'')

'''controlProperty'''

New attribute added to ''Section''. Value is the name of a property, and if specified the Section will only render when the property has a value of ''True''.

'''TextComponent'''

Two new sub-elements are now valid for ''TextComponent''.

''TextProperty'', and ''FontProperty''. Must be specified in that order after the (optional) ''Text'' element.
Both have one required attribute ''name'' which takes the name of a property which will contain the text to draw, or the name of the font to use for rendering.

In case these new elements are used along with the ''Text'' element, the string and font specified in the ''Text'' element will be used as defaults if the ''TextProperty'' or ''FontProperty'' evaluates to empty strings.

To be continued...