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
|
<!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>Wt: Wt::WLocalizedStrings Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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="modules.html"><span>Modules</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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="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="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WLocalizedStrings.html">WLocalizedStrings</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> </div>
<div class="headertitle">
<div class="title">Wt::WLocalizedStrings Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WLocalizedStrings" -->
<p>An abstract class that provides support for localized strings.
<a href="classWt_1_1WLocalizedStrings.html#details">More...</a></p>
<p><code>#include <Wt/WLocalizedStrings></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WLocalizedStrings:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WLocalizedStrings__inherit__graph.png" border="0" usemap="#Wt_1_1WLocalizedStrings_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WLocalizedStrings_inherit__map" id="Wt_1_1WLocalizedStrings_inherit__map">
<area shape="rect" href="classWt_1_1WCombinedLocalizedStrings.html" title="A localized string resolver that bundles multiple string resolvers." alt="" coords="5,80,219,107"/><area shape="rect" href="classWt_1_1WMessageResourceBundle.html" title="Support for localized strings using XML files." alt="" coords="243,80,451,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WLocalizedStrings-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="a04d2e40e52b9827bb5eb4759b9928f66"></a><!-- doxytag: member="Wt::WLocalizedStrings::~WLocalizedStrings" ref="a04d2e40e52b9827bb5eb4759b9928f66" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a04d2e40e52b9827bb5eb4759b9928f66">~WLocalizedStrings</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a71b2ca0b40eed56ee1acba8f865e7220">refresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rereads the message resources. <a href="#a71b2ca0b40eed56ee1acba8f865e7220"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a2ea29ba180ed9af25cf561f0df6a995d">hibernate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purges memory resources, if possible. <a href="#a2ea29ba180ed9af25cf561f0df6a995d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a05666a0ae917e4fd6deafdd2f4b98ba2">resolveKey</a> (const std::string &key, std::string &result)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolves a key in the current locale. <a href="#a05666a0ae917e4fd6deafdd2f4b98ba2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a679c976ebd09d9ab0b1db8e93a6e18d5">resolvePluralKey</a> (const std::string &key, std::string &result,::uint64_t amount)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolves the plural form of a key in the current locale. <a href="#a679c976ebd09d9ab0b1db8e93a6e18d5"></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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLocalizedStrings.html#a401f0531d7d54080aa0f405309818508">evaluatePluralExpression</a> (const std::string &expression,::uint64_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to evaluate a plural expression. <a href="#a401f0531d7d54080aa0f405309818508"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An abstract class that provides support for localized strings. </p>
<p>This abstract class provides the content to localized WStrings, by resolving the key to a string using the current application locale.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a>, <a class="el" href="classWt_1_1WApplication.html#a1039775b5a73ff2efc34a482ebd112a8" title="Sets the resource object that provides localized strings.">WApplication::setLocalizedStrings()</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a401f0531d7d54080aa0f405309818508"></a><!-- doxytag: member="Wt::WLocalizedStrings::evaluatePluralExpression" ref="a401f0531d7d54080aa0f405309818508" args="(const std::string &expression,::uint64_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WLocalizedStrings::evaluatePluralExpression </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>expression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::uint64_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Utility method to evaluate a plural expression. </p>
<p>This evaluates C expressions such as used by ngettext for a particular value, which can be useful to implement plural key resolution.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WLocalizedStrings.html#a679c976ebd09d9ab0b1db8e93a6e18d5" title="Resolves the plural form of a key in the current locale.">resolvePluralKey()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2ea29ba180ed9af25cf561f0df6a995d"></a><!-- doxytag: member="Wt::WLocalizedStrings::hibernate" ref="a2ea29ba180ed9af25cf561f0df6a995d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WLocalizedStrings::hibernate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Purges memory resources, if possible. </p>
<p>This is called afer event handling, and is an opportunity to conserve memory inbetween events, by freeing memory used for cached key/value bindings, if applicable.</p>
<p>The default implementation does nothing. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1WMessageResourceBundle.html#a5e6c391a95229691fcae8c058c637b7b">Wt::WMessageResourceBundle</a>, and <a class="el" href="classWt_1_1WCombinedLocalizedStrings.html#abf4a64defdd472751aab40d561dddd1d">Wt::WCombinedLocalizedStrings</a>.</p>
</div>
</div>
<a class="anchor" id="a71b2ca0b40eed56ee1acba8f865e7220"></a><!-- doxytag: member="Wt::WLocalizedStrings::refresh" ref="a71b2ca0b40eed56ee1acba8f865e7220" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WLocalizedStrings::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rereads the message resources. </p>
<p>Purge any cached key/values, if applicable.</p>
<p>The default implementation does nothing. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1WMessageResourceBundle.html#a8dd275eff8f823ee58a1e673a79b71e7">Wt::WMessageResourceBundle</a>, and <a class="el" href="classWt_1_1WCombinedLocalizedStrings.html#aad27735fdadc6e0deb52f55e8ca77d17">Wt::WCombinedLocalizedStrings</a>.</p>
</div>
</div>
<a class="anchor" id="a05666a0ae917e4fd6deafdd2f4b98ba2"></a><!-- doxytag: member="Wt::WLocalizedStrings::resolveKey" ref="a05666a0ae917e4fd6deafdd2f4b98ba2" args="(const std::string &key, std::string &result)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Wt::WLocalizedStrings::resolveKey </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolves a key in the current locale. </p>
<p>This method is used by <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> to obtain the UTF8 value corresponding to a key in the current locale.</p>
<p>Returns <code>true</code> if the key could be resolved. The value is written in <code>result</code>, encoded using UTF8.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a6e782f1f38a6f56e2024aab1a917a80b" title="Returns the current locale.">WApplication::locale()</a>, <a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1WMessageResourceBundle.html#a22878a466da85139384133f01c7fec77">Wt::WMessageResourceBundle</a>, and <a class="el" href="classWt_1_1WCombinedLocalizedStrings.html#acbe64134b2d1c13abf98ed8b1b039f00">Wt::WCombinedLocalizedStrings</a>.</p>
</div>
</div>
<a class="anchor" id="a679c976ebd09d9ab0b1db8e93a6e18d5"></a><!-- doxytag: member="Wt::WLocalizedStrings::resolvePluralKey" ref="a679c976ebd09d9ab0b1db8e93a6e18d5" args="(const std::string &key, std::string &result,::uint64_t amount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WLocalizedStrings::resolvePluralKey </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::uint64_t </td>
<td class="paramname"><em>amount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolves the plural form of a key in the current locale. </p>
<p>This method is used by <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> to obtain the UTF8 value corresponding to a key in the current locale, taking into account the possibility of multiple plural forms, and chosing the right plural form based on the <code>amount</code> passed.</p>
<p>Throws a std::logic_error if the underlying implementation does not provide support for plural internationalized strings.</p>
<p>Returns <code>true</code> if the key could be resolved. The value is written in <code>result</code>, encoded as UTF8.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a6e782f1f38a6f56e2024aab1a917a80b" title="Returns the current locale.">WApplication::locale()</a>, <a class="el" href="classWt_1_1WString.html#abcff7d3d30972762bd5d9279dc903a36" title="Creates a localized string from a key for a number n.">WString::trn()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1WMessageResourceBundle.html#ad29f61458c5bba4d19d7adcf7f0478ea">Wt::WMessageResourceBundle</a>, and <a class="el" href="classWt_1_1WCombinedLocalizedStrings.html#acbd17cadce597217e89e31512ab1b6ed">Wt::WCombinedLocalizedStrings</a>.</p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Fri Mar 30 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
|
