/usr/include/Wt/WFormWidget is in libwt-dev 3.3.4+dfsg-6ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WFORM_WIDGET_H_
#define WFORM_WIDGET_H_
#include <Wt/WInteractWidget>
#include <Wt/WValidator>
namespace Wt {
class WLabel;
/*! \class WFormWidget Wt/WFormWidget Wt/WFormWidget
* \brief An abstract widget that corresponds to an HTML form element.
*
* A %WFormWidget may receive focus (see canReceiveFocus()), can be
* disabled, and can have a label that acts as proxy for getting
* focus. It provides signals which reflect changes to its value, or
* changes to its focus.
*
* Form widgets also have built-in support for validation, using
* setValidator(WValidator *). If the validator provide client-side
* validation, then an invalid validation state is reflected using the
* style class <tt>"Wt-invalid"</tt>. All validators provided by %Wt
* implement client-side validation.
*
* On the server-side, use validate() method to validate the content
* using a validator previously set.
*/
class WT_API WFormWidget : public WInteractWidget
{
public:
/*! \brief Creates a %WFormWidget with an optional parent.
*/
WFormWidget(WContainerWidget *parent = 0);
/*! \brief Destructor.
*
* If a label was associated with the widget, its buddy is reset to \c 0.
*/
~WFormWidget();
/*! \brief Returns the label associated with this widget.
*
* Returns the label (if there is one) that acts as a proxy for this
* widget.
*
* \sa WLabel::setBuddy(WFormWidget *)
*/
WLabel *label() const { return label_; }
/*! \brief Sets the hidden state of this widget.
*
* If the widget has a label, it is hidden and shown together with
* this widget.
*/
virtual void setHidden(bool hidden,
const WAnimation& animation = WAnimation());
/*! \brief Returns the current value.
*
* This returns the current value as a string.
*/
virtual WT_USTRING valueText() const = 0;
/*! \brief Sets the value text.
*
* This sets the current value from a string value.
*/
virtual void setValueText(const WT_USTRING& value) = 0;
/*! \brief Sets a validator for this field.
*
* The validator is used to validate the current input.
*
* If the validator has no parent yet, then ownership is transferred
* to the form field, and thus the validator will be deleted
* together with the form field.
*
* The default value is \c 0.
*
* \sa validate()
*/
void setValidator(WValidator *validator);
/*! \brief Returns the validator.
*/
virtual WValidator *validator() const { return validator_; }
/*! \brief Validates the field.
*
* \sa validated()
*/
virtual WValidator::State validate();
/*! \brief Sets whether the widget is enabled.
*
* A widget that is disabled cannot receive focus or user interaction.
*
* This is the opposite of setDisabled().
*/
void setEnabled(bool enabled);
/*! \brief Sets the element read-only.
*
* A read-only form element cannot be edited, but the contents can
* still be selected.
*
* By default, a form element area is not read-only.
*
* \sa setEnabled()
*/
virtual void setReadOnly(bool readOnly);
/*! \brief Returns whether the form element is read-only.
*
* \sa setReadOnly()
*/
bool isReadOnly() const;
/*! \brief Sets the placeholder text (<b>deprecated</b>).
*
* \deprecated use setPlaceholderText() instead
*/
void setEmptyText(const WString& emptyText);
/*! \brief Returns the placeholder text (<b>deprecated</b>).
*
* \deprecated use placeholderText() instead.
*/
const WString& emptyText() const {
return placeholderText();
}
/*! \brief Sets the placeholder text.
*
* This sets the text that is shown when the field is empty.
*/
virtual void setPlaceholderText(const WString& placeholder);
/*! \brief Returns the placeholder text.
*
* \sa setPlaceholderText()
*/
const WString& placeholderText() const {
return emptyText_;
}
/*! \brief %Signal emitted when the value was changed.
*
* For a keyboard input, the signal is only emitted when the focus is lost
*/
EventSignal<>& changed();
/*! \brief %Signal emitted when ??
*/
EventSignal<>& selected();
/*! \brief %Signal emitted when the widget is being validated.
*
* This signal may be useful to react to a changed validation state.
*
* \sa validate()
*/
Signal<WValidator::Result>& validated() { return validated_; }
virtual void refresh();
virtual void setToolTip(const WString& text,
TextFormat textFormat = PlainText);
virtual bool canReceiveFocus() const;
virtual int tabIndex() const;
protected:
WLabel *label_;
WValidator *validator_;
JSlot *validateJs_, *filterInput_, *removeEmptyText_;
WString emptyText_;
// also used in WAbstractToggleButton
static const char *CHANGE_SIGNAL;
void applyEmptyText();
virtual void enableAjax();
private:
static const char *SELECT_SIGNAL;
static const int BIT_ENABLED_CHANGED = 0;
static const int BIT_READONLY = 1;
static const int BIT_READONLY_CHANGED = 2;
static const int BIT_JS_OBJECT = 3;
static const int BIT_VALIDATION_CHANGED = 4;
std::bitset<5> flags_;
Signal<WValidator::Result> validated_;
WString validationToolTip_;
void setLabel(WLabel *label);
void validatorChanged();
void defineJavaScript(bool force = false);
void updateEmptyText();
protected:
virtual void updateDom(DomElement& element, bool all);
virtual void propagateRenderOk(bool deep);
virtual void render(WFlags<RenderFlag> flags);
virtual void propagateSetEnabled(bool enabled);
virtual std::string formName() const;
friend class WLabel;
friend class WValidator;
friend class WebSession;
};
}
#endif // WFORM_WIDGET_H_
|