<!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::WTemplate 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.3</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_1WTemplate.html">WTemplate</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WTemplate Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WTemplate" --><!-- doxytag: inherits="Wt::WInteractWidget" -->
<p>A widget that renders an XHTML template.
<a href="classWt_1_1WTemplate.html#details">More...</a></p>
<p><code>#include <Wt/WTemplate></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WTemplate:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WTemplate__inherit__graph.png" border="0" usemap="#Wt_1_1WTemplate_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WTemplate_inherit__map" id="Wt_1_1WTemplate_inherit__map">
<area shape="rect" href="classWt_1_1Auth_1_1LostPasswordWidget.html" title="A widget which initiates a lost-password email." alt="" coords="5,379,208,405"/><area shape="rect" href="classWt_1_1WTemplateFormView.html" title="A template-based View class form form models." alt="" coords="232,379,400,405"/><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="139,229,283,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="147,155,275,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="161,80,260,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="163,5,259,32"/><area shape="rect" href="classWt_1_1Auth_1_1AuthWidget.html" title="An authentication widget." alt="" coords="47,453,196,480"/><area shape="rect" href="classWt_1_1Auth_1_1RegistrationWidget.html" title="A registration widget." alt="" coords="220,453,412,480"/><area shape="rect" href="classWt_1_1Auth_1_1UpdatePasswordWidget.html" title="A widget which allows a user to choose a new password." alt="" coords="436,453,655,480"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WTemplate-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1WTemplate_1_1Functions.html">Functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A collection of predefined functions. <a href="structWt_1_1WTemplate_1_1Functions.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef boost::function< bool(<a class="el" href="classWt_1_1WTemplate.html">WTemplate</a> <br class="typebreak"/>
*t, const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> ><br class="typebreak"/>
&args, std::ostream &result) </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#afb381573504d35b4529fe66be8be8150">Function</a> )</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A function type. <a href="#afb381573504d35b4529fe66be8be8150"></a><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="a74a622a38ba317fcf3f8dc0ae4d43895"></a><!-- doxytag: member="Wt::WTemplate::WTemplate" ref="a74a622a38ba317fcf3f8dc0ae4d43895" args="(WContainerWidget *parent=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895">WTemplate</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a template widget. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#acf69702efa16a728e135958e0fec6622">WTemplate</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a template widget with given template. <a href="#acf69702efa16a728e135958e0fec6622"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a6976f0561b036c6e4980a9991e8b4d38">templateText</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the template. <a href="#a6976f0561b036c6e4980a9991e8b4d38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a51db0813cc62cac123aaaa9a21c4eaa8">setTemplateText</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text, <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> textFormat=XHTMLText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the template text. <a href="#a51db0813cc62cac123aaaa9a21c4eaa8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b">bindString</a> (const std::string &varName, const <a class="el" href="classWt_1_1WString.html">WString</a> &value, <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> textFormat=XHTMLText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a string value to a variable. <a href="#a4be1babfa3a79b08ce73ca7fcca0324b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a3c32ed1444d2e82ffbd6d9718cdee3c9">nestTemplate</a> (const std::string &varName, const <a class="el" href="classWt_1_1WString.html">Wt::WString</a> &templateText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a nested template text to a variable. <a href="#a3c32ed1444d2e82ffbd6d9718cdee3c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a89426dcac3371befc127f7d5b04bb5ed">bindInt</a> (const std::string &varName, int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds an integer value to a variable. <a href="#a89426dcac3371befc127f7d5b04bb5ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203">bindWidget</a> (const std::string &varName, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a widget to a variable. <a href="#a49b2e1de86726ef96875a347a8d02203"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a1b7e969d280a9f245696de10a7137a85">bindEmpty</a> (const std::string &varName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds an empty string to a variable. <a href="#a1b7e969d280a9f245696de10a7137a85"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a">addFunction</a> (const std::string &name, const <a class="el" href="classWt_1_1WTemplate.html#afb381573504d35b4529fe66be8be8150">Function</a> &function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a function. <a href="#ae8f4d8e21baa953323f3c0ce1cb4314a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#ab2b6fc00ef28674be103dd1b13fd0aec">setCondition</a> (const std::string &name, bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a condition. <a href="#ab2b6fc00ef28674be103dd1b13fd0aec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#af667e773c361491c621185c1b5904d61">conditionValue</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a condition value. <a href="#af667e773c361491c621185c1b5904d61"></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_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4">resolveString</a> (const std::string &varName, const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > &args, std::ostream &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolves the string value for a variable name. <a href="#aaf3655dc6954a7fab1158fd3b50d03e4"></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_1WTemplate.html#ad5233b12314148d97dfaabdd2406b485">handleUnresolvedVariable</a> (const std::string &varName, const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > &args, std::ostream &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a variable that could not be resolved. <a href="#ad5233b12314148d97dfaabdd2406b485"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3">resolveWidget</a> (const std::string &varName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolves a widget for a variable name. <a href="#aef922e8441694954e14523a368c6cca3"></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_1WTemplate.html#a2890c4e66cd724c9254ba0f8e322cb96">resolveFunction</a> (const std::string &name, const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > &args, std::ostream &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolves a function call. <a href="#a2890c4e66cd724c9254ba0f8e322cb96"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a9249cc525fe3c16f999644f0f1db6cb4">resolve</a> (const std::string &varName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a widget for a variable name. <a href="#a9249cc525fe3c16f999644f0f1db6cb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a155b52d94ebf495873daa848db105224">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Erases all variable bindings. <a href="#a155b52d94ebf495873daa848db105224"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#aeee888e560c519ac0e33bfc1ebb315e2">setInternalPathEncoding</a> (bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables internal path anchors in the XHTML template. <a href="#aeee888e560c519ac0e33bfc1ebb315e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a6f1bd22a2ec9ae9b364bac82f31c159e">hasInternalPathEncoding</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether internal paths are enabled. <a href="#a6f1bd22a2ec9ae9b364bac82f31c159e"></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_1WTemplate.html#a74f07dc026d40156769ef6d858e21538">refresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the template. <a href="#a74f07dc026d40156769ef6d858e21538"></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_1WTemplate.html#a98baf277a7dd3144a38edb77cbb3d284">renderTemplate</a> (std::ostream &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Renders the template into the given result stream. <a href="#a98baf277a7dd3144a38edb77cbb3d284"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a3a194b78e12be853cbff423c71d62efb">applyArguments</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *w, const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > &args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies arguments to a resolved widget. <a href="#a3a194b78e12be853cbff423c71d62efb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a35d7844ee2f2bbbcde8eeff6683194bd">format</a> (std::ostream &result, const std::string &s, <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> textFormat=PlainText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to safely format an XHTML string. <a href="#a35d7844ee2f2bbbcde8eeff6683194bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WTemplate.html#a8c0ed114c0e3710be3ccd75155253fa9">format</a> (std::ostream &result, const <a class="el" href="classWt_1_1WString.html">WString</a> &s, <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> textFormat=PlainText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to safely format an XHTML string. <a href="#a8c0ed114c0e3710be3ccd75155253fa9"></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_1WTemplate.html#aafe27c3c2f89359a5c02112da3b155ab">enableAjax</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Progresses to an Ajax-enabled widget. <a href="#aafe27c3c2f89359a5c02112da3b155ab"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A widget that renders an XHTML template. </p>
<p>The XHTML template may contain references to variables which replaced by strings are widgets.</p>
<p>Since the template text may be supplied by a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>, you can conveniently store the string in a message resource bundle, and make it localized by using <a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a>.</p>
<p>Placeholders (for variables and functions) are delimited by: <code>${...}</code>. To use a literal <code>"${"</code>, use <code>"$${"</code>.</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> WString userName = ...;
<a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a> *t = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a>();
t->setTemplateText(<span class="stringliteral">"<div> How old are you, ${friend} ? ${age-input} </div>"</span>);
t->bindString(<span class="stringliteral">"friend"</span>, userName, <a class="code" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480ae06bb9ae9a26d13c3dcf9f20d5067885" title="Format text as plain text.">PlainText</a>);
t->bindWidget(<span class="stringliteral">"age-input"</span>, ageEdit_ = <span class="keyword">new</span> WLineEdit());
</pre></div><p>There are currently three syntactic constructs defined: variable place holders, functions and conditional blocks.</p>
<h3>A. Variable placeholders</h3>
<p><code>${var}</code> defines a placeholder for the variable "var", and gets replaced with whatever is bound to that variable:</p>
<ul>
<li>a widget, using <a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a></li>
<li>a string value, using <a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> or <a class="el" href="classWt_1_1WTemplate.html#a89426dcac3371befc127f7d5b04bb5ed" title="Binds an integer value to a variable.">bindInt()</a></li>
<li>or in general, the result of <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> and <a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">resolveWidget()</a> methods.</li>
</ul>
<p>Optionally, additional arguments can be specified using the following syntax:</p>
<p><code>${var arg1="A value" arg2='A second value'}</code></p>
<p>The arguments can thus be simple simple strings or quoted strings (single or double quoted). These arguments are applied to a resolved widget in <a class="el" href="classWt_1_1WTemplate.html#a3a194b78e12be853cbff423c71d62efb" title="Applies arguments to a resolved widget.">applyArguments()</a> and currently supports only style classes.</p>
<p>You can bind widgets and values to variables using <a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a>, <a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> or <a class="el" href="classWt_1_1WTemplate.html#a89426dcac3371befc127f7d5b04bb5ed" title="Binds an integer value to a variable.">bindInt()</a> or by reimplementing the <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> and <a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">resolveWidget()</a> methods.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The use of XML comments (<code><!-- ... --></code>) around variables that are bound to widgets will result in bad behaviour since the template parser is ignorant about these comments and the corresponding widgets will believe that they are rendered but aren't actually.</dd></dl>
<h3>B. Functions</h3>
<p><code>${fun:arg}</code> defines a placeholder for applying a function "fun" to an argument "arg".</p>
<p>Optionally, additional arguments can be specified as with a variable placeholder.</p>
<p><a class="el" href="structWt_1_1WTemplate_1_1Functions.html" title="A collection of predefined functions.">Functions</a> are resolved by <a class="el" href="classWt_1_1WTemplate.html#a2890c4e66cd724c9254ba0f8e322cb96" title="Resolves a function call.">resolveFunction()</a>, and the default implementation considers functions bound with <a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a" title="Binds a function.">addFunction()</a>. There are currently two functions that are generally useful:</p>
<ul>
<li><a class="el" href="structWt_1_1WTemplate_1_1Functions.html#a849649f5cb5609a681cb9361117d0348">Functions::tr()</a> : resolves a localized strings, this is convenient to create a language neutral template, which contains translated strings</li>
<li><a class="el" href="structWt_1_1WTemplate_1_1Functions.html#a73c9f4b259c0947e168da9b6925cfdad">Functions::id()</a> : resolves the id of a bound widget, this is convenient to bind <label> elements to a form widget using its for attribute.</li>
</ul>
<p>For example, the following template uses the "tr" function to translate the age-label using the "age-label" internationalized key.</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a> *t = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a>();
t->addFunction(<span class="stringliteral">"tr"</span>, &<a class="code" href="structWt_1_1WTemplate_1_1Functions.html#a849649f5cb5609a681cb9361117d0348" title="A function that resolves to a localized string.">WTemplate::Functions::tr</a>);
t->setTemplateText(<span class="stringliteral">"<div> ${tr:age-label} ${age-input} </div>"</span>);
t->bindWidget(<span class="stringliteral">"age-input"</span>, ageEdit_ = <span class="keyword">new</span> WLineEdit());
</pre></div><h3>C. Conditional blocks</h3>
<p><code>${<cond>}</code> starts a conditional block with a condition name "cond", and must be closed by a balanced <code>${</cond>}</code>.</p>
<p>For example: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a> *t = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a>();
t->setTemplateText(<span class="stringliteral">"<div> ${<if-register>} Register ... ${</if-register>}</div>"</span>);
t->setCondition(<span class="stringliteral">"if-register"</span>, <span class="keyword">true</span>);
</pre></div><p>Conditions are set using <a class="el" href="classWt_1_1WTemplate.html#ab2b6fc00ef28674be103dd1b13fd0aec" title="Sets a condition.">setCondition()</a>.</p>
<p>The template can return a bound widget using <a class="el" href="classWt_1_1WTemplate.html#a9249cc525fe3c16f999644f0f1db6cb4" title="Returns a widget for a variable name.">resolve()</a>, which already tries to cast the widget to the proper type.</p>
<h3>CSS</h3>
<p>This widget does not provide styling, and can be styled using inline or external CSS as appropriate. </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="afb381573504d35b4529fe66be8be8150"></a><!-- doxytag: member="Wt::WTemplate::Function" ref="afb381573504d35b4529fe66be8be8150" args=")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::function<bool(<a class="el" href="classWt_1_1WTemplate.html">WTemplate</a> *t, const std::vector<<a class="el" href="classWt_1_1WString.html">WString</a>>& args, std::ostream& result) <a class="el" href="classWt_1_1WTemplate.html#afb381573504d35b4529fe66be8be8150">Wt::WTemplate::Function</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A function type. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a" title="Binds a function.">addFunction()</a> </dd>
<dd>
<a class="el" href="structWt_1_1WTemplate_1_1Functions.html#a849649f5cb5609a681cb9361117d0348" title="A function that resolves to a localized string.">Functions::tr()</a>, <a class="el" href="structWt_1_1WTemplate_1_1Functions.html#a73c9f4b259c0947e168da9b6925cfdad" title="A function that resolves the id of a bound widget.">Functions::id()</a> </dd></dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acf69702efa16a728e135958e0fec6622"></a><!-- doxytag: member="Wt::WTemplate::WTemplate" ref="acf69702efa16a728e135958e0fec6622" args="(const WString &text, WContainerWidget *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WTemplate::WTemplate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a template widget with given template. </p>
<p>The <code>templateText</code> must be proper XHTML, and this is checked unless the XHTML is resolved from a message resource bundle. This behavior is similar to a <a class="el" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">WText</a> when configured with the <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480a847ab5a73b906fea275bd16877b420a4" title="Format text as XSS-safe XHTML markup'ed text.">Wt::XHTMLText</a> textformat. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae8f4d8e21baa953323f3c0ce1cb4314a"></a><!-- doxytag: member="Wt::WTemplate::addFunction" ref="ae8f4d8e21baa953323f3c0ce1cb4314a" args="(const std::string &name, const Function &function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::addFunction </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WTemplate.html#afb381573504d35b4529fe66be8be8150">Function</a> & </td>
<td class="paramname"><em>function</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a function. </p>
<p><a class="el" href="structWt_1_1WTemplate_1_1Functions.html" title="A collection of predefined functions.">Functions</a> are useful to automatically resolve placeholders.</p>
<p>The syntax for a function 'fun' applied to a single argument 'bla' is:</p>
<p><code>${fun:bla}</code></p>
<p>There are two predefined functions, which can be bound using: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WTemplate.html#a74a622a38ba317fcf3f8dc0ae4d43895" title="Creates a template widget.">WTemplate</a> *t = ...;
t->addFunction(<span class="stringliteral">"id"</span>, &<a class="code" href="structWt_1_1WTemplate_1_1Functions.html#a73c9f4b259c0947e168da9b6925cfdad" title="A function that resolves the id of a bound widget.">WTemplate::Functions::id</a>);
t->addFunction(<span class="stringliteral">"tr"</span>, &<a class="code" href="structWt_1_1WTemplate_1_1Functions.html#a849649f5cb5609a681cb9361117d0348" title="A function that resolves to a localized string.">WTemplate::Functions::tr</a>);
</pre></div>
</div>
</div>
<a class="anchor" id="a3a194b78e12be853cbff423c71d62efb"></a><!-- doxytag: member="Wt::WTemplate::applyArguments" ref="a3a194b78e12be853cbff423c71d62efb" args="(WWidget *w, const std::vector< WString > &args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::applyArguments </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > & </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Applies arguments to a resolved widget. </p>
<p>Currently only a <code>class</code> argument is handled, which adds one or more style classes to the widget <code>w</code>, using <a class="el" href="classWt_1_1WWidget.html#abb5949e98f47edb7db98d7b6df07a31c" title="Adds a CSS style class.">WWidget::addStyleClass()</a>. </p>
</div>
</div>
<a class="anchor" id="a1b7e969d280a9f245696de10a7137a85"></a><!-- doxytag: member="Wt::WTemplate::bindEmpty" ref="a1b7e969d280a9f245696de10a7137a85" args="(const std::string &varName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::bindEmpty </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds an empty string to a variable. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a89426dcac3371befc127f7d5b04bb5ed"></a><!-- doxytag: member="Wt::WTemplate::bindInt" ref="a89426dcac3371befc127f7d5b04bb5ed" args="(const std::string &varName, int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::bindInt </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds an integer value to a variable. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4be1babfa3a79b08ce73ca7fcca0324b"></a><!-- doxytag: member="Wt::WTemplate::bindString" ref="a4be1babfa3a79b08ce73ca7fcca0324b" args="(const std::string &varName, const WString &value, TextFormat textFormat=XHTMLText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::bindString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> </td>
<td class="paramname"><em>textFormat</em> = <code>XHTMLText</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a string value to a variable. </p>
<p>Each occurrence of the variable within the template will be substituted by its value.</p>
<p>Depending on the <code>textFormat</code>, the <code>value</code> is validated according as for a <a class="el" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">WText</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a>, <a class="el" href="classWt_1_1WTemplate.html#a89426dcac3371befc127f7d5b04bb5ed" title="Binds an integer value to a variable.">bindInt()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a49b2e1de86726ef96875a347a8d02203"></a><!-- doxytag: member="Wt::WTemplate::bindWidget" ref="a49b2e1de86726ef96875a347a8d02203" args="(const std::string &varName, WWidget *widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::bindWidget </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"><em>widget</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a widget to a variable. </p>
<p>The corresponding variable reference within the template will be replaced with the widget (rendered as XHTML). Since a single widget may be instantiated only once in a template, the variable <code>varName</code> may occur at most once in the template.</p>
<p>If a widget was already bound to the variable, it is deleted first. If previously a string or other value was bound to the variable, it is removed.</p>
<p>You may also pass a <code>0</code> <code>widget</code>, which will resolve to an empty string.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">resolveWidget()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a155b52d94ebf495873daa848db105224"></a><!-- doxytag: member="Wt::WTemplate::clear" ref="a155b52d94ebf495873daa848db105224" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Erases all variable bindings. </p>
<p>Removes all strings and deletes all widgets that were previously bound using <a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a> and <a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a>.</p>
<p>This also resets all conditions set using <a class="el" href="classWt_1_1WTemplate.html#ab2b6fc00ef28674be103dd1b13fd0aec" title="Sets a condition.">setCondition()</a>, but does not remove functions added with <a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a" title="Binds a function.">addFunction()</a> </p>
</div>
</div>
<a class="anchor" id="af667e773c361491c621185c1b5904d61"></a><!-- doxytag: member="Wt::WTemplate::conditionValue" ref="af667e773c361491c621185c1b5904d61" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WTemplate::conditionValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a condition value. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#ab2b6fc00ef28674be103dd1b13fd0aec" title="Sets a condition.">setCondition()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aafe27c3c2f89359a5c02112da3b155ab"></a><!-- doxytag: member="Wt::WTemplate::enableAjax" ref="aafe27c3c2f89359a5c02112da3b155ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::enableAjax </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Progresses to an Ajax-enabled widget. </p>
<p>This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.</p>
<p>You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a78016406c4746c56b2c2ffce7c5e181f" title="Progresses to an Ajax-enabled user interface.">WApplication::enableAjax()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#a8e1d7c93f533be68e3d4ee34f65486fd">Wt::WWebWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a35d7844ee2f2bbbcde8eeff6683194bd"></a><!-- doxytag: member="Wt::WTemplate::format" ref="a35d7844ee2f2bbbcde8eeff6683194bd" args="(std::ostream &result, const std::string &s, TextFormat textFormat=PlainText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::format </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> </td>
<td class="paramname"><em>textFormat</em> = <code>PlainText</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Utility method to safely format an XHTML string. </p>
<p>The string is formatted according to the indicated <code>textFormat</code>. It is recommended to use this method when specializing <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> to avoid security risks. </p>
</div>
</div>
<a class="anchor" id="a8c0ed114c0e3710be3ccd75155253fa9"></a><!-- doxytag: member="Wt::WTemplate::format" ref="a8c0ed114c0e3710be3ccd75155253fa9" args="(std::ostream &result, const WString &s, TextFormat textFormat=PlainText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::format </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> </td>
<td class="paramname"><em>textFormat</em> = <code>PlainText</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Utility method to safely format an XHTML string. </p>
<p>The string is formatted according to the indicated <code>textFormat</code>. It is recommended to use this method when specializing <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> to avoid security risks. </p>
</div>
</div>
<a class="anchor" id="ad5233b12314148d97dfaabdd2406b485"></a><!-- doxytag: member="Wt::WTemplate::handleUnresolvedVariable" ref="ad5233b12314148d97dfaabdd2406b485" args="(const std::string &varName, const std::vector< WString > &args, std::ostream &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::handleUnresolvedVariable </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a variable that could not be resolved. </p>
<p>This method is called from <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> for variables that could not be resolved.</p>
<p>The default implementation implementation writes "??" + varName + "??" to the result stream.</p>
<p>The result stream expects a UTF-8 encoded string value.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>When specializing this class, you need to make sure that you append proper XHTML to the <code>result</code>, without unsafe active contents. The <a class="el" href="classWt_1_1WTemplate.html#a35d7844ee2f2bbbcde8eeff6683194bd" title="Utility method to safely format an XHTML string.">format()</a> methods may be used for this purpose.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6f1bd22a2ec9ae9b364bac82f31c159e"></a><!-- doxytag: member="Wt::WTemplate::hasInternalPathEncoding" ref="a6f1bd22a2ec9ae9b364bac82f31c159e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WTemplate::hasInternalPathEncoding </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether internal paths are enabled. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#aeee888e560c519ac0e33bfc1ebb315e2" title="Enables internal path anchors in the XHTML template.">setInternalPathEncoding()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3c32ed1444d2e82ffbd6d9718cdee3c9"></a><!-- doxytag: member="Wt::WTemplate::nestTemplate" ref="a3c32ed1444d2e82ffbd6d9718cdee3c9" args="(const std::string &varName, const Wt::WString &templateText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::nestTemplate </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">Wt::WString</a> & </td>
<td class="paramname"><em>templateText</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a nested template text to a variable. </p>
<p>The corresponding variable reference within the template will will be replaced by the nested template text (like <a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a>), but this nested template text will also be recursively interpreted for place holder substitution. </p>
</div>
</div>
<a class="anchor" id="a74f07dc026d40156769ef6d858e21538"></a><!-- doxytag: member="Wt::WTemplate::refresh" ref="a74f07dc026d40156769ef6d858e21538" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Refreshes the template. </p>
<p>This rerenders the template. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#a48f8c17376bd04d1359481c5441f072a">Wt::WWebWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a98baf277a7dd3144a38edb77cbb3d284"></a><!-- doxytag: member="Wt::WTemplate::renderTemplate" ref="a98baf277a7dd3144a38edb77cbb3d284" args="(std::ostream &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::renderTemplate </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders the template into the given result stream. </p>
<p>The default implementation will parse the template, and resolve variables by calling <a class="el" href="classWt_1_1WTemplate.html#aaf3655dc6954a7fab1158fd3b50d03e4" title="Resolves the string value for a variable name.">resolveString()</a>.</p>
<p>You may want to reimplement this method to manage resources that are needed to load content on-demand (e.g. database objects), or support a custom template language. </p>
</div>
</div>
<a class="anchor" id="a9249cc525fe3c16f999644f0f1db6cb4"></a><!-- doxytag: member="Wt::WTemplate::resolve" ref="a9249cc525fe3c16f999644f0f1db6cb4" args="(const std::string &varName)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T Wt::WTemplate::resolve </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a widget for a variable name. </p>
<p>This is a convience method, which calls <a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">resolveWidget()</a> and casts the result to type <code>T</code>. You may use this method to fetch widgets that have previously been bound using <a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a>. </p>
</div>
</div>
<a class="anchor" id="a2890c4e66cd724c9254ba0f8e322cb96"></a><!-- doxytag: member="Wt::WTemplate::resolveFunction" ref="a2890c4e66cd724c9254ba0f8e322cb96" args="(const std::string &name, const std::vector< WString > &args, std::ostream &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WTemplate::resolveFunction </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolves a function call. </p>
<p>This resolves a function with name <code>name</code>, and one or more arguments <code>args</code>, and writes the result into the stream <code>result</code>. The method returns whether a function was matched and applied.</p>
<p>The default implementation considers functions that were bound using <a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a" title="Binds a function.">addFunction()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#ae8f4d8e21baa953323f3c0ce1cb4314a" title="Binds a function.">addFunction()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaf3655dc6954a7fab1158fd3b50d03e4"></a><!-- doxytag: member="Wt::WTemplate::resolveString" ref="aaf3655dc6954a7fab1158fd3b50d03e4" args="(const std::string &varName, const std::vector< WString > &args, std::ostream &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::resolveString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolves the string value for a variable name. </p>
<p>This is the main method used to resolve variables in the template text, during rendering.</p>
<p>The default implementation considers first whether a string was bound using <a class="el" href="classWt_1_1WTemplate.html#a4be1babfa3a79b08ce73ca7fcca0324b" title="Binds a string value to a variable.">bindString()</a>. If so, that string is returned. If not, it will attempt to resolve a widget with that variable name using <a class="el" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">resolveWidget()</a>, and render it as XHTML. If that fails too, <a class="el" href="classWt_1_1WTemplate.html#ad5233b12314148d97dfaabdd2406b485" title="Handles a variable that could not be resolved.">handleUnresolvedVariable()</a> is called, passing the initial arguments.</p>
<p>You may want to reimplement this method to provide on-demand loading of strings for your template.</p>
<p>The result stream expects a UTF-8 encoded string value.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>When specializing this class, you need to make sure that you append proper XHTML to the <code>result</code>, without unsafe active contents. The <a class="el" href="classWt_1_1WTemplate.html#a35d7844ee2f2bbbcde8eeff6683194bd" title="Utility method to safely format an XHTML string.">format()</a> methods may be used for this purpose.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a98baf277a7dd3144a38edb77cbb3d284" title="Renders the template into the given result stream.">renderTemplate()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aef922e8441694954e14523a368c6cca3"></a><!-- doxytag: member="Wt::WTemplate::resolveWidget" ref="aef922e8441694954e14523a368c6cca3" args="(const std::string &varName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * Wt::WTemplate::resolveWidget </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>varName</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolves a widget for a variable name. </p>
<p>The default implementation returns a widget that was bound using <a class="el" href="classWt_1_1WTemplate.html#a49b2e1de86726ef96875a347a8d02203" title="Binds a widget to a variable.">bindWidget()</a>.</p>
<p>You may want to reimplement this method to create widgets on-demand. All widgets that are returned by this method are reparented to the <a class="el" href="classWt_1_1WTemplate.html" title="A widget that renders an XHTML template.">WTemplate</a>, so they will be deleted when the template is destroyed, but they are not deleted by <a class="el" href="classWt_1_1WTemplate.html#a155b52d94ebf495873daa848db105224" title="Erases all variable bindings.">clear()</a> (unless bind was called on them as in the example below).</p>
<p>This method is typically used for delayed binding of widgets. Usage example: </p>
<div class="fragment"><pre class="fragment"> {
<span class="keywordflow">if</span> (Widget *known = <a class="code" href="classWt_1_1WTemplate.html#aef922e8441694954e14523a368c6cca3" title="Resolves a widget for a variable name.">WTemplate::resolveWidget</a>(varName)) {
<span class="keywordflow">return</span> known;
} <span class="keywordflow">else</span> {
<span class="keywordflow">if</span> (varName == <span class="stringliteral">"age-input"</span>) {
<a class="code" href="classWt_1_1WWidget.html#a95c22589beb69717356b859bbfd20479" title="Creates a widget.">WWidget</a> *w = <span class="keyword">new</span> WLineEdit(); <span class="comment">// widget only created when used</span>
bind(varName, w);
<span class="keywordflow">return</span> w;
}
}
}
</pre></div>
</div>
</div>
<a class="anchor" id="ab2b6fc00ef28674be103dd1b13fd0aec"></a><!-- doxytag: member="Wt::WTemplate::setCondition" ref="ab2b6fc00ef28674be103dd1b13fd0aec" args="(const std::string &name, bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::setCondition </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a condition. </p>
<p>This enables or disables the inclusion of a conditional block.</p>
<p>The default value of all conditions is <code>false</code>. </p>
</div>
</div>
<a class="anchor" id="aeee888e560c519ac0e33bfc1ebb315e2"></a><!-- doxytag: member="Wt::WTemplate::setInternalPathEncoding" ref="aeee888e560c519ac0e33bfc1ebb315e2" args="(bool enabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::setInternalPathEncoding </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables internal path anchors in the XHTML template. </p>
<p>Anchors to internal paths are represented differently depending on the session implementation (plain HTML, Ajax or HTML5 history). By enabling this option, anchors which reference an internal path (by referring a URL of the form <code>href="#/..."</code>), are re-encoded to link to the internal path.</p>
<p>The default value is <code>false</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAnchor.html#ae3ea26646f135bf133871564f5d6798d" title="Sets a link to an internal path (deprecated).">WAnchor::setRefInternalPath()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a51db0813cc62cac123aaaa9a21c4eaa8"></a><!-- doxytag: member="Wt::WTemplate::setTemplateText" ref="a51db0813cc62cac123aaaa9a21c4eaa8" args="(const WString &text, TextFormat textFormat=XHTMLText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WTemplate::setTemplateText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480">TextFormat</a> </td>
<td class="paramname"><em>textFormat</em> = <code>XHTMLText</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the template text. </p>
<p>The <code>text</code> must be proper XHTML, and this is checked unless the XHTML is resolved from a message resource bundle or TextFormat is <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480aeff9ccfd4130ea9922c46d94f82119b7" title="Format text as XHTML markup'ed text.">Wt::XHTMLUnsafeText</a>. This behavior is similar to a <a class="el" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">WText</a> when configured with the <a class="el" href="namespaceWt.html#a140dea437d52d3d7c438ea3bd16a1480a847ab5a73b906fea275bd16877b420a4" title="Format text as XSS-safe XHTML markup'ed text.">Wt::XHTMLText</a> textformat.</p>
<p>Changing the template text does not <a class="el" href="classWt_1_1WTemplate.html#a155b52d94ebf495873daa848db105224" title="Erases all variable bindings.">clear()</a> bound widgets or values.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a155b52d94ebf495873daa848db105224" title="Erases all variable bindings.">clear()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6976f0561b036c6e4980a9991e8b4d38"></a><!-- doxytag: member="Wt::WTemplate::templateText" ref="a6976f0561b036c6e4980a9991e8b4d38" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a>& Wt::WTemplate::templateText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the template. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTemplate.html#a51db0813cc62cac123aaaa9a21c4eaa8" title="Sets the template text.">setTemplateText()</a> </dd></dl>
</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 Thu Nov 1 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>
