blob: 6323f257de3ffd04e65d3b74f5f7a01368397b7f (
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_utils">
<short>Utility functions.</short>
<descr><p>Utility functions used throughout fpGUI. Some have common
implementations and some have platform specific implementations.</p></descr>
<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>
<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>
<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>
<element name="fpgOpenURL.aURL">
<short>URL address to go to</short>
</element>
<element name="fpgFileSize">
<short>Returns the given file's size in bytes</short>
<descr><printshort id="fpgFileSize"/>.</descr>
</element>
<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>
<element name="fpgAddTrailingValue.ALine">
<short>The source string</short>
</element>
<element name="fpgAddTrailingValue.AValue">
<short>The value that must be added</short>
</element>
<element name="fpgAddTrailingValue.ADuplicates">
<short>Are duplicate AValue's allowed</short>
</element>
<element name="fpgAppendPathDelim">
<short>Appends the path delimiter to the given string</short>
<descr><printshort id="fpgAppendPathDelim"/>.</descr>
</element>
<element name="fpgHasSubDirs">
<short>This function returns True if the directory passed has subdirectories</short>
<descr><printshort id="fpgHasSubDirs"/>.</descr>
</element>
<element name="fpgConvertLineEndings">
<short>Replaces all line endings in the string with the native line ending</short>
<descr><printshort id="fpgConvertLineEndings"/>.</descr>
</element>
<element name="fpgAddColon">
<short>Appends a colon symbol to the given text</short>
<descr><printshort id="fpgAddColon"/>. This is so that when we support LTR and RTL
languages, the colon will be added at the correct place. Currently the RTL behaviour
has not been implemented yet.</descr>
</element>
<element name="fpgIsBitSet">
<short>Read a specific bit value in a LongInt variable</short>
<descr>This procedure allows you to read a specific AIndex bit value from the AData variable.</descr>
<seealso>
<link id="fpgSetBit"/>
<link id="fpgGetBit"/>
</seealso>
<version>Deprecated in v1.4</version>
</element>
<element name="fpgGetBit">
<short>Read a specific bit value in a LongInt variable</short>
<descr>This procedure allows you to read a specific ABit bit value from the AData variable.</descr>
<seealso>
<link id="fpgSetBit"/>
</seealso>
<version>Added in v1.4</version>
</element>
<element name="fpgSetBit">
<short>Set a specific bit value in a LongInt variable</short>
<descr>This function allows you to set a specific ABit bit value in a the AData variable.</descr>
<seealso>
<link id="fpgGetBit"/>
</seealso>
<version>Added in v1.4</version>
</element>
<element name="fpgGetToolkitConfigDir">
<short>Returns the general fpGUI Toolkit config file</short>
<descr><printshort id="fpgGetToolkitConfigDir"/>. This is used to store user defined values
that apply to the whole fpGUI toolkit and applications developed with fpGUI. Things like
directory bookmarks, global themes, fonts etc.</descr>
</element>
<element name="fpgAllFilesMask">
<short>Returns the all files mask used to filter files</short>
<descr><printshort id="fpgAllFilesMask"/>. This is used in the File Dialog, File Grid and
many other places. Because FPC 2.2.2 and later contains the ALLFilesMask variable, this
function is now deprecated.</descr>
<version>Deprecated in v1.4</version>
</element>
</module>
</package>
</fpdoc-descriptions>
|
