Merge branch 'master' of ssh://fpgui.git.sourceforge.net/gitroot/fpgui/fpgui

5 files changed, 94 insertions, 44 deletions

diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml
new file mode 100644
index 00000000..137231ce
--- /dev/null
+++ b/docs/xml/gui/fpg_button.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="fpGUI">
+    <module name="fpg_button">
+      <short>This unit defines the push button classes.</short>
+      <element name="TImageLayout">
+        <short>Enum type defining the position of images inside a Button</short>
+      </element>
+      <element name="TImageLayout.ilImageLeft">
+        <short>Image to the left of the button text.</short>
+      </element>
+      <element name="TImageLayout.ilImageTop">
+        <short>Image above the button text.</short>
+      </element>
+      <element name="TImageLayout.ilImageRight">
+        <short>Image to the right of the button text.</short>
+      </element>
+      <element name="TImageLayout.ilImageBottom">
+        <short>Image below the button text.</short>
+      </element>
+      <element name="TfpgBaseButton">
+        <short>Base class the represents a push button control</short>
+      </element>
+      <element name="TfpgBaseButton.ImageLayout">
+        <short>Defines where on the button the image will be displayed</short>
+      </element>
+      <element name="TfpgBaseButton.ImageSpacing">
+        <short>The spacing between the Image and the Text</short>
+        <descr>The <var>ImageSpacing</var> value is in pixels. The value range
+is from -1 to any positive value. -1 has a special meaning and is also the
+default value. When ImageSpacing equals -1, then the spacing between the button
+image and the button text is automatically calculated so that the button text
+is centred in the available horizontal space of the button.</descr>
+      </element>
+      <element name="TfpgBaseButton.ImageName">
+        <short>The registered name of a image to display on the button</short>
+        <descr>
+          <printshort id="TfpgBaseButton.ImageName"/>. This is the name used when
+a image resource was registered with the global <link id="fpg_main.fpgImages">fpgImages</link> instance.</descr>
+      </element>
+
+      <element name="TfpgButton">
+        <short>Concrete button class used in user interfaces</short>
+        <descr><printshort id="TfpgButton"/>. This class is a descendant of <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> and
+simply publishes various properties for runtime type information.</descr>
+        <seealso>
+          <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link>
+        </seealso>
+      </element>
+      <element name="TfpgButton.ImageName" link="TfpgBaseButton.ImageName"/>
+      <element name="TfpgButton.ImageSpacing" link="TfpgBaseButton.ImageSpacing"/>
+      <element name="TfpgButton.ImageLayout" link="TfpgBaseButton.ImageLayout"/>
+
+    </module>
+  </package>
+</fpdoc-descriptions>
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml
index 8a348362..0a88ca1e 100644
--- a/docs/xml/gui/fpg_colormapping.xml
+++ b/docs/xml/gui/fpg_colormapping.xml
@@ -1,30 +1,29 @@
 <?xml version="1.0"?>
 <fpdoc-descriptions>
-  <package name="GUI">
+  <package name="fpGUI">
     <module name="fpg_colormapping">
       <short>This unit contains some color conversion/mapping functions.</short>
       <descr/>
       <element name="RGBToHSV">
         <short>Map RGB colorspace to HSV colorspace.</short>
-        <descr>This function converts a RGB (Red, Green, Blue) colorspace value to HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges. Please see the parameter documentation for more details.</descr>
+        <descr><p>This function converts a RGB (Red, Green, Blue) colorspace value to 
+HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges as
+listed below.</p>
+<dl>
+<dt>Hue</dt>
+<dd>The Hue range is from 0 - 1535. In that range, the primary colors are mapped to the following values. Red = 0. Green = 512 and Blue = 1024.</dd>
+<dt>Saturation</dt>
+<dd>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</dd>
+<dt>Value</dt>
+<dd>The Value value range is from 0.0 to 1.0. Black being 0 and maximum brightness being 1.0.</dd>
+</dl>
+        </descr>
       </element>
       <element name="HSVToRGB">
         <short>Map HSV colorspace to RGB colorspace.</short>
-      </element>
-      <element name="RGBToHSV.Hue">
-        <short>Returned Hue value</short>
-        <descr>The Hue range is from 0 - 1535. In that range, the primary colors are mapped to the following values. Red = 0. Green = 512 and Blue = 1024.</descr>
-      </element>
-      <element name="RGBToHSV.Saturation">
-        <short>Returned Saturation value.</short>
-        <descr>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</descr>
-      </element>
-      <element name="RGBToHSV.Value">
-        <short>Returned Value value.</short>
-        <descr>The Value value range is from 0.0 to 1.0. Black being 0 and maximum brightness being 1.0.</descr>
-      </element>
-      <element name="HSVToRGB.H">
-        <short>Hue value</short>
+        <seealso>
+          <link id="RGBToHSV"/>
+        </seealso>
       </element>
     </module>
   </package>
