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
|
<!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: CEGUIScriptModule.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIScriptModule.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIScriptModule.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: 16/7/2004</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Abstract class interface for scripting support</span>
<a name="l00007"></a>00007 <span class="comment">*************************************************************************/</span>
<a name="l00008"></a>00008 <span class="comment">/***************************************************************************</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00012"></a>00012 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00013"></a>00013 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00014"></a>00014 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00015"></a>00015 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00016"></a>00016 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00017"></a>00017 <span class="comment"> * the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00025"></a>00025 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00027"></a>00027 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00028"></a>00028 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"> ***************************************************************************/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _CEGUIScriptModule_h_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIScriptModule_h_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUIBase.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "CEGUIString.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "CEGUIEvent.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00039"></a>00039 <span class="keyword">namespace </span>CEGUI
<a name="l00040"></a>00040 {
<a name="l00046"></a><a class="code" href="classCEGUI_1_1ScriptModule.html">00046</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <span class="comment">/*************************************************************************</span>
<a name="l00050"></a>00050 <span class="comment"> Construction and Destruction</span>
<a name="l00051"></a>00051 <span class="comment"> *************************************************************************/</span>
<a name="l00056"></a>00056 <a class="code" href="classCEGUI_1_1ScriptModule.html" title="Abstract interface required for all scripting support modules to be used with the CEGUI system...">ScriptModule</a>(<span class="keywordtype">void</span>);
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00063"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#ad2276e99a18523c3d824cf05732bc600">00063</a> <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1ScriptModule.html#ad2276e99a18523c3d824cf05732bc600" title="Destructor for ScriptModule base class.">~ScriptModule</a>(<span class="keywordtype">void</span>) {}
<a name="l00064"></a>00064
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/*************************************************************************</span>
<a name="l00067"></a>00067 <span class="comment"> Abstract interface</span>
<a name="l00068"></a>00068 <span class="comment"> *************************************************************************/</span>
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keywordtype">void</span> executeScriptFile(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& filename, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resourceGroup = <span class="stringliteral">""</span>) = 0;
<a name="l00080"></a>00080
<a name="l00081"></a>00081
<a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">int</span> executeScriptGlobal(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& function_name) = 0;
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> executeScriptedEventHandler(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& handler_name, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a>& e) = 0;
<a name="l00113"></a>00113
<a name="l00114"></a>00114
<a name="l00125"></a>00125 <span class="keyword">virtual</span> <span class="keywordtype">void</span> executeString(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& str) = 0;
<a name="l00126"></a>00126
<a name="l00127"></a>00127
<a name="l00136"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#a2e860178e3b661bc9f3fadfa11862bc4">00136</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ScriptModule.html#a2e860178e3b661bc9f3fadfa11862bc4" title="Method called during system initialisation, prior to running any scripts via the ScriptModule, to enable the ScriptModule to perform any operations required to complete initialisation or binding of the script language to the gui system objects.">createBindings</a>(<span class="keywordtype">void</span>) {}
<a name="l00137"></a>00137
<a name="l00138"></a>00138
<a name="l00148"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#ad96fa1199a2cbc545aa2b31db53149ce">00148</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ScriptModule.html#ad96fa1199a2cbc545aa2b31db53149ce" title="Method called during system destruction, after all scripts have been run via the ScriptModule, to enable the ScriptModule 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.">destroyBindings</a>(<span class="keywordtype">void</span>) {}
<a name="l00149"></a>00149
<a name="l00158"></a>00158 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& getIdentifierString() <span class="keyword">const</span>;
<a name="l00159"></a>00159
<a name="l00178"></a>00178 <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> subscribeEvent(<a class="code" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>* target, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& subscriber_name) = 0;
<a name="l00179"></a>00179
<a name="l00201"></a>00201 <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> subscribeEvent(<a class="code" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>* target, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name, <a class="code" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f" title="Type for a subscriber group. You can use the subscriber group to order calls to multiple subscribers...">Event::Group</a> group, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& subscriber_name) = 0;
<a name="l00202"></a>00202
<a name="l00213"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#a4879fd1d26e19b57a37a835c4b7b9bf1">00213</a> <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultResourceGroup(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resourceGroup)
<a name="l00214"></a>00214 { d_defaultResourceGroup = resourceGroup; }
<a name="l00215"></a>00215
<a name="l00223"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#a157279add8fc3d32db2a072df52fa4d6">00223</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& getDefaultResourceGroup()
<a name="l00224"></a>00224 { <span class="keywordflow">return</span> d_defaultResourceGroup; }
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="keyword">protected</span>:
<a name="l00228"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#a598940009732588c50c7842947e3eb47">00228</a> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ScriptModule.html#a598940009732588c50c7842947e3eb47" title="String that holds some id information about the module.">d_identifierString</a>;
<a name="l00230"></a><a class="code" href="classCEGUI_1_1ScriptModule.html#a294f19749eb6983b353dbb177d23316a">00230</a> <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ScriptModule.html#a294f19749eb6983b353dbb177d23316a" title="holds the default resource group ID for loading script files.">d_defaultResourceGroup</a>;
<a name="l00231"></a>00231 };
<a name="l00232"></a>00232
<a name="l00233"></a>00233
<a name="l00238"></a><a class="code" href="classCEGUI_1_1ScriptFunctor.html">00238</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>
<a name="l00239"></a>00239 {
<a name="l00240"></a>00240 <span class="keyword">public</span>:
<a name="l00241"></a>00241 <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& functionName) : scriptFunctionName(functionName) {}
<a name="l00242"></a>00242 <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>& obj) : scriptFunctionName(obj.scriptFunctionName) {}
<a name="l00243"></a>00243 <span class="keywordtype">bool</span> operator()(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a>& e) <span class="keyword">const</span>;
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="keyword">private</span>:
<a name="l00246"></a>00246 <span class="comment">// no assignment possible</span>
<a name="l00247"></a>00247 <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>& operator=(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ScriptFunctor.html" title="Functor class used for binding named script functions to events.">ScriptFunctor</a>& rhs);
<a name="l00248"></a>00248
<a name="l00249"></a>00249 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> scriptFunctionName;
<a name="l00250"></a>00250 };
<a name="l00251"></a>00251
<a name="l00252"></a>00252 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00253"></a>00253
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="preprocessor">#endif // end of guard _CEGUIScriptModule_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 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>
|
