A template-based View class for form models. More...

#include <Wt/WTemplateFormView.h>

Inheritance diagram for Wt::WTemplateFormView:

Public Member Functions
	WTemplateFormView ()
	Constructor. More...

	WTemplateFormView (const WString &text)
	Constructor. More...

void	setFormWidget (WFormModel::Field field, std::unique_ptr< WWidget > widget)
	Sets the form widget for a given field. More...

void	setFormWidget (WFormModel::Field field, std::unique_ptr< WWidget > widget, const std::function< void()> &updateViewValue, const std::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 ()
	Creates a template widget.

	WTemplate (const WString &text)
	Creates a template widget with given template. More...

virtual WString	templateText () const
	Returns the template. More...

void	setTemplateText (const WString &text, TextFormat textFormat=TextFormat::XHTML)
	Sets the template text. More...

void	setWidgetIdMode (TemplateWidgetIdMode mode)
	Sets how the varName should be reflected on bound widgets. More...

TemplateWidgetIdMode	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=TextFormat::XHTML)
	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, std::unique_ptr< WWidget > widget)
	Binds a widget to a variable. More...

template<typename Widget >
Widget *	bindWidget (const std::string &varName, std::unique_ptr< Widget > widget)
	Binds a widget to a variable, returning a raw pointer. More...

template<typename Widget , typename ... Args>
Widget *	bindNew (const std::string &varName, Args &&...args)
	Creates a new widget with the given arguments, and binds it, returning a raw pointer. More...

std::unique_ptr< WWidget >	removeWidget (const std::string &varName)
	Unbinds a widget by variable name. More...

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override
	Unbinds a widget by widget pointer. 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 WWidget *	resolveWidget (const std::string &varName)
	Resolves a widget for a variable name. More...

virtual const WString &	resolveStringValue (const std::string &varName)
	Resolves a string that was bound to 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 >
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 () override
	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...

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. More...

Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget ()
	Create an InteractWidget.

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...

EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed. More...

EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed. More...

EventSignal< WMouseEvent > &	clicked ()
	Event signal emitted when the primary mouse button was clicked on this widget. More...

EventSignal< WMouseEvent > &	doubleClicked ()
	Event signal emitted when the primary mouse button was double clicked on this widget. More...

EventSignal< WMouseEvent > &	mouseWentDown ()
	Event signal emitted when a mouse button was pushed down on this widget. More...

EventSignal< WMouseEvent > &	mouseWentUp ()
	Event signal emitted when a mouse button 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=nullptr, bool isDragWidgetOnly=false, WObject sourceWidget=nullptr)
	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) override
	Lets the widget overlay over other sibling widgets. More...

virtual void	load () override
	Loads content just before the widget is used. More...

virtual bool	isEnabled () const override
	Returns whether the widget is enabled. More...

Public Member Functions inherited from Wt::WWebWidget
	WWebWidget ()
	Construct a WebWidget.

virtual std::vector< WWidget * >	children () const override
	Returns child widgets. More...

Signal &	childrenChanged ()
	Signal emitted when children have been added or removed. More...

virtual void	setPositionScheme (PositionScheme scheme) override
	Sets the CSS position scheme. More...

virtual PositionScheme	positionScheme () const override
	Returns the CSS position scheme. More...

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
	Sets CSS offsets for a non-statically positioned widget. More...

virtual WLength	offset (Side s) const override
	Returns a CSS offset. More...

virtual void	resize (const WLength &width, const WLength &height) override
	Resizes the widget. More...

virtual WLength	width () const override
	Returns the width. More...

virtual WLength	height () const override
	Returns the height. More...

virtual void	setMinimumSize (const WLength &width, const WLength &height) override
	Sets a minimum size. More...

virtual WLength	minimumWidth () const override
	Returns the minimum width. More...

virtual WLength	minimumHeight () const override
	Returns the minimum height. More...

virtual void	setMaximumSize (const WLength &width, const WLength &height) override
	Sets a maximum size. More...

virtual WLength	maximumWidth () const override
	Returns the maximum width. More...

virtual WLength	maximumHeight () const override
	Returns the maximum height. More...

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. More...

virtual void	setFloatSide (Side s) override
	Specifies a CSS float side. More...

virtual Side	floatSide () const override
	Returns the CSS float side. More...

virtual void	setClearSides (WFlags< Side > sides) override
	Sets the sides that should be cleared of floats. More...

virtual WFlags< Side >	clearSides () const override
	Returns the sides that should remain empty. More...

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
	Sets CSS margins around the widget. More...

