summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/xml/corelib/fpg_base.xml50
-rw-r--r--docs/xml/corelib/fpg_constants.xml40
-rw-r--r--docs/xml/corelib/fpg_imgfmt_bmp.xml12
-rw-r--r--docs/xml/corelib/fpg_main.xml6
-rw-r--r--docs/xml/corelib/fpg_utils.xml8
-rw-r--r--docs/xml/corelib/fpg_wuline.xml5
-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
10 files changed, 85 insertions, 60 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index be47e910..683dd729 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -1,15 +1,21 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
- <package name="fpGUI">
- <!--
- ====================================================================
- gfxbase
- ====================================================================
--->
+
+<package name="fpGUI">
+<descr><p>fpGUI Toolkit is intended for Open Source and Commercial applications.
+fpGUI uses the LGPL2 license with the static linking exception - the same as
+the Free Pascal Compiler's RTL.</p>
+<p>fpGUI is an Object Pascal toolkit for cross-platform application development.
+It provides single-source portability across Linux, MS Windows, *BSD and
+embedded systems running Embedded Linux and Windows CE.</p>
+<p>
+For more information, see the fpGUI Toolkit website at: <url href="http://opensoft.homeip.net/fpgui/" />
+</p>
+</descr>
+
<module name="fpg_base">
<short>The base unit and starting point of fpGUI</short>
- <descr>
- <p>This unit contains all the abstract classes for the CoreLib code
+ <descr><p>This unit contains all the abstract classes for the CoreLib code
of fpGUI. It also defines many types and constants used throughout the toolkit.
</p>
<p>When implementing support for a completely new windowing system
@@ -46,7 +52,7 @@ etc.).
<!-- record type Visibility: default -->
<element name="TRGBTriple">
<short>A record structure holding the RGBA values of a color.</short>
- <descr>This is now marked as "deprecated". Please use TFPColor instead.</descr>
+ <descr>This is now marked as "deprecated". Please use <link id="fpg_base.TFPColor">TFPColor</link> instead.</descr>
<seealso/>
</element>
<!-- variable Visibility: default -->
@@ -91,8 +97,8 @@ means no titlebar or window borders are going to be created.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWindowType.wtModalForm">
- <short>This windows type is similar to <link id="TWindowType.wtWindow">wtWindow</link>, but grabs focus.</short>
- <descr>This windows is the same as <link id="TWindowType.wtWindow">wtWindow</link>, but grabs the input focus until it has closed. This window normally doesn't appear in the taskbar.</descr>
+ <short>This windows type is similar to <link id="fpg_base.TWindowType.wtWindow">wtWindow</link>, but grabs focus.</short>
+ <descr>This windows is the same as <link id="fpg_base.TWindowType.wtWindow">wtWindow</link>, but grabs the input focus until it has closed. This window normally doesn't appear in the taskbar.</descr>
</element>
<!-- enumeration value Visibility: default -->
<element name="TWindowType.wtPopup">
@@ -5331,11 +5337,10 @@ returns the correct enum type detected.
<!-- function Visibility: default -->
<element name="fpgColorToRGBTriple">
<short>Converts the TfpgColor to TRGBTriple type</short>
- <descr>This function converts the given TfpgColor into a TRGBTriple type.
-</descr>
+ <descr>This function converts the given TfpgColor into a TRGBTriple type.</descr>
<errors/>
<seealso>
- <link id="TRGBTriple"/>
+ <link id="fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@@ -5353,7 +5358,7 @@ returns the correct enum type detected.
</descr>
<errors/>
<seealso>
- <link id="TRGBTriple"/>
+ <link id="fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@@ -5497,18 +5502,14 @@ Right. And the Top is always smaller than the Bottom.
</element>
<element name="TfpgCanvasBase.DrawLineClipped">
<short>Draws a line inside a clip rectangle</short>
- <descr>
- <p>
- <printshort id="TfpgCanvasBase.DrawLineClipped"/>. This procedure clips a line to the AClipRect boundaries and
+ <descr><p><printshort id="TfpgCanvasBase.DrawLineClipped"/>. This procedure clips a line to the AClipRect boundaries and
then calls the DrawLine procedure with the clipped coordinates. If the line
lies completely outside of the clip boundary, then the Line routine is not
called. This procedure uses the well known Cohen-Sutherland line clipping
- algorithm to clip each coordinate.
-</p>
- <p>Use this if you did not what to change the Canvas.ClipRegion for some reason.
+ algorithm to clip each coordinate.</p>
+<p>Use this if you did not what to change the Canvas.ClipRegion for some reason.
For a detailed explanation see: http://www.nondot.org/~sabre/graphpro/line6.html
-</p>
- </descr>
+</p></descr>
</element>
<element name="TfpgCanvasBase.ClipLine">
<short>Clips the line based on AClipRect boundaries.</short>
@@ -5516,8 +5517,7 @@ Right. And the Top is always smaller than the Bottom.
</element>
<element name="TFileEntry">
<short>A simple data object representing a file</short>
- <descr>
- <printshort id="TFileEntry"/>. Some properties are OS dependant.</descr>
+ <descr><printshort id="TFileEntry"/>. Some properties are OS dependant.</descr>
</element>
<element name="TFileEntry.Name">
<short>Name of a file</short>
diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml
index e02dd9c7..3f66acbe 100644
--- a/docs/xml/corelib/fpg_constants.xml
+++ b/docs/xml/corelib/fpg_constants.xml
@@ -6,11 +6,21 @@
<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>
+has translations for:</p>
+<ul>
+<li>Afrikaans</li>
+<li>German</li>
+<li>English (default language - but is user selectable)</li>
+<li>Spanish</li>
+<li>French</li>
+<li>Italian</li>
+<li>Portuguese (Brazilian)</li>
+<li>Russian</li>
+</ul>
<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>
+one of the language DEFINES in the interface section of the fpg_constants unit.</p>
+<p>For more details on changing the default language of fpGUI Toolkit, see the topic
+"<link id="fpg_constants.ChangingDefaultLanguage">Changing the default language</link>".</p>
</descr>
<element name="fpgAddColon">
<short>A utility function to add a colon at the correct location in a string</short>
@@ -26,6 +36,28 @@ one of the language DEFINES in the interface section of the fpg_constants unit.
<element name="DOUBLECLICK_DISTANCE">
<short>Maximum distance a mouse pointer can move between two left-clicks and still trigger a double click event</short>
</element>
+
+<topic name="ChangingDefaultLanguage">
+<short>Changing the default language</short>
+<descr><p>Inside the <var>fpg_constants.pas</var> unit there are a few commented language
+defines. If no language specific Define is set, then fpGUI defaults to the English
+language. So say you want to change the default language to German, simply uncomment
+the <b>de</b> define, and recompile fpGUI.
+</p>
+<p>Here is a list of current supported languages and their commented defines as they
+appear in the <var>fpg_constants</var> unit.</p>
+<code>
+{.$DEFINE de} // German
+{.$DEFINE ru} // Russian
+{.$DEFINE fr} // French
+{.$DEFINE pt} // Portuguese (Brazil)
+{.$DEFINE af} // Afrikaans
+{.$DEFINE it} // Italian
+{.$DEFINE es} // Spanish
+</code>
+</descr>
+</topic>
+
</module>
</package>
</fpdoc-descriptions>
diff --git a/docs/xml/corelib/fpg_imgfmt_bmp.xml b/docs/xml/corelib/fpg_imgfmt_bmp.xml
index 9bee3087..aad03cc2 100644
--- a/docs/xml/corelib/fpg_imgfmt_bmp.xml
+++ b/docs/xml/corelib/fpg_imgfmt_bmp.xml
@@ -4,8 +4,7 @@
<module name="fpg_imgfmt_bmp">
<short>BMP image reader implementation</short>
-<descr>This unit implements a BMP (Bitmap) image reader.
-</descr>
+<descr><p>This unit implements a BMP (Bitmap) image reader.</p></descr>
<!-- procedure Visibility: default -->
<element name="ReadImage_BMP">
@@ -15,9 +14,8 @@
<!-- function Visibility: default -->
<element name="LoadImage_BMP">
<short>Load's the image from the file specified.</short>
-<descr>This functions loads the BMP image from the file specified and returns
-a TfpgImage object representing the BMP file.
-</descr>
+<descr><p>This functions loads the BMP image from the file specified and returns
+a <link id="fpg_main.TfpgImage">TfpgImage</link> object representing the BMP file.</p></descr>
</element>
<!-- function result Visibility: default -->
@@ -32,8 +30,8 @@ a TfpgImage object representing the BMP file.
<!-- function Visibility: default -->
<element name="CreateImage_BMP">
-<short>Creates a TfpgImage representing a BMP file from data in memory.</short>
-<descr>Creates a TfpgImage representing a BMP file from data in memory.
+<short>Creates a <link id="fpg_main.TfpgImage">TfpgImage</link> representing a BMP file from data in memory.</short>
+<descr><printshort id="CreateImage_BMP"/>.
</descr>
</element>
diff --git a/docs/xml/corelib/fpg_main.xml b/docs/xml/corelib/fpg_main.xml
index 574931ed..a06e1e3a 100644
--- a/docs/xml/corelib/fpg_main.xml
+++ b/docs/xml/corelib/fpg_main.xml
@@ -15,7 +15,7 @@
<descr>fpgPostMessage posts a message to the event queue, but doesn't wait for it to compelete. It returns immediately.</descr>
<errors/>
<seealso>
- <link id="fpgSendMessage"/>
+ <link id="fpg_main.fpgSendMessage"/>
</seealso>
</element>
<!-- procedure Visibility: default -->
@@ -24,7 +24,7 @@
<descr>fpgSendMessage sends a message to the event queue and waits for it to complete before it returns.</descr>
<errors/>
<seealso>
- <link id="fpgPostMessage"/>
+ <link id="fpg_main.fpgPostMessage"/>
</seealso>
</element>
<element name="fpgColorToRGB">
@@ -62,7 +62,7 @@ is simply an index value, but later translated to a real RGB value via the themi
<short>Prints rectangle information to console</short>
<descr><printshort id="PrintRect"/>. This is a helper function for debugging purposes.</descr>
<seealso>
- <link id="#fpgui.fpg_base.TfpgRect">TfpgRect</link>
+ <link id="fpg_base.TfpgRect">TfpgRect</link>
</seealso>
</element>
<element name="TfpgStyle">
diff --git a/docs/xml/corelib/fpg_utils.xml b/docs/xml/corelib/fpg_utils.xml
index 2b4f74fe..6c0ad9df 100644
--- a/docs/xml/corelib/fpg_utils.xml
+++ b/docs/xml/corelib/fpg_utils.xml
@@ -4,16 +4,14 @@
<module name="fpg_utils">
<short>Utility functions.</short>
-<descr>Utility functions used throughout fpGUI. Some have common
-implementations and some have platform specific implementations.
-</descr>
+<descr><p>Utility functions used throughout fpGUI. Some have common
+implementations and some have platform specific implementations.</p></descr>
<!-- function Visibility: default -->
<element name="fpgToOSEncoding">
<short>Converts string from fpGUI to OS specific filesystem encoding</short>
<descr>This function is specific to filesystem strings like Paths, Filenames
- and Directories.
-</descr>
+ and Directories.</descr>
</element>
<!-- function Visibility: default -->
diff --git a/docs/xml/corelib/fpg_wuline.xml b/docs/xml/corelib/fpg_wuline.xml
index d5a56b33..fd689971 100644
--- a/docs/xml/corelib/fpg_wuline.xml
+++ b/docs/xml/corelib/fpg_wuline.xml
@@ -4,9 +4,8 @@
<module name="fpg_wuline">
<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>
+<descr><p><printshort id="fpg_wuline"/>. For more details see the following Wikipedia page:
+<url href="http://en.wikipedia.org/wiki/Xiaolin_Wu%27s_line_algorithm" /></p></descr>
</module>
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
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-10-17 11:32:22 +0000