Navigation

Phoenix Logo

phoenix_title wx.adv.GenericDatePickerCtrl

This control allows the user to select a date.

Unlike wx.adv.CalendarCtrl, which is a relatively big control, wx.adv.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.

It is only available if USE_DATEPICKCTRL is set to 1.

styles Window Styles

This class supports the following styles:

  • wx.adv.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.adv.DP_DROPDOWN: Creates a control with a month calendar drop-down part from which the user can select a date. This style is not supported in OSX/Cocoa native version.
  • wx.adv.DP_DEFAULT: Creates a control with the style that is best supported for the current platform (currently wx.adv.DP_SPIN under Windows and OSX/Cocoa and wx.adv.DP_DROPDOWN elsewhere).
  • wx.adv.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. This style is not supported in OSX/Cocoa native version.
  • wx.adv.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. This style is not supported in OSX/Cocoa native version currently.
As can be seen from the remarks above, most of the control style are only supported in the native MSW implementation. In portable code it’s recommended to use
DP_DEFAULT style only, possibly combined with DP_SHOWCENTURY (this is also the style used by default if none is specified).

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.adv.DateEvent parameter.

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

See also

wx.adv.CalendarCtrl, wx.adv.DateEvent


class_hierarchy Class Hierarchy

Inheritance diagram for class GenericDatePickerCtrl:


method_summary Methods Summary

__init__ Default constructor.
Create Create the control window.
GetRange If the control had been previously limited to a range of dates using SetRange , returns the lower and upper bounds of this range.
GetValue Returns the currently entered date.
SetRange Sets the valid range for the date selection.
SetValue Changes the current value of the control.

property_summary Properties Summary

Value See GetValue and SetValue

api Class API


class wx.adv.GenericDatePickerCtrl(Control)

DatePickerCtrlGeneric() DatePickerCtrlGeneric(parent, id=wx.ID_ANY, dt=wx.DefaultDateTime, pos=wx.DefaultPosition, size=wx.DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=wx.DefaultValidator, name=”datectrl”)

This control allows the user to select a date.


Methods


__init__(self, *args, **kw)

overload Overloaded Implementations:


__init__ (self)

Default constructor.


__init__ (self, parent, id=ID_ANY, dt=DefaultDateTime, pos=DefaultPosition, size=DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=DefaultValidator, name=”datectrl”)

Initializes the object and calls Create with all the parameters.

Parameters:



Create(self, parent, id=ID_ANY, dt=DefaultDateTime, pos=DefaultPosition, size=DefaultSize, style=DP_DEFAULT|DP_SHOWCENTURY, validator=DefaultValidator, name="datectrl")

Create the control window.

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

Parameters:
  • parent (wx.Window) – Parent window, must not be not None.
  • id (wx.WindowID) – The identifier for the control.
  • dt (wx.DateTime) – The initial value of the control, if an invalid date (such as the default value) is used, the control is set to today.
  • pos (wx.Point) – Initial position.
  • size (wx.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 (long) – The window style, see the description of the styles in the class documentation.
  • validator (wx.Validator) – Validator which can be used for additional date checks.
  • name (string) – Control name.
Return type:

bool
Returns:

True if the control was successfully created or False if creation failed.

GetRange(self)

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.

Return type:tuple
Returns:( bool, dt1, dt2 )

GetValue(self)

Returns the currently entered date.

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

Return type:DateTime

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

Parameters:

Note

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


SetValue(self, dt)

Changes the current value of the control.

The date should be valid unless the control was created with DP_ALLOWNONE style 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


Value

See GetValue and SetValue