summaryrefslogtreecommitdiff
path: root/docs/xml/corelib/fpg_constants.xml
diff options
context:
space:
mode:
authorAndrew Haines <andrewd207@aol.com>2010-08-15 09:22:59 -0400
committerAndrew Haines <andrewd207@aol.com>2010-08-15 09:22:59 -0400
commit917a2daf4ff769ad27631e6c71a7b919c47e4ecb (patch)
treec524983404bd70c97c17395995f962cdf41899cc /docs/xml/corelib/fpg_constants.xml
parent77245bbf79e8568ba143cd7654e8aba352253a81 (diff)
parent59df247d7a5ff46cc8ac697526510b2ff6cbe5d2 (diff)
downloadfpGUI-917a2daf4ff769ad27631e6c71a7b919c47e4ecb.tar.xz
Merge branch 'master' of ssh://fpgui.git.sourceforge.net/gitroot/fpgui/fpgui
Diffstat (limited to 'docs/xml/corelib/fpg_constants.xml')
-rw-r--r--docs/xml/corelib/fpg_constants.xml32
1 files changed, 25 insertions, 7 deletions
diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml
index ccd98914..e02dd9c7 100644
--- a/docs/xml/corelib/fpg_constants.xml
+++ b/docs/xml/corelib/fpg_constants.xml
@@ -1,13 +1,31 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
-<package name="CoreLib">
+<package name="fpGUI">
<module name="fpg_constants">
-<short></short>
-<descr>
+<short>All constants used in fpGUI are defined here</short>
+<descr><p><printshort id="fpg_constants"/>. All the text constants defined here,
+are also the ones that get translated to multiple languages. Currently fpGUI
+and translations for: Afrikaans, German, English (default), Spanish, French,
+Italian, Portuguese (Brazil) and Russian.</p>
+<p>To change the default (compiled in) language used by fpGUI, simply enabled
+one of the language DEFINES in the interface section of the fpg_constants unit.
+</p>
</descr>
-
-</module>
-
-</package>
+ <element name="fpgAddColon">
+ <short>A utility function to add a colon at the correct location in a string</short>
+ <descr>
+ <printshort id="fpgAddColon"/>. This is so that when fpGUI supports LTR and RTL languages, the colon will be added at the correct place.</descr>
+ </element>
+ <element name="DEFAULT_HINT_PAUSE">
+ <short>Default pause in milliseconds before a hint is displayed</short>
+ </element>
+ <element name="DOUBLECLICK_MS">
+ <short>Time maximum time in milliseconds between left-clicks for a double click to be triggered</short>
+ </element>
+ <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>