document various enumerations defined in defs.h; give a name to the anonymous enum...

[wxWidgets.git] / include / wx / msw / spinctrl.h

diff --git a/include/wx/msw/spinctrl.h b/include/wx/msw/spinctrl.h
index 141823067a5d75d789d232e2b43643a7a9293f77..8f200c0267879b1c38ac2be2ea5faea850d81274 100644 (file)
--- a/include/wx/msw/spinctrl.h
+++ b/include/wx/msw/spinctrl.h
@@ -1,4 +1,4 @@
-/////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////
 // Name:        msw/spinctrl.h
 // Purpose:     wxSpinCtrl class declaration for Win32
 // Author:      Vadim Zeitlin
@@ -12,50 +12,132 @@
 #ifndef _WX_MSW_SPINCTRL_H_
 #define _WX_MSW_SPINCTRL_H_
 
-#ifdef __GNUG__
-    #pragma interface "spinctrl.h"
-#endif
-
 #include "wx/spinbutt.h"    // the base class
 
+#if wxUSE_SPINCTRL
+
+#include "wx/dynarray.h"
+
+class WXDLLIMPEXP_FWD_CORE wxSpinCtrl;
+WX_DEFINE_EXPORTED_ARRAY_PTR(wxSpinCtrl *, wxArraySpins);
+
 // ----------------------------------------------------------------------------
 // Under Win32, wxSpinCtrl is a wxSpinButton with a buddy (as MSDN docs call
 // it) text window whose contents is automatically updated when the spin
 // control is clicked.
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxSpinCtrl : public wxSpinButton
+class WXDLLIMPEXP_CORE wxSpinCtrl : public wxSpinButton
 {
 public:
     wxSpinCtrl() { }
 
     wxSpinCtrl(wxWindow *parent,
-               wxWindowID id = -1,
+               wxWindowID id = wxID_ANY,
+               const wxString& value = wxEmptyString,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxSP_ARROW_KEYS,
                int min = 0, int max = 100, int initial = 0,
                const wxString& name = _T("wxSpinCtrl"))
     {
-        Create(parent, id, pos, size, style, min, max, initial, name);
+        Create(parent, id, value, pos, size, style, min, max, initial, name);
     }
 
     bool Create(wxWindow *parent,
-                wxWindowID id = -1,
+                wxWindowID id = wxID_ANY,
+                const wxString& value = wxEmptyString,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxSP_ARROW_KEYS,
                 int min = 0, int max = 100, int initial = 0,
                 const wxString& name = _T("wxSpinCtrl"));
 
+    // a wxTextCtrl-like method (but we can't have GetValue returning wxString
+    // because the base class already has one returning int!)
+    void SetValue(const wxString& text);
+
+    // another wxTextCtrl-like method
+    void SetSelection(long from, long to);
+
+    // implementation only from now on
+    // -------------------------------
+
+    virtual ~wxSpinCtrl();
+
+    virtual void SetValue(int val);
+    virtual int  GetValue() const;
+    virtual bool SetFont(const wxFont &font);
+    virtual void SetFocus();
+
+    virtual bool Enable(bool enable = true);
+    virtual bool Show(bool show = true);
+
+    virtual bool Reparent(wxWindowBase *newParent);
+
+    // wxSpinButton doesn't accept focus, but we do
+    virtual bool AcceptsFocus() const { return wxWindow::AcceptsFocus(); }
+
+    // for internal use only
+
+    // get the subclassed window proc of the buddy text
+    WXFARPROC GetBuddyWndProc() const { return m_wndProcBuddy; }
+
+    // return the spinctrl object whose buddy is the given window or NULL
+    static wxSpinCtrl *GetSpinForTextCtrl(WXHWND hwndBuddy);
+
+    // process a WM_COMMAND generated by the buddy text control
+    bool ProcessTextCommand(WXWORD cmd, WXWORD id);
+
 protected:
-    void DoMoveWindow(int x, int y, int width, int height);
+    virtual void DoGetPosition(int *x, int *y) const;
+    virtual void DoMoveWindow(int x, int y, int width, int height);
+    virtual wxSize DoGetBestSize() const;
+    virtual void DoGetSize(int *width, int *height) const;
+    virtual void DoGetClientSize(int *x, int *y) const;
+#if wxUSE_TOOLTIPS
+    virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS
+
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+    virtual bool MSWOnScroll(int orientation, WXWORD wParam,
+                             WXWORD pos, WXHWND control);
+
+    // handle processing of special keys
+    void OnChar(wxKeyEvent& event);
+    void OnSetFocus(wxFocusEvent& event);
+    void OnKillFocus(wxFocusEvent& event);
+
+    // generate spin control update event with the given value
+    void SendSpinUpdate(int value);
 
-    WXHWND m_hwndBuddy;
+    // called to ensure that the value is in the correct range
+    virtual void NormalizeValue();
 
+
+    // the value of the control before the latest change (which might not have
+    // changed anything in fact -- this is why we need this field)
+    int m_oldValue;
+
+    // the data for the "buddy" text ctrl
+    WXHWND     m_hwndBuddy;
+    WXFARPROC  m_wndProcBuddy;
+
+    // Block text update event after SetValue()    
+    bool m_blockEvent;
+
+    // all existing wxSpinCtrls - this allows to find the one corresponding to
+    // the given buddy window in GetSpinForTextCtrl()
+    static wxArraySpins ms_allSpins;
+
+private:
     DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxSpinCtrl)
 };
 
+#endif // wxUSE_SPINCTRL
+
 #endif // _WX_MSW_SPINCTRL_H_