include/wx/msw/spinctrl.h

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/spinctrl.h
   3 // Purpose:     wxSpinCtrl class declaration for Win32
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     22.07.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSW_SPINCTRL_H_
  13 #define _WX_MSW_SPINCTRL_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "spinctrl.h"
  17 #endif
  18
  19 #include "wx/spinbutt.h"    // the base class
  20
  21 #if wxUSE_SPINCTRL
  22
  23 #include "wx/dynarray.h"
  24
  25 class WXDLLEXPORT wxSpinCtrl;
  26 WX_DEFINE_EXPORTED_ARRAY_PTR(wxSpinCtrl *, wxArraySpins);
  27
  28 // ----------------------------------------------------------------------------
  29 // Under Win32, wxSpinCtrl is a wxSpinButton with a buddy (as MSDN docs call
  30 // it) text window whose contents is automatically updated when the spin
  31 // control is clicked.
  32 // ----------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxSpinCtrl : public wxSpinButton
  35 {
  36 public:
  37     wxSpinCtrl() { }
  38
  39     wxSpinCtrl(wxWindow *parent,
  40                wxWindowID id = wxID_ANY,
  41                const wxString& value = wxEmptyString,
  42                const wxPoint& pos = wxDefaultPosition,
  43                const wxSize& size = wxDefaultSize,
  44                long style = wxSP_ARROW_KEYS,
  45                int min = 0, int max = 100, int initial = 0,
  46                const wxString& name = _T("wxSpinCtrl"))
  47     {
  48         Create(parent, id, value, pos, size, style, min, max, initial, name);
  49     }
  50
  51     bool Create(wxWindow *parent,
  52                 wxWindowID id = wxID_ANY,
  53                 const wxString& value = wxEmptyString,
  54                 const wxPoint& pos = wxDefaultPosition,
  55                 const wxSize& size = wxDefaultSize,
  56                 long style = wxSP_ARROW_KEYS,
  57                 int min = 0, int max = 100, int initial = 0,
  58                 const wxString& name = _T("wxSpinCtrl"));
  59
  60     // a wxTextCtrl-like method (but we can't have GetValue returning wxString
  61     // because the base class already has one returning int!)
  62     void SetValue(const wxString& text);
  63
  64     // another wxTextCtrl-like method
  65     void SetSelection(long from, long to);
  66
  67     // implementation only from now on
  68     // -------------------------------
  69
  70     virtual ~wxSpinCtrl();
  71
  72     virtual void SetValue(int val) { wxSpinButton::SetValue(val); }
  73     virtual int  GetValue() const;
  74     virtual bool SetFont(const wxFont &font);
  75     virtual void SetFocus();
  76
  77     virtual bool Enable(bool enable = true);
  78     virtual bool Show(bool show = true);
  79
  80     // wxSpinButton doesn't accept focus, but we do
  81     virtual bool AcceptsFocus() const { return wxWindow::AcceptsFocus(); }
  82
  83     // for internal use only
  84
  85     // get the subclassed window proc of the buddy text
  86     WXFARPROC GetBuddyWndProc() const { return m_wndProcBuddy; }
  87
  88     // return the spinctrl object whose buddy is the given window or NULL
  89     static wxSpinCtrl *GetSpinForTextCtrl(WXHWND hwndBuddy);
  90
  91     // process a WM_COMMAND generated by the buddy text control
  92     bool ProcessTextCommand(WXWORD cmd, WXWORD id);
  93
  94 protected:
  95     virtual void DoGetPosition(int *x, int *y) const;
  96     virtual void DoMoveWindow(int x, int y, int width, int height);
  97     virtual wxSize DoGetBestSize() const;
  98     virtual void DoGetSize(int *width, int *height) const;
  99
 100     // the handler for wxSpinButton events
 101     void OnSpinChange(wxSpinEvent& event);
 102
 103     // Handle processing of special keys
 104     void OnChar(wxKeyEvent& event);
 105     void OnSetFocus(wxFocusEvent& event);
 106
 107     // the data for the "buddy" text ctrl
 108     WXHWND     m_hwndBuddy;
 109     WXFARPROC  m_wndProcBuddy;
 110
 111     // all existing wxSpinCtrls - this allows to find the one corresponding to
 112     // the given buddy window in GetSpinForTextCtrl()
 113     static wxArraySpins ms_allSpins;
 114
 115 private:
 116     DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
 117     DECLARE_EVENT_TABLE()
 118     DECLARE_NO_COPY_CLASS(wxSpinCtrl)
 119 };
 120
 121 #endif // wxUSE_SPINCTRL
 122
 123 #endif // _WX_MSW_SPINCTRL_H_
 124
 125