Wt  4.10.4
Public Member Functions | Protected Member Functions | List of all members
Wt::WDatePicker Class Reference

A date picker. More...

#include <Wt/WDatePicker.h>

Inheritance diagram for Wt::WDatePicker:
[legend]

Public Member Functions

 WDatePicker ()
 Create a new date picker. More...
 
 WDatePicker (WLineEdit *forEdit)
 Create a new date picker for a line edit. More...
 
 WDatePicker (std::unique_ptr< WInteractWidget > displayWidget, WLineEdit *forEdit)
 Create a new date picker for existing line edit and with custom display widget. More...
 
 ~WDatePicker ()
 Destructor.
 
virtual std::shared_ptr< WDateValidatordateValidator () const
 Returns the validator. More...
 
void setFormat (const WString &format)
 Sets the format used for parsing or writing the date in the line edit. More...
 
const WStringformat () const
 Returns the format. More...
 
WCalendarcalendar () const
 The calendar widget. More...
 
WLineEditlineEdit () const
 The line edit. More...
 
WInteractWidgetdisplayWidget () const
 The display widget. More...
 
WPopupWidgetpopupWidget () const
 The popup widget. More...
 
WDate date () const
 The current date. More...
 
void setDate (const WDate &date)
 Sets the current date. More...
 
void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
virtual void setDisabled (bool disabled) override
 Sets whether the widget is disabled. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
 Hide/unhide the widget.
 
void setBottom (const WDate &bottom)
 Sets the bottom of the valid date range.
 
WDate bottom () const
 Returns the bottom date of the valid range.
 
void setTop (const WDate &top)
 Sets the top of the valid date range.
 
WDate top () const
 Returns the top date of the valid range.
 
Signalchanged ()
 Signal emitted when the value has changed. More...
 
void setPopupVisible (bool visible)
 Shows or hides the popup.
 
SignalpopupClosed ()
 A signal which indicates that the popup has been closed. More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget ()
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (std::unique_ptr< WWidget > implementation)
 Creates a WCompositeWidget with given implementation. More...
 
virtual std::vector< WWidget * > children () const override
 Returns child widgets. More...
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget) override
 Removes a child widget.
 
virtual void setObjectName (const std::string &name) override
 Sets an object name. More...
 
virtual std::string objectName () const override
 Returns the object name. More...
 
virtual const std::string id () const override
 Returns the (unique) identifier for this object. 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< SideclearSides () 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 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 bool isDisabled () const override
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const override
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup) override
 Lets the widget overlay over other sibling widgets. 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 WCssDecorationStyledecorationStyle () 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::Auto) 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 WString toolTip () const override
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
 Enable deferred tooltip. More...
 
virtual void refresh () override
 Refresh the widget. More...
 
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 void load () override
 Loads content just before the widget is used. More...
 
virtual bool loaded () const override
 Returns whether this widget has been loaded. 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 void setFocus (bool focus) override
 Sets focus. More...
 
virtual bool setFirstFocus () override
 Set focus on the widget's first descendant. 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...
 
virtual void setId (const std::string &id) override
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name) override
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name) override
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable) override
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js) override
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled) override
 Propagates that a widget was enabled or disabled through children. 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 std::unique_ptr< WWidgetremoveWidget (WWidget *widget)
 Removes a child widget.
 
template<typename Widget >
std::unique_ptr< Widget > removeWidget (Widget *widget)
 Removes a child widget. 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...
 
WWidgetparent () const
 Returns the parent widget.
 
template<typename Widget >
std::unique_ptr< Widget > removeWidget (Widget *widget)
 Removes a child widget. More...
 
std::unique_ptr< WWidgetremoveFromParent ()
 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< WObjectremoveChild (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...
 
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 void render (WFlags< RenderFlag > flags) override
 Renders the widget. More...
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax () override
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (std::unique_ptr< WWidget > widget)
 Set the implementation widget. More...
 
template<typename Widget >
Widget * setImplementation (std::unique_ptr< Widget > widget)
 Sets the implementation widget, returning a raw pointer. More...
 
template<typename W , typename... Args>
W * setNewImplementation (Args &&... args)
 Creates the implementation widget and sets it, returning a raw pointer. More...
 
WWidgetimplementation ()
 Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const override
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const override
 Returns the widget's built-in border width. 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...
 
void scheduleRender (WFlags< RepaintFlag > flags=None)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method) override
 On-demand stateless slot implementation. More...
 

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::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 

Detailed Description

A date picker.

A date picker shows a line edit and an icon which when clicked popups a WCalendar for editing the date. Any date entered in the line edit is reflected in the calendar, and vice-versa.

Each of these widgets may be accessed individually (lineEdit(), calendar(), and displayWidget()) and there is a constructor that allows you to specify an existing line edit and display widget.

