.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxDatePickerCtrl 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxDatePickerCtrl \- 
  Small date picker control
 
.SH 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.
  
 
.SH "PARENTS"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/datectrl.h
.SH MEMBERS

  
.SS  wxDatePickerCtrl (wxWindow *parentwxWindowID idconst wxDateTime& dt = wxDefaultDateTimeconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDP_DEFAULTconst wxValidator& validator = wxDefaultValidatorconst wxString& name = ``datectrl")

     


      Initializes the object and calls
      Create
      with all the parameters.
     
    
   
  
.SS bool Create (wxWindow *parentwxWindowID idconst wxDateTime& dt = wxDefaultDateTimeconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDP_DEFAULTconst wxValidator& validator = wxDefaultValidatorconst wxString& name = ``datectrl")

   
  
.SS bool GetRange (wxDateTime *dt1wxDateTime *dt2)

     


      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.
     
    
   
  
.SS wxDateTime GetValue ()

     


      Returns the currently selected. If there is no selection or the selection
      is outside of the current range, an invalid object is returned.
     
    
   
  
.SS void SetRange (const wxDateTime& dt1const 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.
     
    
   
  
.SS 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.
     
    
 
.SH "WINDOW STYLES"

.SS wxDP_SPIN

   wxDP_SPIN
  
.SS wxDP_DROPDOWN

   wxDP_DROPDOWN
  
.SS wxDP_DEFAULT

   wxDP_DEFAULT
  
.SS wxDP_ALLOWNONE

   wxDP_ALLOWNONE
  
.SS wxDP_SHOWCENTURY

   wxDP_SHOWCENTURY
  
.SH EVENTS

.SS EVT_DATE_CHANGED(id, func)

   This event fires when the user changes the current selection in the control.
  
.SH "SEE ALSO"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxCalendarCtrl
  ,
  
   
  wxDateEvent
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.