Wt  3.3.9
Public Member Functions | Protected Member Functions | List of all members
Wt::Auth::AuthWidget Class Reference

An authentication widget. More...

#include <Wt/Auth/AuthWidget>

Inheritance diagram for Wt::Auth::AuthWidget:
Inheritance graph
[legend]

Public Member Functions

 AuthWidget (const AuthService &baseAuth, AbstractUserDatabase &users, Login &login, WContainerWidget *parent=0)
 Constructor. More...
 
 AuthWidget (Login &login, WContainerWidget *parent=0)
 Constructor. More...
 
void setModel (AuthModel *model)
 Sets a model. More...
 
AuthModelmodel () const
 Returns the model. More...
 
Loginlogin ()
 Returns the login object. More...
 
void setInternalBasePath (const std::string &path)
 Sets an internal path for authentication services. More...
 
std::string internalBasePath () const
 Returns the internal path. More...
 
void setRegistrationEnabled (bool enabled)
 Configures registration capabilities. More...
 
void registerNewUser ()
 Starts a new registration process. More...
 
virtual void registerNewUser (const Identity &oauth)
 Starts a new registration process. More...
 
virtual void processEnvironment ()
 Processes the (initial) environment. More...
 
virtual void letUpdatePassword (const User &user, bool promptPassword)
 Lets the user update his password. More...
 
virtual void handleLostPassword ()
 Lets the user "recover" a lost password. More...
 
virtual WWidgetcreateLostPasswordView ()
 Creates a lost password view. More...
 
virtual WWidgetcreateRegistrationView (const Identity &id)
 Creates a registration view. More...
 
virtual WWidgetcreateUpdatePasswordView (const User &user, bool promptPassword)
 Creates a view to update a user's password. More...
 
virtual WDialogcreatePasswordPromptDialog (Login &login)
 Creates a password prompt dialog. More...
 
virtual void displayError (const WString &error)
 Displays the error message. More...
 
virtual void displayInfo (const WString &message)
 Displays the info message. More...
 
- Public Member Functions inherited from Wt::WTemplateFormView
 WTemplateFormView (WContainerWidget *parent=0)
 Constructor. More...
 
 WTemplateFormView (const WString &text, WContainerWidget *parent=0)
 Constructor. More...
 
void setFormWidget (WFormModel::Field field, WWidget *widget)
 Sets the form widget for a given field. More...
 
void setFormWidget (WFormModel::Field field, WWidget *widget, const boost::function< void()> &updateViewValue, const boost::function< void()> &updateModelValue)
 Sets the form widget for a given field. More...
 
virtual void updateView (WFormModel *model)
 Updates the View. More...
 
virtual void updateViewField (WFormModel *model, WFormModel::Field field)
 Creates or updates a field in the View. More...
 
virtual void updateViewValue (WFormModel *model, WFormModel::Field field, WFormWidget *edit)
 Updates the value in the View. More...
 
virtual bool updateViewValue (WFormModel *model, WFormModel::Field field, WWidget *edit)
 Updates the value in the View. More...
 
virtual void updateModel (WFormModel *model)
 Updates the Model. More...
 
virtual void updateModelField (WFormModel *model, WFormModel::Field field)
 Updates a field in the Model. More...
 
virtual void updateModelValue (WFormModel *model, WFormModel::Field field, WFormWidget *edit)
 Updates a value in the Model. More...
 
virtual bool updateModelValue (WFormModel *model, WFormModel::Field field, WWidget *edit)
 Updates a value in the Model. More...
 
- Public Member Functions inherited from Wt::WTemplate
 WTemplate (WContainerWidget *parent=0)
 Creates a template widget.
 
 WTemplate (const WString &text, WContainerWidget *parent=0)
 Creates a template widget with given template. More...
 
virtual WString templateText () const
 Returns the template. More...
 
void setTemplateText (const WString &text, TextFormat textFormat=XHTMLText)
 Sets the template text. More...
 
void setWidgetIdMode (WidgetIdMode mode)
 Sets how the varName should be reflected on bound widgets. More...
 
