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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
|
<!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::MouseCursor 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_1MouseCursor.html">MouseCursor</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::MouseCursor Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::MouseCursor" --><!-- doxytag: inherits="CEGUI::EventSet,Singleton< MouseCursor >" -->
<p>Class that allows access to the GUI system mouse cursor.
<a href="classCEGUI_1_1MouseCursor.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::MouseCursor:</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_1MouseCursor__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MouseCursor_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1MouseCursor_inherit__map" id="CEGUI_1_1MouseCursor_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="5,5,131,35"/><area shape="rect" id="node4" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< MouseCursor \>" alt="" coords="155,5,384,35"/></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::MouseCursor:</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_1MouseCursor__coll__graph.gif" border="0" usemap="#CEGUI_1_1MouseCursor_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1MouseCursor_coll__map" id="CEGUI_1_1MouseCursor_coll__map">
<area shape="rect" id="node4" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< MouseCursor \>" alt="" coords="24,197,253,227"/><area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="5,5,131,35"/><area shape="rect" id="node7" href="classCEGUI_1_1URect.html" title="Area rectangle class built using unified dimensions (UDims)." alt="" coords="155,5,264,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1MouseCursor-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="ab57d76e02a0b34bc84308f70be4d261f"></a><!-- doxytag: member="CEGUI::MouseCursor::MouseCursor" ref="ab57d76e02a0b34bc84308f70be4d261f" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#ab57d76e02a0b34bc84308f70be4d261f">MouseCursor</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a598814467cfcb3d7628c3a1c6dc24e03"></a><!-- doxytag: member="CEGUI::MouseCursor::~MouseCursor" ref="a598814467cfcb3d7628c3a1c6dc24e03" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a598814467cfcb3d7628c3a1c6dc24e03">~MouseCursor</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a1bfb5bc7e5332098e7a15db7c3a2bb63">setImage</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &imageset, const <a class="el" href="classCEGUI_1_1String.html">String</a> &image_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current mouse cursor image. <a href="#a1bfb5bc7e5332098e7a15db7c3a2bb63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a926697363127eaf2719edd39bf31000e"></a><!-- doxytag: member="CEGUI::MouseCursor::setImage" ref="a926697363127eaf2719edd39bf31000e" args="(const Image *image)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a926697363127eaf2719edd39bf31000e">setImage</a> (const <a class="el" href="classCEGUI_1_1Image.html">Image</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current mouse cursor image. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#abeafd88205599f515d0e87be4b9c9003">getImage</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current mouse cursor image. <a href="#abeafd88205599f515d0e87be4b9c9003"></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_1MouseCursor.html#a53a217c33cbe2812f24c8ddf6d96be26">draw</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes the cursor draw itself. <a href="#a53a217c33cbe2812f24c8ddf6d96be26"></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_1MouseCursor.html#a0155e05fde0934076d60a4a92bf62457">setPosition</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current mouse cursor position. <a href="#a0155e05fde0934076d60a4a92bf62457"></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_1MouseCursor.html#a554bd8f3d8b490f241ac7bf8b1d80cbe">offsetPosition</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Offset the mouse cursor position by the deltas specified in <em>offset</em>. <a href="#a554bd8f3d8b490f241ac7bf8b1d80cbe"></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_1MouseCursor.html#aa4ae72161443dcc408d09db223c55447">setConstraintArea</a> (const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *area)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the area that the mouse cursor is constrained to. <a href="#aa4ae72161443dcc408d09db223c55447"></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_1MouseCursor.html#a600c7e781d1a0ee143d51b6bb18b51d2">setUnifiedConstraintArea</a> (const <a class="el" href="classCEGUI_1_1URect.html">URect</a> *area)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the area that the mouse cursor is constrained to. <a href="#a600c7e781d1a0ee143d51b6bb18b51d2"></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_1MouseCursor.html#adf983cf90309d623a7fa351c47e482d3">hide</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hides the mouse cursor. <a href="#adf983cf90309d623a7fa351c47e482d3"></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_1MouseCursor.html#a6c94505fff852d37cde785b42bf7d081">show</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shows the mouse cursor. <a href="#a6c94505fff852d37cde785b42bf7d081"></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_1MouseCursor.html#af2b83d68514e261be0ed6e52294bbe93">setVisible</a> (bool visible)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the visibility of the mouse cursor. <a href="#af2b83d68514e261be0ed6e52294bbe93"></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_1MouseCursor.html#afdf2f847d63008c80654e73cf3c0535d">isVisible</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether the mouse cursor is visible. <a href="#afdf2f847d63008c80654e73cf3c0535d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Vector2.html">Point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#af5d495406308c4997559468f0bd0bfe7">getPosition</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current mouse cursor position as a pixel offset from the top-left corner of the display. <a href="#af5d495406308c4997559468f0bd0bfe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a6587e0a3cb91d237913b08926405be87">getConstraintArea</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current constraint area of the mouse cursor. <a href="#a6587e0a3cb91d237913b08926405be87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1URect.html">URect</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a3750a4fc5eb5296f0c791171d8b9e282">getUnifiedConstraintArea</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current constraint area of the mouse cursor. <a href="#a3750a4fc5eb5296f0c791171d8b9e282"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Vector2.html">Point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#aac35588e79297a419676b4656cadf4e8">getDisplayIndependantPosition</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current mouse cursor position as display resolution independant values. <a href="#aac35588e79297a419676b4656cadf4e8"></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_1MouseCursor.html#aa2ecf8763e84d034ff5a57935ed86c71">notifyDisplaySizeChanged</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &new_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function used to notify the <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> of changes in the display size. <a href="#aa2ecf8763e84d034ff5a57935ed86c71"></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_1MouseCursor.html#a02e0bdd356e9380b97dd30b74ac46345">setExplicitRenderSize</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an explicit size for the mouse cursor image to be drawn at. <a href="#a02e0bdd356e9380b97dd30b74ac46345"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec225046e9d4c53924ee7fd65f724f5b"></a><!-- doxytag: member="CEGUI::MouseCursor::getExplicitRenderSize" ref="aec225046e9d4c53924ee7fd65f724f5b" args="() const " -->
const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#aec225046e9d4c53924ee7fd65f724f5b">getExplicitRenderSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the explicit render size currently set. A return size of (0, 0) indicates that the real image size will be used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8617c229d73f23777c63d6ae5a29e8e"></a><!-- doxytag: member="CEGUI::MouseCursor::invalidate" ref="ac8617c229d73f23777c63d6ae5a29e8e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#ac8617c229d73f23777c63d6ae5a29e8e">invalidate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark the cached geometry as invalid so it will be recached next time the mouse cursor is drawn. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1MouseCursor.html">MouseCursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#afa985c783fe3bb52f9ed733bad6b7d5d">getSingleton</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return singleton <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object. <a href="#afa985c783fe3bb52f9ed733bad6b7d5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1MouseCursor.html">MouseCursor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#ac3aa87709b2ab4088b485944db79dcbc">getSingletonPtr</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to singleton <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object. <a href="#ac3aa87709b2ab4088b485944db79dcbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a6dfe875238c50bebed392d4b7e5c8c18">setInitialMousePosition</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static function to pre-initialise the mouse cursor position (prior to <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> instantiation). <a href="#a6dfe875238c50bebed392d4b7e5c8c18"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f4f438dbda761d72bd6860f116da273"></a><!-- doxytag: member="CEGUI::MouseCursor::EventNamespace" ref="a3f4f438dbda761d72bd6860f116da273" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a3f4f438dbda761d72bd6860f116da273">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#ab344defdd058f354e9630874d2ee2bfb">EventImageChanged</a></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"><a class="anchor" id="a83d80f5571b57c48d88188ad9148278f"></a><!-- doxytag: member="CEGUI::MouseCursor::onImageChanged" ref="a83d80f5571b57c48d88188ad9148278f" args="(MouseCursorEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseCursor.html#a83d80f5571b57c48d88188ad9148278f">onImageChanged</a> (<a class="el" href="classCEGUI_1_1MouseCursorEventArgs.html">MouseCursorEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">event triggered internally when image of mouse cursor changes <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that allows access to the GUI system mouse cursor. </p>
<p>The <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> provides functionality to access the position and imagery of the mouse cursor / pointer </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a53a217c33cbe2812f24c8ddf6d96be26"></a><!-- doxytag: member="CEGUI::MouseCursor::draw" ref="a53a217c33cbe2812f24c8ddf6d96be26" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::draw </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes the cursor draw itself. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a6587e0a3cb91d237913b08926405be87"></a><!-- doxytag: member="CEGUI::MouseCursor::getConstraintArea" ref="a6587e0a3cb91d237913b08926405be87" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::MouseCursor::getConstraintArea </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the current constraint area of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the active area that the mouse cursor is constrained to. </dd></dl>
</div>
</div>
<a class="anchor" id="aac35588e79297a419676b4656cadf4e8"></a><!-- doxytag: member="CEGUI::MouseCursor::getDisplayIndependantPosition" ref="aac35588e79297a419676b4656cadf4e8" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Vector2.html">Point</a> CEGUI::MouseCursor::getDisplayIndependantPosition </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current mouse cursor position as display resolution independant values. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Point object describing the current mouse cursor position as resolution independant values that range from 0.0f to 1.0f, where 0.0f represents the left-most and top-most positions, and 1.0f represents the right-most and bottom-most positions. </dd></dl>
</div>
</div>
<a class="anchor" id="abeafd88205599f515d0e87be4b9c9003"></a><!-- doxytag: member="CEGUI::MouseCursor::getImage" ref="abeafd88205599f515d0e87be4b9c9003" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Image.html">Image</a>* CEGUI::MouseCursor::getImage </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current mouse cursor image. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current image used to draw mouse cursor. </dd></dl>
</div>
</div>
<a class="anchor" id="af5d495406308c4997559468f0bd0bfe7"></a><!-- doxytag: member="CEGUI::MouseCursor::getPosition" ref="af5d495406308c4997559468f0bd0bfe7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Vector2.html">Point</a> CEGUI::MouseCursor::getPosition </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current mouse cursor position as a pixel offset from the top-left corner of the display. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Point object describing the mouse cursor position in screen pixels. </dd></dl>
</div>
</div>
<a class="anchor" id="afa985c783fe3bb52f9ed733bad6b7d5d"></a><!-- doxytag: member="CEGUI::MouseCursor::getSingleton" ref="afa985c783fe3bb52f9ed733bad6b7d5d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1MouseCursor.html">MouseCursor</a>& CEGUI::MouseCursor::getSingleton </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return singleton <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Singleton.html">Singleton</a> <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Singleton.html">CEGUI::Singleton< MouseCursor ></a>.</p>
</div>
</div>
<a class="anchor" id="ac3aa87709b2ab4088b485944db79dcbc"></a><!-- doxytag: member="CEGUI::MouseCursor::getSingletonPtr" ref="ac3aa87709b2ab4088b485944db79dcbc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1MouseCursor.html">MouseCursor</a>* CEGUI::MouseCursor::getSingletonPtr </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return pointer to singleton <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to singleton <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> object </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Singleton.html">CEGUI::Singleton< MouseCursor ></a>.</p>
</div>
</div>
<a class="anchor" id="a3750a4fc5eb5296f0c791171d8b9e282"></a><!-- doxytag: member="CEGUI::MouseCursor::getUnifiedConstraintArea" ref="a3750a4fc5eb5296f0c791171d8b9e282" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1URect.html">URect</a>& CEGUI::MouseCursor::getUnifiedConstraintArea </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the current constraint area of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1URect.html" title="Area rectangle class built using unified dimensions (UDims).">URect</a> object describing the active area that the mouse cursor is constrained to. </dd></dl>
</div>
</div>
<a class="anchor" id="adf983cf90309d623a7fa351c47e482d3"></a><!-- doxytag: member="CEGUI::MouseCursor::hide" ref="adf983cf90309d623a7fa351c47e482d3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::hide </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hides the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="afdf2f847d63008c80654e73cf3c0535d"></a><!-- doxytag: member="CEGUI::MouseCursor::isVisible" ref="afdf2f847d63008c80654e73cf3c0535d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::MouseCursor::isVisible </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return whether the mouse cursor is visible. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the mouse cursor is visible, false if the mouse cursor is hidden. </dd></dl>
</div>
</div>
<a class="anchor" id="aa2ecf8763e84d034ff5a57935ed86c71"></a><!-- doxytag: member="CEGUI::MouseCursor::notifyDisplaySizeChanged" ref="aa2ecf8763e84d034ff5a57935ed86c71" args="(const Size &new_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::notifyDisplaySizeChanged </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>new_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function used to notify the <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> of changes in the display size. </p>
<p>You normally would not call this directly; rather you would call the function <a class="el" href="classCEGUI_1_1System.html#a259ef239fb65e93bafd6c777a93dbfb1" title="Notification function to be called when the main display changes size. Client code should call this f...">System::notifyDisplaySizeChanged</a> and that will then call this function for you.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">new_size</td><td><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the new display size in pixels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a554bd8f3d8b490f241ac7bf8b1d80cbe"></a><!-- doxytag: member="CEGUI::MouseCursor::offsetPosition" ref="a554bd8f3d8b490f241ac7bf8b1d80cbe" args="(const Point &offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::offsetPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> & </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Offset the mouse cursor position by the deltas specified in <em>offset</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Point object which describes the amount to move the cursor in each axis.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="aa4ae72161443dcc408d09db223c55447"></a><!-- doxytag: member="CEGUI::MouseCursor::setConstraintArea" ref="aa4ae72161443dcc408d09db223c55447" args="(const Rect *area)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setConstraintArea </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> * </td>
<td class="paramname"><em>area</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the area that the mouse cursor is constrained to. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>Pointer to a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> screen area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a02e0bdd356e9380b97dd30b74ac46345"></a><!-- doxytag: member="CEGUI::MouseCursor::setExplicitRenderSize" ref="a02e0bdd356e9380b97dd30b74ac46345" args="(const Size &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setExplicitRenderSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set an explicit size for the mouse cursor image to be drawn at. </p>
<p>This will override the size that is usually obtained directly from the mouse cursor image and will stay in effect across changes to the mouse cursor image.</p>
<p>Setting this size to (0, 0) will revert back to using the size as obtained from the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> itself.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Reference to a <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object that describes the size at which the cursor image should be drawn in pixels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1bfb5bc7e5332098e7a15db7c3a2bb63"></a><!-- doxytag: member="CEGUI::MouseCursor::setImage" ref="a1bfb5bc7e5332098e7a15db7c3a2bb63" args="(const String &imageset, const String &image_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>imageset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>image_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the current mouse cursor image. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">imageset</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> that contains the desired <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a>.</td></tr>
<tr><td class="paramname">image_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the desired <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> on <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> <em>imageset</em>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>thrown if <em>imageset</em> is not known, or if <em>imageset</em> contains no <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> named <em>image_name</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6dfe875238c50bebed392d4b7e5c8c18"></a><!-- doxytag: member="CEGUI::MouseCursor::setInitialMousePosition" ref="a6dfe875238c50bebed392d4b7e5c8c18" args="(const Point &position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::MouseCursor::setInitialMousePosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> & </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Static function to pre-initialise the mouse cursor position (prior to <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> instantiation). </p>
<p>Calling this function prior to instantiating <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> will prevent the mouse having it's position set to the middle of the initial view. Calling this function after the <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> is instantiated will have no effect.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Reference to a point object describing the initial pixel position to be used for the mouse cursor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0155e05fde0934076d60a4a92bf62457"></a><!-- doxytag: member="CEGUI::MouseCursor::setPosition" ref="a0155e05fde0934076d60a4a92bf62457" args="(const Point &position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> & </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the current mouse cursor position. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Point object describing the new location for the mouse. This will be clipped to within the renderer screen area. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a600c7e781d1a0ee143d51b6bb18b51d2"></a><!-- doxytag: member="CEGUI::MouseCursor::setUnifiedConstraintArea" ref="a600c7e781d1a0ee143d51b6bb18b51d2" args="(const URect *area)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setUnifiedConstraintArea </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1URect.html">URect</a> * </td>
<td class="paramname"><em>area</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the area that the mouse cursor is constrained to. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>Pointer to a <a class="el" href="classCEGUI_1_1URect.html" title="Area rectangle class built using unified dimensions (UDims).">URect</a> object that describes the area of the display that the mouse is allowed to occupy. The given area will be clipped to the current <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> screen area - it is never possible for the mouse to leave this area. If this parameter is NULL, the constraint is set to the size of the current <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> screen area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="af2b83d68514e261be0ed6e52294bbe93"></a><!-- doxytag: member="CEGUI::MouseCursor::setVisible" ref="af2b83d68514e261be0ed6e52294bbe93" args="(bool visible)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::setVisible </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>visible</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the visibility of the mouse cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">visible</td><td>'true' to show the mouse cursor, 'false' to hide it.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a6c94505fff852d37cde785b42bf7d081"></a><!-- doxytag: member="CEGUI::MouseCursor::show" ref="a6c94505fff852d37cde785b42bf7d081" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MouseCursor::show </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shows the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab344defdd058f354e9630874d2ee2bfb"></a><!-- doxytag: member="CEGUI::MouseCursor::EventImageChanged" ref="ab344defdd058f354e9630874d2ee2bfb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1MouseCursor.html#ab344defdd058f354e9630874d2ee2bfb">CEGUI::MouseCursor::EventImageChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the mouse cursor image is changed. Handlers are passed a const <a class="el" href="classCEGUI_1_1MouseCursorEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse cursor...">MouseCursorEventArgs</a> reference with <a class="el" href="classCEGUI_1_1MouseCursorEventArgs.html#ae0a4ad6867afb41a634e28dd80db361a" title="pointer to a MouseCursor object of relevance to the event.">MouseCursorEventArgs::mouseCursor</a> set to the <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> that has had it's image changed, and <a class="el" href="classCEGUI_1_1MouseCursorEventArgs.html#a31d17dd3174973b0bdf7a5457b28e67b" title="pointer to an Image object of relevance to the event.">MouseCursorEventArgs::image</a> set to the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> that is now set for the <a class="el" href="classCEGUI_1_1MouseCursor.html" title="Class that allows access to the GUI system mouse cursor.">MouseCursor</a> (may be 0). </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 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>
|
