summaryrefslogtreecommitdiff
path: root/docs/xml/gui
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-19 16:28:53 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-19 16:28:53 +0200
commit272fc4bdbb42bc4819a12a32235ec7c73427c07b (patch)
tree9794a9456b38c85ae07e4dcb19652cecd519f1ee /docs/xml/gui
parent2e435c928e72a9a0529e30db54122af75160c49b (diff)
parent200dd57560e1ccc04e6fb5dbd57936812e1878b5 (diff)
downloadfpGUI-272fc4bdbb42bc4819a12a32235ec7c73427c07b.tar.xz
Merge branch 'docs' into master.
* Various documentation updates.
Diffstat (limited to 'docs/xml/gui')
-rw-r--r--docs/xml/gui/fpg_colormapping.xml8
-rw-r--r--docs/xml/gui/fpg_colorwheel.xml10
-rw-r--r--docs/xml/gui/fpg_dialogs.xml2
-rw-r--r--docs/xml/gui/fpg_hyperlink.xml4
4 files changed, 11 insertions, 13 deletions
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml
index 0a88ca1e..f605d782 100644
--- a/docs/xml/gui/fpg_colormapping.xml
+++ b/docs/xml/gui/fpg_colormapping.xml
@@ -10,11 +10,11 @@
HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges as
listed below.</p>
<dl>
-<dt>Hue</dt>
+<dt><i>Hue</i></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>
+<dt><i>Saturation</i></dt>
<dd>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</dd>
-<dt>Value</dt>
+<dt><i>Value</i></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>
@@ -22,7 +22,7 @@ listed below.</p>
<element name="HSVToRGB">
<short>Map HSV colorspace to RGB colorspace.</short>
<seealso>
- <link id="RGBToHSV"/>
+ <link id="fpg_colormapping.RGBToHSV">RGBToHSV</link>
</seealso>
</element>
</module>
diff --git a/docs/xml/gui/fpg_colorwheel.xml b/docs/xml/gui/fpg_colorwheel.xml
index 0ec24bdf..0ed78f44 100644
--- a/docs/xml/gui/fpg_colorwheel.xml
+++ b/docs/xml/gui/fpg_colorwheel.xml
@@ -7,12 +7,12 @@
<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 <i>color wheel</i> and a <i>value bar</i>.
</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
+ <li>Set the ColorWheel's <var>ValueBar</var> 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
@@ -25,10 +25,8 @@ 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>To set the color being displayed, use the <link id="fpg_colorwheel.TfpgColorWheel.SetSelectedColor">TfpgColorWheel.SetSelectedColor</link> method.</p>
+ <p>To read the color selected, read the <link id="fpg_colorwheel.TfpgValueBar.SelectedColor">TfpgValueBar.SelectedColor</link> property.</p>
<p>If you want to know when the user picks a color, you
can use the OnChange event in the ValueBar.</p>
</descr>
diff --git a/docs/xml/gui/fpg_dialogs.xml b/docs/xml/gui/fpg_dialogs.xml
index 40b17cde..3df4c24f 100644
--- a/docs/xml/gui/fpg_dialogs.xml
+++ b/docs/xml/gui/fpg_dialogs.xml
@@ -129,7 +129,7 @@ not specified the caption of the message box will be 'Message'.
<element name="SelectFontDialog">
<short>A convenience function to show the font selection dialog.</short>
<seealso>
- <link id="TfpgFontSelectDialog"/>
+ <link id="fpg_dialogs.TfpgFontSelectDialog">TfpgFontSelectDialog</link>
</seealso>
</element>
diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml
index f9239fa5..0c3d507c 100644
--- a/docs/xml/gui/fpg_hyperlink.xml
+++ b/docs/xml/gui/fpg_hyperlink.xml
@@ -3,9 +3,9 @@
<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
+ <descr><p>This component acts like a link found in a web page. You can assign a
target URL and if the user clicks on the component, it will launch a web browser
-using the target URL as destination.</descr>
+using the target URL as destination.</p></descr>
<element name="TfpgHyperlink">
<short>A <var>TfpgCustomLabel</var> descendant that implements hyperlink support</short>
<descr>This is a class to implement a hyperlink. Of course, such as all