← Back to branch summary

~thomir-deactivatedaccount/cegui/fix-build

« back to all changes in this revision

Viewing changes to docs/classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html

  • Committer: Thomi Richards
  • Date: 2013-02-06 22:13:36 UTC
  • Revision ID: thomi.richards@canonical.com-20130206221336-rsmud4k50g6nzv50
Initial code import.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>Crazy Eddies GUI System: CEGUI::EditboxProperties::MaskCodepoint Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.4 -->
 
11
<script type="text/javascript">
 
12
function hasClass(ele,cls) {
 
13
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
 
14
}
 
15
 
 
16
function addClass(ele,cls) {
 
17
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
 
18
}
 
19
 
 
20
function removeClass(ele,cls) {
 
21
  if (hasClass(ele,cls)) {
 
22
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
 
23
    ele.className=ele.className.replace(reg,' ');
 
24
  }
 
25
}
 
26
 
 
27
function toggleVisibility(linkObj) {
 
28
 var base = linkObj.getAttribute('id');
 
29
 var summary = document.getElementById(base + '-summary');
 
30
 var content = document.getElementById(base + '-content');
 
31
 var trigger = document.getElementById(base + '-trigger');
 
32
 if ( hasClass(linkObj,'closed') ) {
 
33
   summary.style.display = 'none';
 
34
   content.style.display = 'block';
 
35
   trigger.src = 'open.png';
 
36
   removeClass(linkObj,'closed');
 
37
   addClass(linkObj,'opened');
 
38
 } else if ( hasClass(linkObj,'opened') ) {
 
39
   summary.style.display = 'block';
 
40
   content.style.display = 'none';
 
41
   trigger.src = 'closed.png';
 
42
   removeClass(linkObj,'opened');
 
43
   addClass(linkObj,'closed');
 
44
 }
 
45
 return false;
 
46
}
 
47
</script>
 
48
<div id="top">
 
49
<div id="titlearea">
 
50
<table cellspacing="0" cellpadding="0">
 
51
 <tbody>
 
52
 <tr style="height: 56px;">
 
53
  <td style="padding-left: 0.5em;">
 
54
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
 
55
  </td>
 
56
 </tr>
 
57
 </tbody>
 
58
</table>
 
59
</div>
 
60
  <div id="navrow1" class="tabs">
 
61
    <ul class="tablist">
 
62
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
63
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
64
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
65
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
66
      <li><a href="files.html"><span>Files</span></a></li>
 
67
    </ul>
 
68
  </div>
 
69
  <div id="navrow2" class="tabs2">
 
70
    <ul class="tablist">
 
71
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
72
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
73
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
74
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
75
    </ul>
 
76
  </div>
 
77
  <div id="nav-path" class="navpath">
 
78
    <ul>
 
79
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
 
80
      <li class="navelem"><a class="el" href="namespaceCEGUI_1_1EditboxProperties.html">EditboxProperties</a>      </li>
 
81
      <li class="navelem"><a class="el" href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html">MaskCodepoint</a>      </li>
 
82
    </ul>
 
83
  </div>
 
84
</div>
 
85
<div class="header">
 
86
  <div class="summary">
 
87
<a href="#pub-methods">Public Member Functions</a>  </div>
 
88
  <div class="headertitle">
 
89
<div class="title">CEGUI::EditboxProperties::MaskCodepoint Class Reference</div>  </div>
 
90
</div>
 
91
<div class="contents">
 
92
<!-- doxytag: class="CEGUI::EditboxProperties::MaskCodepoint" --><!-- doxytag: inherits="CEGUI::Property" -->
 
93
<p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the mask text setting of the edit box.  
 
94
 <a href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html#details">More...</a></p>
 
95
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
96
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::EditboxProperties::MaskCodepoint:</div>
 
97
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 
98
</div>
 
99
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 
100
<div class="center"><img src="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint__inherit__graph.gif" border="0" usemap="#CEGUI_1_1EditboxProperties_1_1MaskCodepoint_inherit__map" alt="Inheritance graph"/></div>
 
101
<map name="CEGUI_1_1EditboxProperties_1_1MaskCodepoint_inherit__map" id="CEGUI_1_1EditboxProperties_1_1MaskCodepoint_inherit__map">
 
102
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="81,5,204,35"/></map>
 
103
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
104
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
105
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::EditboxProperties::MaskCodepoint:</div>
 
106
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
 
107
</div>
 
108
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
 
109
<div class="center"><img src="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint__coll__graph.gif" border="0" usemap="#CEGUI_1_1EditboxProperties_1_1MaskCodepoint_coll__map" alt="Collaboration graph"/></div>
 
110
<map name="CEGUI_1_1EditboxProperties_1_1MaskCodepoint_coll__map" id="CEGUI_1_1EditboxProperties_1_1MaskCodepoint_coll__map">
 
111
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="81,136,204,165"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="89,5,196,35"/></map>
 
112
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
113
 
 
114
<p><a href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint-members.html">List of all members.</a></p>
 
115
<table class="memberdecls">
 
