samples/widgets/spinbtn.cpp

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