summaryrefslogtreecommitdiff
path: root/docs/xml/corelib/fpg_constants.xml
blob: 3f66acbe1113a4155796b813c61f3a072e72052b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpGUI">

<module name="fpg_constants">
<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
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>
<p>For more details on changing the default language of fpGUI Toolkit, see the topic
"<link id="fpg_constants.ChangingDefaultLanguage">Changing the default language</link>".</p>
</descr>
      <element name="fpgAddColon">
        <short>A utility function to add a colon at the correct location in a string</short>
        <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>
      
<topic name="ChangingDefaultLanguage">
<short>Changing the default language</short>
<descr><p>Inside the <var>fpg_constants.pas</var> unit there are a few commented language
defines. If no language specific Define is set, then fpGUI defaults to the English
language. So say you want to change the default language to German, simply uncomment
the <b>de</b> define, and recompile fpGUI.
</p>
<p>Here is a list of current supported languages and their commented defines as they
appear in the <var>fpg_constants</var> unit.</p>
<code>
{.$DEFINE de}     // German
{.$DEFINE ru}     // Russian
{.$DEFINE fr}     // French
{.$DEFINE pt}     // Portuguese (Brazil)
{.$DEFINE af}     // Afrikaans
{.$DEFINE it}     // Italian
{.$DEFINE es}     // Spanish
</code>
</descr>
</topic>    
      
    </module>
  </package>
</fpdoc-descriptions>