summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-06 17:02:38 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-06 17:02:38 +0200
commit835411abe6fdeed50d8b21e3be77536356f7332d (patch)
tree5c1d20450be9677ebcb9ccd10cdc43430cce8074 /docs
parent146f61c46034e4bf0491938226d29741a59e35dd (diff)
downloadfpGUI-835411abe6fdeed50d8b21e3be77536356f7332d.tar.xz
docs: Updated XML Description files to use package name 'fpGUI'.
* Some documentation additions was made too.
Diffstat (limited to 'docs')
-rw-r--r--docs/xml/corelib/fpg_base.xml2
-rw-r--r--docs/xml/corelib/fpg_cmdlineparams.xml2
-rw-r--r--docs/xml/corelib/fpg_constants.xml12
-rw-r--r--docs/xml/corelib/fpg_extinterpolation.xml24
-rw-r--r--docs/xml/corelib/fpg_imagelist.xml2
-rw-r--r--docs/xml/corelib/fpg_imgfmt_bmp.xml2
-rw-r--r--docs/xml/corelib/fpg_main.xml9
-rw-r--r--docs/xml/corelib/fpg_pofiles.xml2
-rw-r--r--docs/xml/corelib/fpg_popupwindow.xml2
-rw-r--r--docs/xml/corelib/fpg_stdimages.xml2
-rw-r--r--docs/xml/corelib/fpg_stringhashlist.xml2
-rw-r--r--docs/xml/corelib/fpg_stringutils.xml2
-rw-r--r--docs/xml/corelib/fpg_translations.xml2
-rw-r--r--docs/xml/corelib/fpg_utils.xml2
-rw-r--r--docs/xml/corelib/fpg_widget.xml2
-rw-r--r--docs/xml/corelib/fpg_wuline.xml7
-rw-r--r--docs/xml/corelib/gdi/fpg_gdi.xml2
-rw-r--r--docs/xml/corelib/x11/fpg_x11.xml2
-rw-r--r--docs/xml/gui/fpg_colormapping.xml2
-rw-r--r--docs/xml/gui/fpg_colorwheel.xml30
-rw-r--r--docs/xml/gui/fpg_dialogs.xml2
-rw-r--r--docs/xml/gui/fpg_hyperlink.xml2
22 files changed, 62 insertions, 54 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index 5fa891ba..e4fd3413 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
- <package name="CoreLib">
+ <package name="fpGUI">
<!--
====================================================================
gfxbase
diff --git a/docs/xml/corelib/fpg_cmdlineparams.xml b/docs/xml/corelib/fpg_cmdlineparams.xml
index 9661a7eb..f75fbbc2 100644
--- a/docs/xml/corelib/fpg_cmdlineparams.xml
+++ b/docs/xml/corelib/fpg_cmdlineparams.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_cmdlineparams">
<short></short>
diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml
index ccd98914..749ad73f 100644
--- a/docs/xml/corelib/fpg_constants.xml
+++ b/docs/xml/corelib/fpg_constants.xml
@@ -1,10 +1,16 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_constants">
-<short></short>
-<descr>
+<short>All constants used in fpGUI are defined here</short>
+<descr><p><printshort id="fpg_constants"/>. All the text constants defined here,
+are also the ones that get translated to multiple languages. Currently fpGUI
+and translations for: Afrikaans, German, English (default), Spanish, French,
+Italian, Portuguese (Brazil) and Russian.</p>
+<p>To change the default (compiled in) language used by fpGUI, simply enabled
+one of the language DEFINES in the interface section of the fpg_constants unit.
+</p>
</descr>
</module>
diff --git a/docs/xml/corelib/fpg_extinterpolation.xml b/docs/xml/corelib/fpg_extinterpolation.xml
index 2fcd0785..af129a1f 100644
--- a/docs/xml/corelib/fpg_extinterpolation.xml
+++ b/docs/xml/corelib/fpg_extinterpolation.xml
@@ -1,22 +1,16 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
-
-<module name="fpg_extinterpolation">
-<short>Extra interpolation filter declarations.</short>
-<descr>
-<p>
-Some more interpolation filters for
-<link id="fpg_base.TfpgCanvasBase.StretchDraw">TfpgCanvas.StretchDraw</link>:<br/>
+ <package name="fpGUI">
+ <module name="fpg_extinterpolation">
+ <short>Extra interpolation filter declarations.</short>
+ <descr>
+ <p>Some more interpolation filters for <link id="fpg_base.TfpgCanvasBase.StretchDraw">TfpgCanvasBase.StretchDraw</link>:<br/>
Bessel, Gaussian and Sinc are infinite impulse response (IIR),
the others are finite impulse response (FIR). The implementation
of Bessel and Sinc are windowed with Blackman filter.</p>
-<p>
-This unit was ported from fcl-image which is part of FPC. A few
+ <p>This unit was ported from fcl-image which is part of FPC. A few
more filters have also been added.</p>
-</descr>
-
-</module>
-
-</package>
+ </descr>
+ </module>
+ </package>
</fpdoc-descriptions>
diff --git a/docs/xml/corelib/fpg_imagelist.xml b/docs/xml/corelib/fpg_imagelist.xml
index dfba96fc..603d4c07 100644
--- a/docs/xml/corelib/fpg_imagelist.xml
+++ b/docs/xml/corelib/fpg_imagelist.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_imagelist">
<short></short>
diff --git a/docs/xml/corelib/fpg_imgfmt_bmp.xml b/docs/xml/corelib/fpg_imgfmt_bmp.xml
index ed3cce90..9bee3087 100644
--- a/docs/xml/corelib/fpg_imgfmt_bmp.xml
+++ b/docs/xml/corelib/fpg_imgfmt_bmp.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_imgfmt_bmp">
<short>BMP image reader implementation</short>
diff --git a/docs/xml/corelib/fpg_main.xml b/docs/xml/corelib/fpg_main.xml
index b40a2867..6906fe4f 100644
--- a/docs/xml/corelib/fpg_main.xml
+++ b/docs/xml/corelib/fpg_main.xml
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
- <package name="CoreLib">
+ <package name="fpGUI">
<module name="fpg_main">
<short>The main unit that ties everything together from CoreLib</short>
<descr>
@@ -46,6 +46,13 @@
<descr>
<printshort id="fpgSetNamedFont"/>. Because fpGUI is a cross-platform toolkit, the same fonts might not be available on all systems. For this reason fpGUI supports "named" or "alias names" for fonts. You can specify a font description, and then give that font description a name. Then any component that has a FontDesc property you can pass the full font description, or the "named" font name. An example of a named font is '#Edit1' which is the default font used for <link id="fpg_edit.TfpgEdit">TfpgEdit</link>.</descr>
</element>
+ <element name="TfpgCanvas.DrawText">
+ <short>Output Text onto the Canvas</short>
+ <descr>
+ <printshort id="TfpgCanvas.DrawText"/>.</descr>
+ </element>
+ <element name="TfpgCanvas.StretchDraw" link="fpg_base.TfpgCanvasBase.StretchDraw">
+ </element>
</module>
<!-- fpg_main -->
</package>
diff --git a/docs/xml/corelib/fpg_pofiles.xml b/docs/xml/corelib/fpg_pofiles.xml
index 7aa3a50c..f4f2f836 100644
--- a/docs/xml/corelib/fpg_pofiles.xml
+++ b/docs/xml/corelib/fpg_pofiles.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_pofiles">
<short></short>
diff --git a/docs/xml/corelib/fpg_popupwindow.xml b/docs/xml/corelib/fpg_popupwindow.xml
index c89dfbb4..d420fd6c 100644
--- a/docs/xml/corelib/fpg_popupwindow.xml
+++ b/docs/xml/corelib/fpg_popupwindow.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_popupwindow">
<short></short>
diff --git a/docs/xml/corelib/fpg_stdimages.xml b/docs/xml/corelib/fpg_stdimages.xml
index c767ee6d..ab799178 100644
--- a/docs/xml/corelib/fpg_stdimages.xml
+++ b/docs/xml/corelib/fpg_stdimages.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_stdimages">
<short></short>
diff --git a/docs/xml/corelib/fpg_stringhashlist.xml b/docs/xml/corelib/fpg_stringhashlist.xml
index 2c3d1b01..3ca5cfec 100644
--- a/docs/xml/corelib/fpg_stringhashlist.xml
+++ b/docs/xml/corelib/fpg_stringhashlist.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_stringhashlist">
<short></short>
diff --git a/docs/xml/corelib/fpg_stringutils.xml b/docs/xml/corelib/fpg_stringutils.xml
index 2070f288..9a99d335 100644
--- a/docs/xml/corelib/fpg_stringutils.xml
+++ b/docs/xml/corelib/fpg_stringutils.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_stringutils">
<short></short>
diff --git a/docs/xml/corelib/fpg_translations.xml b/docs/xml/corelib/fpg_translations.xml
index 647fae53..31d817b4 100644
--- a/docs/xml/corelib/fpg_translations.xml
+++ b/docs/xml/corelib/fpg_translations.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_translations">
<short></short>
diff --git a/docs/xml/corelib/fpg_utils.xml b/docs/xml/corelib/fpg_utils.xml
index 225fffe1..2b4f74fe 100644
--- a/docs/xml/corelib/fpg_utils.xml
+++ b/docs/xml/corelib/fpg_utils.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_utils">
<short>Utility functions.</short>
diff --git a/docs/xml/corelib/fpg_widget.xml b/docs/xml/corelib/fpg_widget.xml
index 935054cf..cb0ed0f5 100644
--- a/docs/xml/corelib/fpg_widget.xml
+++ b/docs/xml/corelib/fpg_widget.xml
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
- <package name="CoreLib">
+ <package name="fpGUI">
<module name="fpg_widget">
<short/>
<descr/>
diff --git a/docs/xml/corelib/fpg_wuline.xml b/docs/xml/corelib/fpg_wuline.xml
index 6b283b3d..d5a56b33 100644
--- a/docs/xml/corelib/fpg_wuline.xml
+++ b/docs/xml/corelib/fpg_wuline.xml
@@ -1,10 +1,11 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_wuline">
-<short></short>
-<descr>
+<short>Xioalin Wu's anti-aliased line drawing algorithm implementation</short>
+<descr><printshort id="fpg_wuline"/>. For more details see the following Wikipedia page:
+http://en.wikipedia.org/wiki/Xiaolin_Wu%27s_line_algorithm
</descr>
</module>
diff --git a/docs/xml/corelib/gdi/fpg_gdi.xml b/docs/xml/corelib/gdi/fpg_gdi.xml
index 1e81eb7c..6fe8bdee 100644
--- a/docs/xml/corelib/gdi/fpg_gdi.xml
+++ b/docs/xml/corelib/gdi/fpg_gdi.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<!--
====================================================================
diff --git a/docs/xml/corelib/x11/fpg_x11.xml b/docs/xml/corelib/x11/fpg_x11.xml
index c435d3f3..27dc6e47 100644
--- a/docs/xml/corelib/x11/fpg_x11.xml
+++ b/docs/xml/corelib/x11/fpg_x11.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<!--
====================================================================
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml
index 8a348362..b833acf1 100644
--- a/docs/xml/gui/fpg_colormapping.xml
+++ b/docs/xml/gui/fpg_colormapping.xml
@@ -1,6 +1,6 @@
<?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/>
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..a43ce118 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>
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