<!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::WValidationStatus 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_1WValidationStatus.html">WValidationStatus</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::WValidationStatus Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::WValidationStatus" --><!-- doxytag: inherits="Wt::WCompositeWidget" --> <p>A widget that keeps track of the validation status of a form widget. <a href="classWt_1_1WValidationStatus.html#details">More...</a></p> <p><code>#include <Wt/WValidationStatus></code></p> <div class="dynheader"> Inheritance diagram for Wt::WValidationStatus:</div> <div class="dyncontent"> <div class="center"><img src="classWt_1_1WValidationStatus__inherit__graph.png" border="0" usemap="#Wt_1_1WValidationStatus_inherit__map" alt="Inheritance graph"/></div> <map name="Wt_1_1WValidationStatus_inherit__map" id="Wt_1_1WValidationStatus_inherit__map"> <area shape="rect" href="classWt_1_1WCompositeWidget.html" title="A widget that hides the implementation of composite widgets." alt="" coords="5,155,168,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="37,80,136,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="39,5,135,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classWt_1_1WValidationStatus-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WValidationStatus.html#aa40ae47e0987dc7e1f0261372ca43ca5">WValidationStatus</a> (<a class="el" href="classWt_1_1WFormWidget.html">WFormWidget</a> *field, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *validStateWidget=0, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *invalidStateWidget=0, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *invalidEmptyStateWidget=0, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classWt_1_1WValidationStatus.html" title="A widget that keeps track of the validation status of a form widget.">WValidationStatus</a> widget for another widget. <a href="#aa40ae47e0987dc7e1f0261372ca43ca5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66ee198ccdd2eb5d0de620fc6326c2e2"></a><!-- doxytag: member="Wt::WValidationStatus::valid" ref="a66ee198ccdd2eb5d0de620fc6326c2e2" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WValidationStatus.html#a66ee198ccdd2eb5d0de620fc6326c2e2">valid</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Is the field currently considered valid? <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< bool > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WValidationStatus.html#a463b399e7c6d20d7bed88d60290d1fd0">validated</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classWt_1_1Signal.html" title="A signal that propagates events to listeners.">Signal</a> emitted when the validation state changed. <a href="#a463b399e7c6d20d7bed88d60290d1fd0"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A widget that keeps track of the validation status of a form widget. </p> <p><em>Since Wt 2.1.3, all standard validators provide client-side validation and this is reflected in the form widget using the style class "Wt-invalid" when the validator returns not <a class="el" href="classWt_1_1WValidator.html#a638a1feefca259ea2f806a8add2d18a3a1bc2acb7589ab9e3050867ebfc32dda3" title="The input is valid.">WValidator::Valid</a>. Therefore, it is unlikely you will need this class anymore.</em></p> <p>Use a WValidationStatus widget to act to changes in validation of a <a class="el" href="classWt_1_1WFormWidget.html" title="An abstract widget that corresponds to an HTML form element.">WFormWidget</a>. The widget may show visual feed-back of the validation state of the input.</p> <p>Visual feed-back may be given by showing an invalidStateWidget when input is invalid, an invalidEmptyStateWidget when the input is invalid because mandatory and empty, or a validStateWidget when input is valid. All of these widgets may be 0, indicating that no widget will be shown for the corresponding state.</p> <p>When validation state changes from invalid to valid, or from valid to invalid, the widget emits the validated signal. This may be used to for example enable or disable a button.</p> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000060">Deprecated:</a></b></dt><dd>Since Wt 3.1.1, validation is handled directly on <a class="el" href="classWt_1_1WFormWidget.html" title="An abstract widget that corresponds to an HTML form element.">WFormWidget</a> subclasses. </dd></dl> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa40ae47e0987dc7e1f0261372ca43ca5"></a><!-- doxytag: member="Wt::WValidationStatus::WValidationStatus" ref="aa40ae47e0987dc7e1f0261372ca43ca5" args="(WFormWidget *field, WWidget *validStateWidget=0, WWidget *invalidStateWidget=0, WWidget *invalidEmptyStateWidget=0, WContainerWidget *parent=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::WValidationStatus::WValidationStatus </td> <td>(</td> <td class="paramtype"><a class="el" href="classWt_1_1WFormWidget.html">WFormWidget</a> * </td> <td class="paramname"><em>field</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>validStateWidget</em> = <code>0</code>, </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>invalidStateWidget</em> = <code>0</code>, </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>invalidEmptyStateWidget</em> = <code>0</code>, </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>Construct a <a class="el" href="classWt_1_1WValidationStatus.html" title="A widget that keeps track of the validation status of a form widget.">WValidationStatus</a> widget for another widget. </p> <p>Constructs a validation status widget for the given field.</p> <p>The validation stateWidgets (if not <code>0</code>) will be managed by this widget, and shown and hidden to reflect the current validation state. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a463b399e7c6d20d7bed88d60290d1fd0"></a><!-- doxytag: member="Wt::WValidationStatus::validated" ref="a463b399e7c6d20d7bed88d60290d1fd0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a><bool>& Wt::WValidationStatus::validated </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classWt_1_1Signal.html" title="A signal that propagates events to listeners.">Signal</a> emitted when the validation state changed. </p> <p>The new state of the validation (valid or invalid) is given as argument. This signal gets emitted when the state changes from <a class="el" href="classWt_1_1WValidator.html#a638a1feefca259ea2f806a8add2d18a3a1bc2acb7589ab9e3050867ebfc32dda3" title="The input is valid.">WValidator::Valid</a> to <a class="el" href="classWt_1_1WValidator.html#a638a1feefca259ea2f806a8add2d18a3aa5bf750faac5f1ca6fb58c8de97bac51" title="The input is invalid.">WValidator::Invalid</a>, or from <a class="el" href="classWt_1_1WValidator.html#a638a1feefca259ea2f806a8add2d18a3aa5bf750faac5f1ca6fb58c8de97bac51" title="The input is invalid.">WValidator::Invalid</a> to <a class="el" href="classWt_1_1WValidator.html#a638a1feefca259ea2f806a8add2d18a3a1bc2acb7589ab9e3050867ebfc32dda3" title="The input is valid.">WValidator::Valid</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 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>