Wt::WPasswordEdit Class Reference

A password edit. More...

#include <Wt/WPasswordEdit.h>

Inheritance diagram for Wt::WPasswordEdit:

Public Member Functions
	WPasswordEdit ()
	Creates a password edit with empty content.
	WPasswordEdit (const WString &content)
	Creates a password edit with given content.
void	setMaxLength (int length) override
	Specifies the maximum length of text that can be entered.
void	setNativeControl (bool nativeControl)
	Changes whether a native HTML5 control is used.
bool	nativeControl () const
	Returns whether a native HTML5 control is used.
void	setMinLength (int length)
	Specifies the minimum length of text that can be entered.
int	minLength () const
	Returns the minimum length of text that can be entered.
void	setRequired (bool required)
	Specifies if the password is required.
bool	isRequired () const
	Return if the password is required.
void	setPattern (const WString &pattern)
	Specifies the pattern that the password must match.
WString	pattern () const
	Return the pattern the password must match.
void	setInvalidTooLongText (const WString &text)
	Sets the message to display when the password is too long.
WString	invalidTooLongText () const
	Returns the message displayed when the password is too long.
void	setInvalidTooShortText (const WString &text)
	Sets the message to display when the password is too small.
WString	invalidTooShortText () const
	Returns the message displayed when the password is too small.
void	setInvalidNoMatchText (const WString &text)
	Sets the message to display when the password does not match the pattern.
WString	invalidNoMatchText () const
	Returns the message displayed when the password does not match the pattern.
void	setInvalidBlankText (const WString &text)
	Sets the message to display when the password is empty and required.
WString	invalidBlankText () const
	Returns the message displayed when the password is empty and required.
void	setValidator (const std::shared_ptr< WValidator > &validator) override
	Sets a validator for this field.
std::shared_ptr< WValidator >	validator () const override
	Returns the validator.
ValidationState	validate () override
	Validates the field.
Public Member Functions inherited from Wt::WLineEdit
	WLineEdit ()
	Creates a line edit with empty content.
	WLineEdit (const WString &content)
	Creates a line edit with given content.
void	setTextSize (int chars)
	Specifies the width of the line edit in number of characters.
int	textSize () const
	Returns the current width of the line edit in number of characters.
virtual void	setText (const WString &text)
	Sets the content of the line edit.
const WString &	text () const
	Returns the current content.
WString	displayText () const
	Returns the displayed text.
int	maxLength () const
	Returns the maximum length of text that can be entered.
void	setEchoMode (EchoMode echoMode)
	Sets the echo mode.
EchoMode	echoMode () const
	Returns the echo mode.
void	setAutoComplete (bool enabled)
	Sets (built-in browser) autocomplete support.
void	setAutoComplete (AutoCompleteMode token)
	Sets (built-in browser) autocomplete support.
bool	autoComplete () const
	Returns if auto-completion support is not off.
AutoCompleteMode	autoCompleteToken () const
	Returns auto-completion support.
void	setInputMode (InputMode mode)
	Sets (built-in browser) input mode support.
InputMode	inputMode () const
	Returns inputMode support.
int	selectionStart () const
	Returns the current selection start.
WString	selectedText () const
	Returns the currently selected text.
bool	hasSelectedText () const
	Returns whether there is selected text.
void	setSelection (int start, int length)
	Selects length characters starting from the start position.
int	cursorPosition () const
	Returns the current cursor position.
virtual WString	valueText () const override
	Returns the current value.
virtual void	setValueText (const WString &value) override
	Sets the current value.
WString	inputMask () const
	Returns the input mask.
void	setInputMask (const WString &mask="", WFlags< InputMaskFlag > flags=None)
	Sets the input mask.
EventSignal &	textInput ()
	Event signal emitted when the text in the input field changed.
Public Member Functions inherited from Wt::WFormWidget
	WFormWidget ()
	Creates a WFormWidget.
	~WFormWidget ()
	Destructor.
WLabel *	label () const
	Returns the label associated with this widget.
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
	Sets the hidden state of this widget.
void	setEnabled (bool enabled)
	Sets whether the widget is enabled.
virtual void	setReadOnly (bool readOnly)
	Sets the element read-only.
bool	isReadOnly () const
	Returns whether the form element is read-only.
