Wt  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Protected Member Functions | List of all members
Wt::Auth::RegistrationWidget Class Reference

A registration widget. More...

#include <Wt/Auth/RegistrationWidget>

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

Public Member Functions

 RegistrationWidget (AuthWidget *authWidget=0)
 Constructor. More...
 
void setModel (RegistrationModel *model)
 Sets the registration model.
 
RegistrationModelmodel () const
 Returns the registration model. More...
 
void update ()
 Updates the user-interface. 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...
 
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...
 
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...
 
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 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...
 
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...
 
- 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 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 void setObjectName (const std::string &name)
 Sets an object name. 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...
 
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 bool validate ()
 Validates the current information. More...
 
virtual void doRegister ()
 Performs the registration. More...
 
virtual void close ()
 Closes the registration widget. More...
 
virtual void registerUserDetails (User &user)
 Registers more user information. More...
 
virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
virtual WFormWidgetcreateFormWidget (RegistrationModel::Field field)
 Creates a form 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...
 
- 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...
 
- 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 Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A registration widget.

This implements a widget which allows a new user to register. The widget renders the "Wt.Auth.template.registration" template. and uses a RegistrationModel for the actual registration logic.

Typically, you may want to specialize this widget to ask for other information.

Constructor & Destructor Documentation

Wt::Auth::RegistrationWidget::RegistrationWidget ( AuthWidget authWidget = 0)

Constructor.

Creates a new authentication.

Member Function Documentation

void Wt::Auth::RegistrationWidget::close ( )
protectedvirtual

Closes the registration widget.

The default implementation simply deletes the widget.

WFormWidget * Wt::Auth::RegistrationWidget::createFormWidget ( RegistrationModel::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::RegistrationWidget::doRegister ( )
protectedvirtual

Performs the registration.

The default implementation checks if the information is valid with validate(), and then calls RegistrationModel::doRegister(). If registration was successful, it calls registerUserDetails() and subsequently logs the user in.

RegistrationModel* Wt::Auth::RegistrationWidget::model ( ) const

Returns the registration model.

This returns the model that is used by the widget to do the actual registration.

void Wt::Auth::RegistrationWidget::registerUserDetails ( User user)
protectedvirtual

Registers more user information.

This method is called when a new user has been successfully registered.

You may want to reimplement this method if you've added other information to the registration form which needs to be annotated to the user.

void Wt::Auth::RegistrationWidget::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::RegistrationWidget::update ( )

Updates the user-interface.

This updates the user-interface to reflect the current state of the model.

bool Wt::Auth::RegistrationWidget::validate ( )
protectedvirtual

Validates the current information.

The default implementation simply calls RegistrationModel::validate() on the model.

You may want to reimplement this method if you've added other information to the registration form that need validation.


Generated on Mon Oct 20 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4