Better documentation for the default parameters values.

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

diff --git a/interface/wx/spinctrl.h b/interface/wx/spinctrl.h
index c693c4d7c9af43c2c3f7c5f913bb069976ca8ecc..7a735a1d61ceacddac8b2ae0ea46687ec198fc2a 100644 (file)
--- a/interface/wx/spinctrl.h
+++ b/interface/wx/spinctrl.h
@@ -17,7 +17,7 @@
     @style{wxSP_WRAP}
         The value wraps at the minimum and maximum.
     @style{wxTE_PROCESS_ENTER}
     @style{wxSP_WRAP}
         The value wraps at the minimum and maximum.
     @style{wxTE_PROCESS_ENTER}

-        Indicates that the control should generate wxEVT_COMMAND_TEXT_ENTER
+        Indicates that the control should generate @c wxEVT_COMMAND_TEXT_ENTER

         events. Using this style will prevent the user from using the Enter key
         for dialog navigation (e.g. activating the default button in the
         dialog) under MSW.
         events. Using this style will prevent the user from using the Enter key
         for dialog navigation (e.g. activating the default button in the
         dialog) under MSW.


@@ -33,7 +33,8 @@
 
     @beginEventEmissionTable{wxSpinEvent}
     @event{EVT_SPINCTRL(id, func)}
 
     @beginEventEmissionTable{wxSpinEvent}
     @event{EVT_SPINCTRL(id, func)}

-        Generated whenever the numeric value of the spinctrl is updated
+        Process a wxEVT_COMMAND_SPINCTRL_UPDATED event, which is generated
+        whenever the numeric value of the spin control is updated.

     @endEventTable
 
     You may also use the wxSpinButton event macros, however the corresponding events
     @endEventTable
 
     You may also use the wxSpinButton event macros, however the corresponding events


@@ -159,6 +160,14 @@ public:
            The value wraps at the minimum and maximum.
     @endStyleTable
 
            The value wraps at the minimum and maximum.
     @endStyleTable
 

+    @beginEventEmissionTable{wxSpinDoubleEvent}
+    @event{EVT_SPINCTRLDOUBLE(id, func)}
+        Generated whenever the numeric value of the spin control is changed,
+        that is, when the up/down spin button is clicked, when ENTER is pressed,
+        or the control loses focus and the new value is different from the last.
+        See wxSpinDoubleEvent.
+    @endEventTable
+

     @library{wxcore}
     @category{ctrl}
     @appearance{spinctrldouble.png}
     @library{wxcore}
     @category{ctrl}
     @appearance{spinctrldouble.png}


@@ -274,3 +283,50 @@ public:
     */
     void SetValue(double value);
 };
     */
     void SetValue(double value);
 };

+
+/**
+    @class wxSpinDoubleEvent
+
+    This event class is used for the events generated by wxSpinCtrlDouble.
+
+    @beginEventTable{wxSpinDoubleEvent}
+    @event{EVT_SPINCTRLDOUBLE(id, func)}
+        Generated whenever the numeric value of the spin control is changed,
+        that is, when the up/down spin button is clicked, when ENTER is pressed,
+        or the control loses focus and the new value is different from the last.
+        See wxSpinDoubleEvent.
+    @endEventTable
+
+    @library{wxcore}
+    @category{events}
+
+    @see wxSpinCtrlDouble
+*/
+class wxSpinDoubleEvent : public wxNotifyEvent
+{
+public:
+    /**
+        The constructor. Not normally used by the user code.
+    */
+    wxSpinDoubleEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
+                      double value = 0);
+
+    /**
+        The copy constructor.
+    */
+    wxSpinDoubleEvent(const wxSpinDoubleEvent& event);
+
+    /**
+        Returns the value associated with this spin control event.
+    */
+    double GetValue() const;
+
+    /**
+        Set the value associated with the event.
+        (Not normally used by user code.)
+    */
+    void SetValue(double value);
+};
+
+wxEventType wxEVT_COMMAND_SPINCTRL_UPDATED;
+wxEventType wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED;