diff options
| author | Andrew Haines <andrewd207@aol.com> | 2010-11-05 17:28:50 -0400 |
|---|---|---|
| committer | Andrew Haines <andrewd207@aol.com> | 2010-11-05 17:28:50 -0400 |
| commit | e320dfae6add39c66ea554dbb161a844ee06db4d (patch) | |
| tree | 78451d8f643babcfb50376c1b6a53da6ef5ff616 /docs/xml | |
| parent | 917a2daf4ff769ad27631e6c71a7b919c47e4ecb (diff) | |
| parent | 735aec8207036adb17f2174ffcb9056bee712ed3 (diff) | |
| download | fpGUI-e320dfae6add39c66ea554dbb161a844ee06db4d.tar.xz | |
Merge branch 'master' of ssh://fpgui.git.sourceforge.net/gitroot/fpgui/fpgui
Diffstat (limited to 'docs/xml')
| -rw-r--r-- | docs/xml/corelib/fpg_base.xml | 4957 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_command_intf.xml | 25 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_constants.xml | 19 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_imgfmt_bmp.xml | 12 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_main.xml | 13 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_utils.xml | 8 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_widget.xml | 91 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_wuline.xml | 5 | ||||
| -rw-r--r-- | docs/xml/fpgui_topic_defaultlanguage.xml | 31 | ||||
| -rw-r--r-- | docs/xml/fpgui_topic_dnd.xml | 32 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_button.xml | 7 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_colormapping.xml | 8 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_colorwheel.xml | 10 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_dialogs.xml | 2 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_form.xml | 30 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_hyperlink.xml | 4 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_tree.xml | 162 |
17 files changed, 567 insertions, 4849 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index be47e910..73174601 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,25 +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>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TRGBTriple.Red">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TRGBTriple.Green">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TRGBTriple.Blue">
- <short/>
- <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 +79,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">
@@ -183,7 +171,6 @@ it is shown for the first time.</short> <element name="TGradientDirection">
<short>Enum types defining how a gradient must be painted</short>
<descr/>
- <seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGradientDirection.gdVertical">
@@ -358,2338 +345,9 @@ it is shown for the first time.</short> <seealso/>
</element>
<!-- constant Visibility: default -->
- <element name="keyNul">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyBackSpace">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyTab">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyLinefeed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyReturn">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyEnter">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyEscape">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDelete">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySpace">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyVoid">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyBreak">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyScrollForw">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyScrollBack">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyBoot">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCompose">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySAK">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyUndo">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyRedo">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMenu">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCancel">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPrintScreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyExecute">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyFind">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyBegin">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyClear">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyInsert">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySelect">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMacro">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHelp">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDo">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPause">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyStop">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySysRq">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyModeSwitch">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyUp">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyLeft">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyRight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPrior">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPageUp">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNext">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPageDown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHome">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyEnd">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF0">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF3">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF4">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF5">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF6">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF7">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF8">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF9">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF10">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF11">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF12">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF13">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF14">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF15">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF16">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF17">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF18">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF19">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF20">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF21">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF22">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF23">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF24">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF25">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF26">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF27">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF28">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF29">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF30">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF31">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF32">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF33">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF34">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF35">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF36">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF37">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF38">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF39">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF40">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF41">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF42">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF43">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF44">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF45">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF46">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF47">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF48">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF49">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF50">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF51">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF52">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF53">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF54">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF55">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF56">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF57">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF58">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF59">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF60">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF61">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF62">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF63">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyF64">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP0">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP3">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP4">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP5">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP6">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP7">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP8">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyP9">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPA">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPB">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPC">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPD">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPE">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPPlus">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPMinus">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPSlash">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPAsterisk">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPStar">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPEqual">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPSeparator">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPDecimal">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPParenLeft">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPParenRight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPSpace">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPEnter">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPTab">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPPlusMinus">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPBegin">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF3">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF4">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF5">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF6">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF7">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF8">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPF9">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyShift">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCtrl">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAlt">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMeta">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySuper">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHyper">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAltGr">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCaps">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNum">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyScroll">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyShiftL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyShiftR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCtrlL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCtrlR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAltL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAltR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMetaL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMetaR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySuperL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySuperR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHyperL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHyperR">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyShiftLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCtrlLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAltLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMetaLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keySuperLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyHyperLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyAltGrLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCapsLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNumLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyScrollLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadRing">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadCaron">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadOgonek">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadIota">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadDoubleAcute">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadBreve">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadAboveDot">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadBelowDot">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadVoicedSound">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadSemiVoicedSound">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadAcute">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadCedilla">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadCircumflex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadDiaeresis">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadGrave">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadTilde">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDeadMacron">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNIL">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyEcuSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyColonSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyCruzeiroSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyFFrancSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyLiraSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyMillSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNairaSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyPesetaSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyRupeeSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyWonSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyNewSheqelSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyDongSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="keyEuroSign">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
<element name="FPG_DEFAULT_FONT_DESC">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="UserNamedColorStart">
- <short/>
+ <short>The default base font used in fpGUI</short>
<descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clAqua">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBlack">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCream">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDkGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clFuchsia">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLime">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLtGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMaroon">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clNavy">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOlive">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPurple">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSilver">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clTeal">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clWhite">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clYellow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clNone">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDefault">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMoneyGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSkyBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMedGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clWindowBackground">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBoxColor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clButtonFace">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clShadow1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clShadow2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clHilite1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clHilite2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clText1">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clText2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clText3">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clText4">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSelection">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSelectionText">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clInactiveSel">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clInactiveSelText">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clScrollBar">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clListBox">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGridLines">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGridHeader">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clWidgetFrame">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clInactiveWgFrame">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clTextCursor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clChoiceListBox">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clUnset">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMenuText">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMenuDisabled">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clAliceBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clAntiqueWhite">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clAquamarine">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clAzure">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBeige">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBisque">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBlanchedAlmond">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBlueViolet">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBrown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clBurlyWood">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCadetBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clChartreuse">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clChocolate">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCoral">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCornflowerBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCornsilk">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCrimson">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clCyan">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkCyan">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkGoldenrod">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkKhaki">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkMagenta">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkOliveGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkOrange">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkOrchid">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkSalmon">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkSeaGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkSlateBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkSlateGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkTurquoise">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDarkViolet">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDeepPink">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDeepSkyBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDimGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clDodgerBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clFireBrick">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clFloralWhite">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clForestGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGainsboro">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGhostWhite">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGold">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGoldenrod">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clGreenYellow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clHoneydew">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clHotPink">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clIndianRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clIndigo">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clIvory">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clKhaki">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLavender">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLavenderBlush">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLawnGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLemonChiffon">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightCoral">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightCyan">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightGoldenrodYellow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightGrey">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightPink">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightSalmon">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightSeaGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightSkyBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightSlateGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightSteelBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLightYellow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLimeGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clLinen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMagenta">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumAquamarine">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumOrchid">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumPurple">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumSeaGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumSlateBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumSpringGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumTurquoise">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMediumVioletRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMidnightBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMintCream">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMistyRose">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clMoccasin">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clNavajoWhite">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOldLace">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOliveDrab">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOrange">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOrangeRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clOrchid">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPaleGoldenrod">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPaleGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPaleTurquoise">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPaleVioletRed">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPaleBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPapayaWhip">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPeachPuff">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPeru">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPink">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPlum">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clPowderBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clRosyBrown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clRoyalBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSaddleBrown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSalmon">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSandyBrown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSeaGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSeashell">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSienna">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSkyBlue2">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSlateBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSlateGray">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSnow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSpringGreen">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clSteelBlue">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clTan">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clThistle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clTomato">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clTurquoise">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clViolet">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clWheat">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clWhiteSmoke">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- constant Visibility: default -->
- <element name="clYellowGreen">
- <short/>
- <descr/>
- <seealso/>
</element>
<!-- object Visibility: default -->
<element name="TfpgRect">
@@ -2761,97 +419,37 @@ Spreadsheet program etc. <errors/>
<seealso/>
</element>
- <!-- variable Visibility: default -->
- <element name="TfpgRect.Top">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TfpgRect.Left">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TfpgRect.Width">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: default -->
- <element name="TfpgRect.Height">
- <short/>
- <descr/>
- <seealso/>
- </element>
+
<!-- procedure Visibility: default -->
<element name="TfpgRect.SetRect">
<short>A convenience function to quickly set a rectangle structure.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetRect.aleft">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetRect.atop">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetRect.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetRect.aheight">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="TfpgRect.Bottom">
<short>Calculates and returns the bottom position of the rectangle.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgRect.Bottom.Result">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="TfpgRect.Right">
<short>Calculates and returns the Right most position of the rectangle.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgRect.Right.Result">
- <short/>
</element>
+
<!-- procedure Visibility: default -->
<element name="TfpgRect.SetBottom">
<short>Sets the bottom value and recalculates the Height value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetBottom.Value">
- <short/>
</element>
+
<!-- procedure Visibility: default -->
<element name="TfpgRect.SetRight">
<short>Sets the Right value and recalculates the Width value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgRect.SetRight.Value">
- <short/>
</element>
+
<!-- record type Visibility: default -->
<element name="TfpgMsgParmMouse">
<short/>
@@ -3005,505 +603,163 @@ Spreadsheet program etc. or widget has a window handle. Widgets are essentially embedded windows without
titlebars or borders inside a main parent window.
</descr>
- <errors/>
- <seealso/>
</element>
+
+<element name="TfpgWindowBase.UpdateWindowPosition">
+<short>Forces fpGUI to act on window position and size properties</short>
+<descr><p>fpGUI implements what is called "delayed resource allocation". It delays
+some action until everything is ready to go. This delayed action applies to setting
+Widget or Form size and position. Why? Imagine you have a complex form
+with lots of anchors, alignments and OnResize event handlers. Now
+somewhere in there you change the size or position of a component.</p>
+
+<code>
+MyWidget.Left := ...
+MyWidget.Top := ...
+MyWidget.Width := ...
+MyWidget.Height := ...
+</code>
+
+<p>If fpGUI acted immediately, as every property is set, it means it
+would have to recalculate all those widget boundaries, and fire all
+OnResize event handlers of the whole form four times. Once for each
+property - as you set them. Not very efficient! To reduce such
+redundant calculations, fpGUI allows you to set all the properties,
+then act on it once you call <var>UpdateWindowPosition</var>. In most cases fpGUI
+can even reduce the API calls needed, because it could pass for
+example Width and Height via one API call. In the case of X11, it can actually do all
+four values in a single API call. Thus improving efficiency and reduces resize calculatios and screen
+redraws.</p>
+</descr>
+</element>
+
+<element name="TfpgWindowBase.Left">
+<short>Specifies the horizontal coordinate of the left edge of a component relative to its parent</short>
+<descr><p><printshort id="TfpgWindowBase.Left"/>. Use the Left property to determine where the left side
+of the control begins or to reposition the left side of the control.
+</p>
+<remark>fpGUI delays acting on the Top, Left, Width and Height properies of a control until the
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+help.</remark></descr>
+<seealso>
+<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+</seealso>
+</element>
+
+<element name="TfpgWindowBase.Top">
+<short>Specifies the vertical (X) coordinate of the top edge of a component relative to its parent</short>
+<descr><p><printshort id="TfpgWindowBase.Top"/>. Use the Top property to determine where the top side
+of the control begins or to reposition the top side of the control.
+</p>
+<remark>fpGUI delays acting on the Top, Left, Width and Height properies of a control until the
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+help.</remark></descr>
+<seealso>
+<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+</seealso>
+</element>
+
+<element name="TfpgWindowBase.Width">
+<short>Specifies the horizontal size of the control or form in pixels</short>
+<descr><p><printshort id="TfpgWindowBase.Width"/>. Use the Width property
+to read or change the width of the control. For TfpgTabSheet controls of for
+controls that have their Align property set to alTop, alBottom or alClient, changing
+this property at runtime has no effect.
+</p>
+<remark>fpGUI delays acting on the Top, Left, Width and Height properies of a control until the
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+help.</remark></descr>
+<seealso>
+<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+</seealso>
+</element>
+
+<element name="TfpgWindowBase.Height">
+<short>Specifies the vertical size of the control or form in pixels</short>
+<descr><p><printshort id="TfpgWindowBase.Height"/>. Use the Height property
+to read or change the height of the control. For TfpgTabSheet controls of for
+controls that have their Align property set to alLeft, alRight or alClient, changing
+this property at runtime has no effect.
+</p>
+<remark>fpGUI delays acting on the Top, Left, Width and Height properies of a control until the
+<var>UpdateWindowPosition</var> method is called. For more information on why this is so, see <link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">UpdateWindowPosition</link>
+help.</remark></descr>
+<seealso>
+<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link>
+</seealso>
+</element>
+
<!-- object Visibility: default -->
<element name="TfpgCanvasBase">
<short>Abstract class used to represent a Canvas for painting</short>
<descr/>
- <errors/>
- <seealso/>
</element>
<!-- object Visibility: default -->
<element name="TfpgImageBase">
<short>Abstract class used to represent a Image</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: private -->
- <element name="TfpgImageBase.GetColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgImageBase.GetColor.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.GetColor.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.GetColor.y">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TfpgImageBase.SetColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.SetColor.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.SetColor.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.SetColor.AValue">
- <short/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FHeight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FColorDepth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FMasked">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FImageData">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FImageDataSize">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FMaskData">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgImageBase.FMaskDataSize">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgImageBase.DoFreeImage">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgImageBase.DoInitImage">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImage.acolordepth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImage.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImage.aheight">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImage.aimgdata">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgImageBase.DoInitImageMask">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImageMask.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImageMask.aheight">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.DoInitImageMask.aimgdata">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TfpgImageBase.Create">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- destructor Visibility: public -->
- <element name="TfpgImageBase.Destroy">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.Invert">
<short>Inverts the Image</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgImageBase.FreeImage">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
+ <descr><printshort id="TfpgImageBase.Invert"/>. This changes the actual
+data of the image. There is no undo function. So if you want to undo this action,
+you must keep copy of the original image before you call <var>Invert</var>.</descr>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.AllocateImage">
<short>Allocates OS resources for the Image</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.AllocateImage.acolordepth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.AllocateImage.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.AllocateImage.aheight">
- <short/>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.AllocateMask">
<short>Allocates OS resources for the Image Mask</short>
<descr/>
- <errors/>
- <seealso/>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.CreateMaskFromSample">
<short>Creates a mask based on the sample point presented by X and Y parameters</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.CreateMaskFromSample.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.CreateMaskFromSample.y">
- <short/>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgImageBase.UpdateImage">
<short>Updates the internal image resources and OS resources from image data</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgImageBase.ImageData">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgImageBase.ImageDataSize">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgImageBase.MaskData">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgImageBase.MaskDataSize">
- <short/>
- <descr/>
- <seealso/>
</element>
+
<!-- property Visibility: public -->
<element name="TfpgImageBase.Width">
<short>Width of the image</short>
<descr/>
- <seealso/>
</element>
<!-- property Visibility: public -->
<element name="TfpgImageBase.Height">
<short>Height of the image</short>
<descr/>
- <seealso/>
</element>
<!-- property Visibility: public -->
<element name="TfpgImageBase.ColorDepth">
<short>Color depth of the image. Currently 24/32-bit is all that is supported.</short>
<descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgImageBase.Masked">
- <short/>
- <descr/>
- <seealso/>
</element>
+
<!-- property Visibility: public -->
<element name="TfpgImageBase.Colors">
<short>Array property to access a specific color of the image based on X and Y co-ordinates</short>
<descr/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.Colors.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgImageBase.Colors.y">
- <short/>
</element>
+
<!-- object Visibility: default -->
<element name="TfpgFontResourceBase">
<short>Encapsulates the resources of a font</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontResourceBase.GetAscent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontResourceBase.GetAscent.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontResourceBase.GetDescent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontResourceBase.GetDescent.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontResourceBase.GetHeight">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontResourceBase.GetHeight.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontResourceBase.GetTextWidth">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontResourceBase.GetTextWidth.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgFontResourceBase.GetTextWidth.txt">
- <short/>
- </element>
- <!-- object Visibility: default -->
- <element name="TfpgFontBase">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgFontBase.FFontDesc">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgFontBase.FFontRes">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontBase.TextWidth">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontBase.TextWidth.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgFontBase.TextWidth.txt">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontBase.Ascent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontBase.Ascent.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontBase.Descent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontBase.Descent.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgFontBase.Height">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgFontBase.Height.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgFontBase.FontDesc">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgFontBase.FontRes">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgFontBase.Handle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TfpgCustomInterpolation">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgCustomInterpolation.FCanvas">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgCustomInterpolation.FImage">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCustomInterpolation.Initialize">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Initialize.AImage">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Initialize.ACanvas">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCustomInterpolation.Execute">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Execute.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Execute.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Execute.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCustomInterpolation.Execute.h">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCustomInterpolation.Canvas">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCustomInterpolation.Image">
- <short/>
- <descr/>
- <seealso/>
</element>
+
<!-- object Visibility: default -->
<element name="TfpgBaseInterpolation">
<short>A abstract class representing a base Interpolation filter.</short>
@@ -3511,2036 +767,189 @@ titlebars or borders inside a main parent window. Gaussian, Sinc etc... These decendant filters are used in the
<link id="TfpgCanvasBase.StretchDraw">Canvas.StretchDraw</link> function.
</descr>
- <errors/>
<seealso>
<link id="TfpgCanvasBase.StretchDraw">Canvas.StretchDraw</link>
</seealso>
</element>
- <!-- variable Visibility: private -->
- <element name="TfpgBaseInterpolation.xfactor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgBaseInterpolation.yfactor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgBaseInterpolation.xsupport">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgBaseInterpolation.ysupport">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgBaseInterpolation.tempimage">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TfpgBaseInterpolation.Horizontal">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Horizontal.width">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TfpgBaseInterpolation.Vertical">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Vertical.dx">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Vertical.dy">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Vertical.width">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Vertical.height">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgBaseInterpolation.Execute">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Execute.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Execute.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Execute.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Execute.h">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgBaseInterpolation.Filter">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgBaseInterpolation.Filter.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgBaseInterpolation.Filter.x">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgBaseInterpolation.MaxSupport">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgBaseInterpolation.MaxSupport.Result">
- <short/>
- </element>
- <!-- destructor Visibility: public -->
- <element name="TfpgBaseInterpolation.Destroy">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TfpgMitchelInterpolation">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgMitchelInterpolation.Filter">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgMitchelInterpolation.Filter.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgMitchelInterpolation.Filter.x">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgMitchelInterpolation.MaxSupport">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgMitchelInterpolation.MaxSupport.Result">
- <short/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgCanvasBase.FFastDoubleBuffer">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgCanvasBase.FInterpolation">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TfpgCanvasBase.SetInterpolation">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetInterpolation.AValue">
- <short/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FBufferedDraw">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FBeginDrawCount">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FWindow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FColor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FTextColor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FLineWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FLineStyle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FFont">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgCanvasBase.FPersistentResources">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoSetFontRes">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetFontRes.fntres">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoSetTextColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetTextColor.cl">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoSetColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetColor.cl">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoSetLineStyle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetLineStyle.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetLineStyle.astyle">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoGetWinRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoGetWinRect.r">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoFillRectangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillRectangle.h">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoXORFillRectangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoXORFillRectangle.col">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoXORFillRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoXORFillRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoXORFillRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoXORFillRectangle.h">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoFillTriangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.x1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.y1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.x2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.y2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.x3">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillTriangle.y3">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoDrawRectangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawRectangle.h">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoDrawLine">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawLine.x1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawLine.y1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawLine.x2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawLine.y2">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoDrawImagePart">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.img">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.xi">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.yi">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawImagePart.h">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoDrawString">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawString.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawString.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawString.txt">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoSetClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoSetClipRect.ARect">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgCanvasBase.DoGetClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgCanvasBase.DoGetClipRect.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoAddClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoAddClipRect.ARect">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoClearClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoBeginDraw">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoBeginDraw.awin">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoBeginDraw.buffered">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoPutBufferToScreen">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoPutBufferToScreen.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoPutBufferToScreen.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoPutBufferToScreen.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoPutBufferToScreen.h">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoEndDraw">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgCanvasBase.GetPixel">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgCanvasBase.GetPixel.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GetPixel.X">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GetPixel.Y">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.SetPixel">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetPixel.X">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetPixel.Y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetPixel.AValue">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoDrawArc">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.a1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoDrawArc.a2">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgCanvasBase.DoFillArc">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.a1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DoFillArc.a2">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TfpgCanvasBase.Create">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- destructor Visibility: public -->
- <element name="TfpgCanvasBase.Destroy">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
<!-- procedure Visibility: public -->
<element name="TfpgCanvasBase.DrawRectangle">
<short>Draws a rectangle.</short>
<descr>
<printshort id="TfpgCanvasBase.DrawRectangle"/> You can specify the size of the rectangle via X, Y, Width and Height parameters or via a TfpgRect parameter.</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawRectangle.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawRectangle.r">
- <short/>
</element>
+
<!-- procedure Visibility: public -->
<element name="TfpgCanvasBase.DrawLine">
<short>Draws a line</short>
<descr>
<printshort id="TfpgCanvasbase.DrawLine"/>. This method draws a line from (x1,y1) to (x2,y2), but does not draw the last pixel. All supported backends follow the Microsoft API and doesn't draw the last pixel. This optimises consecutive lines being drawn without overlapping pixels.</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawLine.x1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawLine.y1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawLine.x2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawLine.y2">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.DrawImage">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImage.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImage.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImage.img">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.DrawImagePart">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.img">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.xi">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.yi">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawImagePart.h">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.DrawArc">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.a1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawArc.a2">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.StretchDraw">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.StretchDraw.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.StretchDraw.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.StretchDraw.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.StretchDraw.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.StretchDraw.ASource">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.CopyRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.CopyRect.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.CopyRect.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.CopyRect.ACanvas">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.CopyRect.SourceRect">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.DrawString">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawString.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawString.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.DrawString.txt">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.FillRectangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillRectangle.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillRectangle.r">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.FillTriangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.x1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.y1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.x2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.y2">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.x3">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillTriangle.y3">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.FillArc">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.a1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.FillArc.a2">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.GradientFill">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GradientFill.ARect">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GradientFill.AStart">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GradientFill.AStop">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GradientFill.ADirection">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.XORFillRectangle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.col">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.XORFillRectangle.r">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.SetClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetClipRect.ARect">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgCanvasBase.GetClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgCanvasBase.GetClipRect.Result">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.AddClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.AddClipRect.ARect">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.ClearClipRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.Clear">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.Clear.AColor">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.GetWinRect">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.GetWinRect.r">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.SetColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetColor.AColor">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.SetTextColor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetTextColor.AColor">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.SetLineStyle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetLineStyle.AWidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetLineStyle.AStyle">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.SetFont">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.SetFont.AFont">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.BeginDraw">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.BeginDraw.ABuffered">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.EndDraw">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.EndDraw.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.EndDraw.y">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.EndDraw.w">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.EndDraw.h">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.EndDraw.ARect">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgCanvasBase.FreeResources">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.Color">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.TextColor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.Font">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.Pixels">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.Pixels.X">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgCanvasBase.Pixels.Y">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.InterpolationFilter">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.FastDoubleBuffer">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.LineStyle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgCanvasBase.LineWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgWindowBase.FParent">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TfpgWindowBase.SetMouseCursor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.SetMouseCursor.AValue">
- <short/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FMouseCursor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FWindowType">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FWindowAttributes">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FTop">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FLeft">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FHeight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FMinWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FMinHeight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgWindowBase.FCanvas">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgWindowBase.HandleIsValid">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.HandleIsValid.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoUpdateWindowPosition">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoUpdateWindowPosition.aleft">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoUpdateWindowPosition.atop">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoUpdateWindowPosition.awidth">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoUpdateWindowPosition.aheight">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoAllocateWindowHandle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoAllocateWindowHandle.AParent">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoReleaseWindowHandle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoSetWindowVisible">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoSetWindowVisible.AValue">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoMoveWindow">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoMoveWindow.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoMoveWindow.y">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgWindowBase.DoWindowToScreen">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.DoWindowToScreen.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoWindowToScreen.ASource">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoWindowToScreen.AScreenPos">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoSetWindowTitle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.DoSetWindowTitle.ATitle">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.DoSetMouseCursor">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.SetParent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.SetParent.AValue">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgWindowBase.GetParent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.GetParent.Result">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgWindowBase.GetCanvas">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.GetCanvas.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.AllocateWindowHandle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.ReleaseWindowHandle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.SetWindowTitle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.SetWindowTitle.ATitle">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.SetHeight">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.SetHeight.AValue">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TfpgWindowBase.SetWidth">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.SetWidth.AValue">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TfpgWindowBase.Create">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.Create.AOwner">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.AfterConstruction">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.AdjustWindowStyle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.SetWindowParameters">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgWindowBase.Right">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.Right.Result">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgWindowBase.Bottom">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.Bottom.Result">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.UpdateWindowPosition">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.MoveWindow">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.MoveWindow.x">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.MoveWindow.y">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgWindowBase.WindowToScreen">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgWindowBase.WindowToScreen.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.WindowToScreen.ASource">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgWindowBase.WindowToScreen.AScreenPos">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.CaptureMouse">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TfpgWindowBase.ReleaseMouse">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.HasHandle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.WindowType">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.WindowAttributes">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Left">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Top">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Width">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Height">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.MinWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.MinHeight">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Canvas">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.Parent">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgWindowBase.MouseCursor">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TfpgApplicationBase">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgApplicationBase.FMainForm">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgApplicationBase.FTerminated">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TfpgApplicationBase.FTopModalForm">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: protected -->
- <element name="TfpgApplicationBase.FIsInitialized">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TfpgApplicationBase.DoGetFontFaceList">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgApplicationBase.DoGetFontFaceList.Result">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TfpgApplicationBase.Create">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TfpgApplicationBase.Create.AParams">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TfpgApplicationBase.GetFontFaceList">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TfpgApplicationBase.GetFontFaceList.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgApplicationBase.IsInitialized">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgApplicationBase.TopModalForm">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgApplicationBase.MainForm">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TfpgApplicationBase.Terminated">
- <short/>
- <descr/>
- <seealso/>
</element>
+
<!-- function Visibility: default -->
<element name="KeycodeToText">
<short>Returns the text representation of a keycode.</short>
<descr>This is mainly used for debugging, but could also be used for Menu Item keyboard
shortcuts etc.
</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="KeycodeToText.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="KeycodeToText.AKey">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="KeycodeToText.AShiftState">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="CheckClipboardKey">
<short>Detects if the pressed keys represent a Clipboard key shortcut</short>
<descr>Detects if the pressed keys represent a Clipboard key shortcut. If it does, it
returns the correct enum type detected.
</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="CheckClipboardKey.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="CheckClipboardKey.AKey">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="CheckClipboardKey.AShiftstate">
- <short/>
</element>
+
<!-- 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>
- <errors/>
+ <descr>This function converts the given TfpgColor into a TRGBTriple type.</descr>
<seealso>
- <link id="TRGBTriple"/>
+ <link id="fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
- <!-- function result Visibility: default -->
- <element name="fpgColorToRGBTriple.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgColorToRGBTriple.AColor">
- <short/>
- </element>
+
<!-- function Visibility: default -->
<element name="RGBTripleTofpgColor">
<short>Converts the TRGBTriple to TfpgColor type</short>
<descr>This function converts the given TRGBTriple into a TfpgColor type.
</descr>
- <errors/>
<seealso>
- <link id="TRGBTriple"/>
+ <link id="fpg_base.TRGBTriple">TRGBTriple</link>
</seealso>
</element>
- <!-- function result Visibility: default -->
- <element name="RGBTripleTofpgColor.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="RGBTripleTofpgColor.AColor">
- <short/>
- </element>
<!-- function Visibility: default -->
<element name="fpgGetRed">
<short>Returns the Red portion of a color value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="fpgGetRed.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetRed.AColor">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="fpgGetGreen">
<short>Returns the Green portion of a color value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="fpgGetGreen.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetGreen.AColor">
- <short/>
</element>
<!-- function Visibility: default -->
<element name="fpgGetBlue">
<short>Returns the Blue portion of a color value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="fpgGetBlue.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetBlue.AColor">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="fpgGetAlpha">
<short>Returns the Alpha portion of a color value.</short>
<descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="fpgGetAlpha.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetAlpha.AColor">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="fpgGetAvgColor">
<short>Calculates the average color using the two supplied</short>
<descr>This function calculates and returns the average color by using AColor1
and AColor2. The Alpha value also gets taken into account.
</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="fpgGetAvgColor.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetAvgColor.AColor1">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="fpgGetAvgColor.AColor2">
- <short/>
</element>
+
<!-- function Visibility: default -->
<element name="PtInRect">
<short>Returns true if APoint is inside ARect rectangle</short>
<descr>This function is used to detect if the point APoint is inside the given
rectangle ARect. If it is, the function returns True, otherwise False.
</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="PtInRect.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="PtInRect.ARect">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="PtInRect.APoint">
- <short/>
</element>
+
<!-- procedure Visibility: default -->
<element name="SortRect">
<short>Fixes the Top, Bottom and Left, Right to always represent a valid rectangle</short>
<descr>This function fixes a rectangle so that the Left point is always smaller than the
Right. And the Top is always smaller than the Bottom.
</descr>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="SortRect.ARect">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="SortRect.left">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="SortRect.top">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="SortRect.right">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="SortRect.bottom">
- <short/>
</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 do not want 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>
<descr>This does not do any drawing, in only clips the line coordinates. This method is used internally by <link id="TfpgCanvasBase.DrawLineClipped"/>.</descr>
</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>
</element>
+
<element name="TFileEntry.Extension">
<short>The extension of a file</short>
</element>
+
<element name="TFileEntry.Size">
<short>Size of a file in bytes</short>
</element>
+
<element name="TFileEntry.IsLink">
<short>Is this item a symbolic link (on unix-type OSes)</short>
</element>
+
<element name="TFileEntry.LinkTarget">
<short>If it is a symbolic link, LinkTarget is what it points too</short>
</element>
+
<element name="TFileEntry.ModTime">
<short>Last modified timestamp</short>
</element>
+
<element name="TFPColor">
<short>A record structure holding the RGBA values of a color.</short>
<descr>This is the same declaration as the one found in FPImage (include with Free Pascal Compiler). In future when FPImage is integrated with fpGUI, I will remove this declaration.</descr>
</element>
+
+<element name="TfpgPoint.ManhattanLength">
+<short>Quick calculation of the length between points</short>
+<descr><p>Returns the sum of the absolute values of X and Y,
+traditionally known as the "Manhattan length" of the vector from
+the origin to the point. For example:</p>
+<code>
+var
+ oldPosition: TfpgPoint;
+ newPosition: TfpgPoint;
+begin
+ newPosition := MousePosition - oldPosition;
+ if (newPosition.ManhattanLength > 5) then
+ begin
+ // the mouse has moved more than 5 pixels since the oldPosition
+ end;
+end;
+</code>
+<p>
+Accuracy is traded for speed. This is a useful, and quick to calculate, approximation to the
+true length:</p>
+<code>
+ TrueLength := sqrt(power(X, 2) + power(Y, 2));
+</code>
+<p>
+The tradition of "Manhattan length" arises because such distances
+apply to travelers who can only travel on a rectangular grid, like
+the streets of Manhattan.</p>
+<p>For a further explanation of "Manhattan length" see the WikiPedia article at
+<link>http://en.wikipedia.org/wiki/Taxicab_geometry</link></p>
+</descr>
+</element>
+
+
</module>
<!-- fpg_base -->
</package>
diff --git a/docs/xml/corelib/fpg_command_intf.xml b/docs/xml/corelib/fpg_command_intf.xml new file mode 100644 index 00000000..03ec28bb --- /dev/null +++ b/docs/xml/corelib/fpg_command_intf.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<fpdoc-descriptions> +<package name="fpGUI"> + +<module name="fpg_command_intf"> +<short>This unit defines the Command design pattern interfaces used by fpGUI</short> +<descr><p><printshort id="fpg_command_intf"/>. The Command design pattern is similar to +the TActions from Delphi or Lazarus.</p></descr> + +<element name="ICommand"> +<short>This interface represents a Command</short> +<descr><printshort id="ICommand"/>. Currently in only defines one procedure called <var>Execute</var>.</descr> +</element> + + +<element name="ICommandHolder"> +<short>An interface that allows to Get or Set a Command</short> +<descr><printshort id="ICommandHolder"/>. An example of a class that implements this interface +is the <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> class.</descr> +</element> + +</module> + +</package> +</fpdoc-descriptions> diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml index e02dd9c7..52377575 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="#fpgui.AdditionalTopics.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,7 @@ 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> + </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..f98efa3d 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"> @@ -72,6 +72,13 @@ fpGUI will be totally reworked to supply built-in and image based theming.</p><p document named <var>theming_spec.txt</var> in the "docs" folder for details of what is planned.</p></descr> </element> + +<element name="fpgRect"> +<seealso> +<link id="fpg_base.TfpgRect">TfpgRect</link> +</seealso> +</element> + </module> <!-- fpg_main --> </package> 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_widget.xml b/docs/xml/corelib/fpg_widget.xml index cb0ed0f5..6868c78a 100644 --- a/docs/xml/corelib/fpg_widget.xml +++ b/docs/xml/corelib/fpg_widget.xml @@ -1,40 +1,57 @@ <?xml version="1.0"?> <fpdoc-descriptions> - <package name="fpGUI"> - <module name="fpg_widget"> - <short/> - <descr/> - <!-- procedure Visibility: public --> - <element name="TfpgWidget.SetPosition"> - <short>Sets the position and size of the component.</short> - <descr>Sets the position and size of the component. It also fires the Resize message. If you are setting up a component like a button on a form, you don't really want the resize event to fire for the button, before the form is displayed (visible). In that case, rather use the components Top, Left, Width and Height properties.</descr> - </element> - <element name="TfpgWidget.FormDesigner"> - <short>If assigned, then this widget is being editing in the Form Designer</short> - </element> - <element name="TfpgWidget.Parent"> - <short>An alias for Owner.</short> - <descr>Unlike Delphi or Lazarus, fpGUI treats Owner and Parent as the same thing. Owner or Parent manages the life of children, and the parent/child hierarchy defines the visual aspect as well.</descr> - </element> - <element name="TfpgWidget.IsContainer"> - <short>Can this component managed child components.</short> - <descr>This is mainly used in fpGUI UI Designer, to know if you can drop on widget inside another widget.</descr> - </element> - <element name="TfpgWidget.Focusable"> - <short>This determines if the widget is allowed to received keyboard focus.</short> - </element> - <element name="TfpgWidget.Anchors"> - <short>Allows the component to resize or reposition based on its Parent.</short> - <descr> - <p>By default Anchors are set to Top Left.</p> - <p> - <b>NOTE</b> - </p> - <p>Anchoring only takes affect <i>after</i> the component is visible on the screen (when the component has a window handle assigned). So if you create a Button in the constructor and set its Anchor property to Bottom/Right, and then set the size of the Form, the Button will <i>not</i> be repositioned. -</p> - <p>This is by design. fpGUI allows you to setup a window layout without triggering unnecesary events as you set property values for each widget. Only when csLoading is not in ComponentState, then anchoring events will be triggered. This allows the developer or the fpGUI UI Designer to setup a window layout undisturbed.</p> - </descr> - </element> - </module> - </package> +<package name="fpGUI"> +<module name="fpg_widget"> +<short/> +<descr/> + +<element name="TfpgWidget.SetPosition"> +<short>Sets the position and size of the component</short> +<descr><printshort id="TfpgWidget.SetPosition"/>. It also fires the Resize message. If you are setting up a component like a button on a form, you don't really want the resize event to fire for the button, before the form is displayed (visible). In that case, rather use the components Top, Left, Width and Height properties.</descr> +<seealso> +<link id="fpg_base.TfpgWindowBase.UpdateWindowPosition">TfpgWindowBase.UpdateWindowPosition</link> +</seealso> +</element> + +<element name="TfpgWidget.FormDesigner"> +<short>If assigned, then this widget is being editing in the Form Designer</short> +</element> + +<element name="TfpgWidget.Parent"> +<short>An alias for Owner</short> +<descr>Unlike Delphi or Lazarus, fpGUI treats Owner and Parent as the same thing. Owner or Parent manages the life of children, and the parent/child hierarchy defines the visual aspect as well.</descr> +</element> + +<element name="TfpgWidget.IsContainer"> +<short>Can this component managed child components</short> +<descr>This is mainly used in fpGUI UI Designer, to know if you can drop on widget inside another widget.</descr> +</element> + +<element name="TfpgWidget.Focusable"> +<short>This determines if the widget is allowed to received keyboard focus</short> +<descr><printshort id="TfpgWidget.Focusable"/>. No focus rectangle will be drawn, even +if the user clicks this component.</descr> +</element> + +<element name="TfpgWidget.Anchors"> +<short>Allows the component to resize or reposition based on its Parent.</short> +<descr><p>By default Anchors are set to Top Left.</p> +<remark>Anchoring only takes affect <i>after</i> the component is visible on the +screen (when the component has a window handle assigned). So if you create a Button +in the constructor and set its Anchor property to Bottom/Right, and then set the +size of the Form, the Button will <i>not</i> be repositioned.</remark> +<p>This is by design. fpGUI allows you to setup a window layout without triggering unnecesary events as you set property values for each widget. Only when csLoading is not in ComponentState, then anchoring events will be triggered. This allows the developer or the fpGUI UI Designer to setup a window layout undisturbed.</p> +</descr> +</element> + +<element name="TfpgWidget.HandleLMouseUp"> +<short>Occurs after the component processed the mouse button press event</short> +<descr><printshort id="TfpgWidget.HandleLMouseUp"/>. By default this method also +triggers the OnClick event, but this behaviour can be overridden by descendant +components.</descr> +</element> + + +</module> +</package> </fpdoc-descriptions> 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/fpgui_topic_defaultlanguage.xml b/docs/xml/fpgui_topic_defaultlanguage.xml new file mode 100644 index 00000000..a4d3fa79 --- /dev/null +++ b/docs/xml/fpgui_topic_defaultlanguage.xml @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> +<package name="fpGUI"> +<topic name="AdditionalTopics"> +<short>Additional Topics</short> + +<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> +</topic> +</package> +</fpdoc-descriptions> diff --git a/docs/xml/fpgui_topic_dnd.xml b/docs/xml/fpgui_topic_dnd.xml new file mode 100644 index 00000000..3c0f4346 --- /dev/null +++ b/docs/xml/fpgui_topic_dnd.xml @@ -0,0 +1,32 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> +<package name="fpGUI"> +<topic name="AdditionalTopics"> +<short>Additional Topics</short> +<topic name='DND'> + +<short>Drag and Drop</short> + +<descr><p>Drag and drop provides a simple visual mechanism which users can use +to transfer information between and within applications. [In the literature this +is referred to as a "direct manipulation model".] Drag and drop is similar in +function to the clipboard's cut and paste mechanism. +</p> +<p>This topic describes the basic drag and drop mechanism and outlines the +approach used to enable it in custom widgets. +</p> +<p><b>Drag and Drop Classes</b></p> +<p>These classes deal with drag and drop and the necessary mime type encoding and +decoding.</p> +<dl> +<dt>TfpgDrag</dt><dd>The Object that initializes the drag and drop action, and +that manages the lifespan of the TfpgMimeData instance.</dd> +<dt>TfpgMimeData</dt><dd>This class manages data and a mime type describing that +data.</dd> +</dl> +</descr> + +</topic> +</topic> +</package> +</fpdoc-descriptions> diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml index 137231ce..dec53067 100644 --- a/docs/xml/gui/fpg_button.xml +++ b/docs/xml/gui/fpg_button.xml @@ -47,9 +47,10 @@ simply publishes various properties for runtime type information.</descr> <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"/> + +<element name="TfpgButton.ImageName" link="TfpgBaseButton.ImageName"/> +<element name="TfpgButton.ImageSpacing" link="TfpgBaseButton.ImageSpacing"/> +<element name="TfpgButton.ImageLayout" link="TfpgBaseButton.ImageLayout"/> </module> </package> 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_form.xml b/docs/xml/gui/fpg_form.xml new file mode 100644 index 00000000..3dfb01fc --- /dev/null +++ b/docs/xml/gui/fpg_form.xml @@ -0,0 +1,30 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> + <package name="fpGUI"> + <module name="fpg_form"> + <short>This unit contains the class implementation representing a Form/Window on the screen</short> + <descr/> + +<element name="TWindowPosition.wpUser"> +<descr>OS or Desktop/Window manager decides the position.</descr> +</element> + +<element name="TWindowPosition.wpAuto"> +<descr>Window gets placed in exact x,y coordinates set by developer.</descr> +</element> + +<element name="TWindowPosition.wpScreenCenter"> +<descr>Window gets centered horizontally and vertically in the current desktop window.</descr> +</element> + +<element name="TWindowPosition.wpOneThirdDown"> +<descr>Following the "golden ratio 1.618" rules or ideas as to what is +pleasing to the eye. The window is positioned one third from +the top of the screen, using the desktop height to calculate, and centered +horizontally. +</descr> +</element> + + </module> + </package> +</fpdoc-descriptions> 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 diff --git a/docs/xml/gui/fpg_tree.xml b/docs/xml/gui/fpg_tree.xml new file mode 100644 index 00000000..60af7603 --- /dev/null +++ b/docs/xml/gui/fpg_tree.xml @@ -0,0 +1,162 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> +<package name="fpGUI"> + +<module name="fpg_tree"> +<short>This unit defines a tree view control</short> +<descr><p><printshort id="fpg_tree"/>. A tree view displays items in an indented +outline. The control provides buttons that allow nodes to be expanded and collapsed. +You can include icons with items' text labels and display different icons to +indicate whether a node is expanded or collapsed.</p> +</descr> + + +<element name="TfpgTreeView"> +<short>Represents a window that displays a hierachy list of items</short> +<descr><p><printshort id="TfpgTreeView"/>. Examples of such hierachies can be +the headings in a document, the entries in a index, or the files and directories +on a disk.</p> +<p>Use TfpgTreeView to add an expanding and contracting outline to a form. Each node +in a tree view control consists of a label and a number of optional bitmapped images. +Each node can have a list of subnodes associated with it. By clicking on a node, +the user can expand or collapse the associated list of subnodes.</p> +<remark>There is basic column support, but this is still very experimental.</remark></descr> +</element> + +<element name="TfpgTreeView.FullCollapse"> +<short>Collapses all the nodes within a tree view control</short> +<descr><printshort id="TfpgTreeView.FullCollapse"/>. Call FullCollapse to hide +all the nodes in the tree view except those at the first level. All node buttons +will change from '-' to '+'.</descr> +<seealso> + <link id="TfpgTreeView.FullExpand"/> +</seealso> +</element> + +<element name="TfpgTreeView.FullExpand"> +<short>Expands all nodes within the tree view control</short> +<descr><printshort id="TfpgTreeView.FullExpand"/>. Call FullExpand to display +all the nodes in the tree view. All node buttons will change from '+' to '-'.</descr> +<seealso> + <link id="TfpgTreeView.FullCollapse"/> +</seealso> +</element> + +<element name="TfpgTreeView.GotoNextNodeUp"> +<short>Moves the selection to the previous node up the tree</short> +</element> + +<element name="TfpgTreeView.GotoNextNodeDown"> +<short>Moves the selection to the next node down the tree</short> +</element> + +<element name="TfpgTreeView.NextNode"> +<short>Return the next node after ANode</short> +<descr><printshort id="TfpgTreeView.NextNode"/>. This function will step into child +nodes as well, to return the correct node. It works on the actual nodes in the tree, +and not just the visible nodes in the tree.</descr> +<seealso> + <link id="TfpgTreeView.PrevNode"/> +</seealso> +</element> + +<element name="TfpgTreeView.PrevNode"> +<short>Return the previous node starting from ANode</short> +<descr><printshort id="TfpgTreeView.PrevNode"/>. This function will step into child +nodes as well, to insure it returns the correct node. It works on the actual nodes +in the tree, and not just on the visible nodes.</descr> +<seealso> + <link id="TfpgTreeView.NextNode"/> +</seealso> +</element> + +<element name="TfpgTreeview.NextVisualNode"> +<short>Return the next visible node starting from ANode</short> +<descr><printshort id="TfpgTreeview.NextVisualNode"/>. This works exactly the same +as <var>NextNode</var> function, but this time it only acts on nodes that are visible.</descr> +<seealso> + <link id="TfpgTreeview.NextNode"/> +</seealso> +</element> + +<element name="TfpgTreeview.PrevVisualNode"> +<short>Return the previous visible node starting from ANode</short> +<descr><printshort id="TfpgTreeview.PrevVisualNode"/>. This works exactly the same +as <var>PrevNode</var> function, but this time it only acts on nodes that are visible.</descr> +<seealso> + <link id="TfpgTreeview.PrevNode"/> +</seealso> +</element> + +<element name="TfpgTreeview.Font"> +<short>This gives you read access to the internal Font resource</short> +<descr><printshort id="TfpgTreeview.Font"/>. If you want to change the font used +in the tree view, use the <link id="TfpgTreeview.FondDesc">FondDesc</link> property instead.</descr> +<seealso> + <link id="TfpgTreeview.FontDesc"/> +</seealso> +</element> + +<element name="TfpgTreeview.RootNode"> +<short>Returns the first node of the tree where all other nodes branch from</short> +<descr><printshort id="TfpgTreeview.RootNode"/>. This node is not a visible node, and +is the internal node all other nodes in the tree branches from.</descr> +</element> + +<element name="TfpgTreeview.Selection"> +<short>Specifies the selected node in the tree vie</short> +<descr><p><printshort id="TfpgTreeview.Selection"/>. Read <var>Selection</var> to access +the selected node of the tree view. If there is no selected node, the value returned +is nil.</p> +<p>Set <var>Selection</var> to set the node in the tree view. If the new node is +a child of a collapsed node, the tree view will automatically +expand the nodes and scroll the new selected node into view. As the parent nodes are +expanded, so the tree view will trigger the OnExpand event as well.</p></descr> +</element> + +<element name="TfpgTreeview.ImageList"> +<short>Refers to the image list associated with the tree view</short> +<descr><printshort id="TfpgTreeview.ImageList"/>. Use the <var>ImageList</var> to +provide a customised list of bitmaps that can be displayed with the node's text. Use +the node's <link id="TfpgTreeNode.ImageIndex">ImageIndex</link> property to specify the +bitmap that must be painted next to the node's text.</descr> +<seealso> + <link id="TfpgTreeNode.ImageIndex"/> +</seealso> +</element> + +<element name="TfpgTreeview.PopupMenu"> +<short>Identifies the pop-up menu associated with the tree view</short> +<descr><printshort id="TfpgTreeview.PopupMenu"/>. Assign a value to <var>PopupMenu</var> +to make a popup-menu appear when the user selects the control and clicks the right mouse +button.</descr> +</element> + +<element name="TfpgTreeview.DefaultColumnWidth"> +<short>Is the default with of columns displayed in the tree view</short> +<descr><p><printshort id="TfpgTreeview.DefaultColumnWidth"/>.</p> +<remark>There is basic column support, but this is still very experimental.</remark></descr> +</element> + +<element name="TfpgTreeview.FontDesc"> +<short>Specifies the font used for the tree view</short> +<descr><printshort id="TfpgTreeview.FontDesc"/>. You can specify the font name and size +in the format <var>fontname-size:attributes</var>, or you can use any of the font +aliases that has been setup. A font alias is a short name for some specific font, font size +and attribute all in one. A font alias is in the format <var>#aliasname</var>.</descr> +</element> + + +<element name="TfpgTreeview.HandleLMouseUp" link="fpg_widget.TfpgWidget.HandleLMouseUp"/> +<element name="TfpgTreeview.HandleLMouseDown" link="fpg_widget.TfpgWidget.HandleLMouseDown"/> +<element name="TfpgTreeview.HandleRMouseUp" link="fpg_widget.TfpgWidget.HandleRMouseUp"/> +<element name="TfpgTreeview.HandleDoubleClick" link="fpg_widget.TfpgWidget.HandleDoubleClick"/> +<element name="TfpgTreeview.HandleKeyPress" link="fpg_widget.TfpgWidget.HandleKeyPress"/> +<element name="TfpgTreeview.HandleMouseScroll" link="fpg_widget.TfpgWidget.HandleMouseScroll"/> + + +</module> + +</package> +</fpdoc-descriptions> + |