Wt examples  3.7.1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Form Class Reference

A simple Form. More...

#include <Form.h>

Inheritance diagram for Form:
Inheritance graph
[legend]

Public Member Functions

 Form (WContainerWidget *parent=0)
 Instantiate a new form. More...
 
- Public Member Functions inherited from Wt::WTable
 WTable ()
 
virtual ~WTable ()
 
WTableCellelementAt (int row, int column)
 
WTableRowrowAt (int row)
 
WTableColumncolumnAt (int column)
 
void removeCell (WTableCell *item)
 
virtual void removeCell (int row, int column)
 
virtual WTableRowinsertRow (int row, std::unique_ptr< WTableRow > tableRow=nullptr)
 
virtual std::unique_ptr< WTableRowremoveRow (int row)
 
virtual WTableColumninsertColumn (int column, std::unique_ptr< WTableColumn > tableColumn=nullptr)
 
virtual std::unique_ptr< WTableColumnremoveColumn (int column)
 
virtual void clear ()
 
int rowCount () const
 
int columnCount () const
 
void setHeaderCount (int count, Orientation orientation=Orientation::Horizontal)
 
int headerCount (Orientation orientation=Orientation::Horizontal)
 
virtual void moveRow (int from, int to)
 
virtual void moveColumn (int from, int to)
 
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget ()
 
EventSignal< WKeyEvent > & keyWentDown ()
 
EventSignal< WKeyEvent > & keyPressed ()
 
EventSignal< WKeyEvent > & keyWentUp ()
 
EventSignalenterPressed ()
 
EventSignalescapePressed ()
 
EventSignal< WMouseEvent > & clicked ()
 
EventSignal< WMouseEvent > & doubleClicked ()
 
EventSignal< WMouseEvent > & mouseWentDown ()
 
EventSignal< WMouseEvent > & mouseWentUp ()
 
EventSignal< WMouseEvent > & mouseWentOut ()
 
EventSignal< WMouseEvent > & mouseWentOver ()
 
EventSignal< WMouseEvent > & mouseMoved ()
 
EventSignal< WMouseEvent > & mouseDragged ()
 
EventSignal< WMouseEvent > & mouseWheel ()
 
EventSignal< WTouchEvent > & touchStarted ()
 
EventSignal< WTouchEvent > & touchEnded ()
 
EventSignal< WTouchEvent > & touchMoved ()
 
EventSignal< WGestureEvent > & gestureStarted ()
 
EventSignal< WGestureEvent > & gestureChanged ()
 
EventSignal< WGestureEvent > & gestureEnded ()
 
void setDraggable (const std::string &mimeType, WWidget *dragWidget=nullptr, bool isDragWidgetOnly=false, WObject *sourceWidget=nullptr)
 
void unsetDraggable ()
 
void setMouseOverDelay (int delay)
 
int mouseOverDelay () const
 
virtual void setPopup (bool popup) override
 
virtual void load () override
 
virtual bool isEnabled () const override
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget ()
 
virtual std::vector< WWidget *> children () const override
 
SignalchildrenChanged ()
 
virtual void setPositionScheme (PositionScheme scheme) override
 
virtual PositionScheme positionScheme () const override
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
 
virtual WLength offset (Side s) const override
 
virtual void resize (const WLength &width, const WLength &height) override
 
virtual WLength width () const override
 
virtual WLength height () const override
 
virtual void setMinimumSize (const WLength &width, const WLength &height) override
 
virtual WLength minimumWidth () const override
 
virtual WLength minimumHeight () const override
 
virtual void setMaximumSize (const WLength &width, const WLength &height) override
 
virtual WLength maximumWidth () const override
 
virtual WLength maximumHeight () const override
 
virtual void setLineHeight (const WLength &height) override
 
virtual WLength lineHeight () const override
 
virtual void setFloatSide (Side s) override
 
virtual Side floatSide () const override
 
virtual void setClearSides (WFlags< Side > sides) override
 
virtual WFlags< SideclearSides () const override
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
 
virtual WLength margin (Side side) const override
 
virtual void setHiddenKeepsGeometry (bool enabled) override
 
virtual bool hiddenKeepsGeometry () const override
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
 
virtual bool isHidden () const override
 
virtual bool isVisible () const override
 
virtual void setDisabled (bool disabled) override
 
virtual bool isDisabled () const override
 
virtual bool isPopup () const override
 
virtual void setInline (bool isInline) override
 
