wxDatePickerCtrl

This control allows the user to select a date. Unlike wxCalendarCtrl, which is a relatively big control, wxDatePickerCtrl is implemented as a small window showing the currently selected date. The control can be edited using the keyboard, and can also display a popup window for more user-friendly date selection, depending on the styles used and the platform, except PalmOS where date is selected using native dialog.

It is only available if wxUSE_DATEPICKCTRL is set to 1.

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/datectrl.h>

(only available if wxUSE_DATEPICKCTRL is set to 1)

Window styles

wxDP_SPIN	Creates a control without a month calendar drop down but with spin-control-like arrows to change individual date components. This style is not supported by the generic version.
wxDP_DROPDOWN	Creates a control with a month calendar drop-down part from which the user can select a date.
wxDP_DEFAULT	Creates a control with the style that is best supported for the current platform (currently wxDP_SPIN under Windows and wxDP_DROPDOWN elsewhere).
wxDP_ALLOWNONE	With this style, the control allows the user to not enter any valid date at all. Without it - the default - the control always has some valid date.
wxDP_SHOWCENTURY	Forces display of the century in the default date format. Without this style the century could be displayed, or not, depending on the default date representation in the system.

Event handling

EVT_DATE_CHANGED(id, func)

This event fires when the user changes the current selection in the control.

See also

wxCalendarCtrl,
wxDateEvent

Members

wxDatePickerCtrl::wxDatePickerCtrl
wxDatePickerCtrl::Create
wxDatePickerCtrl::GetRange
wxDatePickerCtrl::GetValue
wxDatePickerCtrl::SetFormat
wxDatePickerCtrl::SetRange
wxDatePickerCtrl::SetValue

wxDatePickerCtrl::wxDatePickerCtrl

wxDatePickerCtrl(wxWindow *parent, wxWindowID id, const wxDateTime& dt = wxDefaultDateTime, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDP_DEFAULT | wxDP_SHOWCENTURY, const wxValidator& validator = wxDefaultValidator, const wxString& name = "datectrl")

Initializes the object and calls Create with all the parameters.

wxDatePickerCtrl::Create

bool Create(wxWindow *parent, wxWindowID id, const wxDateTime& dt = wxDefaultDateTime, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDP_DEFAULT | wxDP_SHOWCENTURY, const wxValidator& validator = wxDefaultValidator, const wxString& name = "datectrl")

Parameters

parent

Parent window, must not be non-NULL.

id

The identifier for the control.

dt

The initial value of the control, if an invalid date (such as the default value) is used, the control is set to today.

pos

Initial position.

size

Initial size. If left at default value, the control chooses its own best size by using the height approximately equal to a text control and width large enough to show the date string fully.

style

The window style, should be left at 0 as there are no special styles for this control in this version.

validator

Validator which can be used for additional date checks.

name

Control name.

Return value

true if the control was successfully created or false if creation failed.

wxDatePickerCtrl::GetRange

bool GetRange(wxDateTime *dt1, wxDateTime *dt2) const

If the control had been previously limited to a range of dates using SetRange(), returns the lower and upper bounds of this range. If no range is set (or only one of the bounds is set), dt1 and/or dt2 are set to be invalid.

Parameters

dt1

Pointer to the object which receives the lower range limit or becomes invalid if it is not set. May be NULL if the caller is not interested in lower limit

dt2

Same as above but for the upper limit

Return value

false if no range limits are currently set, true if at least one bound is set.

wxDatePickerCtrl::GetValue

wxDateTime GetValue() const

Returns the currently selected. If there is no selection or the selection is outside of the current range, an invalid object is returned.

wxDatePickerCtrl::SetFormat

void SetFormat(const wxChar* format)

Please note that this function is only available in the generic version of this control. The native version always uses the current system locale.

Sets the display format for the date in the control. See wxDateTime for the meaning of format strings.

Remarks

If the format parameter is invalid, the behaviour is undefined.

wxDatePickerCtrl::SetRange

void SetRange(const wxDateTime& dt1, const wxDateTime& dt2)

Sets the valid range for the date selection. If dt1 is valid, it becomes the earliest date (inclusive) accepted by the control. If dt2 is valid, it becomes the latest possible date.

Remarks

If the current value of the control is outside of the newly set range bounds, the behaviour is undefined.

wxDatePickerCtrl::SetValue

void SetValue(const wxDateTime& dt)

Changes the current value of the control. The date should be valid and included in the currently selected range, if any.

Calling this method does not result in a date change event.