summaryrefslogtreecommitdiff
path: root/docs/xml/corelib/gfx_utils.xml
blob: 6c833f0b98aaa6dad373398fac62fd1e8fa441ee (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="CoreLib">

<!--
  ====================================================================
    gfx_utils
  ====================================================================
-->

<module name="gfx_utils">
<short>Utility functions.</short>
<descr>Utility functions used throughout fpGUI. Some have common
implementations and some have platform specific implementations.
</descr>

<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>

<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>

<!-- unresolved type reference Visibility: default -->
<element name="gfxbase">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>

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

<!-- function result Visibility: default -->
<element name="fpgToOSEncoding.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgToOSEncoding.aString">
<short></short>
</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>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgFromOSEncoding.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFromOSEncoding.aString">
<short></short>
</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>
<errors>
</errors>
<seealso>
</seealso>
</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>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgAddTrailingValue.Result">
<short></short>
</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>

<!-- function Visibility: default -->
<element name="fpgFindFirst">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgFindFirst.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFindFirst.Path">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFindFirst.Attr">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFindFirst.Rslt">
<short></short>
</element>

<!-- function Visibility: default -->
<element name="fpgFindNext">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgFindNext.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFindNext.Rslt">
<short></short>
</element>

<!-- function Visibility: default -->
<element name="fpgGetCurrentDir">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgGetCurrentDir.Result">
<short></short>
</element>

<!-- function Visibility: default -->
<element name="fpgSetCurrentDir">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgSetCurrentDir.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgSetCurrentDir.NewDir">
<short></short>
</element>

<!-- function Visibility: default -->
<element name="fpgExpandFileName">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgExpandFileName.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgExpandFileName.FileName">
<short></short>
</element>

<!-- function Visibility: default -->
<element name="fpgFileExists">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>

<!-- function result Visibility: default -->
<element name="fpgFileExists.Result">
<short></short>
</element>

<!-- argument Visibility: default -->
<element name="fpgFileExists.FileName">
<short></short>
</element>

</module> <!-- gfx_utils -->

</package>
</fpdoc-descriptions>