samples/widgets/spinbtn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Program:     wxWidgets Widgets Sample
   3 // Name:        spinbtn.cpp
   4 // Purpose:     Part of the widgets sample showing wxSpinButton
   5 // Author:      Vadim Zeitlin
   6 // Created:     16.04.01
   7 // Id:          $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin
   9 // License:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // for compilers that support precompilation, includes "wx/wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_SPINBTN
  28
  29 // for all others, include the necessary headers
  30 #ifndef WX_PRECOMP
  31     #include "wx/log.h"
  32
  33     #include "wx/bitmap.h"
  34     #include "wx/button.h"
  35     #include "wx/checkbox.h"
  36     #include "wx/radiobox.h"
  37     #include "wx/statbox.h"
  38     #include "wx/textctrl.h"
  39 #endif
  40
  41 #include "wx/spinbutt.h"
  42 #include "wx/spinctrl.h"
  43
  44 #include "wx/sizer.h"
  45
  46 #include "widgets.h"
  47
  48 #include "icons/spinbtn.xpm"
  49
  50 // ----------------------------------------------------------------------------
  51 // constants
  52 // ----------------------------------------------------------------------------
  53
  54 // control ids
  55 enum
  56 {
  57     SpinBtnPage_Reset = 100,
  58     SpinBtnPage_Clear,
  59     SpinBtnPage_SetValue,
  60     SpinBtnPage_SetMinAndMax,
  61     SpinBtnPage_CurValueText,
  62     SpinBtnPage_ValueText,
  63     SpinBtnPage_MinText,
  64     SpinBtnPage_MaxText,
  65     SpinBtnPage_SpinBtn,
  66     SpinBtnPage_SpinCtrl
  67 };
  68
  69 // ----------------------------------------------------------------------------
  70 // SpinBtnWidgetsPage
  71 // ----------------------------------------------------------------------------
  72
  73 class SpinBtnWidgetsPage : public WidgetsPage
  74 {
  75 public:
  76     SpinBtnWidgetsPage(wxBookCtrlBase *book, wxImageList *imaglist);
  77     virtual ~SpinBtnWidgetsPage(){};
  78
  79     virtual wxControl *GetWidget() const { return m_spinbtn; }
  80     virtual wxControl *GetWidget2() const { return m_spinctrl; }
  81     virtual void RecreateWidget() { CreateSpin(); }
  82
  83 protected:
  84     // event handlers
  85     void OnButtonReset(wxCommandEvent& event);
  86     void OnButtonClear(wxCommandEvent& event);
  87     void OnButtonSetValue(wxCommandEvent& event);
  88     void OnButtonSetMinAndMax(wxCommandEvent& event);
  89
  90     void OnCheckOrRadioBox(wxCommandEvent& event);
  91
  92     void OnSpinBtn(wxSpinEvent& event);
  93     void OnSpinBtnUp(wxSpinEvent& event);
  94     void OnSpinBtnDown(wxSpinEvent& event);
  95     void OnSpinCtrl(wxSpinEvent& event);
  96
  97     void OnUpdateUIValueButton(wxUpdateUIEvent& event);
  98     void OnUpdateUIMinMaxButton(wxUpdateUIEvent& event);
  99
 100     void OnUpdateUIResetButton(wxUpdateUIEvent& event);
 101
 102     void OnUpdateUICurValueText(wxUpdateUIEvent& event);
 103
 104     // reset the spinbtn parameters
 105     void Reset();
 106
 107     // (re)create the spinbtn
 108     void CreateSpin();
 109
 110     // is this spinbtn value in range?
 111     bool IsValidValue(int val) const
 112         { return (val >= m_min) && (val <= m_max); }
 113
 114     // the spinbtn range
 115     int m_min, m_max;
 116
 117     // the controls
 118     // ------------
 119
 120     // the check/radio boxes for styles
 121     wxCheckBox *m_chkVert,
 122                *m_chkWrap;
 123
 124     // the spinbtn and the spinctrl and the sizer containing them
 125     wxSpinButton *m_spinbtn;
 126     wxSpinCtrl *m_spinctrl;
 127
 128     wxSizer *m_sizerSpin;
 129
 130     // the text entries for set value/range
 131     wxTextCtrl *m_textValue,
 132                *m_textMin,
 133                *m_textMax;
 134
 135 private:
 136     DECLARE_EVENT_TABLE()
 137     DECLARE_WIDGETS_PAGE(SpinBtnWidgetsPage)
 138 };
 139
 140 // ----------------------------------------------------------------------------
 141 // event tables
 142 // ----------------------------------------------------------------------------
 143
 144 BEGIN_EVENT_TABLE(SpinBtnWidgetsPage, WidgetsPage)
 145     EVT_BUTTON(SpinBtnPage_Reset, SpinBtnWidgetsPage::OnButtonReset)
 146     EVT_BUTTON(SpinBtnPage_SetValue, SpinBtnWidgetsPage::OnButtonSetValue)
 147     EVT_BUTTON(SpinBtnPage_SetMinAndMax, SpinBtnWidgetsPage::OnButtonSetMinAndMax)
 148
 149     EVT_UPDATE_UI(SpinBtnPage_SetValue, SpinBtnWidgetsPage::OnUpdateUIValueButton)
 150     EVT_UPDATE_UI(SpinBtnPage_SetMinAndMax, SpinBtnWidgetsPage::OnUpdateUIMinMaxButton)
 151
 152     EVT_UPDATE_UI(SpinBtnPage_Reset, SpinBtnWidgetsPage::OnUpdateUIResetButton)
 153
 154     EVT_UPDATE_UI(SpinBtnPage_CurValueText, SpinBtnWidgetsPage::OnUpdateUICurValueText)
 155
 156     EVT_SPIN(SpinBtnPage_SpinBtn, SpinBtnWidgetsPage::OnSpinBtn)
 157     EVT_SPIN_UP(SpinBtnPage_SpinBtn, SpinBtnWidgetsPage::OnSpinBtnUp)
 158     EVT_SPIN_DOWN(SpinBtnPage_SpinBtn, SpinBtnWidgetsPage::OnSpinBtnDown)
 159     EVT_SPINCTRL(SpinBtnPage_SpinCtrl, SpinBtnWidgetsPage::OnSpinCtrl)
 160
 161     EVT_CHECKBOX(wxID_ANY, SpinBtnWidgetsPage::OnCheckOrRadioBox)
 162     EVT_RADIOBOX(wxID_ANY, SpinBtnWidgetsPage::OnCheckOrRadioBox)
 163 END_EVENT_TABLE()
 164
 165 // ============================================================================
 166 // implementation
 167 // ============================================================================
 168
 169 IMPLEMENT_WIDGETS_PAGE(SpinBtnWidgetsPage, _T("Spin"));
 170
 171 SpinBtnWidgetsPage::SpinBtnWidgetsPage(wxBookCtrlBase *book,
 172                                        wxImageList *imaglist)
 173                   : WidgetsPage(book)
 174 {
 175     m_chkVert = NULL;
 176     m_chkWrap = NULL;
 177     m_spinbtn = NULL;
 178     m_spinctrl = NULL;
 179     m_textValue = NULL;
 180     m_textMin = NULL;
 181     m_textMax = NULL;
 182     imaglist->Add(wxBitmap(spinbtn_xpm));
 183
 184     // init everything
 185     m_min = 0;
 186     m_max = 10;
 187
 188     m_chkVert =
 189     m_chkWrap = (wxCheckBox *)NULL;
 190
 191     m_spinbtn = (wxSpinButton *)NULL;
 192     m_sizerSpin = (wxSizer *)NULL;
 193
 194     wxSizer *sizerTop = new wxBoxSizer(wxHORIZONTAL);
 195
 196     // left pane
 197     wxStaticBox *box = new wxStaticBox(this, wxID_ANY, _T("&Set style"));
 198     wxSizer *sizerLeft = new wxStaticBoxSizer(box, wxVERTICAL);
 199
 200     m_chkVert = CreateCheckBoxAndAddToSizer(sizerLeft, _T("&Vertical"));
 201     m_chkWrap = CreateCheckBoxAndAddToSizer(sizerLeft, _T("&Wrap"));
 202
 203     sizerLeft->Add(5, 5, 0, wxGROW | wxALL, 5); // spacer
 204
 205     wxButton *btn = new wxButton(this, SpinBtnPage_Reset, _T("&Reset"));
 206     sizerLeft->Add(btn, 0, wxALIGN_CENTRE_HORIZONTAL | wxALL, 15);
 207
 208     // middle pane
 209     wxStaticBox *box2 = new wxStaticBox(this, wxID_ANY,
 210         _T("&Change spinbtn value"));
 211
 212     wxSizer *sizerMiddle = new wxStaticBoxSizer(box2, wxVERTICAL);
 213
 214     wxTextCtrl *text;
 215     wxSizer *sizerRow = CreateSizerWithTextAndLabel(_T("Current value"),
 216                                                     SpinBtnPage_CurValueText,
 217                                                     &text);
 218     text->SetEditable(false);
 219
 220     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 221
 222     sizerRow = CreateSizerWithTextAndButton(SpinBtnPage_SetValue,
 223                                             _T("Set &value"),
 224                                             SpinBtnPage_ValueText,
 225                                             &m_textValue);
 226     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 227
 228     sizerRow = CreateSizerWithTextAndButton(SpinBtnPage_SetMinAndMax,
 229                                             _T("&Min and max"),
 230                                             SpinBtnPage_MinText,
 231                                             &m_textMin);
 232
 233     m_textMax = new wxTextCtrl(this, SpinBtnPage_MaxText, wxEmptyString);
 234     sizerRow->Add(m_textMax, 1, wxLEFT | wxALIGN_CENTRE_VERTICAL, 5);
 235
 236     m_textMin->SetValue( wxString::Format(_T("%d"), m_min) );
 237     m_textMax->SetValue( wxString::Format(_T("%d"), m_max) );
 238
 239     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 240
 241     // right pane
 242     wxSizer *sizerRight = new wxBoxSizer(wxVERTICAL);
 243     sizerRight->SetMinSize(150, 0);
 244     m_sizerSpin = sizerRight; // save it to modify it later
 245
 246     Reset();
 247     CreateSpin();
 248
 249     // the 3 panes panes compose the window
 250     sizerTop->Add(sizerLeft, 0, wxGROW | (wxALL & ~wxLEFT), 10);
 251     sizerTop->Add(sizerMiddle, 0, wxGROW | wxALL, 10);
 252     sizerTop->Add(sizerRight, 1, wxGROW | (wxALL & ~wxRIGHT), 10);
 253
 254     // final initializations
 255     SetSizer(sizerTop);
 256
 257     sizerTop->Fit(this);
 258 }
 259
 260 // ----------------------------------------------------------------------------
 261 // operations
 262 // ----------------------------------------------------------------------------
 263
 264 void SpinBtnWidgetsPage::Reset()
 265 {
 266     m_chkVert->SetValue(true);
 267     m_chkWrap->SetValue(false);
 268 }
 269
 270 void SpinBtnWidgetsPage::CreateSpin()
 271 {
 272     int flags = ms_defaultFlags;
 273
 274     bool isVert = m_chkVert->GetValue();
 275     if ( isVert )
 276         flags |= wxSP_VERTICAL;
 277     else
 278         flags |= wxSP_HORIZONTAL;
 279
 280     if ( m_chkWrap->GetValue() )
 281         flags |= wxSP_WRAP;
 282
 283     int val = m_min;
 284     if ( m_spinbtn )
 285     {
 286         int valOld = m_spinbtn->GetValue();
 287         if ( !IsValidValue(valOld) )
 288         {
 289             val = valOld;
 290         }
 291
 292         m_sizerSpin->Detach( m_spinbtn );
 293         m_sizerSpin->Detach( m_spinctrl );
 294
 295         // there are 3 spacers left
 296         m_sizerSpin->Remove( 0 );
 297         m_sizerSpin->Remove( 0 );
 298         m_sizerSpin->Remove( 0 );
 299
 300         delete m_spinbtn;
 301         delete m_spinctrl;
 302     }
 303
 304     m_spinbtn = new wxSpinButton(this, SpinBtnPage_SpinBtn,
 305                                  wxDefaultPosition, wxDefaultSize,
 306                                  flags);
 307
 308     m_spinbtn->SetValue(val);
 309     m_spinbtn->SetRange(m_min, m_max);
 310
 311     m_spinctrl = new wxSpinCtrl(this, SpinBtnPage_SpinCtrl,
 312                                 wxString::Format(_T("%d"), val),
 313                                 wxDefaultPosition, wxDefaultSize,
 314                                 flags,
 315                                 m_min, m_max, val);
 316
 317     m_sizerSpin->Add(0, 0, 1);
 318     m_sizerSpin->Add(m_spinbtn, 0, wxALIGN_CENTRE | wxALL, 5);
 319     m_sizerSpin->Add(0, 0, 1);
 320     m_sizerSpin->Add(m_spinctrl, 0, wxALIGN_CENTRE | wxALL, 5);
 321     m_sizerSpin->Add(0, 0, 1);
 322
 323     m_sizerSpin->Layout();
 324 }
 325
 326 // ----------------------------------------------------------------------------
 327 // event handlers
 328 // ----------------------------------------------------------------------------
 329
 330 void SpinBtnWidgetsPage::OnButtonReset(wxCommandEvent& WXUNUSED(event))
 331 {
 332     Reset();
 333
 334     CreateSpin();
 335 }
 336
 337 void SpinBtnWidgetsPage::OnButtonSetMinAndMax(wxCommandEvent& WXUNUSED(event))
 338 {
 339     long minNew,
 340          maxNew = 0; // init to suppress compiler warning
 341     if ( !m_textMin->GetValue().ToLong(&minNew) ||
 342          !m_textMax->GetValue().ToLong(&maxNew) ||
 343          minNew >= maxNew )
 344     {
 345         wxLogWarning(_T("Invalid min/max values for the spinbtn."));
 346
 347         return;
 348     }
 349
 350     m_min = minNew;
 351     m_max = maxNew;
 352
 353     m_spinbtn->SetRange(minNew, maxNew);
 354     m_spinctrl->SetRange(minNew, maxNew);
 355 }
 356
 357 void SpinBtnWidgetsPage::OnButtonSetValue(wxCommandEvent& WXUNUSED(event))
 358 {
 359     long val;
 360     if ( !m_textValue->GetValue().ToLong(&val) || !IsValidValue(val) )
 361     {
 362         wxLogWarning(_T("Invalid spinbtn value."));
 363
 364         return;
 365     }
 366
 367     m_spinbtn->SetValue(val);
 368     m_spinctrl->SetValue(val);
 369 }
 370
 371 void SpinBtnWidgetsPage::OnUpdateUIValueButton(wxUpdateUIEvent& event)
 372 {
 373     long val;
 374     event.Enable( m_textValue->GetValue().ToLong(&val) && IsValidValue(val) );
 375 }
 376
 377 void SpinBtnWidgetsPage::OnUpdateUIMinMaxButton(wxUpdateUIEvent& event)
 378 {
 379     long mn, mx;
 380     event.Enable( m_textMin->GetValue().ToLong(&mn) &&
 381                   m_textMax->GetValue().ToLong(&mx) &&
 382                   mn < mx);
 383 }
 384
 385 void SpinBtnWidgetsPage::OnUpdateUIResetButton(wxUpdateUIEvent& event)
 386 {
 387     event.Enable( !m_chkVert->GetValue() || m_chkWrap->GetValue() );
 388 }
 389
 390 void SpinBtnWidgetsPage::OnCheckOrRadioBox(wxCommandEvent& WXUNUSED(event))
 391 {
 392     CreateSpin();
 393 }
 394
 395 void SpinBtnWidgetsPage::OnUpdateUICurValueText(wxUpdateUIEvent& event)
 396 {
 397     event.SetText( wxString::Format(_T("%d"), m_spinbtn->GetValue()));
 398 }
 399
 400 void SpinBtnWidgetsPage::OnSpinBtn(wxSpinEvent& event)
 401 {
 402     int value = event.GetInt();
 403
 404     wxASSERT_MSG( value == m_spinbtn->GetValue(),
 405                   _T("spinbtn value should be the same") );
 406
 407     wxLogMessage(_T("Spin button value changed, now %d"), value);
 408 }
 409
 410 void SpinBtnWidgetsPage::OnSpinBtnUp(wxSpinEvent& event)
 411 {
 412     wxLogMessage( _T("Spin button value incremented, will be %ld (was %d)"),
 413                   event.GetInt(), m_spinbtn->GetValue() );
 414 }
 415
 416 void SpinBtnWidgetsPage::OnSpinBtnDown(wxSpinEvent& event)
 417 {
 418     wxLogMessage( _T("Spin button value decremented, will be %ld (was %d)"),
 419                   event.GetInt(), m_spinbtn->GetValue() );
 420 }
 421
 422 void SpinBtnWidgetsPage::OnSpinCtrl(wxSpinEvent& event)
 423 {
 424     if (!m_spinctrl)
 425         return;
 426     int value = event.GetInt();
 427
 428     wxASSERT_MSG( value == m_spinctrl->GetValue(),
 429                   _T("spinctrl value should be the same") );
 430
 431     wxLogMessage(_T("Spin control value changed, now %d"), value);
 432 }
 433 #endif
 434     // wxUSE_SPINBTN