Scheme files - Revision history

Thomas at 21:36, 25 June 2014

2014-06-25T21:36:44Z

Thomas at 21:36, 25 June 2014

2014-06-25T21:36:17Z

Thomas at 21:33, 25 June 2014

2014-06-25T21:33:11Z

Thomas at 21:32, 25 June 2014

2014-06-25T21:32:53Z

Show changes

Thomas at 23:04, 23 June 2014

2014-06-23T23:04:27Z

Capek: Bot: Automated text replacement (-\[\[(.?)\|.?\]\] +\1)

2011-03-03T23:51:50Z

Bot: Automated text replacement (-\[\[(.*?)\|.*?\]\] +\1)

Capek: Experiment to make the wiki more interlinked

2011-03-03T23:16:31Z

Experiment to make the wiki more interlinked

Capek: Lets use instead of , it is much less typo-prone

2011-02-28T11:22:35Z

Lets use <source> instead of <syntaxhighlight>, it is much less typo-prone

Kulik: yeah I messed up...

2011-02-27T16:32:51Z

yeah I messed up...

Kulik: highlights and categorisation

2011-02-27T16:30:26Z

highlights and categorisation

@@ Line 187: / Line 187: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme version="5" name="MyScheme">
+  <GUIScheme name="MyScheme">
       <Imageset name="MyImages" filename="../datafiles/imagesets/MyImages.imageset" />
       <LookNFeel filename="../datafiles/looknfeel/MySkin.looknfeel" />

@@ Line 60: / Line 60: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       '''<Imageset name="MyImages" filename="../datafiles/imagesets/MyImages.imageset" />'''
   </GUIScheme>
@@ Line 78: / Line 78: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       '''<ImagesetFromFile name="MyBackground" filename="../datafiles/imagesets/MyBackground.tga" />'''
   </GUIScheme>
@@ Line 96: / Line 96: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       '''<Font name="MyFont" filename="../datafiles/fonts/MyFont.font" />'''
   </GUIScheme>
@@ Line 113: / Line 113: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       <Imageset name="MyImages" filename="../datafiles/imagesets/MyImages.imageset" />
       '''<LookNFeel filename="../datafiles/looknfeel/MySkin.looknfeel" />'''
@@ Line 129: / Line 129: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       <Imageset name="MyImages" filename="../datafiles/imagesets/MyImages.imageset" />
       <LookNFeel filename="../datafiles/looknfeel/MySkin.looknfeel" />
@@ Line 165: / Line 165: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       <Imageset name="MyImages" Filename="../datafiles/imagesets/MyImages.imageset" />
       <LookNFeel filename="../datafiles/looknfeel/MySkin.looknfeel" />
@@ Line 187: / Line 187: @@
 <source lang="xml">
   <?xml version="1.0" ?>
-  <GUIScheme name="MyScheme">
+  <GUIScheme version="5" name="MyScheme">
       <Imageset name="MyImages" filename="../datafiles/imagesets/MyImages.imageset" />
       <LookNFeel filename="../datafiles/looknfeel/MySkin.looknfeel" />

@@ Line 9: / Line 9: @@
 This document is largely based on the 'Readme.txt' file in the 'XMLRefSchema' directory of the source distribution by Paul himself.
-__NOTE:__ These XML files are case sensitive, so the XML Elements/Attributes will be written in the case required rather than by capitalization rules.
+'''NOTE:''' These XML files are case sensitive, so the XML Elements/Attributes will be written in the case required rather than by capitalization rules.
 == Document structure ==

← Older revision		Revision as of 23:04, 23 June 2014
Line 32:		Line 32:

	Attributes:		Attributes:
		+	* '''Version''' - specifies the version of the resource file. Should be specified for all files, current CEGUI scheme version is: 5
	* '''Name''' - Specifies the name that the scheme will use within the system. ''Required''.		* '''Name''' - Specifies the name that the scheme will use within the system. ''Required''.

@@ Line 234: / Line 234: @@
 With [[Falagard]] this means that you can totally customize the user interface if the program is properly configured to do so without ever talking to the developers ;)
