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
|
<!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::ScriptModule 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_1ScriptModule.html">ScriptModule</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="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ScriptModule Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ScriptModule" -->
<p>Abstract interface required for all scripting support modules to be used with the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system.
<a href="classCEGUI_1_1ScriptModule.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::ScriptModule:</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_1ScriptModule__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ScriptModule_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ScriptModule_inherit__map" id="CEGUI_1_1ScriptModule_inherit__map">
<area shape="rect" id="node3" href="classCEGUI_1_1LuaScriptModule.html" title="Interface for the LuaScriptModule class." alt="" coords="5,83,176,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::ScriptModule:</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_1ScriptModule__coll__graph.gif" border="0" usemap="#CEGUI_1_1ScriptModule_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ScriptModule_coll__map" id="CEGUI_1_1ScriptModule_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="27,5,133,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ScriptModule-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="a806d5bab582b08617788df36e1638ae2"></a><!-- doxytag: member="CEGUI::ScriptModule::ScriptModule" ref="a806d5bab582b08617788df36e1638ae2" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a806d5bab582b08617788df36e1638ae2">ScriptModule</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2276e99a18523c3d824cf05732bc600"></a><!-- doxytag: member="CEGUI::ScriptModule::~ScriptModule" ref="ad2276e99a18523c3d824cf05732bc600" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#ad2276e99a18523c3d824cf05732bc600">~ScriptModule</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#aec4f69dc1e7426941db9d2e5e5e41f5b">executeScriptFile</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup="")=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a script file. <a href="#aec4f69dc1e7426941db9d2e5e5e41f5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a483fc3776f5c6254bd05c9a6fc64f292">executeScriptGlobal</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &function_name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global function. The function should not take any parameters and should return an integer. <a href="#a483fc3776f5c6254bd05c9a6fc64f292"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a8d4b606d34851972ec06d220f9ed4b02">executeScriptedEventHandler</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &handler_name, const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a scripted global 'event handler' function. The function should take some kind of <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> like parameter that the concrete implementation of this function can create from the passed <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object. The function should not return anything. <a href="#a8d4b606d34851972ec06d220f9ed4b02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#aedf7d59b6471974724c70d6d875e8f53">executeString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. <a href="#aedf7d59b6471974724c70d6d875e8f53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a2e860178e3b661bc9f3fadfa11862bc4">createBindings</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method called during system initialisation, prior to running any scripts via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to complete initialisation or binding of the script language to the gui system objects. <a href="#a2e860178e3b661bc9f3fadfa11862bc4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#ad96fa1199a2cbc545aa2b31db53149ce">destroyBindings</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method called during system destruction, after all scripts have been run via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. <a href="#ad96fa1199a2cbc545aa2b31db53149ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a213df5cd7b98e088946c7dbe0ceae5c6">getIdentifierString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return identification string for the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>. If the internal id string has not been set by the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> creator, a generic string of "Unknown scripting module" will be returned. <a href="#a213df5cd7b98e088946c7dbe0ceae5c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#af5ff0f0e6cdcb47c0a704447cc6d7726">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#af5ff0f0e6cdcb47c0a704447cc6d7726"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a0d787a8c552d7a22a2619cff95c2eccc">subscribeEvent</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *target, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a0d787a8c552d7a22a2619cff95c2eccc"></a><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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a4879fd1d26e19b57a37a835c4b7b9bf1">setDefaultResourceGroup</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the default resource group to be used when loading script files. <a href="#a4879fd1d26e19b57a37a835c4b7b9bf1"></a><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_1ScriptModule.html#a157279add8fc3d32db2a072df52fa4d6">getDefaultResourceGroup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default resource group used when loading script files. <a href="#a157279add8fc3d32db2a072df52fa4d6"></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="a598940009732588c50c7842947e3eb47"></a><!-- doxytag: member="CEGUI::ScriptModule::d_identifierString" ref="a598940009732588c50c7842947e3eb47" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a598940009732588c50c7842947e3eb47">d_identifierString</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> that holds some id information about the module. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a294f19749eb6983b353dbb177d23316a"></a><!-- doxytag: member="CEGUI::ScriptModule::d_defaultResourceGroup" ref="a294f19749eb6983b353dbb177d23316a" args="" -->
static <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScriptModule.html#a294f19749eb6983b353dbb177d23316a">d_defaultResourceGroup</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">holds the default resource group ID for loading script files. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract interface required for all scripting support modules to be used with the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2e860178e3b661bc9f3fadfa11862bc4"></a><!-- doxytag: member="CEGUI::ScriptModule::createBindings" ref="a2e860178e3b661bc9f3fadfa11862bc4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScriptModule::createBindings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method called during system initialisation, prior to running any scripts via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to complete initialisation or binding of the script language to the gui system objects. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#a99ac7c0fc292ad37d39afd7a02f1f625">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="ad96fa1199a2cbc545aa2b31db53149ce"></a><!-- doxytag: member="CEGUI::ScriptModule::destroyBindings" ref="ad96fa1199a2cbc545aa2b31db53149ce" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScriptModule::destroyBindings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Method called during system destruction, after all scripts have been run via the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>, to enable the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#ac008f0590a39c9508291f5258f2d3508">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a8d4b606d34851972ec06d220f9ed4b02"></a><!-- doxytag: member="CEGUI::ScriptModule::executeScriptedEventHandler" ref="a8d4b606d34851972ec06d220f9ed4b02" args="(const String &handler_name, const EventArgs &e)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ScriptModule::executeScriptedEventHandler </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>handler_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> & </td>
<td class="paramname"><em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global 'event handler' function. The function should take some kind of <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> like parameter that the concrete implementation of this function can create from the passed <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object. The function should not return anything. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handler_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 scripted handler function.</td></tr>
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based object that should be passed, by any appropriate means, to the scripted function.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the event was handled.</li>
<li>false if the event was not handled. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#a15ef444b531d4271e718141ad3c90875">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="aec4f69dc1e7426941db9d2e5e5e41f5b"></a><!-- doxytag: member="CEGUI::ScriptModule::executeScriptFile" ref="aec4f69dc1e7426941db9d2e5e5e41f5b" args="(const String &filename, const String &resourceGroup="")=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScriptModule::executeScriptFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</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>resourceGroup</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a script file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the filename of the script file that is to be executed</td></tr>
<tr><td class="paramname">resourceGroup</td><td>Resource group idendifier to be passed to the <a class="el" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a> when loading the script file. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#a0d148c9c80c6ad2430a9b4b38413f0d3">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a483fc3776f5c6254bd05c9a6fc64f292"></a><!-- doxytag: member="CEGUI::ScriptModule::executeScriptGlobal" ref="a483fc3776f5c6254bd05c9a6fc64f292" args="(const String &function_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CEGUI::ScriptModule::executeScriptGlobal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>function_name</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a scripted global function. The function should not take any parameters and should return an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">function_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 function, in the global script environment, that is to be executed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The integer value returned from the script function. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#aebb2d7687a17798865d61455ec57d4d2">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="aedf7d59b6471974724c70d6d875e8f53"></a><!-- doxytag: member="CEGUI::ScriptModule::executeString" ref="aedf7d59b6471974724c70d6d875e8f53" args="(const String &str)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScriptModule::executeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute script code contained in the given <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the valid script code that should be executed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#a577a94fd7107ce1ab448acefb3264ffd">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="a157279add8fc3d32db2a072df52fa4d6"></a><!-- doxytag: member="CEGUI::ScriptModule::getDefaultResourceGroup" ref="a157279add8fc3d32db2a072df52fa4d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::ScriptModule::getDefaultResourceGroup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the default resource group used when loading script files. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> describing the default resource group identifier.. </dd></dl>
</div>
</div>
<a class="anchor" id="a213df5cd7b98e088946c7dbe0ceae5c6"></a><!-- doxytag: member="CEGUI::ScriptModule::getIdentifierString" ref="a213df5cd7b98e088946c7dbe0ceae5c6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::ScriptModule::getIdentifierString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return identification string for the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>. If the internal id string has not been set by the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> creator, a generic string of "Unknown scripting module" will be returned. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding a string that identifies the <a class="el" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a> in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a4879fd1d26e19b57a37a835c4b7b9bf1"></a><!-- doxytag: member="CEGUI::ScriptModule::setDefaultResourceGroup" ref="a4879fd1d26e19b57a37a835c4b7b9bf1" args="(const String &resourceGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::ScriptModule::setDefaultResourceGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default resource group to be used when loading script files. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">resourceGroup</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> describing the default resource group identifier to be used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a0d787a8c552d7a22a2619cff95c2eccc"></a><!-- doxytag: member="CEGUI::ScriptModule::subscribeEvent" ref="a0d787a8c552d7a22a2619cff95c2eccc" args="(EventSet *target, const String &name, Event::Group group, const String &subscriber_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::ScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</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>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </td>
<td class="paramname"><em>group</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>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</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 an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> named <em>name</em> is not in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#a4ab1ae222fc74d03365e8c0f4294f0b3">CEGUI::LuaScriptModule</a>.</p>
</div>
</div>
<a class="anchor" id="af5ff0f0e6cdcb47c0a704447cc6d7726"></a><!-- doxytag: member="CEGUI::ScriptModule::subscribeEvent" ref="af5ff0f0e6cdcb47c0a704447cc6d7726" args="(EventSet *target, const String &name, const String &subscriber_name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::ScriptModule::subscribeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td>
<td class="paramname"><em>target</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>name</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>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>The target <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> for the subscription.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</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 an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> named <em>name</em> is not in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1LuaScriptModule.html#ae8d5843adcac3d47e0d2bf409e7e28e6">CEGUI::LuaScriptModule</a>.</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>
|
