summaryrefslogtreecommitdiff
path: root/docs/xml/corelib/fpg_utils.xml
blob: 2b4f74fe314a8b7e135174f62c5a83dc559ae55a (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
64
65
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpGUI">

<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>

<!-- 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>
</element>

<!-- function Visibility: default -->
<element name="fpgFromOSEncoding">
<short>Converts OS specific filesystem encoding to fpGUI string</short>
<descr>This function is specific to filesystem strings like Paths, Filenames
 and Directories.
</descr>
</element>

<!-- procedure Visibility: default -->
<element name="fpgOpenURL">
<short>Launches the users Web Browser using the specified URL</short>
<descr>On each platform, this function will try and find the appropriate (system
 default) web browser.
</descr>
</element>

<!-- argument Visibility: default -->
<element name="fpgOpenURL.aURL">
<short>URL address to go to</short>
</element>

<!-- function Visibility: default -->
<element name="fpgAddTrailingValue">
<short>If ALine is not '', add the trailing value AValue</short>
<descr>If ALine is not '', add the trailing value AValue
</descr>
</element>

<!-- argument Visibility: default -->
<element name="fpgAddTrailingValue.ALine">
<short>The source string</short>
</element>

<!-- argument Visibility: default -->
<element name="fpgAddTrailingValue.AValue">
<short>The value that must be added</short>
</element>

<!-- argument Visibility: default -->
<element name="fpgAddTrailingValue.ADuplicates">
<short>Are duplicate AValue's allowed</short>
</element>

</module> 

</package>
</fpdoc-descriptions>