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