virtual bool isInline () const override
 
virtual void setDecorationStyle (const WCssDecorationStyle &style) override
 
virtual WCssDecorationStyledecorationStyle () override
 
virtual void setStyleClass (const WString &styleClass) override
 
virtual WString styleClass () const override
 
virtual void addStyleClass (const WString &styleClass, bool force=false) override
 
virtual void removeStyleClass (const WString &styleClass, bool force=false) override
 
virtual bool hasStyleClass (const WString &styleClass) const override
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) override
 
virtual AlignmentFlag verticalAlignment () const override
 
virtual WLength verticalAlignmentLength () const override
 
virtual void setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
 
virtual WString toolTip () const override
 
virtual void refresh () override
 
virtual void setAttributeValue (const std::string &name, const WString &value) override
 
virtual WString attributeValue (const std::string &name) const override
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value) override
 
virtual std::string javaScriptMember (const std::string &name) const override
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args) override
 
virtual bool loaded () const override
 
virtual void setId (const std::string &id) override
 
virtual WWidgetfind (const std::string &name) override
 
virtual WWidgetfindById (const std::string &id) override
 
virtual void setSelectable (bool selectable) override
 
virtual void doJavaScript (const std::string &javascript) override
 
virtual const std::string id () const override
 
void setLoadLaterWhenInvisible (bool)
 
std::string htmlTagName () const
 
void setHtmlTagName (const std::string &tag)
 
virtual void setCanReceiveFocus (bool enabled) override
 
virtual bool canReceiveFocus () const override
 
virtual bool setFirstFocus () override
 
virtual void setFocus (bool focus) override
 
virtual bool hasFocus () const override
 
virtual void setTabIndex (int index) override
 
virtual int tabIndex () const override
 
EventSignalblurred ()
 
EventSignalfocussed ()
 
virtual bool scrollVisibilityEnabled () const final override
 
virtual void setScrollVisibilityEnabled (bool enabled) final override
 
virtual int scrollVisibilityMargin () const final override
 
virtual void setScrollVisibilityMargin (int margin) final override
 
virtual Signal< bool > & scrollVisibilityChanged () final override
 
virtual bool isScrollVisible () const final override
 
virtual void setThemeStyleEnabled (bool enabled) final override
 
virtual bool isThemeStyleEnabled () const final override
 
virtual void setObjectName (const std::string &name) override
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 
WWidgetparent () const
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget)
 
std::unique_ptr< Widget > removeWidget (Widget *widget)
 
std::unique_ptr< WWidgetremoveFromParent ()
 
void setWidth (const WLength &width)
 
void setHeight (const WLength &height)
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 
std::string jsRef () const
 
void setFocus ()
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 
virtual void stopAcceptDrops (const std::string &mimeType)
 
virtual void htmlText (std::ostream &out)
 
bool isRendered () const
 
void hide ()
 
void animateHide (const WAnimation &animation)
 
void show ()
 
void animateShow (const WAnimation &animation)
 
void enable ()
 
void disable ()
 
bool layoutSizeAware () const
 
- Public Member Functions inherited from Wt::WObject
void addChild (std::unique_ptr< WObject > child)
 
Child * addChild (std::unique_ptr< Child > child)
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 
std::unique_ptr< Child > removeChild (Child *child)
 
virtual std::string objectName () const
 
void resetLearnedSlots ()
 
void resetLearnedSlot (void(T::*method)())
 
WStatelessSlot * implementStateless (void(T::*method)())
 
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 
void isNotStateless ()
 
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 
virtual ~observable ()
 
auto bindSafe (void(C::*method)(Args...)) noexcept
 
auto bindSafe (void(C::*method)(Args...) const) const noexcept
 
auto bindSafe (const Function &function) noexcept
 

Private Member Functions

void countryChanged ()
 The user selected a new country: adjust the cities combo box. More...
 
void submit ()
 Submit the form. More...
 
void createUI ()
 
void addValidationStatus (int row, WFormWidget *field)
 Add a validation feedback for a field. More...
 
bool validate ()
 Validate the form, and return whether succesfull. More...
 
bool checkValid (WFormWidget *edit, const WString &text)
 Validate a single form field. More...
 

Private Attributes

WContainerWidgetfeedbackMessages_
 
WLineEditnameEdit_
 
WLineEditfirstNameEdit_
 
WComboBoxcountryEdit_
 
WComboBoxcityEdit_
 
