]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/datectrl.h
first raw revision
[wxWidgets.git] / interface / datectrl.h
index a4fa0ded8f048fc3c294b19d7ea51325f14cb706..501b03cc9d16a3886d2da7390c77ea3d682b2ae3 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        datectrl.h
-// Purpose:     documentation for wxDatePickerCtrl class
+// Purpose:     interface of wxDatePickerCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
            default date representation in the system.
     @endStyleTable
 
-    @beginEventTable
+    @beginEventTable{wxDateEvent}
     @event{EVT_DATE_CHANGED(id, func)}:
-           This event fires when the user changes the current selection in the
-           control.
+           This event fires when the user changes the current selection in the control.
     @endEventTable
 
     @library{wxadv}
     @category{miscpickers}
     @appearance{datepickerctrl.png}
 
-    @seealso
-    wxCalendarCtrl, wxDateEvent
+    @see wxCalendarCtrl, wxDateEvent
 */
 class wxDatePickerCtrl : public wxControl
 {
@@ -91,7 +89,7 @@ public:
             Validator which can be used for additional date checks.
         @param name
             Control name.
-        
+
         @returns @true if the control was successfully created or @false if
                  creation failed.
     */
@@ -108,14 +106,14 @@ public:
         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
-        
+
         @returns @false if no range limits are currently set, @true if at least one
                  bound is set.
     */
@@ -132,7 +130,7 @@ public:
         control. The native version always uses the current system locale.
         Sets the display format for the date in the control. See wxDateTime for the
         meaning of format strings.
-        
+
         @remarks If the format parameter is invalid, the behaviour is undefined.
     */
     void SetFormat(const wxChar* format);
@@ -141,7 +139,7 @@ public:
         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.
     */
@@ -154,3 +152,4 @@ public:
     */
     void SetValue(const wxDateTime& dt);
 };
+