virtual WLength	margin (Side side) const override
	Returns a CSS margin set. More...

virtual void	setHiddenKeepsGeometry (bool enabled) override
	Sets whether the widget keeps its geometry when hidden. More...

virtual bool	hiddenKeepsGeometry () const override
	Returns whether the widget keeps its geometry when hidden. More...

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
	Hides or shows the widget. More...

virtual bool	isHidden () const override
	Returns whether the widget is set hidden. More...

virtual bool	isVisible () const override
	Returns whether the widget is visible. More...

virtual void	setDisabled (bool disabled) override
	Sets whether the widget is disabled. More...

virtual bool	isDisabled () const override
	Returns whether the widget is set disabled. More...

virtual bool	isPopup () const override
	Returns whether the widget is overlayed. More...

virtual void	setInline (bool isInline) override
	Sets whether the widget is displayed inline or as a block. More...

virtual bool	isInline () const override
	Returns whether the widget is displayed inline or as block. More...

virtual void	setDecorationStyle (const WCssDecorationStyle &style) override
	Sets a CSS decoration style. More...

virtual WCssDecorationStyle &	decorationStyle () override
	Returns the decoration style of this widget. More...

virtual void	setStyleClass (const WString &styleClass) override
	Sets (one or more) CSS style classes. More...

virtual WString	styleClass () const override
	Returns the CSS style class. More...

virtual void	addStyleClass (const WString &styleClass, bool force=false) override
	Adds a CSS style class. More...

virtual void	removeStyleClass (const WString &styleClass, bool force=false) override
	Removes a CSS style class. More...

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. More...

virtual AlignmentFlag	verticalAlignment () const override
	Returns the vertical alignment. More...

virtual WLength	verticalAlignmentLength () const override
	Returns the fixed vertical alignment that was set. More...

virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
	Sets a tooltip. More...

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
	Enable deferred tooltip. More...

virtual WString	toolTip () const override
	Returns the tooltip.

virtual void	setAttributeValue (const std::string &name, const WString &value) override
	Sets an attribute value. More...

virtual WString	attributeValue (const std::string &name) const override
	Returns an attribute value. More...

virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override
	Sets a JavaScript member. More...

virtual std::string	javaScriptMember (const std::string &name) const override
	Returns the value of a JavaScript member. More...

virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override
	Calls a JavaScript member. More...

virtual bool	loaded () const override
	Returns whether this widget has been loaded. More...

virtual void	setId (const std::string &id) override
	Sets the CSS Id. More...

virtual WWidget *	find (const std::string &name) override
	Finds a descendent widget by name. More...

virtual WWidget *	findById (const std::string &id) override
	Finds a descendent widget by id.

virtual void	setSelectable (bool selectable) override
	Sets as selectable. More...

virtual void	doJavaScript (const std::string &javascript) override
	Executes the given JavaScript statements when the widget is rendered or updated. More...

virtual const std::string	id () const override
	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...

virtual void	setCanReceiveFocus (bool enabled) override
	Sets whether the widget can receive focus. More...

virtual bool	canReceiveFocus () const override
	Returns whether the widget can receive focus. More...

virtual bool	setFirstFocus () override
	Set focus on the widget's first descendant. More...

virtual void	setFocus (bool focus) override
	Sets focus. More...

virtual bool	hasFocus () const override
	Returns whether the widget currently has the focus.

virtual void	setTabIndex (int index) override
	Sets the tab index. More...

virtual int	tabIndex () const override
	Returns the tab index. More...

EventSignal &	blurred ()
	Signal emitted when the widget lost focus. More...

EventSignal &	focussed ()
	Signal emitted when the widget recieved focus. More...

virtual bool	scrollVisibilityEnabled () const final override
	Returns whether scroll visibility detection is enabled for this widget. More...

virtual void	setScrollVisibilityEnabled (bool enabled) final override
	Sets whether scroll visibility detection is enabled for this widget. More...

virtual int	scrollVisibilityMargin () const final override
	Returns the margin around the viewport within which the widget is considered visible. More...

virtual void	setScrollVisibilityMargin (int margin) final override
	Sets the margin around the viewport within which the widget is considered visible. More...

virtual Signal< bool > &	scrollVisibilityChanged () final override
	Signal triggered when the scroll visibility of this widget changes. More...

virtual bool	isScrollVisible () const final override
	Returns whether this widget is currently considered scroll visible. More...

virtual void	setThemeStyleEnabled (bool enabled) final override
	Sets whether theme styling for a widget is enabled or disabled. More...

