*****************
wx.DatePickerCtrl
*****************

Inheritance diagram for `wx.DatePickerCtrl`:

|

.. inheritance-diagram:: wx.DatePickerCtrl

|

Description
===========

This control allows the user to select a date. Unlike  `wx.CalendarCtrl <../calendar/wx.CalendarCtrl.html>`_, 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.

.. seealso:: `wx.CalendarCtrl <../calendar/wx.CalendarCtrl.html>`_, `wx.DateEvent <../Events/wx.DateEvent.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.DatePickerCtrlBase` 
* `wx.Control <wx.Control.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


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
^^^^^^^^^^^^^^^^^^

|

.. figure:: ../images/wxWidgets/wxmsw/datepickerctrl.png 
   :alt: wxMSW
   :figclass: floatleft
   
   **wxMSW**


.. figure:: ../images/wxWidgets/wxmac/datepickerctrl.png 
   :alt: wxMAC
   :figclass: floatright

   **wxMAC**


.. figure:: ../images/wxWidgets/wxgtk/datepickerctrl.png
   :alt: wxGTK
   :figclass: floatcenter

   **wxGTK**


|

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetLowerLimit <#GetLowerLimit>`_
* `GetUpperLimit <#GetUpperLimit>`_
* `GetValue <#GetValue>`_
* `SetRange <#SetRange>`_
* `SetValue <#SetValue>`_


Properties Summary
^^^^^^^^^^^^^^^^^^

* `LowerLimit <#LowerLimit>`_ 
* `UpperLimit <#UpperLimit>`_ 
* `Value <#Value>`_ 


Class API
=========

Methods
^^^^^^^


.. method:: __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 <wx.Window.html>`_)
   * `id` (int)
   * `dt` (`wx.DateTime <wx.DateTime.html>`_)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)
   * `validator` (`wx.Validator <wx.Validator.html>`_)
   * `name` (string)

   |

   **Returns:**

   `wx.DatePickerCtrl <wx.DatePickerCtrl.html>`_
 
------------

.. method:: 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 <wx.DateTime.html>`_ value returned will be invalid.

   |

   **Returns:**

   `wx.DateTime <wx.DateTime.html>`_

------------

.. method:: 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 <wx.DateTime.html>`_ value returned will be invalid.

   |

   **Returns:**

   `wx.DateTime <wx.DateTime.html>`_

------------

.. method:: GetValue()

   Returns the currently selected date.

   If there is no selection or the selection is outside of the current range, an invalid `wx.DateTime <wx.DateTime.html>`_ value is returned.

   |

   **Returns:**

   `wx.DateTime <wx.DateTime.html>`_

------------

.. method:: 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 <wx.DateTime.html>`_)
   * `dt2` (`wx.DateTime <wx.DateTime.html>`_)


------------

.. method:: 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 <wx.DateTime.html>`_)

------------

Properties
^^^^^^^^^^

.. attribute:: LowerLimit

   See `GetLowerLimit <#GetLowerLimit>`_

.. attribute:: UpperLimit

   See `GetUpperLimit <#GetUpperLimit>`_

.. attribute:: Value

   See `GetValue <#GetValue>`_ and `SetValue <#SetValue>`_