virtual void	setPlaceholderText (const WString &placeholder)
	Sets the placeholder text.
const WString &	placeholderText () const
	Returns the placeholder text.
EventSignal &	changed ()
	Signal emitted when the value was changed.
Signal< WValidator::Result > &	validated ()
	Signal emitted when the widget is being validated.
virtual void	refresh () override
	Refresh the widget.
virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
	Sets a tooltip.
virtual bool	canReceiveFocus () const override
	Returns whether the widget can receive focus.
virtual int	tabIndex () const override
	Returns the tab index.
Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget ()
	Create an InteractWidget.
EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down.
EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered.
EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released.
EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed.
EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed.
EventSignal< WMouseEvent > &	clicked ()
	Event signal emitted when the primary mouse button was clicked on this widget.
EventSignal< WMouseEvent > &	doubleClicked ()
	Event signal emitted when the primary mouse button was double clicked on this widget.
EventSignal< WMouseEvent > &	mouseWentDown ()
	Event signal emitted when a mouse button was pushed down on this widget.
EventSignal< WMouseEvent > &	mouseWentUp ()
	Event signal emitted when a mouse button was released on this widget.
EventSignal< WMouseEvent > &	mouseWentOut ()
	Event signal emitted when the mouse went out of this widget.
EventSignal< WMouseEvent > &	mouseWentOver ()
	Event signal emitted when the mouse entered this widget.
EventSignal< WMouseEvent > &	mouseMoved ()
	Event signal emitted when the mouse moved over this widget.
EventSignal< WMouseEvent > &	mouseDragged ()
	Event signal emitted when the mouse is dragged over this widget.
EventSignal< WMouseEvent > &	mouseWheel ()
	Event signal emitted when the mouse scroll wheel was used.
EventSignal< WTouchEvent > &	touchStarted ()
	Event signal emitted when a finger is placed on the screen.
EventSignal< WTouchEvent > &	touchEnded ()
	Event signal emitted when a finger is removed from the screen.
EventSignal< WTouchEvent > &	touchMoved ()
	Event signal emitted when a finger, which is already placed on the screen, is moved across the screen.
EventSignal< WGestureEvent > &	gestureStarted ()
	Event signal emitted when a gesture is started.
EventSignal< WGestureEvent > &	gestureChanged ()
	Event signal emitted when a gesture is changed.
EventSignal< WGestureEvent > &	gestureEnded ()
	Event signal emitted when a gesture is ended.
void	setDraggable (const std::string &mimeType, WWidget *dragWidget=nullptr, bool isDragWidgetOnly=false, WObject *sourceWidget=nullptr)
	Configure dragging for drag and drop.
void	unsetDraggable ()
	Disable drag & drop for this widget.
void	setMouseOverDelay (int delay)
	Sets a delay for the mouse over event.
int	mouseOverDelay () const
	Returns the mouse over signal delay.
virtual void	setPopup (bool popup) override
	Lets the widget overlay over other sibling widgets.
virtual void	load () override
	Loads content just before the widget is used.
virtual bool	isEnabled () const override
	Returns whether the widget is enabled.
Public Member Functions inherited from Wt::WWebWidget
	WWebWidget ()
	Construct a WebWidget.
virtual std::vector< WWidget * >	children () const override
	Returns child widgets.
Signal &	childrenChanged ()
	Signal emitted when children have been added or removed.
virtual void	setPositionScheme (PositionScheme scheme) override
	Sets the CSS position scheme.
virtual PositionScheme	positionScheme () const override
	Returns the CSS position scheme.
virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
	Sets CSS offsets for a non-statically positioned widget.
virtual WLength	offset (Side s) const override
	Returns a CSS offset.
virtual void	resize (const WLength &width, const WLength &height) override
	Resizes the widget.
virtual WLength	width () const override
	Returns the width.
virtual WLength	height () const override
	Returns the height.
virtual void	setMinimumSize (const WLength &width, const WLength &height) override
	Sets a minimum size.
virtual WLength	minimumWidth () const override
	Returns the minimum width.
virtual WLength	minimumHeight () const override
	Returns the minimum height.
virtual void	setMaximumSize (const WLength &width, const WLength &height) override
	Sets a maximum size.