virtual bool	isThemeStyleEnabled () const final override
	Returns whether this widget is currently styled by the chosen theme. More...

virtual void	setObjectName (const std::string &name) override
	Sets an object name. More...

void	setFocus ()
	Sets focus. More...

virtual void	setFocus (bool focus)=0
	Sets focus. More...

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...

WWidget *	parent () const
	Returns the parent widget.

template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...

std::unique_ptr< WWidget >	removeFromParent ()
	Removes the widget from its parent. 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=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
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. More...

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. 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...

Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
	Default constructor.

virtual	~observable ()
	Destructor. More...

template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...)) noexcept
	Protects a method call against object destruction. More...

template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
	Protects a const method call against object destruction. More...

template<typename Function >
auto	bindSafe (const Function &function) noexcept
	Protects a function against object destruction. More...

Protected Member Functions
virtual std::unique_ptr< WWidget >	createFormWidget (WFormModel::Field field)
	Creates a form widget. More...

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=TextFormat::Plain)
	Utility method to safely format an XHTML string. More...

void	format (std::ostream &result, const WString &s, TextFormat textFormat=TextFormat::Plain)
	Utility method to safely format an XHTML string. More...

virtual void	enableAjax () override
	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) override
	Propagates that a widget was enabled or disabled through children. More...

Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot *	getStateless (Method method) override
	On-demand stateless slot implementation. More...

virtual void	render (WFlags< RenderFlag > flags) override
	Renders the widget. 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 ()
	Creates a widget.

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=None)
	Schedules rerendering of the widget. More...

Additional Inherited Members
Public Types inherited from Wt::WTemplate
typedef TemplateWidgetIdMode	WidgetIdMode
	Typedef for enum Wt::TemplateWidgetIdMode.

typedef std::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 std::string	jsStringLiteral (const std::string &v, char delimiter='\'')
	Turn a CharEncoding::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...

Detailed Description

A template-based View class for form models.

This implements a View to be used in conjunction with WFormModel models to implement forms.

For each model field, it uses a number of conventional template placeholder variables to represent the label, editor, and validation messages in the template. For a field name 'field', we have:

'field': the actual (form) widget for viewing/editing the value
'field-label': the label text
'field-info': a text that contains help or validation messages
'if:field': condition for the visibility of the field

A typical template uses blocks of the following-format (in the example below illustrated for a field 'UserName'):

${<if:UserName>}
  <label for="${id:UserName}">${UserName-label}</label>
  ${UserName} ${UserName-info}
${</if:UserName>}

The View may render fields of more than one model, and does not necessarily need to render all information of each model. The latter can be achieved by either calling updateViewField() and updateModelField() for individual model fields, or by hiding fields in the model that are not to be shown in the view.

The updateView() method updates the view based on a model (e.g. to propagate changed values or validation feed-back), while the updateModel() method updates the model with values entered in the View.

The view is passive: it will not perform any updates by itself of either the View or Model. You will typically bind a method to the StandardButton::Ok button and do:

void MyView::okClicked()
{
  updateModel(model_);
  if (model_->validate()) {
    ...
  } else {
    updateView(model_);
  }
}

Constructor & Destructor Documentation

◆ WTemplateFormView() [1/2]

Wt::WTemplateFormView::WTemplateFormView ( )

Constructor.

For convenience, this initializes the template with:

addFunction("id", &Functions::id);
addFunction("tr", &Functions::tr);
addFunction("block", &Functions::block);

◆ WTemplateFormView() [2/2]

Wt::WTemplateFormView::WTemplateFormView ( const WString & text )

Constructor.

For convenience, this initializes the template with:

addFunction("id", &Functions::id);
addFunction("tr", &Functions::tr);
addFunction("block", &Functions::block);

Member Function Documentation

◆ createFormWidget()

