samples/widgets/slider.cpp

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