WDateEditbirthDateEdit_
 
WLineEditchildCountEdit_
 
WLineEditweightEdit_
 
WTextArearemarksEdit_
 

Additional Inherited Members

- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 
- Static Public Member Functions inherited from Wt::WWebWidget
static std::string jsStringLiteral (const std::string &v, char delimiter='\'')
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 
- Protected Member Functions inherited from Wt::WTable
virtual std::unique_ptr< WTableCellcreateCell (int row, int column)
 
virtual std::unique_ptr< WTableRowcreateRow (int row)
 
virtual std::unique_ptr< WTableColumncreateColumn (int column)
 
- Protected Member Functions inherited from Wt::WInteractWidget
virtual void propagateSetEnabled (bool enabled) override
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual void enableAjax () override
 
virtual WStatelessSlot * getStateless (Method method) override
 
virtual void render (WFlags< RenderFlag > flags) override
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 
virtual void layoutSizeChanged (int width, int height)
 
 WWidget ()
 
virtual void dropEvent (WDropEvent dropEvent)
 
virtual int boxPadding (Orientation orientation) const
 
virtual int boxBorder (Orientation orientation) const
 
void scheduleRender (WFlags< RepaintFlag > flags=None)
 

Detailed Description

A simple Form.

Shows how a simple form can made, with an emphasis on how to handle validation.

Definition at line 35 of file Form.h.

Constructor & Destructor Documentation

◆ Form()

Form::Form ( WContainerWidget parent = 0)

Instantiate a new form.

Definition at line 17 of file Form.C.

18  : WTable(parent)
19 {
20  createUI();
21 }
void createUI()
Definition: Form.C:23

Member Function Documentation

◆ addValidationStatus()

void Form::addValidationStatus ( int  row,
WFormWidget field 
)
private

Add a validation feedback for a field.

◆ checkValid()

bool Form::checkValid ( WFormWidget edit,
const WString text 
)
private

Validate a single form field.

Checks the given field, and appends the given text to the error messages on problems.

Definition at line 158 of file Form.C.

159 {
160  if (edit->validate() != WValidator::Valid) {
161  feedbackMessages_->addWidget(new WText(text));
163  edit->label()->decorationStyle().setForegroundColor(Wt::red);
164  edit->setStyleClass("Wt-invalid");
165 
166  return false;
167  } else {
169  edit->setStyleClass("");
170 
171  return true;
172  }
173 }
virtual void setStyleClass(const WString &styleClass) override
virtual WCssDecorationStyle & decorationStyle() override
WContainerWidget * feedbackMessages_
Definition: Form.h:53
void setForegroundColor(WColor color)
WLabel * label() const
virtual void addWidget(std::unique_ptr< WWidget > widget)
virtual ValidationState validate()

◆ countryChanged()

void Form::countryChanged ( )
private

The user selected a new country: adjust the cities combo box.

Definition at line 124 of file Form.C.

125 {
126  cityEdit_->clear();
127  cityEdit_->addItem("");
129 
130  switch (countryEdit_->currentIndex()) {
131  case 0:
132  break;
133  case 1:
134  cityEdit_->addItem("Antwerp");
135  cityEdit_->addItem("Brussels");
136  cityEdit_->addItem("Oekene");
137  break;
138  case 2:
139  cityEdit_->addItem("Amsterdam");
140  cityEdit_->addItem("Den Haag");
141  cityEdit_->addItem("Rotterdam");
142  break;
143  case 3:
144  cityEdit_->addItem("London");
145  cityEdit_->addItem("Bristol");
146  cityEdit_->addItem("Oxford");
147  cityEdit_->addItem("Stonehenge");
148  break;
149  case 4:
150  cityEdit_->addItem("Boston");
151  cityEdit_->addItem("Chicago");
152  cityEdit_->addItem("Los Angeles");
153  cityEdit_->addItem("New York");
154  break;
155  }
156 }
void addItem(const WString &text)
void setCurrentIndex(int index)
WComboBox * countryEdit_
Definition: Form.h:58
WComboBox * cityEdit_
Definition: Form.h:59
int currentIndex() const

◆ createUI()

void Form::createUI ( )
private

Definition at line 23 of file Form.C.

