Version: 2.9.3
Public Member Functions
wxDatePickerCtrl Class Reference

#include <wx/datectrl.h>

Inheritance diagram for wxDatePickerCtrl:

Detailed Description

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.

Styles

This class supports the following styles:

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxDateEvent& event)

Event macros for events emitted by this class:

Library:  wxAdvanced
Category:  Picker Controls

Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
See also:
wxCalendarCtrl, wxDateEvent

Public Member Functions

 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")
 Create the control window.
virtual bool GetRange (wxDateTime *dt1, wxDateTime *dt2) const =0
 If the control had been previously limited to a range of dates using SetRange(), returns the lower and upper bounds of this range.
virtual wxDateTime GetValue () const =0
 Returns the currently entered date.
virtual void SetRange (const wxDateTime &dt1, const wxDateTime &dt2)=0
 Sets the valid range for the date selection.
virtual void SetValue (const wxDateTime &dt)=0
 Changes the current value of the control.

List of all members.


Constructor & Destructor Documentation

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.


Member Function Documentation

bool wxDatePickerCtrl::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" 
)

Create the control window.

This method should only be used for objects created using default constructor.

Parameters:
parentParent window, must not be non-NULL.
idThe identifier for the control.
dtThe initial value of the control, if an invalid date (such as the default value) is used, the control is set to today.
posInitial position.
sizeInitial 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.
styleThe window style, see the description of the styles in the class documentation.
validatorValidator which can be used for additional date checks.
nameControl name.
Returns:
true if the control was successfully created or false if creation failed.
virtual bool wxDatePickerCtrl::GetRange ( wxDateTime dt1,
wxDateTime dt2 
) const [pure virtual]

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.

Notice that when using a native MSW implementation of this control the lower range is always set, even if SetRange() hadn't been called explicitly, as the native control only supports dates later than year 1601.

Parameters:
dt1Pointer 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.
dt2Same as above but for the upper limit.
Returns:
false if no range limits are currently set, true if at least one bound is set.
virtual wxDateTime wxDatePickerCtrl::GetValue ( ) const [pure virtual]

Returns the currently entered date.

For a control with wxDP_ALLOWNONE style the returned value may be invalid if no date is entered, otherwise it is always valid.

virtual void wxDatePickerCtrl::SetRange ( const wxDateTime dt1,
const wxDateTime dt2 
) [pure virtual]

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.
virtual void wxDatePickerCtrl::SetValue ( const wxDateTime dt) [pure virtual]

Changes the current value of the control.

The date should be valid unless the control was created with wxDP_ALLOWNONE style and included in the currently selected range, if any.

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

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines