interface/datectrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        datectrl.h
   3 // Purpose:     interface of wxDatePickerCtrl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDatePickerCtrl
  11     @wxheader{datectrl.h}
  12
  13     This control allows the user to select a date. Unlike
  14     wxCalendarCtrl, which is a relatively big control,
  15     wxDatePickerCtrl is implemented as a small window showing the currently
  16     selected date.
  17     The control can be edited using the keyboard, and can also display a popup
  18     window for more user-friendly date selection, depending on the styles used and
  19     the platform, except PalmOS where date is selected using native dialog.
  20
  21     It is only available if @c wxUSE_DATEPICKCTRL is set to 1.
  22
  23     @beginStyleTable
  24     @style{wxDP_SPIN}:
  25            Creates a control without a month calendar drop down but with
  26            spin-control-like arrows to change individual date components. This
  27            style is not supported by the generic version.
  28     @style{wxDP_DROPDOWN}:
  29            Creates a control with a month calendar drop-down part from which
  30            the user can select a date.
  31     @style{wxDP_DEFAULT}:
  32            Creates a control with the style that is best supported for the
  33            current platform (currently wxDP_SPIN under Windows and
  34            wxDP_DROPDOWN elsewhere).
  35     @style{wxDP_ALLOWNONE}:
  36            With this style, the control allows the user to not enter any valid
  37            date at all. Without it - the default - the control always has some
  38            valid date.
  39     @style{wxDP_SHOWCENTURY}:
  40            Forces display of the century in the default date format. Without
  41            this style the century could be displayed, or not, depending on the
  42            default date representation in the system.
  43     @endStyleTable
  44
  45     @beginEventTable
  46     @event{EVT_DATE_CHANGED(id, func)}:
  47            This event fires when the user changes the current selection in the
  48            control.
  49     @endEventTable
  50
  51     @library{wxadv}
  52     @category{miscpickers}
  53     @appearance{datepickerctrl.png}
  54
  55     @see wxCalendarCtrl, wxDateEvent
  56 */
  57 class wxDatePickerCtrl : public wxControl
  58 {
  59 public:
  60     /**
  61         Initializes the object and calls Create() with
  62         all the parameters.
  63     */
  64     wxDatePickerCtrl(wxWindow* parent, wxWindowID id,
  65                      const wxDateTime& dt = wxDefaultDateTime,
  66                      const wxPoint& pos = wxDefaultPosition,
  67                      const wxSize& size = wxDefaultSize,
  68                      long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
  69                      const wxValidator& validator = wxDefaultValidator,
  70                      const wxString& name = "datectrl");
  71
  72     /**
  73         @param parent
  74             Parent window, must not be non-@NULL.
  75         @param id
  76             The identifier for the control.
  77         @param dt
  78             The initial value of the control, if an invalid date (such as the
  79             default value) is used, the control is set to today.
  80         @param pos
  81             Initial position.
  82         @param size
  83             Initial size. If left at default value, the control chooses its
  84             own best size by using the height approximately equal to a text control and
  85             width large enough to show the date string fully.
  86         @param style
  87             The window style, should be left at 0 as there are no
  88             special styles for this control in this version.
  89         @param validator
  90             Validator which can be used for additional date checks.
  91         @param name
  92             Control name.
  93
  94         @returns @true if the control was successfully created or @false if
  95                  creation failed.
  96     */
  97     bool Create(wxWindow* parent, wxWindowID id,
  98                 const wxDateTime& dt = wxDefaultDateTime,
  99                 const wxPoint& pos = wxDefaultPosition,
 100                 const wxSize& size = wxDefaultSize,
 101                 long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
 102                 const wxValidator& validator = wxDefaultValidator,
 103                 const wxString& name = "datectrl");
 104
 105     /**
 106         If the control had been previously limited to a range of dates using
 107         SetRange(), returns the lower and upper
 108         bounds of this range. If no range is set (or only one of the bounds is set),
 109          @a dt1 and/or @a dt2 are set to be invalid.
 110
 111         @param dt1
 112             Pointer to the object which receives the lower range limit or
 113             becomes invalid if it is not set. May be @NULL if the caller is not
 114             interested in lower limit
 115         @param dt2
 116             Same as above but for the upper limit
 117
 118         @returns @false if no range limits are currently set, @true if at least one
 119                  bound is set.
 120     */
 121     bool GetRange(wxDateTime* dt1, wxDateTime dt2) const;
 122
 123     /**
 124         Returns the currently selected. If there is no selection or the selection is
 125         outside of the current range, an invalid object is returned.
 126     */
 127     wxDateTime GetValue() const;
 128
 129     /**
 130         Please note that this function is only available in the generic version of this
 131         control. The native version always uses the current system locale.
 132         Sets the display format for the date in the control. See wxDateTime for the
 133         meaning of format strings.
 134
 135         @remarks If the format parameter is invalid, the behaviour is undefined.
 136     */
 137     void SetFormat(const wxChar* format);
 138
 139     /**
 140         Sets the valid range for the date selection. If @a dt1 is valid, it becomes
 141         the earliest date (inclusive) accepted by the control. If @a dt2 is valid,
 142         it becomes the latest possible date.
 143
 144         @remarks If the current value of the control is outside of the newly set
 145                  range bounds, the behaviour is undefined.
 146     */
 147     void SetRange(const wxDateTime& dt1, const wxDateTime& dt2);
 148
 149     /**
 150         Changes the current value of the control. The date should be valid and included
 151         in the currently selected range, if any.
 152         Calling this method does not result in a date change event.
 153     */
 154     void SetValue(const wxDateTime& dt);
 155 };
 156