116
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
117
Public Member Functions</h2></td></tr>
 
118
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html#a45b8426272023d82cb533d2c64f31deb">get</a> (const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver) const </td></tr>
 
119
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>.  <a href="#a45b8426272023d82cb533d2c64f31deb"></a><br/></td></tr>
 
120
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html#aed64fb92d515c61e90ded6bd29d0d683">set</a> (<a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value)</td></tr>
 
121
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the value of the property.  <a href="#aed64fb92d515c61e90ded6bd29d0d683"></a><br/></td></tr>
 
122
</table>
 
123
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
124
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the mask text setting of the edit box. </p>
 
125
<p>This property offers access to the mask text setting for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> object.</p>
 
126
<dl class="user"><dt><b>Usage:</b></dt><dd><ul>
 
127
<li>Name: <a class="el" href="classCEGUI_1_1EditboxProperties_1_1MaskCodepoint.html" title="Property to access the mask text setting of the edit box.">MaskCodepoint</a></li>
 
128
<li>Format: "[uint]"</li>
 
129
</ul>
 
130
</dd></dl>
 
131
<dl class="user"><dt><b>Where:</b></dt><dd><ul>
 
132
<li>[uint] is the Unicode utf32 value of the codepoint used for masking text. </li>
 
133
</ul>
 
134
</dd></dl>
 
135
</div><hr/><h2>Member Function Documentation</h2>
 
136
<a class="anchor" id="a45b8426272023d82cb533d2c64f31deb"></a><!-- doxytag: member="CEGUI::EditboxProperties::MaskCodepoint::get" ref="a45b8426272023d82cb533d2c64f31deb" args="(const PropertyReceiver *receiver) const " -->
 
137
<div class="memitem">
 
138
<div class="memproto">
 
139
      <table class="memname">
 
140
        <tr>
 
141
          <td class="memname"><a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::EditboxProperties::MaskCodepoint::get </td>
 
142
          <td>(</td>
 
143
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *&#160;</td>
 
144
          <td class="paramname"><em>receiver</em></td><td>)</td>
 
145
          <td> const<code> [virtual]</code></td>
 
146
        </tr>
 
147
      </table>
 
148
</div>
 
149
<div class="memdoc">
 
150
 
 
151
<p>Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. </p>
 
152
<dl><dt><b>Parameters:</b></dt><dd>
 
153
  <table class="params">
 
154
    <tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
 
155
  </table>
 
156
  </dd>
 
157
</dl>
 
158
<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 containing a textual representation of the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> </dd></dl>
 
159
 
 
160
<p>Implements <a class="el" href="classCEGUI_1_1Property.html#a47b2146f07d6a725075d06dc62396ab1">CEGUI::Property</a>.</p>
 
161
 
 
162
</div>
 
163
</div>
 
164
<a class="anchor" id="aed64fb92d515c61e90ded6bd29d0d683"></a><!-- doxytag: member="CEGUI::EditboxProperties::MaskCodepoint::set" ref="aed64fb92d515c61e90ded6bd29d0d683" args="(PropertyReceiver *receiver, const String &amp;value)" -->
 
165
<div class="memitem">
 
166
<div class="memproto">
 
167
      <table class="memname">
 
168
        <tr>
 
169
          <td class="memname">void CEGUI::EditboxProperties::MaskCodepoint::set </td>
 
170
          <td>(</td>
 
171
          <td class="paramtype"><a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *&#160;</td>
 
172
          <td class="paramname"><em>receiver</em>, </td>
 
173
        </tr>
 
174
        <tr>
 
175
          <td class="paramkey"></td>
 
176
          <td></td>
 
177
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
 
178
          <td class="paramname"><em>value</em>&#160;</td>
 
179
        </tr>
 
180
        <tr>
 
181
          <td></td>
 
182
          <td>)</td>
 
183
          <td></td><td><code> [virtual]</code></td>
 
184
        </tr>
 
185
      </table>
 
186
</div>
 
187
<div class="memdoc">
 
188
 
 
189
<p>Sets the value of the property. </p>
 
190
<dl><dt><b>Parameters:</b></dt><dd>
 
191
  <table class="params">
 
192
    <tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
 
193
    <tr><td class="paramname">value</td><td>A <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that contains a textual representation of the new value to assign to the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>.</td></tr>
 
194
  </table>
 
195
  </dd>
 
196
</dl>
 
197
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
198
<dl><dt><b>Exceptions:</b></dt><dd>
 
199
  <table class="exception">
 
200
    <tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>Thrown when the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> was unable to interpret the content of <em>value</em>. </td></tr>
 
201
  </table>
 
202
  </dd>
 
203
</dl>
 
204
 
 
205
<p>Implements <a class="el" href="classCEGUI_1_1Property.html#a66405360c2f98359dbb90f9700fc8251">CEGUI::Property</a>.</p>
 
206
 
 
207
</div>
 
208
</div>
 
209
</div>
 
210
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by&#160;
 
211
<a href="http://www.doxygen.org/index.html">
 
212
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
 
213
</body>
 
214
</html>