The date format used by default is "dd/MM/yyyy" and can be changed using setFormat(). At any time, the date set may be read using date(), or can be changed using setDate().

Usage example:

Wt::WDatePicker *picker = addWidget(std::make_unique<Wt::WDatePicker>());
picker->setFormat("dd-MM-yyyy");
picker->setDate(Wt::WDate(1976, 6, 14));
A date picker.
Definition: WDatePicker.h:54
void setFormat(const WString &format)
Sets the format used for parsing or writing the date in the line edit.
Definition: WDatePicker.C:109
void setDate(const WDate &date)
Sets the current date.
Definition: WDatePicker.C:145
A value class that represents a date on the Gregorian calendar.
Definition: WDate.h:62

i18n

Internationalization of WDatePicker is mostly handled through the internationalization mechanism of WDate.

Deprecated:
The date picker is deprecated in favor of WDateEdit

Constructor & Destructor Documentation

◆ WDatePicker() [1/3]

Wt::WDatePicker::WDatePicker ( )

Create a new date picker.

This constructor creates a line edit with an icon that leads to a popup calendar. A WDateValidator is configured for the line edit.

◆ WDatePicker() [2/3]

Wt::WDatePicker::WDatePicker ( WLineEdit forEdit)

Create a new date picker for a line edit.

This constructor creates an icon that leads to a popup calendar.

The forEdit argument is the lineEdit that works in conjunction with the date picker. This widget does not become part of the date picker, and may be located anywhere else.

◆ WDatePicker() [3/3]

Wt::WDatePicker::WDatePicker ( std::unique_ptr< WInteractWidget displayWidget,
WLineEdit forEdit 
)

Create a new date picker for existing line edit and with custom display widget.

The displayWidget is a button or image which much be clicked to open the date picker.

The forEdit argument is the lineEdit that works in conjunction with the date picker.

Member Function Documentation

◆ calendar()

WCalendar* Wt::WDatePicker::calendar ( ) const

The calendar widget.

Returns the calendar widget.

◆ changed()

Signal& Wt::WDatePicker::changed ( )

Signal emitted when the value has changed.

This signal is emitted when a new date has been entered (either through the line edit, or through the calendar popup).

◆ date()

WDate Wt::WDatePicker::date ( ) const

The current date.

Reads the current date from the lineEdit().

Returns an invalid date (for which WDate::isValid() returns false) if the date could not be parsed using the current format().

See also
setDate(), WDate::fromString(), WLineEdit::text()

◆ dateValidator()

std::shared_ptr< WDateValidator > Wt::WDatePicker::dateValidator ( ) const
virtual

Returns the validator.

Most of the configuration of the date edit is stored in the validator.

◆ displayWidget()

WInteractWidget* Wt::WDatePicker::displayWidget ( ) const

The display widget.

Returns the icon which activates the popup.

◆ format()

const WString& Wt::WDatePicker::format ( ) const

Returns the format.

See also
setFormat()

◆ lineEdit()

WLineEdit* Wt::WDatePicker::lineEdit ( ) const

The line edit.

Returns the line edit which works in conjunction with this date picker.

◆ popupClosed()

Signal& Wt::WDatePicker::popupClosed ( )

A signal which indicates that the popup has been closed.

The signal is only fired when the popup has been closed by the user.

◆ popupWidget()

WPopupWidget* Wt::WDatePicker::popupWidget ( ) const

The popup widget.

Returns the popup widget that contains the calendar.

◆ render()

void Wt::WDatePicker::render ( WFlags< RenderFlag flags)
overrideprotectedvirtual

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

◆ setDate()

void Wt::WDatePicker::setDate ( const WDate date)

Sets the current date.

Does nothing if the current date is Null.

See also
date()

◆ setDisabled()

void Wt::WDatePicker::setDisabled ( bool  disabled)
overridevirtual

Sets whether the widget is disabled.

Enables or disables the widget (including all its descendant widgets). setDisabled(false) will enable this widget and all descendant widgets that are not disabled. A widget is only enabled if it and all its ancestors in the widget tree are disabled.

Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

Note
enable() and disable() are considered to be stateless slots by default. If you override setDisabled() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().
See also
disable(), enable()

Reimplemented from Wt::WCompositeWidget.

◆ setEnabled()

void Wt::WDatePicker::setEnabled ( bool  enabled)

Sets whether the widget is enabled.

This is the oppositie of setDisabled().

◆ setFormat()

void Wt::WDatePicker::setFormat ( const WString format)

Sets the format used for parsing or writing the date in the line edit.

Sets the format used for representing the date in the line edit. If the line edit has a WDateValidator configured for it, then also there the format is updated.

The default format is 'dd/MM/yyyy'.

See also
format(), WDate::toString()