---[[User:lindquist|lindquist]] 03:49, 14 Dec 2005 (CET)
+--[[User:lindquist]] 03:49, 14 Dec 2005 (CET)
 [[Category:Manuals]]

@@ Line 3: / Line 3: @@
 The scheme file concerns resource loading.
-The first thing most users do when initialising CEGUI, is to load a scheme. This could for example be "../datafiles/schemes/TaharezLookSkin.scheme". This scheme file is probably the most used currently, and will load the Falagard version of classic TaharezLook into the library.
+The first thing most users do when initialising CEGUI, is to load a scheme. This could for example be "../datafiles/schemes/TaharezLookSkin.scheme". This scheme file is probably the most used currently, and will load the [[Falagard]] version of classic TaharezLook into the library.
 If one takes a closer look at this file, they'll see that it is a XML document, ready to be edited... The nice thing here is that it's no longer necessary to recompile, to change the resources to be loaded. Furthermore a scheme acts like a "resource package" as we can unload all resources that is loaded by a scheme given we know its name. From a coding perspective this is nice as it simplifies the resource management. All you have to create/destroy is the scheme it self. CEGUI worries about all the individual resources specified in the XML file for you...
@@ Line 180: / Line 180: @@
 * '''WindowType''' - The name for the new "factory". ''Required''.
 * '''TargetType''' - The name of the target window factory which will have the look'n'feel assigned. ''Required''.
-* '''LookNFeel''' - The name of the look'n'feel to use. That's the WidgetLook name from the Falagard XML. ''Required''.
+* '''LookNFeel''' - The name of the look'n'feel to use. That's the WidgetLook name from the [[Falagard]] XML. ''Required''.
 <source lang="xml">
@@ Line 194: / Line 194: @@
 </source>
-This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to Falagard skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".
+This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to [[Falagard]] skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".
 === FalagardMapping in CEGUI 0.5.X ===
@@ Line 203: / Line 203: @@
 * '''WindowType''' - The name for the new "factory". ''Required''.
 * '''TargetType''' - The name of the target window factory which will have the look'n'feel assigned. ''Required''.
-* '''LookNFeel''' - The name of the look'n'feel to use. That's the WidgetLook name from the Falagard XML. ''Required''.
+* '''LookNFeel''' - The name of the look'n'feel to use. That's the WidgetLook name from the [[Falagard]] XML. ''Required''.
 * '''Renderer''' - Then name of the window renderer factory to use. This module implements the widget rendering code. ''Required''.
@@ Line 218: / Line 218: @@
 </source>
-This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to Falagard skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".
+This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to [[Falagard]] skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".
 === WindowAlias ===
@@ Line 232: / Line 232: @@
 Schemes are especially useful for artists not familiar with C++ programming, as everything you "set up" in the scheme can be used from XML layouts.
-With Falagard this means that you can totally customize the user interface if the program is properly configured to do so without ever talking to the developers ;)
+With [[Falagard]] this means that you can totally customize the user interface if the program is properly configured to do so without ever talking to the developers ;)
 --[[User:lindquist|lindquist]] 03:49, 14 Dec 2005 (CET)
 [[Category:Manuals]]

@@ Line 35: / Line 35: @@
 ''GUIScheme'' is the root element and is the only "global" tag.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 42: / Line 42: @@
       ...
   </GUIScheme>
-</syntaxhighlight>
+</source>
 All schemes will have this XML as all the "magic" goes inside it :-)
@@ Line 55: / Line 55: @@
 * '''ResourceGroup''' - The resource group identifier to pass to the resource provider when loading the file. ''Optional''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
       '''<Imageset Name="MyImages" Filename="../datafiles/imagesets/MyImages.imageset" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 In this example the file "../datafiles/imagesets/MyImages.imageset" must define the imageset named "MyImages".
@@ Line 73: / Line 73: @@
 * '''ResourceGroup''' - The resource group identifier to pass to the resource provider when loading the image file. ''Optional''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
       '''<ImagesetFromFile Name="MyBackground" Filename="../datafiles/imagesets/MyBackground.tga" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 In this example the file "../datafiles/imagesets/MyBackground" is a Targa (.TGA) image file. By default an Imageset loaded like this defines a single image named '''full_image''' that covers the entire texture (the content of the image file).
