]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/datectrl.h
Add wxNavigationEnabled<> helper for implementing TAB navigation.
[wxWidgets.git] / interface / wx / datectrl.h
index 90d457a2208723002faa6a14bcb02e125a5f132f..87d4598db9225570e951b7505f1016abe8cd163c 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxDatePickerCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -40,7 +40,7 @@
            default date representation in the system.
     @endStyleTable
 
-    @beginEventTable{wxDateEvent}
+    @beginEventEmissionTable{wxDateEvent}
     @event{EVT_DATE_CHANGED(id, func)}
            This event fires when the user changes the current selection in the
            control.
@@ -105,6 +105,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
@@ -124,17 +129,6 @@ public:
     */
     virtual wxDateTime GetValue() const = 0;
 
-    /**
-        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.
-    */
-    bool SetFormat(const wxString& 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
@@ -146,8 +140,11 @@ public:
     virtual void SetRange(const wxDateTime& dt1, const wxDateTime& dt2) = 0;
 
     /**
-        Changes the current value of the control. The date should be valid and
-        included in the currently selected range, if any.
+        Changes the current value of the control.
+
+        The date should be valid unless the control was created with @c
+        wxDP_ALLOWNONE style and included in the currently selected range, if
+        any.
 
         Calling this method does not result in a date change event.
     */