24 {
25  WLabel *label;
26  int row = 0;
27 
28  // Title
29  elementAt(row, 0)->setColumnSpan(3);
30  elementAt(row, 0)->setContentAlignment(AlignTop | AlignCenter);
31  elementAt(row, 0)->setPadding(10);
32  WText *title = new WText(tr("example.form"),
33  elementAt(row, 0));
34  title->decorationStyle().font().setSize(WFont::XLarge);
35 
36  // error messages
37  ++row;
38  elementAt(row, 0)->setColumnSpan(3);
39  feedbackMessages_ = elementAt(row, 0);
41 
43  errorStyle.setForegroundColor(Wt::red);
44  errorStyle.font().setSize(WFont::Smaller);
45  errorStyle.font().setWeight(WFont::Bold);
46  errorStyle.font().setStyle(WFont::Italic);
47 
48  // Name
49  ++row;
50  nameEdit_ = new WLineEdit(elementAt(row, 2));
51  label = new WLabel(tr("example.name"), elementAt(row, 0));
52  label->setBuddy(nameEdit_);
53  nameEdit_->setValidator(new WValidator(true));
55 
56  // First name
57  ++row;
58  firstNameEdit_ = new WLineEdit(elementAt(row, 2));
59  label = new WLabel(tr("example.firstname"), elementAt(row,0));
60  label->setBuddy(firstNameEdit_);
61 
62  // Country
63  ++row;
64  countryEdit_ = new WComboBox(elementAt(row, 2));
65  countryEdit_->addItem("");
66  countryEdit_->addItem("Belgium");
67  countryEdit_->addItem("Netherlands");
68  countryEdit_->addItem("United Kingdom");
69  countryEdit_->addItem("United States");
70  label = new WLabel(tr("example.country"), elementAt(row, 0));
71  label->setBuddy(countryEdit_);
74 
75  // City
76  ++row;
77  cityEdit_ = new WComboBox(elementAt(row, 2));
78  cityEdit_->addItem(tr("example.choosecountry"));
79  label = new WLabel(tr("example.city"), elementAt(row, 0));
80  label->setBuddy(cityEdit_);
81 
82  // Birth date
83  ++row;
84 
85  birthDateEdit_ = new WDateEdit(elementAt(row, 2));
86  birthDateEdit_->setBottom(WDate(1900, 1, 1));
87  birthDateEdit_->setTop(WDate::currentDate());
88  label = new WLabel(tr("example.birthdate"), elementAt(row, 0));
89  label->setBuddy(birthDateEdit_);
90  birthDateEdit_->setFormat("dd/MM/yyyy");
91  birthDateEdit_->validator()->setMandatory(true);
92 
93  // Child count
94  ++row;
95  childCountEdit_ = new WLineEdit("0", elementAt(row, 2));
96  label = new WLabel(tr("example.childcount"),
97  elementAt(row, 0));
98  label->setBuddy(childCountEdit_);
100  childCountEdit_->validator()->setMandatory(true);
101 
102  ++row;
103  remarksEdit_ = new WTextArea(elementAt(row, 2));
105  remarksEdit_->setRows(5);
106  label = new WLabel(tr("example.remarks"),
107  elementAt(row, 0));
108  label->setBuddy(remarksEdit_);
109 
110  // Submit
111  ++row;
112  WPushButton *submit = new WPushButton(tr("submit"),
113  elementAt(row, 0));
114  submit->clicked().connect(this, &Form::submit);
115  submit->setMargin(15, Top);
116  elementAt(row, 0)->setColumnSpan(3);
117  elementAt(row, 0)->setContentAlignment(AlignTop | AlignCenter);
118 
119  // Set column widths for label and validation icon
120  elementAt(2, 0)->resize(WLength(30, WLength::FontEx), WLength::Auto);
121  elementAt(2, 1)->resize(20, WLength::Auto);
122 }
void submit()
Submit the form.
Definition: Form.C:192
virtual WCssDecorationStyle & decorationStyle() override
virtual std::shared_ptr< WValidator > validator() const
EventSignal< WMouseEvent > & clicked()
void countryChanged()
The user selected a new country: adjust the cities combo box.
Definition: Form.C:124
void setStyle(FontStyle style)
static WString tr(const char *key)
void addItem(const WString &text)
void setPadding(const WLength &padding, WFlags< Side > sides=AllSides)
void setFormat(const WString &format)
void setSize(FontSize size)
void setContentAlignment(WFlags< AlignmentFlag > contentAlignment)
WLineEdit * firstNameEdit_
Definition: Form.h:56
void setWeight(FontWeight weight, int value=400)
void setBuddy(WFormWidget *buddy)
virtual void setMargin(const WLength &margin, WFlags< Side > sides=AllSides) override
WTableCell * elementAt(int row, int column)
void setTop(const WDate &top)
void setValidator(const std::shared_ptr< WValidator > &validator)
void setColumns(int cols)
WComboBox * countryEdit_
Definition: Form.h:58
WContainerWidget * feedbackMessages_
Definition: Form.h:53
void setColumnSpan(int colSpan)
WLineEdit * childCountEdit_
Definition: Form.h:62
void setForegroundColor(WColor color)
virtual void resize(const WLength &width, const WLength &height) override
WComboBox * cityEdit_
Definition: Form.h:59
EventSignal & enterPressed()
EventSignal & changed()
WTextArea * remarksEdit_
Definition: Form.h:65
Wt::Signals::connection connect(F function)
WDateEdit * birthDateEdit_
Definition: Form.h:61
void setRows(int rows)
void setBottom(const WDate &bottom)
WLineEdit * nameEdit_
Definition: Form.h:55