WidgetIdMode widgetIdMode () const
 Returns how the varName is reflected on a bound widget. More...
 
virtual void bindString (const std::string &varName, const WString &value, TextFormat textFormat=XHTMLText)
 Binds a string value to a variable. More...
 
void bindInt (const std::string &varName, int value)
 Binds an integer value to a variable. More...
 
virtual void bindWidget (const std::string &varName, WWidget *widget)
 Binds a widget to a variable. More...
 
WWidgettakeWidget (const std::string &varName)
 Unbinds a widget. More...
 
void bindEmpty (const std::string &varName)
 Binds an empty string to a variable. More...
 
void addFunction (const std::string &name, const Function &function)
 Binds a function. More...
 
void setCondition (const std::string &name, bool value)
 Sets a condition. More...
 
virtual bool conditionValue (const std::string &name) const
 Returns a condition value. More...
 
std::set< std::string > conditionsSet ()
 Returns the set of conditions set to true.
 
virtual void resolveString (const std::string &varName, const std::vector< WString > &args, std::ostream &result)
 Resolves the string value for a variable name. More...
 
virtual void handleUnresolvedVariable (const std::string &varName, const std::vector< WString > &args, std::ostream &result)
 Handles a variable that could not be resolved. More...
 
virtual WWidgetresolveWidget (const std::string &varName)
 Resolves a widget for a variable name. More...
 
virtual bool resolveFunction (const std::string &name, const std::vector< WString > &args, std::ostream &result)
 Resolves a function call. More...
 
template<typename T >
resolve (const std::string &varName)
 Returns a widget for a variable name. More...
 
virtual void clear ()
 Erases all variable bindings. More...
 
void setInternalPathEncoding (bool enabled)
 Enables internal path anchors in the XHTML template. More...
 
bool hasInternalPathEncoding () const
 Returns whether internal paths are enabled. More...
 
void setEncodeTemplateText (bool on)
 Configures when internal path encoding is done. More...
 
bool encodeTemplateText () const
 Returns whether internal path encoding is done on the template text. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void renderTemplate (std::ostream &result)
 Renders the template into the given result stream. More...
 
bool renderTemplateText (std::ostream &result, const WString &templateText)
 Renders a template into the given result stream. More...
 
std::string getErrorText ()
 Renders the errors during renderring. More...
 
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget (WContainerWidget *parent=0)
 Create an InteractWidget with optional parent.
 
EventSignal< WKeyEvent > & keyWentDown ()
 Event signal emitted when a keyboard key is pushed down. More...
 
EventSignal< WKeyEvent > & keyPressed ()
 Event signal emitted when a "character" was entered. More...
 
EventSignal< WKeyEvent > & keyWentUp ()
 Event signal emitted when a keyboard key is released. More...
 
EventSignalenterPressed ()
 Event signal emitted when enter was pressed. More...
 
EventSignalescapePressed ()
 Event signal emitted when escape was pressed. More...
 
EventSignal< WMouseEvent > & clicked ()
 Event signal emitted when a mouse key was clicked on this widget. More...
 
EventSignal< WMouseEvent > & doubleClicked ()
 Event signal emitted when a mouse key was double clicked on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentDown ()
 Event signal emitted when a mouse key was pushed down on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentUp ()
 Event signal emitted when a mouse key was released on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOut ()
 Event signal emitted when the mouse went out of this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOver ()
 Event signal emitted when the mouse entered this widget. More...
 
EventSignal< WMouseEvent > & mouseMoved ()
 Event signal emitted when the mouse moved over this widget. More...
 
EventSignal< WMouseEvent > & mouseDragged ()
 Event signal emitted when the mouse is dragged over this widget. More...
 
EventSignal< WMouseEvent > & mouseWheel ()
 Event signal emitted when the mouse scroll wheel was used. More...
 
EventSignal< WTouchEvent > & touchStarted ()
 Event signal emitted when a finger is placed on the screen. More...
 
EventSignal< WTouchEvent > & touchEnded ()
 Event signal emitted when a finger is removed from the screen. More...
 
