X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/526954c5968baa29218c994ec48e476ae2bd4b9f..58cc15871d1a5ec5a6cc17f50be3e2006f57571f:/interface/wx/datectrl.h diff --git a/interface/wx/datectrl.h b/interface/wx/datectrl.h index 3236f5a5f0..32829e081a 100644 --- a/interface/wx/datectrl.h +++ b/interface/wx/datectrl.h @@ -67,6 +67,11 @@ public: const wxString& name = "datectrl"); /** + Create the control window. + + This method should only be used for objects created using default + constructor. + @param parent Parent window, must not be non-@NULL. @param id @@ -81,8 +86,8 @@ public: 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. + The window style, see the description of the styles in the class + documentation. @param validator Validator which can be used for additional date checks. @param name @@ -105,6 +110,11 @@ public: range is set (or only one of the bounds is set), @a dt1 and/or @a dt2 are set to be invalid. + Notice that when using a native MSW implementation of this control the + lower range is always set, even if SetRange() hadn't been called + explicitly, as the native control only supports dates later than year + 1601. + @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 @@ -118,9 +128,10 @@ public: virtual bool GetRange(wxDateTime* dt1, wxDateTime* dt2) const = 0; /** - Returns the currently selected. If there is no selection or the - selection is outside of the current range, an invalid object is - returned. + Returns the currently entered date. + + For a control with @c wxDP_ALLOWNONE style the returned value may be + invalid if no date is entered, otherwise it is always valid. */ virtual wxDateTime GetValue() const = 0;