std::unique_ptr< WWidget > Wt::WTemplateFormView::createFormWidget ( WFormModel::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 in Wt::Form::Dbo::FormView< C >, Wt::Auth::UpdatePasswordWidget, Wt::Auth::RegistrationWidget, and Wt::Auth::AuthWidget.

◆ indicateValidation()

void Wt::WTemplateFormView::indicateValidation	(	WFormModel::Field	field,
		bool	validated,
		WText *	info,
		WWidget *	edit,
		const WValidator::Result &	validation
	)

protectedvirtual

Indicates the validation result.

The default implementation calls WTheme::applyValidationStyle()

Note: We changed the signature to take an edit WWidget instead of WFormWidget in Wt 3.3.1!

◆ setFormWidget() [1/2]

void Wt::WTemplateFormView::setFormWidget	(	WFormModel::Field	field,
		std::unique_ptr< WWidget >	widget
	)

Sets the form widget for a given field.

When the widget is a form widget, then the View class will use WFormWidget::setValueText() to update it with model values, and WFormWidget::valueText() to update the model with view data.

You can override this default behaviour by either using the overloaded setFormWidget() that allows to specify these functions, or reimplement updateViewValue() or updateModelValue().

◆ setFormWidget() [2/2]

void Wt::WTemplateFormView::setFormWidget	(	WFormModel::Field	field,
		std::unique_ptr< WWidget >	widget,
		const std::function< void()> &	updateViewValue,
		const std::function< void()> &	updateModelValue
	)

Sets the form widget for a given field.

This overloaded functions allows functions to be provided to update the view and model for this field.

◆ updateModel()

void Wt::WTemplateFormView::updateModel ( WFormModel * model )

virtual

Updates the Model.

This creates or updates all field values in the model.

See also: updateModelField(), WFormModel::fields()

◆ updateModelField()

void Wt::WTemplateFormView::updateModelField	(	WFormModel *	model,
		WFormModel::Field	field
	)

virtual

Updates a field in the Model.

This calls updateModelValue() to update the model value.

◆ updateModelValue() [1/2]

void Wt::WTemplateFormView::updateModelValue	(	WFormModel *	model,
		WFormModel::Field	field,
		WFormWidget *	edit
	)

virtual

Updates a value in the Model.

The default implementation calls updateModelValue(WFormModel *, WFormModel::Field, WWidget *), and if that returns false, it then calls WFormModel::setValue() with WFormWidget::valueText().

Reimplemented in Wt::Form::Dbo::FormView< C >.

◆ updateModelValue() [2/2]

virtual bool Wt::WTemplateFormView::updateModelValue	(	WFormModel *	model,
		WFormModel::Field	field,
		WWidget *	edit
	)

virtual

Updates a value in the Model.

The default implementation considers only a specialized update function that may have been configured in setFormWidget() and returns false if no such function was configured.

Reimplemented in Wt::Form::Dbo::FormView< C >.

◆ updateView()

void Wt::WTemplateFormView::updateView ( WFormModel * model )

virtual

Updates the View.

This creates or updates all fields in the view.

See also: updateViewField(), WFormModel::fields()

◆ updateViewField()

void Wt::WTemplateFormView::updateViewField	(	WFormModel *	model,
		WFormModel::Field	field
	)

virtual

Creates or updates a field in the View.

This will update or create and bind widgets in the template to represent the field. To create the form widget that implements the editing, it calls createFormWidget().

The default behaviour interprets WFormModel::isVisible(), WFormModel::isReadOnly(), WFormModel::label() and WFormModel::validator() to update the View, and calls updateViewValue() to update the view value. If no form widget has been set for the given field using setFormWidget(), then it calls createFormWidget() to try to create one.

It's usually more convenient to reimplement updateViewValue() to override specifically how the value from the model should be used to update the form widget.

◆ updateViewValue() [1/2]

void Wt::WTemplateFormView::updateViewValue	(	WFormModel *	model,
		WFormModel::Field	field,
		WFormWidget *	edit
	)

virtual

Updates the value in the View.

The default implementation calls updateViewValue(WFormModel *, WFormField::Field, WWidget *). If this function returned false, it sets WFormModel::valueText() into WFormWidget::setValueText().

Reimplemented in Wt::Form::Dbo::FormView< C >.

◆ updateViewValue() [2/2]

virtual bool Wt::WTemplateFormView::updateViewValue	(	WFormModel *	model,
		WFormModel::Field	field,
		WWidget *	edit
	)

virtual

Updates the value in the View.

The default implementation considers only a specialized update function that may have been configured in setFormWidget() and returns false if no such function was configured.

Reimplemented in Wt::Form::Dbo::FormView< C >.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WTemplateFormView() [1/2]

◆ WTemplateFormView() [2/2]

Member Function Documentation

◆ createFormWidget()

◆ indicateValidation()

◆ setFormWidget() [1/2]

◆ setFormWidget() [2/2]

◆ updateModel()

◆ updateModelField()

◆ updateModelValue() [1/2]

◆ updateModelValue() [2/2]

◆ updateView()

◆ updateViewField()

◆ updateViewValue() [1/2]

◆ updateViewValue() [2/2]