From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 27 Sep 2010 11:57:03 +0000 (+0000)
Subject: Document wxSpinDoubleEvent class.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/ba81782ac3002ad2fa3ad87fbbcdb299df69a6a3

Document wxSpinDoubleEvent class.

Add documentation for the class itself and the associated EVT_SPINCTRLDOUBLE
macro.

Patch by Carsten Fuchs.

Closes #12520.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65654 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/spinctrl.h b/interface/wx/spinctrl.h
index c693c4d7c9..4fa5dd4ed0 100644
--- a/interface/wx/spinctrl.h
+++ b/interface/wx/spinctrl.h
@@ -159,6 +159,14 @@ public:
            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}
@@ -274,3 +282,47 @@ public:
     */
     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);
+};