interface/wx/datectrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        datectrl.h
   3 // Purpose:     interface of wxDatePickerCtrl
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /// wxDatePickerCtrl styles
   9 enum
  10 {
  11     /// default style on this platform, either wxDP_SPIN or wxDP_DROPDOWN
  12     wxDP_DEFAULT = 0,
  13
  14     /// a spin control-like date picker (not supported in generic version)
  15     wxDP_SPIN = 1,
  16
  17     /// a combobox-like date picker (not supported in mac version)
  18     wxDP_DROPDOWN = 2,
  19
  20     /// always show century in the default date display (otherwise it depends on
  21     /// the system date format which may include the century or not)
  22     wxDP_SHOWCENTURY = 4,
  23
  24     /// allow not having any valid date in the control (by default it always has
  25     /// some date, today initially if no valid date specified in ctor)
  26     wxDP_ALLOWNONE = 8
  27 };
  28
  29
  30 /**
  31     @class wxDatePickerCtrl
  32
  33     This control allows the user to select a date. Unlike wxCalendarCtrl, which
  34     is a relatively big control, wxDatePickerCtrl is implemented as a small
  35     window showing the currently selected date. The control can be edited using
  36     the keyboard, and can also display a popup window for more user-friendly
  37     date selection, depending on the styles used and the platform.
  38
  39     It is only available if @c wxUSE_DATEPICKCTRL is set to 1.
  40
  41     @beginStyleTable
  42     @style{wxDP_SPIN}
  43            Creates a control without a month calendar drop down but with
  44            spin-control-like arrows to change individual date components. This
  45            style is not supported by the generic version.
  46     @style{wxDP_DROPDOWN}
  47            Creates a control with a month calendar drop-down part from which
  48            the user can select a date. This style is not supported in OSX/Cocoa
  49            native version.
  50     @style{wxDP_DEFAULT}
  51            Creates a control with the style that is best supported for the
  52            current platform (currently wxDP_SPIN under Windows and OSX/Cocoa
  53            and wxDP_DROPDOWN elsewhere).
  54     @style{wxDP_ALLOWNONE}
  55            With this style, the control allows the user to not enter any valid
  56            date at all. Without it - the default - the control always has some
  57            valid date. This style is not supported in OSX/Cocoa native version.
  58     @style{wxDP_SHOWCENTURY}
  59            Forces display of the century in the default date format. Without
  60            this style the century could be displayed, or not, depending on the
  61            default date representation in the system. This style is not
  62            supported in OSX/Cocoa native version currently.
  63     @endStyleTable
  64
  65     As can be seen from the remarks above, most of the control style are only
  66     supported in the native MSW implementation. In portable code it's
  67     recommended to use @c wxDP_DEFAULT style only, possibly combined with @c
  68     wxDP_SHOWCENTURY (this is also the style used by default if none is
  69     specified).
  70
  71     @beginEventEmissionTable{wxDateEvent}
  72     @event{EVT_DATE_CHANGED(id, func)}
  73            This event fires when the user changes the current selection in the
  74            control.
  75     @endEventTable
  76
  77     @library{wxadv}
  78     @category{pickers}
  79     @appearance{datepickerctrl}
  80
  81     @see wxCalendarCtrl, wxDateEvent
  82 */
  83 class wxDatePickerCtrl : public wxControl
  84 {
  85 public:
  86     /**
  87        Default constructor.
  88     */
  89     wxDatePickerCtrl();
  90
  91     /**
  92         Initializes the object and calls Create() with all the parameters.
  93     */
  94     wxDatePickerCtrl(wxWindow* parent, wxWindowID id,
  95                      const wxDateTime& dt = wxDefaultDateTime,
  96                      const wxPoint& pos = wxDefaultPosition,
  97                      const wxSize& size = wxDefaultSize,
  98                      long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
  99                      const wxValidator& validator = wxDefaultValidator,
 100                      const wxString& name = "datectrl");
 101
 102     /**
 103         Create the control window.
 104
 105         This method should only be used for objects created using default
 106         constructor.
 107
 108         @param parent
 109             Parent window, must not be non-@NULL.
 110         @param id
 111             The identifier for the control.
 112         @param dt
 113             The initial value of the control, if an invalid date (such as the
 114             default value) is used, the control is set to today.
 115         @param pos
 116             Initial position.
 117         @param size
 118             Initial size. If left at default value, the control chooses its own
 119             best size by using the height approximately equal to a text control
 120             and width large enough to show the date string fully.
 121         @param style
 122             The window style, see the description of the styles in the class
 123             documentation.
 124         @param validator
 125             Validator which can be used for additional date checks.
 126         @param name
 127             Control name.
 128
 129         @return @true if the control was successfully created or @false if
 130                  creation failed.
 131     */
 132     bool Create(wxWindow* parent, wxWindowID id,
 133                 const wxDateTime& dt = wxDefaultDateTime,
 134                 const wxPoint& pos = wxDefaultPosition,
 135                 const wxSize& size = wxDefaultSize,
 136                 long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
 137                 const wxValidator& validator = wxDefaultValidator,
 138                 const wxString& name = "datectrl");
 139
 140     /**
 141         If the control had been previously limited to a range of dates using
 142         SetRange(), returns the lower and upper bounds of this range. If no
 143         range is set (or only one of the bounds is set), @a dt1 and/or @a dt2
 144         are set to be invalid.
 145
 146         Notice that when using a native MSW implementation of this control the
 147         lower range is always set, even if SetRange() hadn't been called
 148         explicitly, as the native control only supports dates later than year
 149         1601.
 150
 151         @param dt1
 152             Pointer to the object which receives the lower range limit or
 153             becomes invalid if it is not set. May be @NULL if the caller is not
 154             interested in lower limit.
 155         @param dt2
 156             Same as above but for the upper limit.
 157
 158         @return @false if no range limits are currently set, @true if at least
 159                  one bound is set.
 160     */
 161     virtual bool GetRange(wxDateTime* dt1, wxDateTime* dt2) const;
 162
 163     /**
 164         Returns the currently entered date.
 165
 166         For a control with @c wxDP_ALLOWNONE style the returned value may be
 167         invalid if no date is entered, otherwise it is always valid.
 168     */
 169     virtual wxDateTime GetValue() const;
 170
 171     /**
 172         Sets the valid range for the date selection. If @a dt1 is valid, it
 173         becomes the earliest date (inclusive) accepted by the control. If
 174         @a dt2 is valid, it becomes the latest possible date.
 175
 176         @remarks If the current value of the control is outside of the newly
 177                  set range bounds, the behaviour is undefined.
 178     */
 179     virtual void SetRange(const wxDateTime& dt1, const wxDateTime& dt2);
 180
 181     /**
 182         Changes the current value of the control.
 183
 184         The date should be valid unless the control was created with @c
 185         wxDP_ALLOWNONE style and included in the currently selected range, if
 186         any.
 187
 188         Calling this method does not result in a date change event.
 189     */
 190     virtual void SetValue(const wxDateTime& dt);
 191 };
 192