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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::FalagardComponentBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html">FalagardComponentBase</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardComponentBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardComponentBase" -->
<p>Common base class used for renderable components within an <a class="el" href="classCEGUI_1_1ImagerySection.html" title="Class that encapsulates a re-usable collection of imagery specifications.">ImagerySection</a>.
<a href="classCEGUI_1_1FalagardComponentBase.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::FalagardComponentBase:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1FalagardComponentBase__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardComponentBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardComponentBase_inherit__map" id="CEGUI_1_1FalagardComponentBase_inherit__map">
<area shape="rect" id="node3" href="classCEGUI_1_1FrameComponent.html" title="Class that encapsulates information for a frame with background (9 images in total)" alt="" coords="5,83,181,112"/><area shape="rect" id="node5" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component." alt="" coords="205,83,392,112"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::FalagardComponentBase:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1FalagardComponentBase__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardComponentBase_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardComponentBase_coll__map" id="CEGUI_1_1FalagardComponentBase_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="28,5,134,35"/><area shape="rect" id="node6" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component." alt="" coords="192,113,357,143"/><area shape="rect" id="node4" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle." alt="" coords="381,113,520,143"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardComponentBase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f4a749c3e3c773185536e55a3f1083a"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::FalagardComponentBase" ref="a8f4a749c3e3c773185536e55a3f1083a" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a8f4a749c3e3c773185536e55a3f1083a">FalagardComponentBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a494a7328b5e46cfed688cd45ad54de02"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::~FalagardComponentBase" ref="a494a7328b5e46cfed688cd45ad54de02" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a494a7328b5e46cfed688cd45ad54de02">~FalagardComponentBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a1f187ccbc6063567a28d697625e417e1">render</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> &srcWindow, const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> *modColours=0, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clipper=0, bool clipToDisplay=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render this component. More correctly, the component is cached for rendering. <a href="#a1f187ccbc6063567a28d697625e417e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a693e97d4131f8966995d4d488493ee40">render</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> &srcWindow, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &baseRect, const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> *modColours=0, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clipper=0, bool clipToDisplay=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render this component. More correctly, the component is cached for rendering. <a href="#a693e97d4131f8966995d4d488493ee40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#acf6a2460d4efaf9390db8e1ef7f266ff">getComponentArea</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> of this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. <a href="#acf6a2460d4efaf9390db8e1ef7f266ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a2e0b1fffec8a1ef872382041636b78f2">setComponentArea</a> (const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> &area)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the ImageryComponent's <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. <a href="#a2e0b1fffec8a1ef872382041636b78f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a17c73a044a955dfb3677b88f7ad0e639">getColours</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> set for use by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. <a href="#a17c73a044a955dfb3677b88f7ad0e639"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a71d78fa0e03f1f7a7af06e8f2a2d28c5">setColours</a> (const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> &cols)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the colours to be used by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. <a href="#a71d78fa0e03f1f7a7af06e8f2a2d28c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a45790cbdf465483e16f6a54fb21e857e">setColoursPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property where colour values can be obtained. <a href="#a45790cbdf465483e16f6a54fb21e857e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a6955c5eb4546686971c52d0213c0d6a1">setColoursPropertyIsColourRect</a> (bool setting=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the colours property source represents a full <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>. <a href="#a6955c5eb4546686971c52d0213c0d6a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a166dde3857d83d130b8310dd6afccfcc">setVertFormattingPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property where vertical formatting option can be obtained. <a href="#a166dde3857d83d130b8310dd6afccfcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a84174b051923644a3f3b8dbfa834552b">setHorzFormattingPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property where horizontal formatting option can be obtained. <a href="#a84174b051923644a3f3b8dbfa834552b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a3cf3502a40c52e4a8d4182e71c84c794">initColoursRect</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd, const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> *modCols, <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> &cr) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper method to initialise a <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> with appropriate values according to the way the <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a> is set up. <a href="#a3cf3502a40c52e4a8d4182e71c84c794"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f4d18924b465414c68f162fea054622"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::render_impl" ref="a3f4d18924b465414c68f162fea054622" args="(Window &srcWindow, Rect &destRect, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const =0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a3f4d18924b465414c68f162fea054622">render_impl</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> &srcWindow, <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &destRect, const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> *modColours, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clipper, bool clipToDisplay) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method to do main render caching work. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a9aa87c8920d316d9c747c5430e24b97d">writeColoursXML</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes xml for the colours to a OutStream. Will prefer property colours before explicit. <a href="#a9aa87c8920d316d9c747c5430e24b97d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a764732a954e607a058da8c1f94c40615">writeVertFormatXML</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes xml for the vertical formatting to a OutStream if such a property is defined. <a href="#a764732a954e607a058da8c1f94c40615"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#ab0fba3f3ee4cdae7359b61659b3e1171">writeHorzFormatXML</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes xml for the horizontal formatting to a OutStream if such a property is defined. <a href="#ab0fba3f3ee4cdae7359b61659b3e1171"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7964b60a4f43af69e02785f526b7abff"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_area" ref="a7964b60a4f43af69e02785f526b7abff" args="" -->
<a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a7964b60a4f43af69e02785f526b7abff">d_area</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destination area for this component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf436333e7719daa3996e9e6ad67252e"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_colours" ref="acf436333e7719daa3996e9e6ad67252e" args="" -->
<a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#acf436333e7719daa3996e9e6ad67252e">d_colours</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">base colours to be applied when rendering the image component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaba6493408b17d9d4a1fe8e45314057"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_colourPropertyName" ref="afaba6493408b17d9d4a1fe8e45314057" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#afaba6493408b17d9d4a1fe8e45314057">d_colourPropertyName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">name of property to fetch colours from. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68923623c1a2c848ee7a7f8ccd644130"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_colourProperyIsRect" ref="a68923623c1a2c848ee7a7f8ccd644130" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a68923623c1a2c848ee7a7f8ccd644130">d_colourProperyIsRect</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the colour property will fetch a full <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a254fd89bd094309001237f7b54329f70"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_vertFormatPropertyName" ref="a254fd89bd094309001237f7b54329f70" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#a254fd89bd094309001237f7b54329f70">d_vertFormatPropertyName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">name of property to fetch vertical formatting setting from. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6f5503ee1a3ebe9e0edfd6dd1309d67"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::d_horzFormatPropertyName" ref="ab6f5503ee1a3ebe9e0edfd6dd1309d67" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardComponentBase.html#ab6f5503ee1a3ebe9e0edfd6dd1309d67">d_horzFormatPropertyName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">name of property to fetch horizontal formatting setting from. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Common base class used for renderable components within an <a class="el" href="classCEGUI_1_1ImagerySection.html" title="Class that encapsulates a re-usable collection of imagery specifications.">ImagerySection</a>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a17c73a044a955dfb3677b88f7ad0e639"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::getColours" ref="a17c73a044a955dfb3677b88f7ad0e639" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a>& CEGUI::FalagardComponentBase::getColours </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> set for use by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> object holding the colours currently in use by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="acf6a2460d4efaf9390db8e1ef7f266ff"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::getComponentArea" ref="acf6a2460d4efaf9390db8e1ef7f266ff" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a>& CEGUI::FalagardComponentBase::getComponentArea </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> of this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> object describing the ImageryComponent's current target area. </dd></dl>
</div>
</div>
<a class="anchor" id="a3cf3502a40c52e4a8d4182e71c84c794"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::initColoursRect" ref="a3cf3502a40c52e4a8d4182e71c84c794" args="(const Window &wnd, const ColourRect *modCols, ColourRect &cr) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::initColoursRect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>wnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> * </td>
<td class="paramname"><em>modCols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> & </td>
<td class="paramname"><em>cr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Helper method to initialise a <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> with appropriate values according to the way the <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a> is set up. </p>
<p>This will try and get values from multiple places:</p>
<ul>
<li>a property attached to <em>wnd</em> </li>
<li>or the integral d_colours value. </li>
</ul>
</div>
</div>
<a class="anchor" id="a693e97d4131f8966995d4d488493ee40"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::render" ref="a693e97d4131f8966995d4d488493ee40" args="(Window &srcWindow, const Rect &baseRect, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>srcWindow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> & </td>
<td class="paramname"><em>baseRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> * </td>
<td class="paramname"><em>modColours</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> * </td>
<td class="paramname"><em>clipper</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clipToDisplay</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Render this component. More correctly, the component is cached for rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">srcWindow</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> to use as the base for translating the component's <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> into pixel values.</td></tr>
<tr><td class="paramname">baseRect</td><td><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> to use as the base for translating the component's <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> into pixel values.</td></tr>
<tr><td class="paramname">modColours</td><td><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f187ccbc6063567a28d697625e417e1"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::render" ref="a1f187ccbc6063567a28d697625e417e1" args="(Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rect *clipper=0, bool clipToDisplay=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>srcWindow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> * </td>
<td class="paramname"><em>modColours</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> * </td>
<td class="paramname"><em>clipper</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clipToDisplay</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Render this component. More correctly, the component is cached for rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">srcWindow</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> to use as the base for translating the component's <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> into pixel values.</td></tr>
<tr><td class="paramname">modColours</td><td><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> describing colours that are to be modulated with the component's stored colour values to calculate a set of 'final' colour values to be used. May be 0.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a71d78fa0e03f1f7a7af06e8f2a2d28c5"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setColours" ref="a71d78fa0e03f1f7a7af06e8f2a2d28c5" args="(const ColourRect &cols)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setColours </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> & </td>
<td class="paramname"><em>cols</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the colours to be used by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cols</td><td><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> object describing the colours to be used by this <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6955c5eb4546686971c52d0213c0d6a1"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect" ref="a6955c5eb4546686971c52d0213c0d6a1" args="(bool setting=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setColoursPropertyIsColourRect </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set whether the colours property source represents a full <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td><ul>
<li>true if the colours property will access a <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> object.</li>
<li>false if the colours property will access a colour object.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a45790cbdf465483e16f6a54fb21e857e"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setColoursPropertySource" ref="a45790cbdf465483e16f6a54fb21e857e" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setColoursPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property where colour values can be obtained. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the property.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a2e0b1fffec8a1ef872382041636b78f2"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setComponentArea" ref="a2e0b1fffec8a1ef872382041636b78f2" args="(const ComponentArea &area)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setComponentArea </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> & </td>
<td class="paramname"><em>area</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the ImageryComponent's <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td><a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> object describing a new target area for the <a class="el" href="classCEGUI_1_1ImageryComponent.html" title="Class that encapsulates information for a single image component.">ImageryComponent</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a84174b051923644a3f3b8dbfa834552b"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setHorzFormattingPropertySource" ref="a84174b051923644a3f3b8dbfa834552b" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setHorzFormattingPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property where horizontal formatting option can be obtained. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the property.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a166dde3857d83d130b8310dd6afccfcc"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::setVertFormattingPropertySource" ref="a166dde3857d83d130b8310dd6afccfcc" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardComponentBase::setVertFormattingPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property where vertical formatting option can be obtained. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the property.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a9aa87c8920d316d9c747c5430e24b97d"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::writeColoursXML" ref="a9aa87c8920d316d9c747c5430e24b97d" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::FalagardComponentBase::writeColoursXML </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes xml for the colours to a OutStream. Will prefer property colours before explicit. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is intended as a helper method for sub-classes when outputting xml to a stream.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if xml element was written.</li>
<li>false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.) </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ab0fba3f3ee4cdae7359b61659b3e1171"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::writeHorzFormatXML" ref="ab0fba3f3ee4cdae7359b61659b3e1171" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::FalagardComponentBase::writeHorzFormatXML </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes xml for the horizontal formatting to a OutStream if such a property is defined. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is intended as a helper method for sub-classes when outputting xml to a stream.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if xml element was written.</li>
<li>false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.) </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a764732a954e607a058da8c1f94c40615"></a><!-- doxytag: member="CEGUI::FalagardComponentBase::writeVertFormatXML" ref="a764732a954e607a058da8c1f94c40615" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::FalagardComponentBase::writeVertFormatXML </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes xml for the vertical formatting to a OutStream if such a property is defined. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is intended as a helper method for sub-classes when outputting xml to a stream.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if xml element was written.</li>
<li>false if nothing was output due to the formatting not being set (sub-class may then choose to do something else.) </li>
</ul>
</dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
