samples/widgets/slider.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Program:     wxWindows Widgets Sample
   3 // Name:        slider.cpp
   4 // Purpose:     Part of the widgets sample showing wxSlider
   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/slider.h"
  36     #include "wx/statbox.h"
  37     #include "wx/textctrl.h"
  38 #endif
  39
  40 #if wxUSE_TOOLTIPS
  41     #include "wx/tooltip.h"
  42 #endif
  43
  44 #include "wx/sizer.h"
  45
  46 #include "widgets.h"
  47 #if wxUSE_SLIDER
  48 #include "icons/slider.xpm"
  49
  50 // ----------------------------------------------------------------------------
  51 // constants
  52 // ----------------------------------------------------------------------------
  53
  54 // control ids
  55 enum
  56 {
  57     SliderPage_Reset = wxID_HIGHEST,
  58     SliderPage_Clear,
  59     SliderPage_SetValue,
  60     SliderPage_SetMinAndMax,
  61     SliderPage_SetTickFreq,
  62     SliderPage_SetThumbLen,
  63     SliderPage_CurValueText,
  64     SliderPage_ValueText,
  65     SliderPage_MinText,
  66     SliderPage_MaxText,
  67     SliderPage_TickFreqText,
  68     SliderPage_ThumbLenText,
  69     SliderPage_RadioSides,
  70     SliderPage_BothSides,
  71     SliderPage_Slider
  72 };
  73
  74 // sides radiobox values
  75 enum
  76 {
  77     StaticSides_Top,
  78     StaticSides_Bottom,
  79     StaticSides_Left,
  80     StaticSides_Right
  81 };
  82
  83 // ----------------------------------------------------------------------------
  84 // SliderWidgetsPage
  85 // ----------------------------------------------------------------------------
  86
  87 class SliderWidgetsPage : public WidgetsPage
  88 {
  89 public:
  90     SliderWidgetsPage(wxNotebook *notebook, wxImageList *imaglist);
  91     virtual ~SliderWidgetsPage();
  92
  93 protected:
  94     // event handlers
  95     void OnButtonReset(wxCommandEvent& event);
  96     void OnButtonClear(wxCommandEvent& event);
  97     void OnButtonSetValue(wxCommandEvent& event);
  98     void OnButtonSetMinAndMax(wxCommandEvent& event);
  99     void OnButtonSetTickFreq(wxCommandEvent& event);
 100     void OnButtonSetThumbLen(wxCommandEvent& event);
 101
 102     void OnCheckOrRadioBox(wxCommandEvent& event);
 103
 104     void OnSlider(wxScrollEvent& event);
 105
 106     void OnUpdateUIValueButton(wxUpdateUIEvent& event);
 107     void OnUpdateUIMinMaxButton(wxUpdateUIEvent& event);
 108     void OnUpdateUITickFreq(wxUpdateUIEvent& event);
 109     void OnUpdateUIThumbLen(wxUpdateUIEvent& event);
 110     void OnUpdateUIRadioSides(wxUpdateUIEvent& event);
 111     void OnUpdateUIBothSides(wxUpdateUIEvent& event);
 112
 113     void OnUpdateUIResetButton(wxUpdateUIEvent& event);
 114
 115     void OnUpdateUICurValueText(wxUpdateUIEvent& event);
 116
 117     // reset the slider parameters
 118     void Reset();
 119
 120     // (re)create the slider
 121     void CreateSlider();
 122
 123     // set the tick frequency from the text field value
 124     void DoSetTickFreq();
 125
 126     // set the thumb len from the text field value
 127     void DoSetThumbLen();
 128
 129     // is this slider value in range?
 130     bool IsValidValue(int val) const
 131         { return (val >= m_min) && (val <= m_max); }
 132
 133     // the slider range
 134     int m_min, m_max;
 135
 136     // the controls
 137     // ------------
 138
 139     // the check/radio boxes for styles
 140     wxCheckBox *m_chkLabels,
 141                *m_chkVert,
 142                *m_chkTicks,
 143                *m_chkBothSides;
 144
 145     wxRadioBox *m_radioSides;
 146
 147     // the slider itself and the sizer it is in
 148     wxSlider *m_slider;
 149     wxSizer *m_sizerSlider;
 150
 151     // the text entries for set value/range
 152     wxTextCtrl *m_textValue,
 153                *m_textMin,
 154                *m_textMax,
 155                *m_textTickFreq,
 156                *m_textThumbLen;
 157
 158 private:
 159     DECLARE_EVENT_TABLE()
 160     DECLARE_WIDGETS_PAGE(SliderWidgetsPage)
 161 };
 162
 163 // ----------------------------------------------------------------------------
 164 // event tables
 165 // ----------------------------------------------------------------------------
 166
 167 BEGIN_EVENT_TABLE(SliderWidgetsPage, WidgetsPage)
 168     EVT_BUTTON(SliderPage_Reset, SliderWidgetsPage::OnButtonReset)
 169     EVT_BUTTON(SliderPage_SetValue, SliderWidgetsPage::OnButtonSetValue)
 170     EVT_BUTTON(SliderPage_SetMinAndMax, SliderWidgetsPage::OnButtonSetMinAndMax)
 171     EVT_BUTTON(SliderPage_SetTickFreq, SliderWidgetsPage::OnButtonSetTickFreq)
 172     EVT_BUTTON(SliderPage_SetThumbLen, SliderWidgetsPage::OnButtonSetThumbLen)
 173
 174     EVT_UPDATE_UI(SliderPage_SetValue, SliderWidgetsPage::OnUpdateUIValueButton)
 175     EVT_UPDATE_UI(SliderPage_SetMinAndMax, SliderWidgetsPage::OnUpdateUIMinMaxButton)
 176     EVT_UPDATE_UI(SliderPage_SetTickFreq, SliderWidgetsPage::OnUpdateUITickFreq)
 177     EVT_UPDATE_UI(SliderPage_SetThumbLen, SliderWidgetsPage::OnUpdateUIThumbLen)
 178     EVT_UPDATE_UI(SliderPage_TickFreqText, SliderWidgetsPage::OnUpdateUITickFreq)
 179     EVT_UPDATE_UI(SliderPage_RadioSides, SliderWidgetsPage::OnUpdateUIRadioSides)
 180     EVT_UPDATE_UI(SliderPage_BothSides, SliderWidgetsPage::OnUpdateUIBothSides)
 181
 182     EVT_UPDATE_UI(SliderPage_Reset, SliderWidgetsPage::OnUpdateUIResetButton)
 183
 184     EVT_UPDATE_UI(SliderPage_CurValueText, SliderWidgetsPage::OnUpdateUICurValueText)
 185
 186     EVT_COMMAND_SCROLL(SliderPage_Slider, SliderWidgetsPage::OnSlider)
 187
 188     EVT_CHECKBOX(-1, SliderWidgetsPage::OnCheckOrRadioBox)
 189     EVT_RADIOBOX(-1, SliderWidgetsPage::OnCheckOrRadioBox)
 190 END_EVENT_TABLE()
 191
 192 // ============================================================================
 193 // implementation
 194 // ============================================================================
 195
 196 IMPLEMENT_WIDGETS_PAGE(SliderWidgetsPage, _T("Slider"));
 197
 198 SliderWidgetsPage::SliderWidgetsPage(wxNotebook *notebook,
 199                                        wxImageList *imaglist)
 200                   : WidgetsPage(notebook)
 201 {
 202     imaglist->Add(wxBitmap(slider_xpm));
 203
 204     // init everything
 205     m_min = 0;
 206     m_max = 100;
 207
 208     m_chkVert =
 209     m_chkTicks =
 210     m_chkLabels =
 211     m_chkBothSides = (wxCheckBox *)NULL;
 212
 213     m_radioSides = (wxRadioBox *)NULL;
 214
 215     m_slider = (wxSlider *)NULL;
 216     m_sizerSlider = (wxSizer *)NULL;
 217
 218     wxSizer *sizerTop = new wxBoxSizer(wxHORIZONTAL);
 219
 220     // left pane
 221     wxStaticBox *box = new wxStaticBox(this, -1, _T("&Set style"));
 222     wxSizer *sizerLeft = new wxStaticBoxSizer(box, wxVERTICAL);
 223
 224     m_chkVert = CreateCheckBoxAndAddToSizer(sizerLeft, _T("&Vertical"));
 225     m_chkTicks = CreateCheckBoxAndAddToSizer(sizerLeft, _T("Show &ticks"));
 226     m_chkLabels = CreateCheckBoxAndAddToSizer(sizerLeft, _T("Show &labels"));
 227     static const wxString sides[] =
 228     {
 229         _T("top"),
 230         _T("bottom"),
 231         _T("left"),
 232         _T("right"),
 233     };
 234     m_radioSides = new wxRadioBox(this, SliderPage_RadioSides, _T("&Ticks/Labels"),
 235                                  wxDefaultPosition, wxDefaultSize,
 236                                  WXSIZEOF(sides), sides,
 237                                  1, wxRA_SPECIFY_COLS);
 238     sizerLeft->Add(m_radioSides, 0, wxGROW | wxALL, 5);
 239     m_chkBothSides = CreateCheckBoxAndAddToSizer
 240                      (sizerLeft, _T("&Both sides"), SliderPage_BothSides);
 241 #if wxUSE_TOOLTIPS
 242     m_chkBothSides->SetToolTip( _T("\"Both sides\" is only supported \nin Win95 and Universal") );
 243 #endif // wxUSE_TOOLTIPS
 244
 245     sizerLeft->Add(5, 5, 0, wxGROW | wxALL, 5); // spacer
 246
 247     wxButton *btn = new wxButton(this, SliderPage_Reset, _T("&Reset"));
 248     sizerLeft->Add(btn, 0, wxALIGN_CENTRE_HORIZONTAL | wxALL, 15);
 249
 250     // middle pane
 251     wxStaticBox *box2 = new wxStaticBox(this, -1, _T("&Change slider value"));
 252     wxSizer *sizerMiddle = new wxStaticBoxSizer(box2, wxVERTICAL);
 253
 254     wxTextCtrl *text;
 255     wxSizer *sizerRow = CreateSizerWithTextAndLabel(_T("Current value"),
 256                                                     SliderPage_CurValueText,
 257                                                     &text);
 258     text->SetEditable(FALSE);
 259
 260     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 261
 262     sizerRow = CreateSizerWithTextAndButton(SliderPage_SetValue,
 263                                             _T("Set &value"),
 264                                             SliderPage_ValueText,
 265                                             &m_textValue);
 266     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 267
 268     sizerRow = CreateSizerWithTextAndButton(SliderPage_SetMinAndMax,
 269                                             _T("&Min and max"),
 270                                             SliderPage_MinText,
 271                                             &m_textMin);
 272
 273     m_textMax = new wxTextCtrl(this, SliderPage_MaxText, _T(""));
 274     sizerRow->Add(m_textMax, 1, wxLEFT | wxALIGN_CENTRE_VERTICAL, 5);
 275
 276     m_textMin->SetValue( wxString::Format(_T("%d"), m_min) );
 277     m_textMax->SetValue( wxString::Format(_T("%d"), m_max) );
 278
 279     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 280
 281     sizerRow = CreateSizerWithTextAndButton(SliderPage_SetTickFreq,
 282                                             _T("Tick &frequency"),
 283                                             SliderPage_TickFreqText,
 284                                             &m_textTickFreq);
 285
 286     m_textTickFreq->SetValue(_T("10"));
 287
 288     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 289
 290     sizerRow = CreateSizerWithTextAndButton(SliderPage_SetThumbLen,
 291                                             _T("Thumb &lenght"),
 292                                             SliderPage_ThumbLenText,
 293                                             &m_textThumbLen);
 294
 295     sizerMiddle->Add(sizerRow, 0, wxALL | wxGROW, 5);
 296
 297     // right pane
 298     wxSizer *sizerRight = new wxBoxSizer(wxHORIZONTAL);
 299     sizerRight->SetMinSize(150, 40);
 300     m_sizerSlider = sizerRight; // save it to modify it later
 301
 302     Reset();
 303     CreateSlider();
 304
 305     // the 3 panes panes compose the window
 306     sizerTop->Add(sizerLeft, 0, wxGROW | (wxALL & ~wxLEFT), 10);
 307     sizerTop->Add(sizerMiddle, 0, wxGROW | wxALL, 10);
 308     sizerTop->Add(sizerRight, 1, wxGROW | (wxALL & ~wxRIGHT), 10);
 309
 310     // final initializations
 311     SetAutoLayout(TRUE);
 312     SetSizer(sizerTop);
 313
 314     sizerTop->Fit(this);
 315 }
 316
 317 SliderWidgetsPage::~SliderWidgetsPage()
 318 {
 319 }
 320
 321 // ----------------------------------------------------------------------------
 322 // operations
 323 // ----------------------------------------------------------------------------
 324
 325 void SliderWidgetsPage::Reset()
 326 {
 327     m_chkVert->SetValue(FALSE);
 328     m_chkTicks->SetValue(TRUE);
 329     m_chkLabels->SetValue(TRUE);
 330     m_chkBothSides->SetValue(FALSE);
 331
 332     m_radioSides->SetSelection(StaticSides_Top);
 333 }
 334
 335 void SliderWidgetsPage::CreateSlider()
 336 {
 337     int flags = 0;
 338
 339     bool isVert = m_chkVert->GetValue();
 340     if ( isVert )
 341         flags |= wxSL_VERTICAL;
 342     else
 343         flags |= wxSL_HORIZONTAL;
 344
 345     if ( m_chkLabels->GetValue() )
 346     {
 347         flags |= wxSL_LABELS;
 348     }
 349
 350     if ( m_chkTicks->GetValue() )
 351     {
 352         flags |= wxSL_AUTOTICKS;
 353     }
 354
 355     switch ( m_radioSides->GetSelection() )
 356     {
 357         case StaticSides_Top:
 358             flags |= wxSL_TOP;
 359             break;
 360         case StaticSides_Left:
 361             flags |= wxSL_LEFT;
 362             break;
 363         case StaticSides_Bottom:
 364             flags |= wxSL_BOTTOM;
 365             break;
 366         case StaticSides_Right:
 367             flags |= wxSL_RIGHT;
 368             break;
 369         default:
 370             wxFAIL_MSG(_T("unexpected radiobox selection"));
 371             // fall through
 372     }
 373
 374     if ( m_chkBothSides->GetValue() )
 375     {
 376         flags |= wxSL_BOTH;
 377     }
 378
 379     int val = m_min;
 380     if ( m_slider )
 381     {
 382         int valOld = m_slider->GetValue();
 383         if ( !IsValidValue(valOld) )
 384         {
 385             val = valOld;
 386         }
 387
 388         m_sizerSlider->Detach( m_slider );
 389
 390         if ( m_sizerSlider->GetChildren().GetCount() )
 391         {
 392             // we have 2 spacers, remove them too
 393             m_sizerSlider->Remove( 0 );
 394             m_sizerSlider->Remove( 0 );
 395         }
 396
 397         delete m_slider;
 398     }
 399
 400     m_slider = new wxSlider(this, SliderPage_Slider,
 401                             val, m_min, m_max,
 402                             wxDefaultPosition, wxDefaultSize,
 403                             flags);
 404
 405     if ( isVert )
 406     {
 407         m_sizerSlider->Add(0, 0, 1);
 408         m_sizerSlider->Add(m_slider, 0, wxGROW | wxALL, 5);
 409         m_sizerSlider->Add(0, 0, 1);
 410     }
 411     else
 412     {
 413         m_sizerSlider->Add(m_slider, 1, wxCENTRE | wxALL, 5);
 414     }
 415
 416     if ( m_chkTicks->GetValue() )
 417     {
 418         DoSetTickFreq();
 419     }
 420
 421     m_sizerSlider->Layout();
 422 }
 423
 424 void SliderWidgetsPage::DoSetTickFreq()
 425 {
 426     long freq;
 427     if ( !m_textTickFreq->GetValue().ToLong(&freq) )
 428     {
 429         wxLogWarning(_T("Invalid slider tick frequency"));
 430
 431         return;
 432     }
 433
 434     m_slider->SetTickFreq(freq, 0 /* unused */);
 435 }
 436
 437 void SliderWidgetsPage::DoSetThumbLen()
 438 {
 439     long len;
 440     if ( !m_textThumbLen->GetValue().ToLong(&len) )
 441     {
 442         wxLogWarning(_T("Invalid slider thumb lenght"));
 443
 444         return;
 445     }
 446
 447     m_slider->SetThumbLength(len);
 448 }
 449
 450 // ----------------------------------------------------------------------------
 451 // event handlers
 452 // ----------------------------------------------------------------------------
 453
 454 void SliderWidgetsPage::OnButtonReset(wxCommandEvent& WXUNUSED(event))
 455 {
 456     Reset();
 457
 458     CreateSlider();
 459 }
 460
 461 void SliderWidgetsPage::OnButtonSetTickFreq(wxCommandEvent& WXUNUSED(event))
 462 {
 463     DoSetTickFreq();
 464 }
 465
 466 void SliderWidgetsPage::OnButtonSetThumbLen(wxCommandEvent& WXUNUSED(event))
 467 {
 468     DoSetThumbLen();
 469 }
 470
 471 void SliderWidgetsPage::OnButtonSetMinAndMax(wxCommandEvent& WXUNUSED(event))
 472 {
 473     long minNew,
 474          maxNew = 0; // init to suppress compiler warning
 475     if ( !m_textMin->GetValue().ToLong(&minNew) ||
 476          !m_textMax->GetValue().ToLong(&maxNew) ||
 477          minNew >= maxNew )
 478     {
 479         wxLogWarning(_T("Invalid min/max values for the slider."));
 480
 481         return;
 482     }
 483
 484     m_min = minNew;
 485     m_max = maxNew;
 486
 487     m_slider->SetRange(minNew, maxNew);
 488 }
 489
 490 void SliderWidgetsPage::OnButtonSetValue(wxCommandEvent& WXUNUSED(event))
 491 {
 492     long val;
 493     if ( !m_textValue->GetValue().ToLong(&val) || !IsValidValue(val) )
 494     {
 495         wxLogWarning(_T("Invalid slider value."));
 496
 497         return;
 498     }
 499
 500     m_slider->SetValue(val);
 501 }
 502
 503 void SliderWidgetsPage::OnUpdateUIValueButton(wxUpdateUIEvent& event)
 504 {
 505     long val;
 506     event.Enable( m_textValue->GetValue().ToLong(&val) && IsValidValue(val) );
 507 }
 508
 509 void SliderWidgetsPage::OnUpdateUITickFreq(wxUpdateUIEvent& event)
 510 {
 511     long freq;
 512     event.Enable( m_chkTicks->GetValue() &&
 513                   m_textTickFreq->GetValue().ToLong(&freq) &&
 514                   (freq > 0) && (freq <= m_max - m_min) );
 515 }
 516
 517 void SliderWidgetsPage::OnUpdateUIThumbLen(wxUpdateUIEvent& event)
 518 {
 519     long val;
 520     event.Enable( m_textThumbLen->GetValue().ToLong(&val));
 521 }
 522
 523 void SliderWidgetsPage::OnUpdateUIMinMaxButton(wxUpdateUIEvent& event)
 524 {
 525     long mn, mx;
 526     event.Enable( m_textMin->GetValue().ToLong(&mn) &&
 527                   m_textMax->GetValue().ToLong(&mx) &&
 528                   mn < mx);
 529 }
 530
 531 void SliderWidgetsPage::OnUpdateUIResetButton(wxUpdateUIEvent& event)
 532 {
 533     event.Enable( m_chkVert->GetValue() ||
 534                   !m_chkTicks->GetValue() ||
 535                   !m_chkLabels->GetValue() ||
 536                   m_chkBothSides->GetValue() );
 537 }
 538
 539 void SliderWidgetsPage::OnCheckOrRadioBox(wxCommandEvent& WXUNUSED(event))
 540 {
 541     CreateSlider();
 542 }
 543
 544 void SliderWidgetsPage::OnUpdateUICurValueText(wxUpdateUIEvent& event)
 545 {
 546     event.SetText( wxString::Format(_T("%d"), m_slider->GetValue()) );
 547 }
 548
 549 void SliderWidgetsPage::OnUpdateUIRadioSides(wxUpdateUIEvent& event)
 550 {
 551     event.Enable( m_chkLabels->GetValue() || m_chkTicks->GetValue() );
 552 }
 553
 554 void SliderWidgetsPage::OnUpdateUIBothSides(wxUpdateUIEvent& event)
 555 {
 556 #if defined(__WIN95__) || defined(__WXUNIVERSAL__)
 557     event.Enable( m_chkTicks->GetValue() );
 558 #else
 559     event.Enable( FALSE );
 560 #endif // defined(__WIN95__) || defined(__WXUNIVERSAL__)
 561 }
 562
 563 void SliderWidgetsPage::OnSlider(wxScrollEvent& event)
 564 {
 565     wxASSERT_MSG( event.GetInt() == m_slider->GetValue(),
 566                   wxT("slider value should be the same") );
 567
 568     wxEventType eventType = event.GetEventType();
 569
 570     /*
 571         This array takes the EXACT order of the declarations in
 572         include/wx/event.h
 573         (section "wxScrollBar and wxSlider event identifiers")
 574     */
 575     static const wxChar *eventNames[] =
 576     {
 577         wxT("wxEVT_SCROLL_TOP"),
 578         wxT("wxEVT_SCROLL_BOTTOM"),
 579         wxT("wxEVT_SCROLL_LINEUP"),
 580         wxT("wxEVT_SCROLL_LINEDOWN"),
 581         wxT("wxEVT_SCROLL_PAGEUP"),
 582         wxT("wxEVT_SCROLL_PAGEDOWN"),
 583         wxT("wxEVT_SCROLL_THUMBTRACK"),
 584         wxT("wxEVT_SCROLL_THUMBRELEASE"),
 585         wxT("wxEVT_SCROLL_ENDSCROLL")
 586     };
 587
 588     int index = eventType - wxEVT_SCROLL_TOP;
 589
 590     /*
 591         If this assert is triggered, there is an unknown slider event which
 592         should be added to the above eventNames array.
 593     */
 594     wxASSERT_MSG(index >= 0 && (size_t)index < WXSIZEOF(eventNames),
 595                  wxT("Unknown slider event") );
 596
 597
 598     static int s_numSliderEvents = 0;
 599
 600     wxLogMessage(wxT("Slider event #%d: %s (pos = %d)"),
 601                  s_numSliderEvents++,
 602                  eventNames[index],
 603                  event.GetPosition());
 604 }
 605
 606 #endif
 607     // wxUSE_SLIDER