EventSignal< WTouchEvent > & touchMoved ()
 Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...
 
EventSignal< WGestureEvent > & gestureStarted ()
 Event signal emitted when a gesture is started. More...
 
EventSignal< WGestureEvent > & gestureChanged ()
 Event signal emitted when a gesture is changed. More...
 
EventSignal< WGestureEvent > & gestureEnded ()
 Event signal emitted when a gesture is ended. More...
 
void setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
 Configure dragging for drag and drop. More...
 
void unsetDraggable ()
 Disable drag & drop for this widget. More...
 
void setMouseOverDelay (int delay)
 Sets a delay for the mouse over event. More...
 
int mouseOverDelay () const
 Returns the mouse over signal delay. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget (WContainerWidget *parent=0)
 Construct a WebWidget with a given parent. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength())
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &id)
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &javascript)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
void setLoadLaterWhenInvisible (bool)
 Change the way the widget is loaded when invisible. More...
 
std::string htmlTagName () const
 returns the current html tag name More...
 
void setHtmlTagName (const std::string &tag)
 set the custom HTML tag name More...
 
const std::vector< WWidget * > & children () const
 Returns contained widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
EventSignalblurred ()
 Signal emitted when the widget lost focus. More...
 
EventSignalfocussed ()
 Signal emitted when the widget recieved focus. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(finaloverride)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. More...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Protected Member Functions

virtual void create ()
 Creates the user-interface. More...
 
virtual void createLoginView ()
 Creates the login view. More...
 
virtual void createLoggedInView ()
 Creates the view shown when the user is logged in. More...
 
virtual void createPasswordLoginView ()
 Creates a password login view. More...
 
virtual void createOAuthLoginView ()
 Creates a widget to login using OAuth. More...
 
virtual WDialogshowDialog (const WString &title, WWidget *contents)
 Shows a dialog. More...
 
RegistrationModelregistrationModel ()
 Returns the registration model. More...
 
virtual RegistrationModelcreateRegistrationModel ()
 Creates a registration model. More...
 
virtual WWidgetcreateFormWidget (AuthModel::Field field)
 Creates a form widget. More...
 
virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
- Protected Member Functions inherited from Wt::WTemplateFormView
virtual void indicateValidation (WFormModel::Field field, bool validated, WText *info, WWidget *edit, const WValidator::Result &validation)
 Indicates the validation result. More...
 
- Protected Member Functions inherited from Wt::WTemplate
virtual void applyArguments (WWidget *w, const std::vector< WString > &args)
 Applies arguments to a resolved widget. More...
 
void format (std::ostream &result, const std::string &s, TextFormat textFormat=PlainText)
 Utility method to safely format an XHTML string. More...
 
void format (std::ostream &result, const WString &s, TextFormat textFormat=PlainText)
 Utility method to safely format an XHTML string. More...
 
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
void reset ()
 Notifies the template that it has changed and must be rerendered. More...
 
- Protected Member Functions inherited from Wt::WInteractWidget
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 

Additional Inherited Members