@@ Line 91: / Line 91: @@
 * '''ResourceGroup''' - The resource group identifier to pass to the resource provider when loading the file. ''Optional''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
       '''<Font Name="MyFont" Filename="../datafiles/fonts/MyFont.font" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 The Font element always loads font XML files. These are not covered here.
@@ Line 108: / Line 108: @@
 * '''ResourceGroup''' - The resource group identifier to pass to the resource provider when loading the file. ''Optional''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 114: / Line 114: @@
       '''<LookNFeel Filename="../datafiles/looknfeel/MySkin.looknfeel" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 Loading a look'n'feel specification is not enough. We must create a FalagardMapping as well. More on this soon. Just know that now the widget looks specified in MySkin.looknfeel are available to falagard mappings. At least the imageset we use in MySkin is available ;-)
@@ Line 124: / Line 124: @@
 * '''Filename''' - Specifies the name of the loadable module (dll / .so / etc). ''Required''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 131: / Line 131: @@
       '''<WindowSet Filename="CEGUIFalagardBase" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 CEGUI 0.4.X provides 3 windowsets. Falagard, WindowsLook and TaharezLook. The above sample code is only valid for CEGUI 0.4.X.
@@ Line 143: / Line 143: @@
 * '''Filename''' - Specifies the name of the loadable module (dll / .so / etc). ''Required''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 150: / Line 150: @@
       '''<WindowRendererSet Filename="CEGUIFalagardWRBase" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 CEGUI 0.5.0 only provides one WindowRendererSet. Falagard. It's perfectly possible to write your own WindowRendererSet in C++. Take a look at the CEGUIFalagardWRBase module if you're curious :)
@@ Line 160: / Line 160: @@
 * '''Name''' - Name of the factory / window type which is to be added.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 169: / Line 169: @@
       </WindowSet>
   </GUIScheme>
-</syntaxhighlight>
+</source>
 In this example we only load the "Falagard/Button" factory. If you only need a few widgets and not the whole set, this could save you some memory.
@@ Line 182: / Line 182: @@
 * '''LookNFeel''' - The name of the look'n'feel to use. That's the WidgetLook name from the Falagard XML. ''Required''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 192: / Line 192: @@
       '''<FalagardMapping WindowType="My/Button" TargetType="Falagard/Button" LookNFeel="MyButton" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to Falagard skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".
@@ Line 206: / Line 206: @@
 * '''Renderer''' - Then name of the window renderer factory to use. This module implements the widget rendering code. ''Required''.
-<syntaxhighlight lang="xml">
+<source lang="xml">
   <?xml version="1.0" ?>
   <GUIScheme Name="MyScheme">
@@ Line 216: / Line 216: @@
       '''<FalagardMapping WindowType="My/Button" TargetType="CEGUI/PushButton" LookNFeel="MyButton" Renderer="Falagard/Button" />'''
   </GUIScheme>
-</syntaxhighlight>
+</source>
 This would be a proper scheme to use the look'n'feel created in [[The Beginners Guide to Falagard skinning - Part I]]. The new type of button window would in this case be available from code or XML layouts by the type name "My/Button".

Scheme files - Revision history

Thomas at 21:36, 25 June 2014

Thomas at 21:36, 25 June 2014

Thomas at 21:33, 25 June 2014

Thomas at 21:32, 25 June 2014

Thomas at 23:04, 23 June 2014

Capek: Bot: Automated text replacement (-\[\[(.*?)\|.*?\]\] +\1)

Capek: Experiment to make the wiki more interlinked

Capek: Lets use instead of , it is much less typo-prone

Kulik: yeah I messed up...

Kulik: highlights and categorisation

Capek: Bot: Automated text replacement (-\[\[(.?)\|.?\]\] +\1)