--- /dev/null
+/////////////////////////////////////////////////////////////////////////////
+// Name: datectrl.h
+// Purpose: interface of wxDatePickerCtrl
+// Author: wxWidgets team
+// RCS-ID: $Id$
+// Licence: wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+ @class wxDatePickerCtrl
+ @wxheader{datectrl.h}
+
+ 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 @c wxUSE_DATEPICKCTRL is set to 1.
+
+ @beginStyleTable
+ @style{wxDP_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.
+ @style{wxDP_DROPDOWN}
+ Creates a control with a month calendar drop-down part from which
+ the user can select a date.
+ @style{wxDP_DEFAULT}
+ Creates a control with the style that is best supported for the
+ current platform (currently wxDP_SPIN under Windows and
+ wxDP_DROPDOWN elsewhere).
+ @style{wxDP_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.
+ @style{wxDP_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.
+ @endStyleTable
+
+ @beginEventTable{wxDateEvent}
+ @event{EVT_DATE_CHANGED(id, func)}
+ This event fires when the user changes the current selection in the
+ control.
+ @endEventTable
+
+ @library{wxadv}
+ @category{pickers}
+ <!-- @appearance{datepickerctrl.png} -->
+
+ @see wxCalendarCtrl, wxDateEvent
+*/
+class wxDatePickerCtrl : public wxControl
+{
+public:
+ /**
+ Initializes the object and calls Create() with all the parameters.
+ */
+ wxDatePickerCtrl(wxWindow* parent, wxWindowID id,
+ const wxDateTime& dt = wxDefaultDateTime,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = "datectrl");
+
+ /**
+ @param parent
+ Parent window, must not be non-@NULL.
+ @param id
+ The identifier for the control.
+ @param dt
+ The initial value of the control, if an invalid date (such as the
+ default value) is used, the control is set to today.
+ @param pos
+ Initial position.
+ @param 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.
+ @param style
+ The window style, should be left at 0 as there are no special
+ styles for this control in this version.
+ @param validator
+ Validator which can be used for additional date checks.
+ @param name
+ Control name.
+
+ @return @true if the control was successfully created or @false if
+ creation failed.
+ */
+ bool Create(wxWindow* parent, wxWindowID id,
+ const wxDateTime& dt = wxDefaultDateTime,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDP_DEFAULT | wxDP_SHOWCENTURY,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = "datectrl");
+
+ /**
+ 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), @a dt1 and/or @a dt2
+ are set to be invalid.
+
+ @param dt1
+ Pointer to the object which receives the lower range limit or
+ becomes invalid if it is not set. May be @NULL if the caller is not
+ interested in lower limit.
+ @param dt2
+ Same as above but for the upper limit.
+
+ @return @false if no range limits are currently set, @true if at least
+ one bound is set.
+ */
+ bool GetRange(wxDateTime* dt1, wxDateTime dt2) const;
+
+ /**
+ Returns the currently selected. If there is no selection or the
+ selection is outside of the current range, an invalid object is
+ returned.
+ */
+ wxDateTime GetValue() const;
+
+ /**
+ Sets the display format for the date in the control. See wxDateTime for
+ the meaning of format strings.
+
+ @note This function is only available in the generic version of this
+ control. The native version always uses the current system locale.
+
+ @remarks If the format parameter is invalid, the behaviour is undefined.
+ */
+ void SetFormat(const wxChar* format);
+
+ /**
+ Sets the valid range for the date selection. If @a dt1 is valid, it
+ becomes the earliest date (inclusive) accepted by the control. If
+ @a dt2 is valid, it becomes the latest possible date.
+
+ @remarks If the current value of the control is outside of the newly
+ set range bounds, the behaviour is undefined.
+ */
+ void SetRange(const wxDateTime& dt1, const wxDateTime& dt2);
+
+ /**
+ 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.
+ */
+ void SetValue(const wxDateTime& dt);
+};
+
projects / wxWidgets.git / blobdiff