FAQ - Revision history

Thomas at 23:37, 26 June 2014

2014-06-26T23:37:16Z

Capek: Bot: Fixing redirects

2011-03-03T23:36:08Z

Bot: Fixing redirects

Capek: Experiment to make the wiki more interlinked

2011-03-03T23:15:42Z

Experiment to make the wiki more interlinked

Capek: Robot: Cosmetic changes

2011-02-26T15:08:13Z

Robot: Cosmetic changes

Kulik: removed session id from the link

2010-10-01T09:18:01Z

removed session id from the link

Kulik: /* You mentioned something about "supported rendering systems", what's that all about and which systems are supported? */

2010-10-01T09:17:19Z

‎You mentioned something about "supported rendering systems", what's that all about and which systems are supported?

Rackle: /* What properties are available for use in XML layouts, and what format do I use for the value strings? */

2008-01-02T23:56:52Z

‎What properties are available for use in XML layouts, and what format do I use for the value strings?

Rackle: /* (How) can I create a menu ? */

2008-01-02T23:49:12Z

‎(How) can I create a menu ?

Pompei2 at 12:24, 2 August 2007

2007-08-02T12:24:30Z

Billfur at 06:22, 11 May 2007

2007-05-11T06:22:25Z

@@ Line 173: / Line 173: @@
 If you start at the documentation for the base Property class ([http://www.cegui.org.uk/api_reference/classCEGUI_1_1Property.html Property base]), you will get an inheritance diagram showing all properties in the system. When you click one, you'll get its page. Each page has a description of the format in which you should provide its value.
-Besides, as an overview, each widget has its properties placed within an appropriately named C++ namespace within the [http://www.cegui.org.uk/api_reference/namespaces.html namespaces section of the API reference].
+Besides, as an overview, each widget has its properties placed within an appropriately named C++ namespace within the [http://static.cegui.org.uk/docs/current/namespaces.html namespaces section of the API reference].
 Also, remember that properties are inherited. So for example, when looking up properties for a PushButton, also check the properties for ButtonBase and Window too - since these properties are also available to you.

@@ Line 177: / Line 177: @@
 Also, remember that properties are inherited. So for example, when looking up properties for a PushButton, also check the properties for ButtonBase and Window too - since these properties are also available to you.
-The [[PropertyFinder]] tool generates a list of the properties for every widget. Lists of properties for the [[SetProperty|Taharez]] and [[SetProperty (WindowsLook)|Windows]] schemes are available online.
+The [[PropertyFinder]] tool generates a list of the properties for every widget. Lists of properties for the [[Property reference for TaharezLook|Taharez]] and [[Property reference for WindowsLook|Windows]] schemes are available online.
 === (How) can I create a menu ? ===
 Yes you can. Rackle wrote [http://www.cegui.org.uk/wiki/index.php?title=MenuAndPopup an article] about how to create menus, submenus and popup menus, including some code.

@@ Line 12: / Line 12: @@
 However, from 0.5 on the library is released under the [http://www.opensource.org/licenses/mit-license.php MIT] license, which is less restrictive then LGPL. You may for example statically link to libraries. The main reason for this switch is the fact that the Ogre3D project has started to provide dual licensing to allow console development. And in order to keep CEGUI as their preferred GUI system, we have switched as well.
-=== What is the situation with the Falagard components and the Creative Commons license? ===
+=== What is the situation with the [[Falagard]] components and the Creative Commons license? ===
-There is no situation! The Creative Commons license only applies to the documentation where that notice appears; the source code, libraries, and all other materials relating to the Falagard skinning system are licensed under LGPL or MIT (depending upon the version; see above).
+There is no situation! The Creative Commons license only applies to the documentation where that notice appears; the source code, libraries, and all other materials relating to the [[Falagard]] skinning system are licensed under LGPL or MIT (depending upon the version; see above).
-=== Why is the Falagard documentation licensed separately? Why is it not LGPL/MIT like the rest of the library? ===
+=== Why is the [[Falagard]] documentation licensed separately? Why is it not LGPL/MIT like the rest of the library? ===
 Originally that documentation was only to be available as a PDF file intended for self-printing into a mini-book, and the "this work" portion of the license notification applies to the text of that book; the documentation is considered a separate work from the code / library itself, and so it licensed separately.

@@ Line 13: / Line 13: @@
 === What is the situation with the Falagard components and the Creative Commons license? ===
-There is no situation!  The Creative Commons license only applies to the documentation where that notice appears; the source code, libraries, and all other materials relating to the Falagard skinning system are licensed under LGPL or MIT (depending upon the version; see above).
+There is no situation! The Creative Commons license only applies to the documentation where that notice appears; the source code, libraries, and all other materials relating to the Falagard skinning system are licensed under LGPL or MIT (depending upon the version; see above).
-=== Why is the Falagard documentation licensed separately?  Why is it not LGPL/MIT like the rest of the library? ===
+=== Why is the Falagard documentation licensed separately? Why is it not LGPL/MIT like the rest of the library? ===
 Originally that documentation was only to be available as a PDF file intended for self-printing into a mini-book, and the "this work" portion of the license notification applies to the text of that book; the documentation is considered a separate work from the code / library itself, and so it licensed separately.
@@ Line 67: / Line 67: @@
 === What is the Mk-1 version of CEGUI? ===
 The Mk-1 version was a Windows®/DirectX® only library and was really a dry run for what became the Mk-2 system. There was only ever 'alpha' versions of the Mk-1 code, and it is now considered obselete and is not supported.
 === I am having major troubles integrating CEGUI with my project, will you do it for me? ===
@@ Line 73: / Line 73: @@
 === I have (or think I have) found a bug. How should I proceed? ===
-If you are certain that it's a bug and not, for example, a misunderstanding of what is happening, then the bug should be reported via the [http://www.cegui.org.uk/mantis/index.php | Mantis Tracker] However, before submitting a bug to the tracker, it is asked that you first do a quick search to see if the bug has already been reported. If you are unsure whether something is a bug or not, then it may be discussed on the web site forums prior to submitting a bug report to the project bug tracker.
+If you are certain that it's a bug and not, for example, a misunderstanding of what is happening, then the bug should be reported via the [http://www.cegui.org.uk/mantis/index.php Mantis Tracker] However, before submitting a bug to the tracker, it is asked that you first do a quick search to see if the bug has already been reported. If you are unsure whether something is a bug or not, then it may be discussed on the web site forums prior to submitting a bug report to the project bug tracker.
 === I notice that feature/widget 'X' is missing. Will this be added to CEGUI? ===
@@ Line 160: / Line 160: @@
   </Imageset>
-What this does is define an Imageset using the backdrop.tga. A single image "Backdrop" is defined that starts at location (0,0) and is 1024 x 768 in size. You should be careful in that the source image file should have dimensions that are powers of two - this is because the image is loaded as a texture, and may be stretched if the powers-of-two requirement is not observed.<br>
+What this does is define an Imageset using the backdrop.tga. A single image "Backdrop" is defined that starts at location (0,0) and is 1024 x 768 in size. You should be careful in that the source image file should have dimensions that are powers of two - this is because the image is loaded as a texture, and may be stretched if the powers-of-two requirement is not observed.<br />
 Once you have your imageset defined, you can load it either by adding a reference to it in whichever scheme you are loading, or manually using the ImagesetManager:
   CEGUI::ImagesetManager::getSingleton().createImageset("myImageset.imagset");
 Once the thing is loaded, you set the image into the StaticImage like so:
   myStaticImage->setImage("BackdropImageset", "Backdrop");
-Notice that the names we specify here are the ones that were originally specified in the imageset XML file.<br>
+Notice that the names we specify here are the ones that were originally specified in the imageset XML file.<br />
 === I can't see the items I've added to my Combobox, how do I get the list to show when I press the button? ===
-The height you specify for the combobox widget includes the height of the drop down list; it's not just for the 'Editbox' portion of the widget (the height of which  is usually automatically determined based upon the font).  Ensure that when specifying the height for your combobox, you have provided sufficient space for the list to appear.
+The height you specify for the combobox widget includes the height of the drop down list; it's not just for the 'Editbox' portion of the widget (the height of which is usually automatically determined based upon the font). Ensure that when specifying the height for your combobox, you have provided sufficient space for the list to appear.
 === What properties are available for use in XML layouts, and what format do I use for the value strings? ===
@@ Line 175: / Line 175: @@
 Besides, as an overview, each widget has its properties placed within an appropriately named C++ namespace within the [http://www.cegui.org.uk/api_reference/namespaces.html namespaces section of the API reference].
-Also, remember that properties are inherited.  So for example, when looking up properties for a PushButton, also check the properties for ButtonBase and Window too - since these properties are also available to you.
+Also, remember that properties are inherited. So for example, when looking up properties for a PushButton, also check the properties for ButtonBase and Window too - since these properties are also available to you.
-The [[PropertyFinder]] tool generates a list of the properties for every widget.  Lists of properties for the [[SetProperty |Taharez]] and [[SetProperty (WindowsLook) |Windows]] schemes are available online.
+The [[PropertyFinder]] tool generates a list of the properties for every widget. Lists of properties for the [[SetProperty|Taharez]] and [[SetProperty (WindowsLook)|Windows]] schemes are available online.
 === (How) can I create a menu ? ===
 Yes you can. Rackle wrote [http://www.cegui.org.uk/wiki/index.php?title=MenuAndPopup an article] about how to create menus, submenus and popup menus, including some code.

@@ Line 76: / Line 76: @@
 === I notice that feature/widget 'X' is missing. Will this be added to CEGUI? ===
-Requests for new features and/or widgets are welcomed in this forum: http://www.cegui.org.uk/phpBB2/viewforum.php?f=3&sid=587eedf3463c00490686f8cddc61a257
+Requests for new features and/or widgets are welcomed in this forum: http://www.cegui.org.uk/phpBB2/viewforum.php?f=3
 This is the best way because most people will read it, including the team. This helps others to give input as well, which migth result in clearly defined requests.

@@ Line 52: / Line 52: @@
 === You mentioned something about "supported rendering systems", what's that all about and which systems are supported? ===
-CEGUI can be used with various rendering systems. There are currently CEGUI renderer modules for Microsoft® DirectX® 8.1 and 9, OpenGL, the Ogre engine, and the Irrlicht engine.
+CEGUI can be used with various rendering systems. There are currently CEGUI renderer modules for Microsoft® DirectX® 9, 10 and 11, OpenGL, the Ogre engine, and the Irrlicht engine (CEGUI 0.7). DirectFB renderer is available but experimental. A null renderer is also available but not very useful for end applications.
 === There is no renderer module for my rendering engine or API of choice, will other rendering system be supported? ===

← Older revision		Revision as of 23:49, 2 January 2008
Line 180:		Line 180:

	=== (How) can I create a menu ? ===		=== (How) can I create a menu ? ===
−	~~Yes you can. Rackle wrote~~ [http://www.cegui.org.uk/wiki/index.php?title=MenuAndPopup an article] about ~~how to create~~ menus, submenus and popup menus, including some code.	+	Read this [http://www.cegui.org.uk/wiki/index.php?title=MenuAndPopup article] about creating menus, submenus and popup menus, including some code.

← Older revision		Revision as of 12:24, 2 August 2007
Line 178:		Line 178:

	An [http://www.cegui.org.uk/wiki/index.php/SetProperty overview of all properties of every widget], with a short description of each property has been automatically generated by [http://www.cegui.org.uk/wiki/index.php?title=PropertyFinder Rackle's PropertFinder]		An [http://www.cegui.org.uk/wiki/index.php/SetProperty overview of all properties of every widget], with a short description of each property has been automatically generated by [http://www.cegui.org.uk/wiki/index.php?title=PropertyFinder Rackle's PropertFinder]
		+
		+	=== (How) can I create a menu ? ===
		+	Yes you can. Rackle wrote [http://www.cegui.org.uk/wiki/index.php?title=MenuAndPopup an article] about how to create menus, submenus and popup menus, including some code.

@@ Line 8: / Line 8: @@
 === How is CEGUI licensed? ===
-Up and until version 0.4.1, CEGUI '''is''' licenced under [http://www.gnu.org/licenses/lgpl.html LGPL], which basically means you can dynamically link to it (ie. use it as a library) in a non-GPL project, as long as you fulfil the other requirements of the LGPL.
+Up and until version 0.4.1, CEGUI '''is''' licensed under [http://www.gnu.org/licenses/lgpl.html LGPL], which basically means you can dynamically link to it (ie. use it as a library) in a non-GPL project, as long as you fulfill the other requirements of the LGPL.
-However, from 0.5 on the library is released under the [http://www.opensource.org/licenses/mit-license.php MIT] licence, which is less restrictive then LGPL. You may for example statically link to libraries. The main reason for this switch is the fact that the Ogre3D project has started to provide dual licensing to allow console development. And in order to keep CEGUI as their preferred GUI system, we have switched as well.
+However, from 0.5 on the library is released under the [http://www.opensource.org/licenses/mit-license.php MIT] license, which is less restrictive then LGPL. You may for example statically link to libraries. The main reason for this switch is the fact that the Ogre3D project has started to provide dual licensing to allow console development. And in order to keep CEGUI as their preferred GUI system, we have switched as well.
 === What is the situation with the Falagard components and the Creative Commons license? ===
 There is no situation!  The Creative Commons license only applies to the documentation where that notice appears; the source code, libraries, and all other materials relating to the Falagard skinning system are licensed under LGPL or MIT (depending upon the version; see above).
-=== Why is the Falagard documentation licensed seperately?  Why is it not LGPL/MIT like the rest of the library? ===
+=== Why is the Falagard documentation licensed separately?  Why is it not LGPL/MIT like the rest of the library? ===
-Originally that documentation was only to be available as a PDF file intended for self-printing into a mini-book, and the "this work" portion of the license notification applies to the text of that book; the documentation is considered a seperate work from the code / library itself, and so it licensed seperately.
+Originally that documentation was only to be available as a PDF file intended for self-printing into a mini-book, and the "this work" portion of the license notification applies to the text of that book; the documentation is considered a separate work from the code / library itself, and so it licensed separately.
 === How much does CEGUI cost? ===
@@ Line 61: / Line 61: @@
 === Why doesn't CEGUI collect its own inputs? Why do I need to inject the inputs myself? ===
-CEGUI does not collect its own input so that the system can remain as flexible as possible. We didn't want to tie people down to one system or input library.
+CEGUI does not collect its own input so that the system can remain as flexible as possible. We don't want to tie people down to one system or input library.
 === I have seen mention of a Lua scripting module, how can I get this? ===
 The Lua scripting module is provided with CEGUI and resides in the same source repository. Downloading CEGUI binary/source/svn will get you everything you need.
-=== I can't find many of the things you talk about in my crayzedsgui code, what's wrong? ===
+=== What is the Mk-1 version of CEGUI? ===
-You probably have one of the older Mk-1 alpha releases. Get the newer Mk-2 releases instead, the archive files for these generally have names with cegui_mk2 in them.
+The Mk-1 version was a Windows®/DirectX® only library and was really a dry run for what became the Mk-2 system. There was only ever 'alpha' versions of the Mk-1 code, and it is now considered obselete and is not supported.
-−
-=== Why are there two versions of the system? ===
-The Mk-1 version was a Windows®/DirectX® only library and was really a dry run for what became the Mk-2 system. There was only ever 'alpha' versions of the Mk-1 code, so it was never anywhere near finished.
-−
-=== Are the Mk-1 and Mk-2 systems interface compatible? ===
-No. The interfaces of the two systems are totally different, although many of the general concepts have remained the same.
-−
-=== The Mk-1 system is so much more lightweight than the Mk-2 system. Can I still use the Mk-1 code? Is the Mk-1 code still being developed and supported? ===
-Short Answer: Not really.
-−
-Long Answer: There were too many weak areas within the Mk-1 system and development on this version has ceased completely. There is no longer any support for the Mk-1 version; in general it would be better for everyone if they migrated to the Mk-2 version of the system.
 === I am having major troubles integrating CEGUI with my project, will you do it for me? ===
-No. The CEGUI developers have enough to do without writing users projects for them. Follow the Howto's and Tutorials from the home page.
+No. The CEGUI developers have enough to do without writing users projects for them. Refer to the Howto's and Tutorials from the home page.
 === I have (or think I have) found a bug. How should I proceed? ===
@@ Line 95: / Line 84: @@
 Each new member gets added by invitation by the current team. Most probably because that person has contributed some valuable patches, or is of great help in the forums. It will of course depend on the current state of the project to know which positions are required.
-So the best way to become involved is to show your face at the web site forums, the irc channel, and state what your intentions are (to help in avoiding duplicated effort), thereby becoming a constructive individual for CEGUI and its community. And some patches are a huge pro!
+So the best way to become involved is to show your face at the web site forums, the irc channel, and state what your intentions are (to help in avoiding duplicated effort), thereby becoming a constructive individual for CEGUI and its community.
 === Is there managed code / Microsoft .Net support for the CEGUI library? ===