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.
(only available if wxUSE_DATEPICKCTRL is set to 1)
|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.|
|EVT_DATE_CHANGED(id, func)||This event fires when the user changes the current selection in the control.|
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.
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")
true if the control was successfully created or false if creation failed.
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.
false if no range limits are currently set, true if at least one bound is set.
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.
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.
If the format parameter is invalid, the behaviour is undefined.
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.
If the current value of the control is outside of the newly set range bounds, the behaviour is undefined.
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.