Difference between revisions of "Overview of GUI files"

From CEGUI Wiki - Crazy Eddie's GUI System (Open Source)
Jump to: navigation, search
m (Link to ImagesetManager API doc)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
There are a lot of files that go into creating a GUI with CEGUI. Here is an overview (thanks to lindquist for the original version). An expanded version of this brief overview would be quite useful.
+
There are a lot of files that go into creating a GUI with CEGUI. Here is an overview (thanks to lindquist for the original version). An expanded version of this brief overview would be quite useful.
  
==Overview of CEGUI resource files==
+
== Overview of CEGUI resource files ==
==='''.imageset Files'''===
+
=== '''.imageset Files''' ===
 
An imageset is an xml file describing a set of images contained in an image file.
 
An imageset is an xml file describing a set of images contained in an image file.
When an imageset is loaded, images from that file become available to the application via the [http://www.cegui.org.uk/api_reference/classCEGUI_1_1ImagesetManager.html ImagesetManager].
+
When an imageset is loaded, images from that file become available to the application via the [http://static.cegui.org.uk/docs/current/classCEGUI_1_1ImageManager.html ImageManager].
  
Editor: [http://www.cegui.org.uk/phpBB2/viewtopic.php?t=1346 CEImagesetEditor in the works by Martignasse.]
+
Editor: [[CEED]]
  
==='''[[Scheme files|.scheme Files]]'''===
+
=== '''[[Scheme files]]''' ===
A scheme file is an xml file describing the binding of widgets defined in a looknfeel file and the base Falagard widget set. Once loaded the component in the scheme file are available via the WindowManager. A detailed description of [[Scheme files]] is also available.
+
A scheme file is an xml file describing the binding of widgets defined in a looknfeel file and the base Falagard widget set. Once loaded the components in the scheme file are available via the [http://static.cegui.org.uk/docs/current/classCEGUI_1_1WindowManager.html WindowManager]. A detailed description of [[Scheme files]] is also available.
  
 
Editor: none
 
Editor: none
  
 
+
=== '''.looknfeel Files''' ===
==='''.looknfeel Files'''===
+
 
These are also xml files, which define the visual aspect of widgets declared in the scheme file.
 
These are also xml files, which define the visual aspect of widgets declared in the scheme file.
  
Line 20: Line 19:
  
  
==='''.layout Files'''===
+
=== '''.layout Files''' ===
A layout file is also in xml format. It describes a set of widgets to create and their positions, sizes, and other attributes. Basically this describes the final on-screen layout of your GUI, hence the name.
+
A layout file is also in xml format. It describes a set of widgets to create and their positions, sizes, and other attributes. Basically this describes the final on-screen layout of your GUI, hence the name.
  
Editor: [[The_"official"_layout_editor]]
+
Editor: [[CEED]]
  
  
==='''.font Files'''===
+
=== '''.font Files''' ===
 
These simple xml files give the location of a font file (like a TrueType .ttf file) and define a few extra properties about how CEGUI should use that font.
 
These simple xml files give the location of a font file (like a TrueType .ttf file) and define a few extra properties about how CEGUI should use that font.
  
Line 32: Line 31:
  
  
==About [[%22Falagard%22_Skinning_System_Documentation | Falagard]]==
+
== About Falagard Skinning System ==
Falagard is the part of the API that makes it possible to create a completly new set of widgets (at the visual level) from xml files.
+
Falagard is the part of the API that makes it possible to create a completely new set of widgets (at the visual level) from XML files.
  
 
You can, with a looknfeel, describe a widget and make it appear as you want (by using images defined in some imageset) and finally bind it to one of the widgets from a Falagard Base widget set in a scheme file.
 
You can, with a looknfeel, describe a widget and make it appear as you want (by using images defined in some imageset) and finally bind it to one of the widgets from a Falagard Base widget set in a scheme file.
  
Link: [[%22Falagard%22_Skinning_System_Documentation | Falagard documentation]]
+
Link: [http://static.cegui.org.uk/docs/current/fal_man.html Falagard skinning system for CEGUI]
  
==Related Documents==
+
== Related Documents ==
 
* [[XML File formats]] - Detailed documentation of the various XML file formats.
 
* [[XML File formats]] - Detailed documentation of the various XML file formats.
 +
 +
[[Category:Manuals]]

Latest revision as of 14:46, 16 July 2014

There are a lot of files that go into creating a GUI with CEGUI. Here is an overview (thanks to lindquist for the original version). An expanded version of this brief overview would be quite useful.

Overview of CEGUI resource files

.imageset Files

An imageset is an xml file describing a set of images contained in an image file. When an imageset is loaded, images from that file become available to the application via the ImageManager.

Editor: CEED

Scheme files

A scheme file is an xml file describing the binding of widgets defined in a looknfeel file and the base Falagard widget set. Once loaded the components in the scheme file are available via the WindowManager. A detailed description of Scheme files is also available.

Editor: none

.looknfeel Files

These are also xml files, which define the visual aspect of widgets declared in the scheme file.

Editor: none


.layout Files

A layout file is also in xml format. It describes a set of widgets to create and their positions, sizes, and other attributes. Basically this describes the final on-screen layout of your GUI, hence the name.

Editor: CEED


.font Files

These simple xml files give the location of a font file (like a TrueType .ttf file) and define a few extra properties about how CEGUI should use that font.

Editor:


About Falagard Skinning System

Falagard is the part of the API that makes it possible to create a completely new set of widgets (at the visual level) from XML files.

You can, with a looknfeel, describe a widget and make it appear as you want (by using images defined in some imageset) and finally bind it to one of the widgets from a Falagard Base widget set in a scheme file.

Link: Falagard skinning system for CEGUI

Related Documents