◆ submit()

void Form::submit ( )
private

Submit the form.

Definition at line 192 of file Form.C.

193 {
194  if (validate()) {
195  // do something useful with the data...
196  std::wstring name
197  = firstNameEdit_->text() + L" " + nameEdit_->text();
198 
199  std::wstring remarks
200  = remarksEdit_->text();
201 
202  clear();
203 
204  new WText(WString::fromUTF8("<p>Thank you, {1}, "
205  "for all this precious data.</p>").arg(name),
206  elementAt(0, 0));
207 
208  if (!remarks.empty())
209  new WText("<p>You had some remarks. Splendid !</p>", elementAt(0, 0));
210 
211  wApp->quit();
212  }
213 }
bool validate()
Validate the form, and return whether succesfull.
Definition: Form.C:175
const WString & text() const
WLineEdit * firstNameEdit_
Definition: Form.h:56
WTableCell * elementAt(int row, int column)
const WString & text() const
WTextArea * remarksEdit_
Definition: Form.h:65
WLineEdit * nameEdit_
Definition: Form.h:55
virtual void clear()

◆ validate()

bool Form::validate ( )
private

Validate the form, and return whether succesfull.

Definition at line 175 of file Form.C.

176 {
178  bool valid = true;
179 
180  if (!checkValid(nameEdit_, tr("error.name")))
181  valid = false;
182  if (!checkValid(countryEdit_, tr("error.country")))
183  valid = false;
184  if (!checkValid(birthDateEdit_, tr("error.birthdate")))
185  valid = false;
186  if (!checkValid(childCountEdit_, tr("error.childcount")))
187  valid = false;
188 
189  return valid;
190 }
static WString tr(const char *key)
virtual void clear()
WComboBox * countryEdit_
Definition: Form.h:58
WContainerWidget * feedbackMessages_
Definition: Form.h:53
WLineEdit * childCountEdit_
Definition: Form.h:62
bool checkValid(WFormWidget *edit, const WString &text)
Validate a single form field.
Definition: Form.C:158
WDateEdit * birthDateEdit_
Definition: Form.h:61
WLineEdit * nameEdit_
Definition: Form.h:55

Member Data Documentation

◆ birthDateEdit_

WDateEdit* Form::birthDateEdit_
private

Definition at line 61 of file Form.h.

◆ childCountEdit_

WLineEdit* Form::childCountEdit_
private

Definition at line 62 of file Form.h.

◆ cityEdit_

WComboBox* Form::cityEdit_
private

Definition at line 59 of file Form.h.

◆ countryEdit_

WComboBox* Form::countryEdit_
private

Definition at line 58 of file Form.h.

◆ feedbackMessages_

WContainerWidget* Form::feedbackMessages_
private

Definition at line 53 of file Form.h.

◆ firstNameEdit_

WLineEdit* Form::firstNameEdit_
private

Definition at line 56 of file Form.h.

◆ nameEdit_

WLineEdit* Form::nameEdit_
private

Definition at line 55 of file Form.h.

◆ remarksEdit_

WTextArea* Form::remarksEdit_
private

Definition at line 65 of file Form.h.

◆ weightEdit_

WLineEdit* Form::weightEdit_
private

Definition at line 63 of file Form.h.


The documentation for this class was generated from the following files:

Generated on Tue Dec 15 2020 for the C++ Web Toolkit (Wt) by doxygen 1.8.13