Merge branch 'next' of D:\Git_New\flightgear into next

[flightgear.git] / docs-mini / README.gui

diff --git a/docs-mini/README.gui b/docs-mini/README.gui
index 2f6dfe63fd3923e65ee628ee62074f975dd20feb..34f4cbbbf2391f1276d56db796a6dbbefb7ed11e 100644 (file)
--- a/docs-mini/README.gui
+++ b/docs-mini/README.gui
@@ -74,11 +74,17 @@ a simple, "hello world" dialog:
    <width>150</width>
    <height>100</height>
    <modal>false</modal>
+   <draggable>true</draggable>
 
    <text>
     <x>10</x>
     <y>50</y>
     <label>Hello, world</label>
+    <color>
+     <red>1.0</red>
+     <green>0.0</green>
+     <blue>0.0</blue>
+    </color>
    </text>
 
    <button>
@@ -105,10 +111,10 @@ All objects, including the top-level dialog, accept the following
 properties, though they will ignore any that are not relevant:
 
  x - the X position of the bottom left corner of the object, in
-   pseudo-pixels.  The default is 0.
+   pseudo-pixels.  The default is to center the dialog.
 
  y - the Y position of the bottom left corner of the object, in
-   pseudo-pixels.  The default is 0.
+   pseudo-pixels.  The default is to center the dialog.
 
  width - the width of the object, in pseudo-pixels.  The default is
    the width of the parent container.
@@ -116,6 +122,19 @@ properties, though they will ignore any that are not relevant:
  height - the height of the object, in pseudo-pixels.  The default is
    the width of the parent container.
 
+ border - the border thickness, in pseudo-pixels.  The default is 2.
+
+ color - a subgroup to specify the dialogs color:
+  red   - specify the red color component of the color scheme.
+  green - specify the green color component of the color scheme.
+  blue  - specify the blue color component of the color scheme.
+  alpha - specify the alpha color component of the color scheme.
+
+ font - a subgroup to specify a specific font type
+  name - the name of the font (excluding it's .txf extension)
+  size - size of the font
+  slant -  the slant of the font (in pseudo-pixels)
+
  legend - the text legend to display in the object.
 
  label - the text label to display near the object.
@@ -130,8 +149,8 @@ properties, though they will ignore any that are not relevant:
    presses the [RETURN] key.
 
 Objects may appear nested within the top-level dialog or a "group"
-object.  Here are all the object types allowed, with their special
-properties:
+or a "frame" object.  Here are all the object types allowed, with their
+special properties:
 
 
 dialog
@@ -146,6 +165,8 @@ file, since the root element is named PropertyList.
   modal - true if the dialog is modal (it blocks the rest of the
     program), false otherwise.  The default is false.
 
+  draggable - false if the dialog is not draggable. The default is true.
+
 Example:
 
 <PropertyList>
@@ -166,14 +187,17 @@ Example:
 </PropertyList>
 
 
-group
------
+group and frame
+---------------
 
 A group of subobjects.  This object does not draw anything on the
 screen, but all of its children specify their coordinates relative to
 the group; using groups makes it easy to move parts of a dialog
 around.
 
+A frame is a visual representation of a group and has  a border and an
+adjustable background color.
+
 Example:
 
   <group>
@@ -225,6 +249,14 @@ Example:
    <label>Heading</label>
   </text>
 
+  <text>
+   <x>10</x>
+   <y>200</y>
+   <label>-9.9999</label> <!-- placeholder for width -->
+   <format>%-0.4f m</format>
+   <property>/foo/altitude</property>
+  </text>
+
 
 checkbox
 --------
@@ -290,6 +322,27 @@ Example:
   </combo>
 
 
+
+select
+------
+
+A scrollable list of selections.
+
+  selection - a path in the property tree which holds the selectable items.
+
+Example:
+
+  <select>
+   <x>10</x>
+   <y>50</y>
+   <width>200</width>
+   <height>25</height>
+   <property>/sim/aircraft</property>
+   <selection>/sim/aircraft-types</selection>
+  </select>
+
+
+
 slider
 ------
 
@@ -337,5 +390,27 @@ Example:
    <max>360</max>
   </dial>
 
+textbox
+-------
+
+The text will be retrieved/buffered from/within a specified
+property tree, like:
+
+<textbox>
+    <!-- position -->
+    <x>100</x>
+    <y>100</y>
+
+    <!-- dimensions -->
+    <width>200</width> 
+    <height>400</height>
+
+    <property>/gui/path-to-text-node/contents</property>
+
+    <slider>15</slider> <!--width for slider -->
+    <wrap>false</wrap> <!-- don't wrap text; default: true -->
+
+    <editable>true</editable> <!-- whether the puLargeInput is supposed to be editable -->
+</textbox>  
 
 __end__