File: classCEGUI_1_1MinibidiVisualMapping.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (215 lines) | stat: -rw-r--r-- 11,938 bytes parent folder | download | duplicates (2)
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
<!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::MinibidiVisualMapping 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&#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_1MinibidiVisualMapping.html">MinibidiVisualMapping</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::MinibidiVisualMapping Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::MinibidiVisualMapping" --><!-- doxytag: inherits="CEGUI::BiDiVisualMapping" -->
<p>minibidi based implementation of <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html" title="Abstract class to wrap a BiDi visual mapping of a text string.">BiDiVisualMapping</a>.  
 <a href="classCEGUI_1_1MinibidiVisualMapping.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::MinibidiVisualMapping:</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_1MinibidiVisualMapping__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MinibidiVisualMapping_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1MinibidiVisualMapping_inherit__map" id="CEGUI_1_1MinibidiVisualMapping_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1BiDiVisualMapping.html" title="Abstract class to wrap a BiDi visual mapping of a text string." alt="" coords="16,5,197,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::MinibidiVisualMapping:</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_1MinibidiVisualMapping__coll__graph.gif" border="0" usemap="#CEGUI_1_1MinibidiVisualMapping_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1MinibidiVisualMapping_coll__map" id="CEGUI_1_1MinibidiVisualMapping_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1BiDiVisualMapping.html" title="Abstract class to wrap a BiDi visual mapping of a text string." alt="" coords="16,101,197,131"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="53,5,160,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1MinibidiVisualMapping-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="el" href="namespaceCEGUI.html#a02f7ab6edd88cf0e97329fad5a6be6fa">BidiCharType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MinibidiVisualMapping.html#ac6e19b26b88c7a48b4acc7eb942fca17">getBidiCharType</a> (const utf32 char_to_check) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the BiDi char type of a char.  <a href="#ac6e19b26b88c7a48b4acc7eb942fca17"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MinibidiVisualMapping.html#a3230c1d84e93ef0ee2983a4ec34ff181">reorderFromLogicalToVisual</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;logical, <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;visual, <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> &amp;l2v, <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ac6e02aed2da8afdd90d36ad2cff03ded">StrIndexList</a> &amp;v2l) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reorder a string from a logical (type order) bidi string to a visual (the way it displayed) string.  <a href="#a3230c1d84e93ef0ee2983a4ec34ff181"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>minibidi based implementation of <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html" title="Abstract class to wrap a BiDi visual mapping of a text string.">BiDiVisualMapping</a>. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac6e19b26b88c7a48b4acc7eb942fca17"></a><!-- doxytag: member="CEGUI::MinibidiVisualMapping::getBidiCharType" ref="ac6e19b26b88c7a48b4acc7eb942fca17" args="(const utf32 char_to_check) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceCEGUI.html#a02f7ab6edd88cf0e97329fad5a6be6fa">BidiCharType</a> CEGUI::MinibidiVisualMapping::getBidiCharType </td>
          <td>(</td>
          <td class="paramtype">const utf32&#160;</td>
          <td class="paramname"><em>char_to_check</em></td><td>)</td>
          <td> const<code> [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>Implements <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#a7a4907df76b7f22f3cfd6a8c12a1a0b4">CEGUI::BiDiVisualMapping</a>.</p>

</div>
</div>
<a class="anchor" id="a3230c1d84e93ef0ee2983a4ec34ff181"></a><!-- doxytag: member="CEGUI::MinibidiVisualMapping::reorderFromLogicalToVisual" ref="a3230c1d84e93ef0ee2983a4ec34ff181" args="(const String &amp;logical, String &amp;visual, StrIndexList &amp;l2v, StrIndexList &amp;v2l) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::MinibidiVisualMapping::reorderFromLogicalToVisual </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</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> &amp;&#160;</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> &amp;&#160;</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> &amp;&#160;</td>
          <td class="paramname"><em>v2l</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const<code> [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>Implements <a class="el" href="classCEGUI_1_1BiDiVisualMapping.html#ae9ea258afa2e8d34655c82a50db5799a">CEGUI::BiDiVisualMapping</a>.</p>

</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&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>