virtual WLength	maximumWidth () const override
	Returns the maximum width.
virtual WLength	maximumHeight () const override
	Returns the maximum height.
virtual void	setLineHeight (const WLength &height) override
	Sets the CSS line height for contained text.
virtual WLength	lineHeight () const override
	Returns the CSS line height for contained text.
virtual void	setFloatSide (Side s) override
	Specifies a CSS float side.
virtual Side	floatSide () const override
	Returns the CSS float side.
virtual void	setClearSides (WFlags< Side > sides) override
	Sets the sides that should be cleared of floats.
virtual WFlags< Side >	clearSides () const override
	Returns the sides that should remain empty.
virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
	Sets CSS margins around the widget.
virtual WLength	margin (Side side) const override
	Returns a CSS margin set.
virtual void	setHiddenKeepsGeometry (bool enabled) override
	Sets whether the widget keeps its geometry when hidden.
virtual bool	hiddenKeepsGeometry () const override
	Returns whether the widget keeps its geometry when hidden.
virtual bool	isHidden () const override
	Returns whether the widget is set hidden.
virtual bool	isVisible () const override
	Returns whether the widget is visible.
virtual void	setDisabled (bool disabled) override
	Sets whether the widget is disabled.
virtual bool	isDisabled () const override
	Returns whether the widget is set disabled.
virtual bool	isPopup () const override
	Returns whether the widget is overlayed.
virtual void	setInline (bool isInline) override
	Sets whether the widget is displayed inline or as a block.
virtual bool	isInline () const override
	Returns whether the widget is displayed inline or as block.
virtual void	setDecorationStyle (const WCssDecorationStyle &style) override
	Sets a CSS decoration style.
virtual WCssDecorationStyle &	decorationStyle () override
	Returns the decoration style of this widget.
virtual void	setStyleClass (const WString &styleClass) override
	Sets (one or more) CSS style classes.
virtual WString	styleClass () const override
	Returns the CSS style class.
virtual void	addStyleClass (const WString &styleClass, bool force=false) override
	Adds a CSS style class.
virtual void	removeStyleClass (const WString &styleClass, bool force=false) override
	Removes a CSS style class.
virtual bool	hasStyleClass (const WString &styleClass) const override
	Returns whether the widget has a style class.
virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) override
	Sets the vertical alignment.
virtual AlignmentFlag	verticalAlignment () const override
	Returns the vertical alignment.
virtual WLength	verticalAlignmentLength () const override
	Returns the fixed vertical alignment that was set.
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
	Enable deferred tooltip.
virtual WString	toolTip () const override
	Returns the tooltip.
void	showToolTipOnHover (bool enable)
	Enable/disable whether tooltip is shown on hover.
void	showToolTip ()
	Force tooltip to show.
void	hideToolTip ()
	Hide the tooltip.
virtual void	setAttributeValue (const std::string &name, const WString &value) override
	Sets an attribute value.
virtual WString	attributeValue (const std::string &name) const override
	Returns an attribute value.
virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override
	Sets a JavaScript member.
virtual std::string	javaScriptMember (const std::string &name) const override
	Returns the value of a JavaScript member.
virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override
	Calls a JavaScript member.
virtual bool	loaded () const override
	Returns whether this widget has been loaded.
virtual void	setId (const std::string &id) override
	Sets the CSS Id.
virtual WWidget *	find (const std::string &name) override
	Finds a descendent widget by name.
virtual WWidget *	findById (const std::string &id) override
	Finds a descendent widget by id.
virtual void	setSelectable (bool selectable) override
	Sets as selectable.
virtual void	doJavaScript (const std::string &javascript) override
	Executes the given JavaScript statements when the widget is rendered or updated.
virtual const std::string	id () const override
	Returns the (unique) identifier for this object.
void	setLoadLaterWhenInvisible (bool)
	Change the way the widget is loaded when invisible.
std::string	htmlTagName () const
	returns the current html tag name
void	setHtmlTagName (const std::string &tag)
	set the custom HTML tag name
virtual void	setCanReceiveFocus (bool enabled) override
	Sets whether the widget can receive focus.
virtual bool	setFirstFocus () override
	Set focus on the widget's first descendant.
virtual void	setFocus (bool focus) override
	Sets focus.
