<!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::Auth::Login 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="namespaceWt_1_1Auth.html">Auth</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Auth_1_1Login.html">Login</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::Auth::Login Class Reference<div class="ingroups"><a class="el" href="group__auth.html">Authentication module (Wt::Auth)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::Login" --><!-- doxytag: inherits="Wt::WObject" -->
<p>A class that manages the current login state.
<a href="classWt_1_1Auth_1_1Login.html#details">More...</a></p>
<p><code>#include <Wt/Auth/Login></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::Login:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1Login__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1Login_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1Login_inherit__map" id="Wt_1_1Auth_1_1Login_inherit__map">
<area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="13,5,109,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1Login-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_1Auth_1_1Login.html#a528837a0fd1e66dfce9eae6ff15a7b79">Login</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a528837a0fd1e66dfce9eae6ff15a7b79"></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_1Auth_1_1Login.html#a444914a55b6c0e4bdc24e6bb380443ba">login</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, <a class="el" href="group__auth.html#ga0ce4a4a08ad982d03a99a5405394b796">LoginState</a> state=StrongLogin)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Logs a user in. <a href="#a444914a55b6c0e4bdc24e6bb380443ba"></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_1Auth_1_1Login.html#af10e98871028d79460a4e64415ca90e4">logout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Logs the current user out. <a href="#af10e98871028d79460a4e64415ca90e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__auth.html#ga0ce4a4a08ad982d03a99a5405394b796">LoginState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Login.html#aeabbf36f671e898fae0c3a6f1cdb5298">state</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current login state. <a href="#aeabbf36f671e898fae0c3a6f1cdb5298"></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_1Auth_1_1Login.html#aece418e93d9e9b3ad5a783225cece9cc">loggedIn</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a user has successfully logged in. <a href="#aece418e93d9e9b3ad5a783225cece9cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Login.html#a41667e44dc8a3a5aa95fd38f28b11571">user</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user currently identified. <a href="#a41667e44dc8a3a5aa95fd38f28b11571"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Login.html#aafb1d791aeee8b59d28faeda88e8392b">changed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal that indicates login changes. <a href="#aafb1d791aeee8b59d28faeda88e8392b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class that manages the current login state. </p>
<p>This is a model class which is typically associated with a single session, for the duration of the session.</p>
<p>Widgets that implement authentication (and thus produce authentication changes), will indicate their result in this object using the <a class="el" href="classWt_1_1Auth_1_1Login.html#a444914a55b6c0e4bdc24e6bb380443ba" title="Logs a user in.">login()</a> or <a class="el" href="classWt_1_1Auth_1_1Login.html#af10e98871028d79460a4e64415ca90e4" title="Logs the current user out.">logout()</a> methods.</p>
<p>Widgets that want to react to login state changes (typically, as user logging in or out) should listen to the <a class="el" href="classWt_1_1Auth_1_1Login.html#aafb1d791aeee8b59d28faeda88e8392b" title="Signal that indicates login changes.">changed()</a> signal of this object.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AuthWidget.html" title="An authentication widget.">AuthWidget</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a528837a0fd1e66dfce9eae6ff15a7b79"></a><!-- doxytag: member="Wt::Auth::Login::Login" ref="a528837a0fd1e66dfce9eae6ff15a7b79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Auth::Login::Login </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Creates a login object in the LoggedOut state. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aafb1d791aeee8b59d28faeda88e8392b"></a><!-- doxytag: member="Wt::Auth::Login::changed" ref="aafb1d791aeee8b59d28faeda88e8392b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a>& Wt::Auth::Login::changed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal that indicates login changes. </p>
<p>This signal is emitted as a result of <a class="el" href="classWt_1_1Auth_1_1Login.html#a444914a55b6c0e4bdc24e6bb380443ba" title="Logs a user in.">login()</a> or <a class="el" href="classWt_1_1Auth_1_1Login.html#af10e98871028d79460a4e64415ca90e4" title="Logs the current user out.">logout()</a>. </p>
</div>
</div>
<a class="anchor" id="aece418e93d9e9b3ad5a783225cece9cc"></a><!-- doxytag: member="Wt::Auth::Login::loggedIn" ref="aece418e93d9e9b3ad5a783225cece9cc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Auth::Login::loggedIn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether a user has successfully logged in. </p>
<p>This returns <code>true</code> only if the state is WeakLogin or StrongLogin.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Login.html#aeabbf36f671e898fae0c3a6f1cdb5298" title="Returns the current login state.">state()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a444914a55b6c0e4bdc24e6bb380443ba"></a><!-- doxytag: member="Wt::Auth::Login::login" ref="a444914a55b6c0e4bdc24e6bb380443ba" args="(const User &user, LoginState state=StrongLogin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::Login::login </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__auth.html#ga0ce4a4a08ad982d03a99a5405394b796">LoginState</a> </td>
<td class="paramname"><em>state</em> = <code>StrongLogin</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Logs a user in. </p>
<p>A user can be logged in using either a DisabledLogin, WeakLogin or StrongLogin <code>state</code>. The login state is forced to DisabledLogin if <a class="el" href="classWt_1_1Auth_1_1User.html#a25cc981dabd643012eaa9e18bf6d4d57" title="Returns the account status.">User::status()</a> returns Disabled.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Login.html#af10e98871028d79460a4e64415ca90e4" title="Logs the current user out.">logout()</a>, <a class="el" href="classWt_1_1Auth_1_1Login.html#aece418e93d9e9b3ad5a783225cece9cc" title="Returns whether a user has successfully logged in.">loggedIn()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af10e98871028d79460a4e64415ca90e4"></a><!-- doxytag: member="Wt::Auth::Login::logout" ref="af10e98871028d79460a4e64415ca90e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::Login::logout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Logs the current user out. </p>
<p>Sets the state to LoggedOut. </p>
</div>
</div>
<a class="anchor" id="aeabbf36f671e898fae0c3a6f1cdb5298"></a><!-- doxytag: member="Wt::Auth::Login::state" ref="aeabbf36f671e898fae0c3a6f1cdb5298" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__auth.html#ga0ce4a4a08ad982d03a99a5405394b796">LoginState</a> Wt::Auth::Login::state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current login state. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Login.html#a444914a55b6c0e4bdc24e6bb380443ba" title="Logs a user in.">login()</a>, <a class="el" href="classWt_1_1Auth_1_1Login.html#af10e98871028d79460a4e64415ca90e4" title="Logs the current user out.">logout()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a41667e44dc8a3a5aa95fd38f28b11571"></a><!-- doxytag: member="Wt::Auth::Login::user" ref="a41667e44dc8a3a5aa95fd38f28b11571" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & Wt::Auth::Login::user </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the user currently identified. </p>
<p>Returns the user currently identified.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This may also be a user whose account is currently disabled. </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>
