Add wxNavigationEnabled<> helper for implementing TAB navigation.

[wxWidgets.git] / interface / wx / datectrl.h

diff --git a/interface/wx/datectrl.h b/interface/wx/datectrl.h
index 3ca36d556c6fd4adaa26dfb920b69c447bcabc4f..87d4598db9225570e951b7505f1016abe8cd163c 100644 (file)
--- a/interface/wx/datectrl.h
+++ b/interface/wx/datectrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxDatePickerCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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
 
            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.
     @event{EVT_DATE_CHANGED(id, func)}
            This event fires when the user changes the current selection in the
            control.


@@ -48,7 +48,7 @@
 
     @library{wxadv}
     @category{pickers}
 
     @library{wxadv}
     @category{pickers}

-    <!-- @appearance{datepickerctrl.png} -->
+    @appearance{datepickerctrl.png}

 
     @see wxCalendarCtrl, wxDateEvent
 */
 
     @see wxCalendarCtrl, wxDateEvent
 */


@@ -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.
 
         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
         @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


@@ -115,25 +120,14 @@ public:
         @return @false if no range limits are currently set, @true if at least
                  one bound is set.
     */
         @return @false if no range limits are currently set, @true if at least
                  one bound is set.
     */

-    bool GetRange(wxDateTime* dt1, wxDateTime dt2) const;
+    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 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);
+    virtual wxDateTime GetValue() const = 0;

 
     /**
         Sets the valid range for the date selection. If @a dt1 is valid, it
 
     /**
         Sets the valid range for the date selection. If @a dt1 is valid, it


@@ -143,14 +137,17 @@ public:
         @remarks If the current value of the control is outside of the newly
                  set range bounds, the behaviour is undefined.
     */
         @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);
+    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.
     */
 
         Calling this method does not result in a date change event.
     */

-    void SetValue(const wxDateTime& dt);
+    virtual void SetValue(const wxDateTime& dt) = 0;

 };
 
 };