diff --git a/docs/xml/gui/fpg_colorwheel.xml b/docs/xml/gui/fpg_colorwheel.xml
index 6340555b..0ec24bdf 100644
--- a/docs/xml/gui/fpg_colorwheel.xml
+++ b/docs/xml/gui/fpg_colorwheel.xml
@@ -1,23 +1,23 @@
 <?xml version="1.0"?>
 <fpdoc-descriptions>
-  <package name="GUI">
+  <package name="fpGUI">
     <module name="fpg_colorwheel">
-      <short>The unit contains a ColorWheel and ValueBar component.</short>
-      <descr>
+      <short>The unit contains a ColorWheel and ValueBar component</short>
+      <descr><p><printshort id="fpg_colorwheel"/>.</p>
         <p>
           <b>Using the components:</b>
         </p>
-        <p>Normally, you use both a color wheel and a value bar.

+        <p>Normally, you use both a color wheel and a value bar.
 </p>
         <ol>
           <li>Put a color wheel on your form.</li>
           <li>Put a value bar on your form beside the wheel.</li>
-          <li>Set the ColorWheel's ValueBar property to the ValueBar component

-   you just put on the form.</li>
+          <li>Set the ColorWheel's ValueBar property to the ValueBar component
+you just put on the form.</li>
         </ol>
-        <p>The two components are now linked together. When a selection is

-made in the color wheel the value bar will update to show the range

-for that selection.

+        <p>The two components are now linked together. When a selection is
+made in the color wheel the value bar will update to show the range
+for that selection.
 </p>
         <p>
           <b>Note:</b> you won't see the colors in the UI Designer. Colors will
@@ -25,12 +25,12 @@ only be displayed at runtime.</p>
         <p>
           <b>Reading and setting the color:</b>
         </p>
-        <p>To set the color being displayed, use the SetSelectedColor method

-           of the color wheel.</p>
-        <p>To read the color selected, read the SelectedColor property

-           of the ValueBar.</p>
-        <p>If you want to know when the user picks a color, you

-           can use the OnChange event in the ValueBar.</p>
+        <p>To set the color being displayed, use the SetSelectedColor method
+of the color wheel.</p>
+        <p>To read the color selected, read the SelectedColor property
+of the ValueBar.</p>
+        <p>If you want to know when the user picks a color, you
+can use the OnChange event in the ValueBar.</p>
       </descr>
       <element name="TfpgColorWheel">
         <short>A colorwheel component.</short>
diff --git a/docs/xml/gui/fpg_dialogs.xml b/docs/xml/gui/fpg_dialogs.xml
index 62b43bbb..40b17cde 100644
--- a/docs/xml/gui/fpg_dialogs.xml
+++ b/docs/xml/gui/fpg_dialogs.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <fpdoc-descriptions>
-<package name="GUI">
+<package name="fpGUI">
 
 <module name="fpg_dialogs">
 <short>Various dialogs used by fpGUI based applications.</short>
@@ -85,20 +85,15 @@ When the dialog is opened the file specified is pre selected.
 <!-- property Visibility: public -->
 <element name="TfpgFileDialog.Filter">
 <short>File mask filters available in the dialog.</short>
-<descr>
-<p>
-The filter consists out of two parts separated by a | sign. If more than
+<descr><p>The filter consists out of two parts separated by a | sign. If more than
 one filter needs to be specified each filter is also separated by a | sign.
 The format for a single filter is: &lt;description&gt;|&lt;filemask&gt;
 The format for multiple filters are: &lt;description&gt;|&lt;filemask&gt;|&lt;description&gt;|&lt;filemask&gt;|&lt;description&gt;|&lt;filemask&gt;
 </p>
-<p>
- Example:<br/>
- <ul>
-   <li><p>'All Files (*)|*'</p></li>
-   <li><p>'All Files (*)|*|Object Pascal (*.pas)|*.pas'</p></li>
- </ul>
-</p>
+<p>Example:</p>
+<code>'All Files (*)|*'
+'All Files (*)|*|Object Pascal (*.pas)|*.pas'
+</code>
 <p>           
 A filemask can also contain more than one mask separated by a ; sign.<br/>
 eg: 'Object Pascal|*.pas;*.lpi;*.pp'
diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml
index fd99f0ea..f9239fa5 100644
--- a/docs/xml/gui/fpg_hyperlink.xml
+++ b/docs/xml/gui/fpg_hyperlink.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <fpdoc-descriptions>
-  <package name="GUI">
+  <package name="fpGUI">
     <module name="fpg_hyperlink">
       <short>A label component that can launch a web browser</short>
       <descr>This component acts like a link found in a web page. You can assign a