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
|
<!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::BiDiVisualMapping 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_1BiDiVisualMapping.html">BiDiVisualMapping</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::BiDiVisualMapping Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::BiDiVisualMapping" -->
<p>Abstract class to wrap a BiDi visual mapping of a text string.
<a href="classCEGUI_1_1BiDiVisualMapping.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::BiDiVisualMapping:</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_1BiDiVisualMapping__inherit__graph.gif" border="0" usemap="#CEGUI_1_1BiDiVisualMapping_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1BiDiVisualMapping_inherit__map" id="CEGUI_1_1BiDiVisualMapping_inherit__map">
<area shape="rect" id="node3" href="classCEGUI_1_1FribidiVisualMapping.html" title="fribidi based implementation of BiDiVisualMapping." alt="" coords="5,83,197,112"/><area shape="rect" id="node5" href="classCEGUI_1_1MinibidiVisualMapping.html" title="minibidi based implementation of BiDiVisualMapping." alt="" coords="221,83,424,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::BiDiVisualMapping:</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_1BiDiVisualMapping__coll__graph.gif" border="0" usemap="#CEGUI_1_1BiDiVisualMapping_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1BiDiVisualMapping_coll__map" id="CEGUI_1_1BiDiVisualMapping_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="43,5,149,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1BiDiVisualMapping-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6e02aed2da8afdd90d36ad2cff03ded"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::StrIndexList" ref="ac6e02aed2da8afdd90d36ad2cff03ded" args="" -->
typedef std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type definition for collection used to hold mapping index lists. <br/></td></tr>
<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="a8e2ddacdace7de8392550acd7ee4f5f3"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::~BiDiVisualMapping" ref="a8e2ddacdace7de8392550acd7ee4f5f3" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#a8e2ddacdace7de8392550acd7ee4f5f3">~BiDiVisualMapping</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceCEGUI.html#a02f7ab6edd88cf0e97329fad5a6be6fa">BidiCharType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#a7a4907df76b7f22f3cfd6a8c12a1a0b4">getBidiCharType</a> (const utf32 char_to_check) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the BiDi char type of a char. <a href="#a7a4907df76b7f22f3cfd6a8c12a1a0b4"></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_1BiDiVisualMapping.html#ae9ea258afa2e8d34655c82a50db5799a">reorderFromLogicalToVisual</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &logical, <a class="el" href="classCEGUI_1_1String.html">String</a> &visual, <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> &l2v, <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> &v2l) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reorder a string from a logical (type order) bidi string to a visual (the way it displayed) string. <a href="#ae9ea258afa2e8d34655c82a50db5799a"></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_1BiDiVisualMapping.html#a39aaf99993b959347d0e6f76a589c3fe">updateVisual</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &logical)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use reorderFromLogicalToVisual to update the internal visual mapping data and visual string representation based upon the logical string <em>logical</em>. <a href="#a39aaf99993b959347d0e6f76a589c3fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0db5d2263373213917002c7d704fbe74"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::getL2vMapping" ref="a0db5d2263373213917002c7d704fbe74" args="() const " -->
const <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> </td><td class="memItemRight" valign="bottom"><b>getL2vMapping</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ab6998f632e214c5293288d12b724d3"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::getV2lMapping" ref="a7ab6998f632e214c5293288d12b724d3" args="() const " -->
const <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> </td><td class="memItemRight" valign="bottom"><b>getV2lMapping</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91f9fca6775793b68feb7ed6465544ca"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::getTextVisual" ref="a91f9fca6775793b68feb7ed6465544ca" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getTextVisual</b> () const </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="ae034aec488bbc62100f5e238cffaeb33"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::d_l2vMapping" ref="ae034aec488bbc62100f5e238cffaeb33" args="" -->
<a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> </td><td class="memItemRight" valign="bottom"><b>d_l2vMapping</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33cb037ad266a4b73304d1b31dae1565"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::d_v2lMapping" ref="a33cb037ad266a4b73304d1b31dae1565" args="" -->
<a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> </td><td class="memItemRight" valign="bottom"><b>d_v2lMapping</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a758f4a21ee729d79909417bb51d145a2"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::d_textVisual" ref="a758f4a21ee729d79909417bb51d145a2" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>d_textVisual</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class to wrap a BiDi visual mapping of a text string. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7a4907df76b7f22f3cfd6a8c12a1a0b4"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::getBidiCharType" ref="a7a4907df76b7f22f3cfd6a8c12a1a0b4" args="(const utf32 char_to_check) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceCEGUI.html#a02f7ab6edd88cf0e97329fad5a6be6fa">BidiCharType</a> CEGUI::BiDiVisualMapping::getBidiCharType </td>
<td>(</td>
<td class="paramtype">const utf32 </td>
<td class="paramname"><em>char_to_check</em></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the BiDi char type of a char. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">charToCheck</td><td>The utf32 character code that will be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the BidiCharType enumerated values indicating the BiDi char type. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1FribidiVisualMapping.html#a463d0f50f5f9d8ce102c5f12e0f645bb">CEGUI::FribidiVisualMapping</a>, and <a class="el" href="classCEGUI_1_1MinibidiVisualMapping.html#ac6e19b26b88c7a48b4acc7eb942fca17">CEGUI::MinibidiVisualMapping</a>.</p>
</div>
</div>
<a class="anchor" id="ae9ea258afa2e8d34655c82a50db5799a"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::reorderFromLogicalToVisual" ref="ae9ea258afa2e8d34655c82a50db5799a" args="(const String &logical, String &visual, StrIndexList &l2v, StrIndexList &v2l) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::BiDiVisualMapping::reorderFromLogicalToVisual </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>logical</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>visual</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> & </td>
<td class="paramname"><em>l2v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> & </td>
<td class="paramname"><em>v2l</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reorder a string from a logical (type order) bidi string to a visual (the way it displayed) string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">logical</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object to be reordered.</td></tr>
<tr><td class="paramname">visual</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the result reordered string.</td></tr>
<tr><td class="paramname">l2vMapping</td><td>List of integers that map the pos of each char from logical string in the visual string.</td></tr>
<tr><td class="paramname">v2lMapping</td><td>List of integers that map the pos of each char from visual string in the logical string.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if successful.</li>
<li>false if the operation failed. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1FribidiVisualMapping.html#ada9947fe7178c5812170670f0eea02e9">CEGUI::FribidiVisualMapping</a>, and <a class="el" href="classCEGUI_1_1MinibidiVisualMapping.html#a3230c1d84e93ef0ee2983a4ec34ff181">CEGUI::MinibidiVisualMapping</a>.</p>
</div>
</div>
<a class="anchor" id="a39aaf99993b959347d0e6f76a589c3fe"></a><!-- doxytag: member="CEGUI::BiDiVisualMapping::updateVisual" ref="a39aaf99993b959347d0e6f76a589c3fe" args="(const String &logical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::BiDiVisualMapping::updateVisual </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>logical</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use reorderFromLogicalToVisual to update the internal visual mapping data and visual string representation based upon the logical string <em>logical</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">logical</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object representing the logical text order.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the update was a success.</li>
<li>false if something went wrong. </li>
</ul>
</dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
