src/msw/slider95.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/slider95.cpp
   3 // Purpose:     wxSlider95, using the Win95 trackbar control
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart 1998
   9 //                  Vadim Zeitlin 2004
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // ============================================================================
  14 // declarations
  15 // ============================================================================
  16
  17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  18 #pragma implementation "slider95.h"
  19 #endif
  20
  21 // ----------------------------------------------------------------------------
  22 // headers
  23 // ----------------------------------------------------------------------------
  24
  25 // For compilers that support precompilation, includes "wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29     #pragma hdrstop
  30 #endif
  31
  32 #if wxUSE_SLIDER
  33
  34 #ifndef WX_PRECOMP
  35     #include "wx/brush.h"
  36 #endif
  37
  38 #include "wx/slider.h"
  39 #include "wx/msw/subwin.h"
  40
  41 #if !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
  42     #include <commctrl.h>
  43 #endif
  44
  45 // ----------------------------------------------------------------------------
  46 // constants
  47 // ----------------------------------------------------------------------------
  48
  49 // indices of labels in wxSlider95::m_labels
  50 enum
  51 {
  52     SliderLabel_Min,
  53     SliderLabel_Max,
  54     SliderLabel_Value,
  55     SliderLabel_Last
  56 };
  57
  58 // the gap between the slider and the labels, in pixels
  59 static const int HGAP = 5;
  60
  61 // ----------------------------------------------------------------------------
  62 // XTI
  63 // ----------------------------------------------------------------------------
  64
  65 #if wxUSE_EXTENDED_RTTI
  66 WX_DEFINE_FLAGS( wxSliderStyle )
  67
  68 wxBEGIN_FLAGS( wxSliderStyle )
  69     // new style border flags, we put them first to
  70     // use them for streaming out
  71     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  72     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  73     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  74     wxFLAGS_MEMBER(wxBORDER_RAISED)
  75     wxFLAGS_MEMBER(wxBORDER_STATIC)
  76     wxFLAGS_MEMBER(wxBORDER_NONE)
  77
  78     // old style border flags
  79     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  80     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  81     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  82     wxFLAGS_MEMBER(wxRAISED_BORDER)
  83     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  84     wxFLAGS_MEMBER(wxBORDER)
  85
  86     // standard window styles
  87     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  88     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  89     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  90     wxFLAGS_MEMBER(wxWANTS_CHARS)
  91     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  92     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  93     wxFLAGS_MEMBER(wxVSCROLL)
  94     wxFLAGS_MEMBER(wxHSCROLL)
  95
  96     wxFLAGS_MEMBER(wxSL_HORIZONTAL)
  97     wxFLAGS_MEMBER(wxSL_VERTICAL)
  98     wxFLAGS_MEMBER(wxSL_AUTOTICKS)
  99     wxFLAGS_MEMBER(wxSL_LABELS)
 100     wxFLAGS_MEMBER(wxSL_LEFT)
 101     wxFLAGS_MEMBER(wxSL_TOP)
 102     wxFLAGS_MEMBER(wxSL_RIGHT)
 103     wxFLAGS_MEMBER(wxSL_BOTTOM)
 104     wxFLAGS_MEMBER(wxSL_BOTH)
 105     wxFLAGS_MEMBER(wxSL_SELRANGE)
 106
 107 wxEND_FLAGS( wxSliderStyle )
 108
 109 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSlider95, wxControl,"wx/scrolbar.h")
 110
 111 wxBEGIN_PROPERTIES_TABLE(wxSlider95)
 112     wxEVENT_RANGE_PROPERTY( Scroll , wxEVT_SCROLL_TOP , wxEVT_SCROLL_ENDSCROLL , wxScrollEvent )
 113     wxEVENT_PROPERTY( Updated , wxEVT_COMMAND_SLIDER_UPDATED , wxCommandEvent )
 114
 115     wxPROPERTY( Value , int , SetValue, GetValue , 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 116     wxPROPERTY( Minimum , int , SetMin, GetMin, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 117     wxPROPERTY( Maximum , int , SetMax, GetMax, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 118     wxPROPERTY( PageSize , int , SetPageSize, GetLineSize, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 119     wxPROPERTY( LineSize , int , SetLineSize, GetLineSize, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 120     wxPROPERTY( ThumbLength , int , SetThumbLength, GetThumbLength, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 121     wxPROPERTY_FLAGS( WindowStyle , wxSliderStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 122 wxEND_PROPERTIES_TABLE()
 123
 124 wxBEGIN_HANDLERS_TABLE(wxSlider95)
 125 wxEND_HANDLERS_TABLE()
 126
 127 wxCONSTRUCTOR_8( wxSlider95 , wxWindow* , Parent , wxWindowID , Id , int , Value , int , Minimum , int , Maximum , wxPoint , Position , wxSize , Size , long , WindowStyle )
 128 #else
 129 IMPLEMENT_DYNAMIC_CLASS(wxSlider95, wxControl)
 130 #endif
 131
 132 // ============================================================================
 133 // wxSlider95 implementation
 134 // ============================================================================
 135
 136 // ----------------------------------------------------------------------------
 137 // construction
 138 // ----------------------------------------------------------------------------
 139
 140 void wxSlider95::Init()
 141 {
 142     m_labels = NULL;
 143
 144     m_pageSize = 1;
 145     m_lineSize = 1;
 146     m_rangeMax = 0;
 147     m_rangeMin = 0;
 148     m_tickFreq = 0;
 149 }
 150
 151 bool
 152 wxSlider95::Create(wxWindow *parent,
 153                    wxWindowID id,
 154                    int value,
 155                    int minValue,
 156                    int maxValue,
 157                    const wxPoint& pos,
 158                    const wxSize& size,
 159                    long style,
 160                    const wxValidator& validator,
 161                    const wxString& name)
 162 {
 163     // initialize everything
 164     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 165         return false;
 166
 167     // ensure that we have correct values for GetLabelsSize()
 168     m_rangeMin = minValue;
 169     m_rangeMax = maxValue;
 170
 171     // create the labels first, so that our DoGetBestSize() could take them
 172     // into account
 173     //
 174     // note that we could simply create 3 wxStaticTexts here but it could
 175     // result in some observable side effects at wx level (e.g. the parent of
 176     // wxSlider would have 3 more children than expected) and so we prefer not
 177     // to do it like this
 178     if ( m_windowStyle & wxSL_LABELS )
 179     {
 180         m_labels = new wxSubwindows(SliderLabel_Last);
 181
 182         HWND hwndParent = GetHwndOf(parent);
 183         for ( size_t n = 0; n < SliderLabel_Last; n++ )
 184         {
 185             (*m_labels)[n] = ::CreateWindow
 186                                (
 187                                     wxT("STATIC"),
 188                                     NULL,
 189                                     WS_CHILD | WS_VISIBLE | SS_CENTER,
 190                                     0, 0, 0, 0,
 191                                     hwndParent,
 192                                     (HMENU)NewControlId(),
 193                                     wxGetInstance(),
 194                                     NULL
 195                                );
 196         }
 197
 198         m_labels->SetFont(GetFont());
 199     }
 200
 201     // now create the main control too
 202     if ( !MSWCreateControl(TRACKBAR_CLASS, wxEmptyString, pos, size) )
 203         return false;
 204
 205     // and initialize everything
 206     SetRange(minValue, maxValue);
 207     SetValue(value);
 208     SetPageSize((maxValue - minValue)/10);
 209
 210     return true;
 211 }
 212
 213 WXDWORD wxSlider95::MSWGetStyle(long style, WXDWORD *exstyle) const
 214 {
 215     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 216
 217     // TBS_HORZ is 0 anyhow, but do mention it explicitly for clarity
 218     msStyle |= style & wxSL_VERTICAL ? TBS_VERT : TBS_HORZ;
 219
 220     if ( style & wxSL_AUTOTICKS )
 221         msStyle |= TBS_AUTOTICKS ;
 222
 223     // again, TBS_RIGHT is 0 but do include it for clarity
 224     if ( style & wxSL_LEFT )
 225         msStyle |= TBS_LEFT;
 226     else if ( style & wxSL_RIGHT )
 227         msStyle |= TBS_RIGHT;
 228     else if ( style & wxSL_TOP )
 229         msStyle |= TBS_TOP;
 230     else if ( style & wxSL_BOTTOM )
 231         msStyle |= TBS_BOTTOM;
 232     else if ( style & wxSL_BOTH )
 233         msStyle |= TBS_BOTH;
 234     else if ( !(style & wxSL_AUTOTICKS) )
 235         msStyle |= TBS_NOTICKS;
 236
 237     if ( style & wxSL_SELRANGE )
 238         msStyle |= TBS_ENABLESELRANGE;
 239
 240     return msStyle;
 241 }
 242
 243 wxSlider95::~wxSlider95()
 244 {
 245     delete m_labels;
 246 }
 247
 248 // ----------------------------------------------------------------------------
 249 // event handling
 250 // ----------------------------------------------------------------------------
 251
 252 bool wxSlider95::MSWOnScroll(int WXUNUSED(orientation),
 253                              WXWORD wParam,
 254                              WXWORD WXUNUSED(pos),
 255                              WXHWND control)
 256 {
 257     wxEventType scrollEvent;
 258     switch ( wParam )
 259     {
 260         case SB_TOP:
 261             scrollEvent = wxEVT_SCROLL_TOP;
 262             break;
 263
 264         case SB_BOTTOM:
 265             scrollEvent = wxEVT_SCROLL_BOTTOM;
 266             break;
 267
 268         case SB_LINEUP:
 269             scrollEvent = wxEVT_SCROLL_LINEUP;
 270             break;
 271
 272         case SB_LINEDOWN:
 273             scrollEvent = wxEVT_SCROLL_LINEDOWN;
 274             break;
 275
 276         case SB_PAGEUP:
 277             scrollEvent = wxEVT_SCROLL_PAGEUP;
 278             break;
 279
 280         case SB_PAGEDOWN:
 281             scrollEvent = wxEVT_SCROLL_PAGEDOWN;
 282             break;
 283
 284         case SB_THUMBTRACK:
 285             scrollEvent = wxEVT_SCROLL_THUMBTRACK;
 286             break;
 287
 288         case SB_THUMBPOSITION:
 289             scrollEvent = wxEVT_SCROLL_THUMBRELEASE;
 290             break;
 291
 292         case SB_ENDSCROLL:
 293             scrollEvent = wxEVT_SCROLL_ENDSCROLL;
 294             break;
 295
 296         default:
 297             // unknown scroll event?
 298             return false;
 299     }
 300
 301     int newPos = (int) ::SendMessage((HWND) control, TBM_GETPOS, 0, 0);
 302     if ( (newPos < GetMin()) || (newPos > GetMax()) )
 303     {
 304         // out of range - but we did process it
 305         return true;
 306     }
 307
 308     SetValue(newPos);
 309
 310     wxScrollEvent event(scrollEvent, m_windowId);
 311     event.SetPosition(newPos);
 312     event.SetEventObject( this );
 313     GetEventHandler()->ProcessEvent(event);
 314
 315     wxCommandEvent cevent( wxEVT_COMMAND_SLIDER_UPDATED, GetId() );
 316     cevent.SetInt( newPos );
 317     cevent.SetEventObject( this );
 318
 319     return GetEventHandler()->ProcessEvent( cevent );
 320 }
 321
 322 void wxSlider95::Command (wxCommandEvent & event)
 323 {
 324     SetValue (event.GetInt());
 325     ProcessCommand (event);
 326 }
 327
 328 // ----------------------------------------------------------------------------
 329 // geometry stuff
 330 // ----------------------------------------------------------------------------
 331
 332 wxRect wxSlider95::GetBoundingBox() const
 333 {
 334     // take care not to call our own functions which would call us recursively
 335     int x, y, w, h;
 336     wxSliderBase::DoGetPosition(&x, &y);
 337     wxSliderBase::DoGetSize(&w, &h);
 338
 339     wxRect rect(x, y, w, h);
 340     if ( m_labels )
 341         rect.Union(m_labels->GetBoundingBox());
 342
 343     return rect;
 344 }
 345
 346 void wxSlider95::DoGetSize(int *width, int *height) const
 347 {
 348     wxRect rect = GetBoundingBox();
 349
 350     if ( width )
 351         *width = rect.width;
 352     if ( height )
 353         *height = rect.height;
 354 }
 355
 356 void wxSlider95::DoGetPosition(int *x, int *y) const
 357 {
 358     wxRect rect = GetBoundingBox();
 359
 360     if ( x )
 361         *x = rect.x;
 362     if ( y )
 363         *y = rect.y;
 364 }
 365
 366 int wxSlider95::GetLabelsSize(int *width) const
 367 {
 368     int cy;
 369
 370     if ( width )
 371     {
 372         // find the max label width
 373         int wLabelMin, wLabelMax;
 374         GetTextExtent(Format(m_rangeMin), &wLabelMin, &cy);
 375         GetTextExtent(Format(m_rangeMax), &wLabelMax, &cy);
 376
 377         *width = wxMax(wLabelMin, wLabelMax);
 378     }
 379     else
 380     {
 381         cy = GetCharHeight();
 382     }
 383
 384     return EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 385 }
 386
 387 void wxSlider95::DoMoveWindow(int x, int y, int width, int height)
 388 {
 389     // all complications below are because we need to position the labels,
 390     // without them everything is easy
 391     if ( !m_labels )
 392     {
 393         wxSliderBase::DoMoveWindow(x, y, width, height);
 394         return;
 395     }
 396
 397     if ( HasFlag(wxSL_VERTICAL) )
 398     {
 399         int wLabel;
 400         int hLabel = GetLabelsSize(&wLabel);
 401
 402         int xLabel = HasFlag(wxSL_LEFT) ? x + width - wLabel : x;
 403
 404         // position the slider itself along the left/right edge
 405         ::MoveWindow(GetHwnd(),
 406                      HasFlag(wxSL_LEFT) ? x : x + wLabel + HGAP,
 407                      y + hLabel/2,
 408                      width - wLabel - HGAP,
 409                      height - hLabel,
 410                      TRUE);
 411
 412         // position all labels: min at the top, value in the middle and max at
 413         // the bottom
 414         ::MoveWindow((*m_labels)[SliderLabel_Min],
 415                      xLabel, y, wLabel, hLabel, TRUE);
 416
 417         ::MoveWindow((*m_labels)[SliderLabel_Value],
 418                      xLabel, y + (height - hLabel)/2, wLabel, hLabel, TRUE);
 419
 420         ::MoveWindow((*m_labels)[SliderLabel_Max],
 421                      xLabel, y + height - hLabel, wLabel, hLabel, TRUE);
 422     }
 423     else // horizontal
 424     {
 425         int wLabel;
 426         int hLabel = GetLabelsSize(&wLabel);
 427
 428         int yLabel = HasFlag(wxSL_TOP) ? y + height - hLabel : y;
 429
 430         // position the slider itself along the top/bottom edge
 431         ::MoveWindow(GetHwnd(),
 432                      x,
 433                      HasFlag(wxSL_TOP) ? y : y + hLabel,
 434                      width,
 435                      height - hLabel,
 436                      TRUE);
 437
 438         // position all labels: min on the left, value in the middle and max to
 439         // the right
 440         ::MoveWindow((*m_labels)[SliderLabel_Min],
 441                      x, yLabel, wLabel, hLabel, TRUE);
 442
 443         ::MoveWindow((*m_labels)[SliderLabel_Value],
 444                      x + (width - wLabel)/2, yLabel, wLabel, hLabel, TRUE);
 445
 446         ::MoveWindow((*m_labels)[SliderLabel_Max],
 447                      x + width - wLabel, yLabel, wLabel, hLabel, TRUE);
 448     }
 449 }
 450
 451 wxSize wxSlider95::DoGetBestSize() const
 452 {
 453     // these values are arbitrary
 454     static const int length = 100;
 455     static const int thickness = 26;
 456
 457     wxSize size;
 458     if ( HasFlag(wxSL_VERTICAL) )
 459     {
 460         size.x = thickness;
 461         size.y = length;
 462
 463         if ( m_labels )
 464         {
 465             int wLabel;
 466             int hLabel = GetLabelsSize(&wLabel);
 467
 468             // account for the labels
 469             size.x += HGAP + wLabel;
 470
 471             // labels are indented relative to the slider itself
 472             size.y += hLabel;
 473         }
 474     }
 475     else // horizontal
 476     {
 477         size.x = length;
 478         size.y = thickness;
 479
 480         if ( m_labels )
 481         {
 482             // labels add extra height
 483             size.y += GetLabelsSize();
 484         }
 485     }
 486
 487     return size;
 488 }
 489
 490 // ----------------------------------------------------------------------------
 491 // slider-specific methods
 492 // ----------------------------------------------------------------------------
 493
 494 int wxSlider95::GetValue() const
 495 {
 496     return ::SendMessage(GetHwnd(), TBM_GETPOS, 0, 0);
 497 }
 498
 499 void wxSlider95::SetValue(int value)
 500 {
 501     ::SendMessage(GetHwnd(), TBM_SETPOS, (WPARAM)TRUE, (LPARAM)value);
 502
 503     if ( m_labels )
 504     {
 505         ::SetWindowText((*m_labels)[SliderLabel_Value], Format(value));
 506     }
 507 }
 508
 509 void wxSlider95::SetRange(int minValue, int maxValue)
 510 {
 511     m_rangeMin = minValue;
 512     m_rangeMax = maxValue;
 513
 514     ::SendMessage(GetHwnd(), TBM_SETRANGE, TRUE, MAKELONG(minValue, maxValue));
 515
 516     if ( m_labels )
 517     {
 518         ::SetWindowText((*m_labels)[SliderLabel_Min], Format(m_rangeMin));
 519         ::SetWindowText((*m_labels)[SliderLabel_Max], Format(m_rangeMax));
 520     }
 521 }
 522
 523 void wxSlider95::SetTickFreq(int n, int pos)
 524 {
 525     m_tickFreq = n;
 526     ::SendMessage( GetHwnd(), TBM_SETTICFREQ, (WPARAM) n, (LPARAM) pos );
 527 }
 528
 529 void wxSlider95::SetPageSize(int pageSize)
 530 {
 531     ::SendMessage( GetHwnd(), TBM_SETPAGESIZE, (WPARAM) 0, (LPARAM) pageSize );
 532     m_pageSize = pageSize;
 533 }
 534
 535 int wxSlider95::GetPageSize() const
 536 {
 537     return m_pageSize;
 538 }
 539
 540 void wxSlider95::ClearSel()
 541 {
 542     ::SendMessage(GetHwnd(), TBM_CLEARSEL, (WPARAM) TRUE, (LPARAM) 0);
 543 }
 544
 545 void wxSlider95::ClearTicks()
 546 {
 547     ::SendMessage(GetHwnd(), TBM_CLEARTICS, (WPARAM) TRUE, (LPARAM) 0);
 548 }
 549
 550 void wxSlider95::SetLineSize(int lineSize)
 551 {
 552     m_lineSize = lineSize;
 553     ::SendMessage(GetHwnd(), TBM_SETLINESIZE, (WPARAM) 0, (LPARAM) lineSize);
 554 }
 555
 556 int wxSlider95::GetLineSize() const
 557 {
 558     return (int)::SendMessage(GetHwnd(), TBM_GETLINESIZE, 0, 0);
 559 }
 560
 561 int wxSlider95::GetSelEnd() const
 562 {
 563     return (int)::SendMessage(GetHwnd(), TBM_SETSELEND, 0, 0);
 564 }
 565
 566 int wxSlider95::GetSelStart() const
 567 {
 568     return (int)::SendMessage(GetHwnd(), TBM_GETSELSTART, 0, 0);
 569 }
 570
 571 void wxSlider95::SetSelection(int minPos, int maxPos)
 572 {
 573     ::SendMessage(GetHwnd(), TBM_SETSEL,
 574                   (WPARAM) TRUE /* redraw */,
 575                   (LPARAM) MAKELONG( minPos, maxPos) );
 576 }
 577
 578 void wxSlider95::SetThumbLength(int len)
 579 {
 580     ::SendMessage(GetHwnd(), TBM_SETTHUMBLENGTH, (WPARAM) len, (LPARAM) 0);
 581 }
 582
 583 int wxSlider95::GetThumbLength() const
 584 {
 585   return (int)::SendMessage( GetHwnd(), TBM_GETTHUMBLENGTH, 0, 0);
 586 }
 587
 588 void wxSlider95::SetTick(int tickPos)
 589 {
 590   ::SendMessage( GetHwnd(), TBM_SETTIC, (WPARAM) 0, (LPARAM) tickPos );
 591 }
 592
 593 // ----------------------------------------------------------------------------
 594 // composite control methods
 595 // ----------------------------------------------------------------------------
 596
 597 WXHWND wxSlider95::GetStaticMin() const
 598 {
 599     return m_labels ? (WXHWND)(*m_labels)[SliderLabel_Min] : NULL;
 600 }
 601
 602 WXHWND wxSlider95::GetStaticMax() const
 603 {
 604     return m_labels ? (WXHWND)(*m_labels)[SliderLabel_Max] : NULL;
 605 }
 606
 607 WXHWND wxSlider95::GetEditValue() const
 608 {
 609     return m_labels ? (WXHWND)(*m_labels)[SliderLabel_Value] : NULL;
 610 }
 611
 612 bool wxSlider95::ContainsHWND(WXHWND hWnd) const
 613 {
 614     return m_labels && m_labels->HasWindow((HWND)hWnd);
 615 }
 616
 617 bool wxSlider95::Show(bool show)
 618 {
 619     if ( !wxSliderBase::Show(show) )
 620         return false;
 621
 622     if ( m_labels )
 623         m_labels->Show(show);
 624
 625     return true;
 626 }
 627
 628 #endif // wxUSE_SLIDER