wx.DatePickerCtrl

Inheritance diagram for wx.DatePickerCtrl:

Description

This control allows the user to select a date. Unlike wx.CalendarCtrl, which is a relatively big control, wx.DatePickerCtrl 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 wx.USE_DATEPICKCTRL is set to 1.

See also

wx.CalendarCtrl, wx.DateEvent

Derived From

• wx.DatePickerCtrlBase
• wx.Control
• wx.Window
• wx.EvtHandler
• wx.Object

Known Subclasses

wx.GenericDatePickerCtrl

Window Styles

Window Style	Description
wx.DP_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.
wx.DP_DROPDOWN	Creates a control with a month calendar drop-down part from which the user can select a date.
wx.DP_DEFAULT	Creates a control with the style that is best supported for the current platform (currently wx.DP_SPIN under Windows and wx.DP_DROPDOWN elsewhere).
wx.DP_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.
wx.DP_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

Event Name	Description
wx.EVT_DATE_CHANGED(id, func)	This event fires when the user changes the current selection in the control.

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

• __init__
• GetLowerLimit
• GetUpperLimit
• GetValue
• SetRange
• SetValue

Properties Summary

• LowerLimit
• UpperLimit
• Value

Class API

Methods

__init__(parent, id=-1, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DP_DEFAULT|wx.DP_SHOWCENTURY, validator=wx.DefaultValidator, name=wx.DatePickerCtrlNameStr)

Create a new wx.DatePickerCtrl.

Parameters:

• parent (wx.Window)
• id (int)
• dt (wx.DateTime)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• validator (wx.Validator)
• name (string)

Returns:

wx.DatePickerCtrl

---

GetLowerLimit()

Gets the lower limit of the valid range for the date selection, if any.

If there is no range or there is no lower limit, then the wx.DateTime value returned will be invalid.

Returns:

wx.DateTime

---

GetUpperLimit()

Gets the upper limit of the valid range for the date selection, if any.

If there is no range or there is no lower limit, then the wx.DateTime value returned will be invalid.

Returns:

wx.DateTime

---

GetValue()

Returns the currently selected date.

If there is no selection or the selection is outside of the current range, an invalid wx.DateTime value is returned.

Returns:

wx.DateTime

---

SetRange(dt1, 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.

Parameters:

• dt1 (wx.DateTime)
• dt2 (wx.DateTime)

---

SetValue(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

Parameters:

• dt (wx.DateTime)

---

Properties

LowerLimit

See GetLowerLimit

UpperLimit

See GetUpperLimit

Value

See GetValue and SetValue