- Public Types inherited from Wt::WTemplate
typedef boost::function< bool(WTemplate *t, const std::vector< WString > &args, std::ostream &result)> Function
 A function type. More...
 
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Static Public Member Functions inherited from Wt::WWebWidget
static WString escapeText (const WString &text, bool newlinesToo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static std::string & escapeText (std::string &text, bool newlinestoo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static bool removeScript (WString &text)
 Remove tags/attributes from text that are not passive (deprecated). More...
 
static std::string jsStringLiteral (const std::string &v, char delimiter= '\'')
 Turn a UTF8 encoded string into a JavaScript string literal. More...
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

An authentication widget.

The authentication widget is a widget that provides a login or logout function (depending on whether the user is currently logged in). You can use it for either or both purposes.

Login or logout events are signalled to a Login object on which this widget acts.

The widget also processes environmental information related to authentication:

The processEnvironment() method initiates this process, and should typically be called only at application startup time.

The authentication widget is implemented as a View for an AuthModel, which can be set using setModel(). The login logic (at this moment only for password-based authentication) is handled by this model.

It is very likely that the off-the shelf authentication widget does not satisfy entirely to your taste or functional requirements. The widget uses three methods to allow customization:

Constructor & Destructor Documentation

Wt::Auth::AuthWidget::AuthWidget ( const AuthService baseAuth,
AbstractUserDatabase users,
Login login,
WContainerWidget parent = 0 
)

Constructor.

Creates a new authentication widget. This creates an AuthModel using the given authentication service baseAuth and user database users.

The result of authentication changes is propagated to the rest of the application using a login object.

Authentication services need to be configured in the model().

Wt::Auth::AuthWidget::AuthWidget ( Login login,
WContainerWidget parent = 0 
)

Constructor.

Creates a new authentication widget.

The result of authentication changes is propagated to the rest of the application using a login object.

You need to call setModel() to configure a model for this view.

Member Function Documentation

void Wt::Auth::AuthWidget::create ( )
protectedvirtual

Creates the user-interface.

This method is called just before an initial rendering, and creates the initial view.

The default implementation calls createLoginView() or createLoggedInView() depending on whether a user is currently logged in.

WWidget * Wt::Auth::AuthWidget::createFormWidget ( AuthModel::Field  field)
protectedvirtual

Creates a form widget.

This method is called by updateViewField() when it needs to create a form widget for a field, and none was specified using setFormWidget().

Reimplemented from Wt::WTemplateFormView.

void Wt::Auth::AuthWidget::createLoggedInView ( )
protectedvirtual

Creates the view shown when the user is logged in.

The default implementation renders the "Wt.Auth.template.logged-in" template.

void Wt::Auth::AuthWidget::createLoginView ( )
protectedvirtual

Creates the login view.

This creates a view that allows the user to login, and is shown when no user is current logged in.

The default implementation renders the "Wt.Auth.template.login" template, and binds fields using createPasswordLoginView() and createOAuthLoginView().

WWidget * Wt::Auth::AuthWidget::createLostPasswordView ( )
virtual

Creates a lost password view.

When email verification has been enabled, the user may indicate that he has lost his password – then proof of controlling the same email address that had associated with his account is sufficient to allow him to enter a new password.

This creates the widget used to let the user enter his email address. The default implementation creates a new LostPasswordWidget.

See also
handleLostPassword()
void Wt::Auth::AuthWidget::createOAuthLoginView ( )
protectedvirtual

Creates a widget to login using OAuth.

The default implementation adds an icon for each OAuth service provider available.

There's alot to say about making a usable login mechanism for OAuth (and federated login services in general), see https://sites.google.com/site/oauthgoog/UXFedLogin.

See also
createLoginView()
void Wt::Auth::AuthWidget::createPasswordLoginView ( )
protectedvirtual

Creates a password login view.

This is used by the default implementation of createLoginView() to prompt for the information needed for logging in using a username and password. The default implementation implements a view guided by the model().

See also
createLoginView()
WDialog * Wt::Auth::AuthWidget::createPasswordPromptDialog ( Login login)
virtual

Creates a password prompt dialog.

This creates a dialog password. The user is taken from the login object, which also signals an eventual success using its Login::changed() signal.

The default implementation instantiates a PasswordPromptDialog.

RegistrationModel * Wt::Auth::AuthWidget::createRegistrationModel ( )
protectedvirtual

Creates a registration model.

This method creates a registration model. The default implementation creates a RegistrationModel() but you may want to reimplement this function to return a specialized registration model (complementing a specialized registration view).

See also
registerNewUser()
WWidget * Wt::Auth::AuthWidget::createRegistrationView ( const Identity id)
virtual

Creates a registration view.

This creates a registration view, optionally using information already obtained from a third party identification service (such as an OAuth provider).

The default implementation creates a new RegistrationWidget with a model created using createRegistrationModel().

See also
registerNewUser()
WWidget * Wt::Auth::AuthWidget::createUpdatePasswordView ( const User user,
bool  promptPassword 
)
virtual

Creates a view to update a user's password.

If promptPassword is true, the user has to enter his current password in addition to a new password.

This creates the widget used to let the user chose a new password. The default implementation instantiates an UpdatePasswordWidget.

See also
letUpdatePassword()
void Wt::Auth::AuthWidget::displayError ( const WString error)
virtual

Displays the error message.

This method display an dialog showing the error

void Wt::Auth::AuthWidget::displayInfo ( const WString message)
virtual

Displays the info message.

This method display an dialog showing the info

void Wt::Auth::AuthWidget::handleLostPassword ( )
virtual

Lets the user "recover" a lost password.

This creates a view to let the user enter his email address, used to send an email containing instructions to enter a new password.

The default implementation creates a new view using createLostPasswordView() and shows it in a dialog using showDialog().

std::string Wt::Auth::AuthWidget::internalBasePath ( ) const

Returns the internal path.

See also
setInternalBasePath()
void Wt::Auth::AuthWidget::letUpdatePassword ( const User user,
bool  promptPassword 
)
virtual

Lets the user update his password.

This creates a view to let the user enter his new password.

The default implementation creates a new view using createUpdatePasswordView() and shows it in a dialog using showDialog().

Login& Wt::Auth::AuthWidget::login ( )

Returns the login object.

This login object is used to keep track of the user currently authenticated.

AuthModel* Wt::Auth::AuthWidget::model ( ) const

Returns the model.

The model is used only for the login function.

See also
setModel()
void Wt::Auth::AuthWidget::processEnvironment ( )
virtual

Processes the (initial) environment.

This method process environmental information that may be relevant to authentication:

  • email tokens, which are indicated through an internal path. The widget uses dialogs (by default) to interact with the user to act on the token.
  • authentication tokens, which are stored in browser cookies, to implement remember-me functionality. When logging in using an authentication token, the login is considered "weak" (since a user may have inadvertently forgotten to logout from a public computer). You should let the user authenticate using another, primary method before doing sensitive operations. The createPasswordPromptDialog() method may be useful for this.
See also
letUpdatePassword()
void Wt::Auth::AuthWidget::registerNewUser ( )

Starts a new registration process.

This calls registerNewUser(0).

void Wt::Auth::AuthWidget::registerNewUser ( const Identity oauth)
virtual

Starts a new registration process.

This starts a new registration process, and may be called in response to a user action, an internal path change, or an OAuthService login procedure which identified a new user. In the latter case, the OAuth-provided information is passed as parameter oauth.

The default implementation creates a view using createRegistrationView(), and shows it in a dialog using showDialog().

RegistrationModel * Wt::Auth::AuthWidget::registrationModel ( )
protected

Returns the registration model.

Calls createRegistrationModel() or resets a previously created one.

See also
registerNewUser()
void Wt::Auth::AuthWidget::render ( WFlags< RenderFlag flags)
protectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WWebWidget.

void Wt::Auth::AuthWidget::setInternalBasePath ( const std::string &  path)

Sets an internal path for authentication services.

Only the registration function is made available through an internal path (so that one can redirect a user to the registration page). Other internal paths involved in authentication are configured in the service classes:

void Wt::Auth::AuthWidget::setModel ( AuthModel model)

Sets a model.

This sets a model to be used for authentication.

void Wt::Auth::AuthWidget::setRegistrationEnabled ( bool  enabled)

Configures registration capabilities.

Although the AuthWidget itself does not implement a registration view, it may offer a button/link to do so, and calls registerNewUser() when a user wishes to register.

Even if registration is not enabled, the result of an OAuthService login process may be that a new user is identified. Then the createRegistrationView() is also used to present this new user with a registration view, passing the information obtained through OAuth.

WDialog * Wt::Auth::AuthWidget::showDialog ( const WString title,
WWidget contents 
)
protectedvirtual

Shows a dialog.

This shows a dialog. The default method creates a standard WDialog, with the given title and contents as central widget.

When the central widget is deleted, it deletes the dialog.


Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11