virtual bool	hasFocus () const override
	Returns whether the widget currently has the focus.
virtual void	setTabIndex (int index) override
	Sets the tab index.
EventSignal &	blurred ()
	Signal emitted when the widget lost focus.
EventSignal &	focussed ()
	Signal emitted when the widget recieved focus.
virtual bool	scrollVisibilityEnabled () const final override
	Returns whether scroll visibility detection is enabled for this widget.
virtual void	setScrollVisibilityEnabled (bool enabled) final override
	Sets whether scroll visibility detection is enabled for this widget.
virtual int	scrollVisibilityMargin () const final override
	Returns the margin around the viewport within which the widget is considered visible.
virtual void	setScrollVisibilityMargin (int margin) final override
	Sets the margin around the viewport within which the widget is considered visible.
virtual Signal< bool > &	scrollVisibilityChanged () final override
	Signal triggered when the scroll visibility of this widget changes.
virtual bool	isScrollVisible () const final override
	Returns whether this widget is currently considered scroll visible.
virtual void	setThemeStyleEnabled (bool enabled) final override
	Sets whether theme styling for a widget is enabled or disabled.
virtual bool	isThemeStyleEnabled () const final override
	Returns whether this widget is currently styled by the chosen theme.
virtual void	setObjectName (const std::string &name) override
	Sets an object name.
void	setFocus ()
	Sets focus.
virtual void	setFocus (bool focus)=0
	Sets focus.
Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor.
WWidget *	parent () const
	Returns the parent widget.
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)
	Removes a child widget.
template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget.
std::unique_ptr< WWidget >	removeFromParent ()
	Removes the widget from its parent.
void	setWidth (const WLength &width)
	Sets the width.
void	setHeight (const WLength &height)
	Sets the height.
virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical, WFlags< Orientation > adjustOrientations=AllOrientations)
	Positions a widget next to another widget.
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.
void	setFocus ()
	Sets focus.
virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping.
virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping.
virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation.
bool	isRendered () const
	Returns whether the widget is rendered.
void	hide ()
	Hides the widget.
void	animateHide (const WAnimation &animation)
	Hides the widget using an animation.
void	show ()
	Shows the widget.
void	animateShow (const WAnimation &animation)
	Shows the widget using an animation.
void	enable ()
	Enables the widget.
void	disable ()
	Disable thes widget.
bool	layoutSizeAware () const
	Returns whether the widget is layout size aware.
virtual void	scheduleThemeStyleApply (std::shared_ptr< Wt::WTheme > theme, WWidget *child, int role)
	Schedules a theme style to be applied at the next render.
virtual void	applyThemeStyles ()
	Apply the theme style scheduled.
Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)
	Add a child WObject whose lifetime is determined by this WObject.
template<typename Child >
Child *	addChild (std::unique_ptr< Child > child)
	Add a child WObject, returning a raw pointer.
std::unique_ptr< WObject >	removeChild (WObject *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject.
template<typename Child >
std::unique_ptr< Child >	removeChild (Child *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject.
virtual std::string	objectName () const
	Returns the object name.
void	resetLearnedSlots ()
	Resets learned stateless slot implementations.
template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation.
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation.
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)(), void(T::*undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance.
void	isNotStateless ()
	Marks the current function as not stateless.
template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method.
Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
	Default constructor.
virtual	~observable ()
	Destructor.
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...)) noexcept
	Protects a method call against object destruction.
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
	Protects a const method call against object destruction.
template<typename Function >
auto	bindSafe (const Function &function) noexcept
	Protects a function against object destruction.

Additional Inherited Members
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 std::string	jsStringLiteral (const std::string &v, char delimiter='\'')
	Turn a CharEncoding::UTF8 encoded string into a JavaScript string literal.
Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr()
Static Public Attributes inherited from Wt::WInteractWidget
static const std::string	noDefault = "Wt-no-default"
	Class name used to prevent default action of the events.
Protected Member Functions inherited from Wt::WLineEdit
virtual int	boxPadding (Orientation orientation) const override
	Returns the widget's built-in padding.
virtual int	boxBorder (Orientation orientation) const override
	Returns the widget's built-in border width.
virtual void	render (WFlags< RenderFlag > flags) override
	Renders the widget.
