File: CastleControls.TCastleTheme.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (270 lines) | stat: -rw-r--r-- 17,524 bytes parent folder | download
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
<!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: CastleControls: Class TCastleTheme</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">
<a name="TCastleTheme"></a><h1 class="cio">Class TCastleTheme</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td><a class="section" href="#PasDoc-Fields">Fields</a></td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleControls.html">CastleControls</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCastleTheme = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Theme for 2D GUI controls. Should only be used through the single global instance <a class="normal" href="CastleControls.html#Theme">Theme</a>.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TCastleTheme</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Fields"></a><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#TooltipTextColor">TooltipTextColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#TextColor">TextColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#MessageTextColor">MessageTextColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#MessageInputTextColor">MessageInputTextColor</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#BarEmptyColor">BarEmptyColor</a></b>: <a  href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#BarFilledColor">BarFilledColor</a></b>: <a  href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleControls.TCastleTheme.html#BackgroundTint">BackgroundTint</a></b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleControls.TCastleTheme.html#Create">Create</a></b>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a  href="CastleControls.TCastleTheme.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleControls.TCastleTheme.html#Draw">Draw</a></b>(const Rect: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const ImageType: <a  href="CastleControls.html#TThemeImage">TThemeImage</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleControls.TCastleTheme.html#Draw">Draw</a></b>(const Rect: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const ImageType: <a  href="CastleControls.html#TThemeImage">TThemeImage</a>; const Color: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>);</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastleTheme.html#Images">Images</a></b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: <a  href="CastleImages.TCastleImage.html">TCastleImage</a> read GetImages write SetImages;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastleTheme.html#OwnsImages">OwnsImages</a></b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: boolean read GetOwnsImages write SetOwnsImages;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastleTheme.html#Corners">Corners</a></b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: <a  href="CastleVectors.html#TVector4Integer">TVector4Integer</a> read GetCorners write SetCorners;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastleTheme.html#MessageFont">MessageFont</a></b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read FMessageFont write SetMessageFont;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleControls.TCastleTheme.html#OwnsMessageFont">OwnsMessageFont</a></b>: boolean
      read FOwnsMessageFont write FOwnsMessageFont default true;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TooltipTextColor"></a><code><b>TooltipTextColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TextColor"></a><code><b>TextColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MessageTextColor"></a><code><b>MessageTextColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MessageInputTextColor"></a><code><b>MessageInputTextColor</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="BarEmptyColor"></a><code><b>BarEmptyColor</b>: <a  href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="BarFilledColor"></a><code><b>BarFilledColor</b>: <a  href="CastleVectors.html#TVector3Byte">TVector3Byte</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="BackgroundTint"></a><code><b>BackgroundTint</b>: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Tint of background image under <a class="normal" href="CastleControls.TCastleDialog.html">TCastleDialog</a>. Default is (0.25, 0.25, 0.25, 1), which makes background darker, which helps dialog to stand out.</p>
</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Draw"></a><code>procedure <b>Draw</b>(const Rect: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const ImageType: <a  href="CastleControls.html#TThemeImage">TThemeImage</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Draw the selected theme image on screen. If you do not specify a color, <a class="normal" href="CastleColors.html#White">white</a> will be used, so image will be displayed as-is. Specifying a color means that image will be multiplied by it, just like for <a class="normal" href="CastleGLImages.TGLImage.html#Color">TGLImage.Color</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Draw"></a><code>procedure <b>Draw</b>(const Rect: <a  href="CastleRectangles.TRectangle.html">TRectangle</a>; const ImageType: <a  href="CastleControls.html#TThemeImage">TThemeImage</a>; const Color: <a  href="CastleColors.html#TCastleColor">TCastleColor</a>);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Images"></a><code>property <b>Images</b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: <a  href="CastleImages.TCastleImage.html">TCastleImage</a> read GetImages write SetImages;</code></td>
</tr>
<tr><td colspan="2">
<p>
2D GUI images, represented as <a class="normal" href="CastleImages.TCastleImage.html">TCastleImage</a>. Although they all have sensible defaults, you can also change them at any time. Simply create <a class="normal" href="CastleImages.TCastleImage.html">TCastleImage</a> instance (e.g. by <a class="normal" href="CastleImages.html#LoadImage">LoadImage</a> function) and assign it here. Be sure to adjust also <a class="normal" href="CastleControls.TCastleTheme.html#OwnsImages">OwnsImages</a> if you want the theme to automatically free the image when it's no longer used.

<p>The alpha channel of the image, if any, is automatically correctly used (for alpha test or alpha blending, see <a class="normal" href="CastleGLImages.TGLImage.html">TGLImage</a>).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="OwnsImages"></a><code>property <b>OwnsImages</b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: boolean read GetOwnsImages write SetOwnsImages;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Corners"></a><code>property <b>Corners</b>[constImageType:<a  href="CastleControls.html#TThemeImage">TThemeImage</a>]: <a  href="CastleVectors.html#TVector4Integer">TVector4Integer</a> read GetCorners write SetCorners;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Corners</code> that determine how image on <a class="normal" href="CastleControls.TCastleTheme.html#Images">Images</a> is stretched when drawing by <a class="normal" href="CastleControls.TCastleTheme.html#Draw">TCastleTheme.Draw</a> method. Together with assigning <a class="normal" href="CastleControls.TCastleTheme.html#Images">Images</a>, adjust also this property. It is used for images rendered using <a class="normal" href="CastleGLImages.TGLImage.html#Draw3x3">TGLImage.Draw3x3</a>, it determines how the image is stretched. The <code>corners</code> are specified as 4D vector, order like in CSS: top, right, down, left.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MessageFont"></a><code>property <b>MessageFont</b>: <a  href="CastleFonts.TCastleFont.html">TCastleFont</a> read FMessageFont write SetMessageFont;</code></td>
</tr>
<tr><td colspan="2">
<p>
Font used by dialogs. Leave <code>Nil</code> to use <a class="normal" href="CastleControls.html#UIFont">UIFont</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="OwnsMessageFont"></a><code>property <b>OwnsMessageFont</b>: boolean
      read FOwnsMessageFont write FOwnsMessageFont default true;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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&amp;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:09</em>
</span>
</td></tr></table></body></html>