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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleLCLUtils</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<h1 class="unit">Unit CastleLCLUtils</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td>Classes, Interfaces, Objects and Records</td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td>Types</td><td><a class="section" href="#PasDoc-Constants">Constants</a></td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Utilities for cooperation between LCL and "Castle Game Engine".</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>Dialogs</li><li>Classes</li><li>Controls</li><li><a href="CastleFileFilters.html">CastleFileFilters</a></li><li><a href="CastleKeysMouse.html">CastleKeysMouse</a></li><li>Graphics</li><li><a href="CastleVectors.html">CastleVectors</a></li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToDialog">FileFiltersToDialog</a></b>(const FileFilters: string; Dialog: TFileDialog; const AllFields: boolean = true);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToDialog">FileFiltersToDialog</a></b>(const FileFilters: string; out LCLFilter: string; out LCLFilterIndex: Integer; const AllFields: boolean = true);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToDialog">FileFiltersToDialog</a></b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; Dialog: TFileDialog; const AllFields: boolean = true);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToDialog">FileFiltersToDialog</a></b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; out LCLFilter: string; out LCLFilterIndex: Integer; const AllFields: boolean = true);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#SQuoteLCLCaption">SQuoteLCLCaption</a></b>(const S: string): string;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToOpenDialog">FileFiltersToOpenDialog</a></b>(const FileFilters: string; Dialog: TFileDialog); deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToOpenDialog">FileFiltersToOpenDialog</a></b>(const FileFilters: string; out LCLFilter: string; out LCLFilterIndex: Integer); deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#FileFiltersToOpenDialog">FileFiltersToOpenDialog</a></b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; out LCLFilter: string; out LCLFilterIndex: Integer); deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#KeyLCLToCastle">KeyLCLToCastle</a></b>(const Key: Word; const Shift: TShiftState; out MyKey: <a href="CastleKeysMouse.html#TKey">TKey</a>; out MyCharKey: char);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#KeyCastleToLCL">KeyCastleToLCL</a></b>(const Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; const CharKey: char; const Modifiers: <a href="CastleKeysMouse.html#TModifierKeys">TModifierKeys</a>; out LazKey: Word; out Shift: TShiftState);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleLCLUtils.html#KeyCastleToLCL">KeyCastleToLCL</a></b>(const Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; const CharKey: char; out LazKey: Word; out Shift: TShiftState);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#MouseButtonLCLToCastle">MouseButtonLCLToCastle</a></b>( const MouseButton: Controls.TMouseButton; out MyMouseButton: <a href="CastleKeysMouse.html#TMouseButton">CastleKeysMouse.TMouseButton</a>): boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#FilenameToURISafeUTF8">FilenameToURISafeUTF8</a></b>(const FileName: string): string;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#URIToFilenameSafeUTF8">URIToFilenameSafeUTF8</a></b>(const URL: string): string;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#ColorToVector3">ColorToVector3</a></b>(const Color: TColor): <a href="CastleVectors.html#TVector3Single">TVector3Single</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleLCLUtils.html#ColorToVector3Byte">ColorToVector3Byte</a></b>(const Color: TColor): <a href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleLCLUtils.html#CursorCastleToLCL">CursorCastleToLCL</a></b>: array [<a href="CastleKeysMouse.html#TMouseCursor">TMouseCursor</a>] of TCursor =
( crDefault, crNone, crDefault ,
crArrow, crHourGlass, crIBeam, crHandPoint );</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToDialog"></a><code>procedure <b>FileFiltersToDialog</b>(const FileFilters: string; Dialog: TFileDialog; const AllFields: boolean = true);</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert file filters into LCL Dialog.Filter, Dialog.FilterIndex. Suitable for both open and save dialogs (TOpenDialog, TSaveDialog both descend from TFileDialog).
<p>Input filters are either given as a string FileFilters (encoded just like for <a class="normal" href="CastleFileFilters.TFileFilterList.html#AddFiltersFromString">TFileFilterList.AddFiltersFromString</a>), or as <a class="normal" href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a> instance.
<p>Output filters are either written to LCLFilter, LCLFilterIndex variables, or set appropriate properties of given Dialog instance.
<p>When AllFields is false, then filters starting with "All " in the name, like "All files", "All images", are not included in the output.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToDialog"></a><code>procedure <b>FileFiltersToDialog</b>(const FileFilters: string; out LCLFilter: string; out LCLFilterIndex: Integer; const AllFields: boolean = true);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToDialog"></a><code>procedure <b>FileFiltersToDialog</b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; Dialog: TFileDialog; const AllFields: boolean = true);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToDialog"></a><code>procedure <b>FileFiltersToDialog</b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; out LCLFilter: string; out LCLFilterIndex: Integer; const AllFields: boolean = true);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="SQuoteLCLCaption"></a><code>function <b>SQuoteLCLCaption</b>(const S: string): string;</code></td>
</tr>
<tr><td colspan="1">
<p>
Make each '&' inside string '&&', this way the string will not contain special '&x' sequences when used as a TMenuItem.Caption and such.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToOpenDialog"></a><code>procedure <b>FileFiltersToOpenDialog</b>(const FileFilters: string; Dialog: TFileDialog); deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Deprecated names, use the identifiers without "Open" in new code. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToOpenDialog"></a><code>procedure <b>FileFiltersToOpenDialog</b>(const FileFilters: string; out LCLFilter: string; out LCLFilterIndex: Integer); deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FileFiltersToOpenDialog"></a><code>procedure <b>FileFiltersToOpenDialog</b>(FFList: <a href="CastleFileFilters.TFileFilterList.html">TFileFilterList</a>; out LCLFilter: string; out LCLFilterIndex: Integer); deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p> </td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="KeyLCLToCastle"></a><code>procedure <b>KeyLCLToCastle</b>(const Key: Word; const Shift: TShiftState; out MyKey: <a href="CastleKeysMouse.html#TKey">TKey</a>; out MyCharKey: char);</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert Key (Lazarus key code) to Castle Game Engine <a class="normal" href="CastleKeysMouse.html#TKey">TKey</a>.
<p>In addition, this tries to convert Key to a character (MyCharKey). It's awful that this function has to do convertion to Char, but that's the way of VCL and LCL: KeyPress and KeyDown are separate events. While I want to have them in one event, and passed as one event to TUIControl.KeyDown.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="KeyCastleToLCL"></a><code>procedure <b>KeyCastleToLCL</b>(const Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; const CharKey: char; const Modifiers: <a href="CastleKeysMouse.html#TModifierKeys">TModifierKeys</a>; out LazKey: Word; out Shift: TShiftState);</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert <a class="normal" href="CastleKeysMouse.html#TKey">TKey</a> and/or character code into Lazarus key code (VK_xxx) and shift state. Sets LazKey to VK_UNKNOWN (zero) when convertion not possible (or when Key is K_None and CharKey = #0).
<p>Note that this is not a perfect reverse of <a class="normal" href="CastleLCLUtils.html#KeyLCLToCastle">KeyLCLToCastle</a> function. It can't, as there are ambiguities (e.g. character 'A' may be a key K_A with mkShift in modifiers).
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="KeyCastleToLCL"></a><code>procedure <b>KeyCastleToLCL</b>(const Key: <a href="CastleKeysMouse.html#TKey">TKey</a>; const CharKey: char; out LazKey: Word; out Shift: TShiftState);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="MouseButtonLCLToCastle"></a><code>function <b>MouseButtonLCLToCastle</b>( const MouseButton: Controls.TMouseButton; out MyMouseButton: <a href="CastleKeysMouse.html#TMouseButton">CastleKeysMouse.TMouseButton</a>): boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert Lazarus Controls.TMouseButton value to Castle Game Engine <a class="normal" href="CastleKeysMouse.html#TMouseButton">CastleKeysMouse.TMouseButton</a>.
<p>(By coincidence, my type name and values are the same as used by LCL; but beware — the order of values in my type is different (mbMiddle is in the middle in my type)).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FilenameToURISafeUTF8"></a><code>function <b>FilenameToURISafeUTF8</b>(const FileName: string): string;</code></td>
</tr>
<tr><td colspan="1">
<p>
mcCustom treat like mcDefault</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="URIToFilenameSafeUTF8"></a><code>function <b>URIToFilenameSafeUTF8</b>(const URL: string): string;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="ColorToVector3"></a><code>function <b>ColorToVector3</b>(const Color: TColor): <a href="CastleVectors.html#TVector3Single">TVector3Single</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Convert LCL color values to our colors (vectors).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="ColorToVector3Byte"></a><code>function <b>ColorToVector3Byte</b>(const Color: TColor): <a href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CursorCastleToLCL"></a><code><b>CursorCastleToLCL</b>: array [<a href="CastleKeysMouse.html#TMouseCursor">TMouseCursor</a>] of TCursor =
( crDefault, crNone, crDefault ,
crArrow, crHourGlass, crIBeam, crHandPoint );</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:10</em>
</span>
</td></tr></table></body></html>
|