Protected Member Functions inherited from Wt::WFormWidget
virtual void	enableAjax () override
	Progresses to an Ajax-enabled widget.
virtual void	propagateSetEnabled (bool enabled) override
	Propagates that a widget was enabled or disabled through children.
Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot *	getStateless (Method method) override
	On-demand stateless slot implementation.
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.
virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change.
	WWidget ()
	Creates a widget.
virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event.
void	scheduleRender (WFlags< RepaintFlag > flags=None)
	Schedules rerendering of the widget.

Detailed Description

A password edit.

A password edit is a line edit where the character are hidden.

The widget corresponds to the HTML <input type="password"> tag.

Member Function Documentation

invalidBlankText()

WString Wt::WPasswordEdit::invalidBlankText

(

)

const

Returns the message displayed when the password is empty and required.

See also

setInvalidBlankText(const WString&)

invalidNoMatchText()

WString Wt::WPasswordEdit::invalidNoMatchText

(

)

const

Returns the message displayed when the password does not match the pattern.

See also

setInvalidNoMatchText(const WString&)

invalidTooLongText()

WString Wt::WPasswordEdit::invalidTooLongText

(

)

const

Returns the message displayed when the password is too long.

See also

setInvalidTooLongText(const WString&)

invalidTooShortText()

WString Wt::WPasswordEdit::invalidTooShortText

(

)

const

Returns the message displayed when the password is too small.

See also

setInvalidTooShortText(const WString&)

isRequired()

bool Wt::WPasswordEdit::isRequired

(

)

const

Return if the password is required.

See also

setRequired(bool)

minLength()

int Wt::WPasswordEdit::minLength

(

)

const

Returns the minimum length of text that can be entered.

See also

setMinLength(int)

nativeControl()

bool Wt::WPasswordEdit::nativeControl

(

)

const

Returns whether a native HTML5 control is used.

See also

setNativeControl(bool)

pattern()

WString Wt::WPasswordEdit::pattern

(

)

const

Return the pattern the password must match.

See also

setPattern()

setInvalidBlankText()

void Wt::WPasswordEdit::setInvalidBlankText

(

const WString &

text

)

Sets the message to display when the password is empty and required.

The default value is "This field cannot be empty".

setInvalidNoMatchText()

void Wt::WPasswordEdit::setInvalidNoMatchText

(

const WString &

text

)

Sets the message to display when the password does not match the pattern.

The default value is "Invalid input".

setInvalidTooLongText()

void Wt::WPasswordEdit::setInvalidTooLongText

(

const WString &

text

)

Sets the message to display when the password is too long.

The default value is "Password too long".

setInvalidTooShortText()

void Wt::WPasswordEdit::setInvalidTooShortText

(

const WString &

text

)

Sets the message to display when the password is too small.

The default value is "Password too small".

setMaxLength()

void Wt::WPasswordEdit::setMaxLength ( int  length )

overridevirtual

Specifies the maximum length of text that can be entered.

A value <= 0 indicates that there is no limit.

The default value is -1.

Reimplemented from Wt::WLineEdit.

setMinLength()

void Wt::WPasswordEdit::setMinLength

(

int

length

)

Specifies the minimum length of text that can be entered.

The default value is 0.

setNativeControl()

void Wt::WPasswordEdit::setNativeControl

(

bool

nativeControl

)

Changes whether a native HTML5 control is used.

When enabled the browser's native attribute for password input (<input type="password">) will be used instead of a validator.

This option is set to false by default.

See also

nativeControl()

setPattern()

void Wt::WPasswordEdit::setPattern

(

const WString &

pattern

)

Specifies the pattern that the password must match.

The default value is "".

setRequired()

void Wt::WPasswordEdit::setRequired

(

bool

required

)

Specifies if the password is required.

If true, the password cannot be empty.

The default value is true.

setValidator()

void Wt::WPasswordEdit::setValidator ( const std::shared_ptr< WValidator > &  validator )

overridevirtual

Sets a validator for this field.

The validator is used to validate the current input.

The default value is 0.

See also

validate()

Reimplemented from Wt::WFormWidget.

validate()

ValidationState Wt::WPasswordEdit::validate ( )

overridevirtual

Validates the field.

See also

validated()

Reimplemented from Wt::WLineEdit.