1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/slider.cpp
3 // Purpose: wxSlider, using the Win95 (and later) trackbar control
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart 1998
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 // ============================================================================
15 // ============================================================================
17 // ----------------------------------------------------------------------------
19 // ----------------------------------------------------------------------------
21 // For compilers that support precompilation, includes "wx.h".
22 #include "wx/wxprec.h"
30 #include "wx/slider.h"
33 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
37 #include "wx/msw/subwin.h"
39 // ----------------------------------------------------------------------------
41 // ----------------------------------------------------------------------------
46 // indices of labels in wxSlider::m_labels
55 // the gaps between the slider and the labels, in pixels
58 // the width of the borders including white space
59 const int BORDERPAD
= 8;
60 // these 2 values are arbitrary:
64 } // anonymous namespace
66 // ============================================================================
67 // wxSlider implementation
68 // ============================================================================
70 // ----------------------------------------------------------------------------
72 // ----------------------------------------------------------------------------
87 bool wxSlider::Create(wxWindow
*parent
,
95 const wxValidator
& validator
,
98 wxCHECK_MSG( minValue
< maxValue
, false,
99 wxT("Slider minimum must be strictly less than the maximum.") );
101 // our styles are redundant: wxSL_LEFT/RIGHT imply wxSL_VERTICAL and
102 // wxSL_TOP/BOTTOM imply wxSL_HORIZONTAL, but for backwards compatibility
103 // reasons we can't really change it, instead try to infer the orientation
104 // from the flags given to us here
105 switch ( style
& (wxSL_LEFT
| wxSL_RIGHT
| wxSL_TOP
| wxSL_BOTTOM
) )
109 style
|= wxSL_VERTICAL
;
114 style
|= wxSL_HORIZONTAL
;
118 // no specific direction, do we have at least the orientation?
119 if ( !(style
& (wxSL_HORIZONTAL
| wxSL_VERTICAL
)) )
121 // no, choose default
122 style
|= wxSL_BOTTOM
| wxSL_HORIZONTAL
;
126 wxASSERT_MSG( !(style
& wxSL_VERTICAL
) || !(style
& wxSL_HORIZONTAL
),
127 wxT("incompatible slider direction and orientation") );
130 // initialize everything
131 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
134 // ensure that we have correct values for GetLabelsSize()
135 m_rangeMin
= minValue
;
136 m_rangeMax
= maxValue
;
138 // create the labels first, so that our DoGetBestSize() could take them
141 // note that we could simply create 3 wxStaticTexts here but it could
142 // result in some observable side effects at wx level (e.g. the parent of
143 // wxSlider would have 3 more children than expected) and so we prefer not
144 // to do it like this
145 if ( m_windowStyle
& wxSL_LABELS
)
147 m_labels
= new wxSubwindows(SliderLabel_Last
);
149 HWND hwndParent
= GetHwndOf(parent
);
150 for ( size_t n
= 0; n
< SliderLabel_Last
; n
++ )
152 wxWindowIDRef lblid
= NewControlId();
154 HWND wnd
= ::CreateWindow
158 WS_CHILD
| WS_VISIBLE
| SS_CENTER
,
161 (HMENU
)wxUIntToPtr(lblid
.GetValue()),
166 m_labels
->Set(n
, wnd
, lblid
);
168 m_labels
->SetFont(GetFont());
171 // now create the main control too
172 if ( !MSWCreateControl(TRACKBAR_CLASS
, wxEmptyString
, pos
, size
) )
175 // and initialize everything
176 SetRange(minValue
, maxValue
);
178 SetPageSize((maxValue
- minValue
)/10);
180 // we need to position the labels correctly if we have them and if
181 // SetSize() hadn't been called before (when best size was determined by
182 // MSWCreateControl()) as in this case they haven't been put in place yet
183 if ( m_labels
&& size
.x
!= wxDefaultCoord
&& size
.y
!= wxDefaultCoord
)
191 WXDWORD
wxSlider::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
193 WXDWORD msStyle
= wxControl::MSWGetStyle(style
, exstyle
);
195 // TBS_HORZ, TBS_RIGHT and TBS_BOTTOM are 0 but do include them for clarity
196 msStyle
|= style
& wxSL_VERTICAL
? TBS_VERT
: TBS_HORZ
;
198 if ( style
& wxSL_BOTH
)
200 // this fully specifies the style combined with TBS_VERT/HORZ above
203 else // choose one direction
205 if ( style
& wxSL_LEFT
)
207 else if ( style
& wxSL_RIGHT
)
208 msStyle
|= TBS_RIGHT
;
209 else if ( style
& wxSL_TOP
)
211 else if ( style
& wxSL_BOTTOM
)
212 msStyle
|= TBS_BOTTOM
;
215 if ( style
& wxSL_AUTOTICKS
)
216 msStyle
|= TBS_AUTOTICKS
;
218 msStyle
|= TBS_NOTICKS
;
220 if ( style
& wxSL_SELRANGE
)
221 msStyle
|= TBS_ENABLESELRANGE
;
226 wxSlider::~wxSlider()
231 // ----------------------------------------------------------------------------
233 // ----------------------------------------------------------------------------
235 bool wxSlider::MSWOnScroll(int WXUNUSED(orientation
),
237 WXWORD
WXUNUSED(pos
),
240 wxEventType scrollEvent
;
244 scrollEvent
= wxEVT_SCROLL_TOP
;
248 scrollEvent
= wxEVT_SCROLL_BOTTOM
;
252 scrollEvent
= wxEVT_SCROLL_LINEUP
;
256 scrollEvent
= wxEVT_SCROLL_LINEDOWN
;
260 scrollEvent
= wxEVT_SCROLL_PAGEUP
;
264 scrollEvent
= wxEVT_SCROLL_PAGEDOWN
;
268 scrollEvent
= wxEVT_SCROLL_THUMBTRACK
;
272 case SB_THUMBPOSITION
:
275 scrollEvent
= wxEVT_SCROLL_THUMBRELEASE
;
276 m_isDragging
= false;
280 // this seems to only happen when the mouse wheel is used: in
281 // this case, as it might be unexpected to get THUMBRELEASE
282 // without preceding THUMBTRACKs, we don't generate it at all
283 // but generate CHANGED event because the control itself does
284 // not send us SB_ENDSCROLL for whatever reason when mouse
286 scrollEvent
= wxEVT_SCROLL_CHANGED
;
291 scrollEvent
= wxEVT_SCROLL_CHANGED
;
295 // unknown scroll event?
299 int newPos
= ValueInvertOrNot((int) ::SendMessage((HWND
) control
, TBM_GETPOS
, 0, 0));
300 if ( (newPos
< GetMin()) || (newPos
> GetMax()) )
302 // out of range - but we did process it
308 wxScrollEvent
event(scrollEvent
, m_windowId
);
309 event
.SetPosition(newPos
);
310 event
.SetEventObject( this );
311 HandleWindowEvent(event
);
313 wxCommandEvent
cevent( wxEVT_COMMAND_SLIDER_UPDATED
, GetId() );
314 cevent
.SetInt( newPos
);
315 cevent
.SetEventObject( this );
317 return HandleWindowEvent( cevent
);
320 void wxSlider::Command (wxCommandEvent
& event
)
322 SetValue (event
.GetInt());
323 ProcessCommand (event
);
326 // ----------------------------------------------------------------------------
328 // ----------------------------------------------------------------------------
330 wxRect
wxSlider::GetBoundingBox() const
332 // take care not to call our own functions which would call us recursively
334 wxSliderBase::DoGetPosition(&x
, &y
);
335 wxSliderBase::DoGetSize(&w
, &h
);
337 wxRect
rect(x
, y
, w
, h
);
340 wxRect lrect
= m_labels
->GetBoundingBox();
341 GetParent()->ScreenToClient(&lrect
.x
, &lrect
.y
);
348 void wxSlider::DoGetSize(int *width
, int *height
) const
350 wxRect rect
= GetBoundingBox();
355 *height
= rect
.height
;
358 void wxSlider::DoGetPosition(int *x
, int *y
) const
360 wxRect rect
= GetBoundingBox();
368 int wxSlider::GetLabelsSize(int *widthMin
, int *widthMax
) const
370 if ( widthMin
&& widthMax
)
372 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
374 *widthMin
= GetTextExtent(Format(m_rangeMin
)).x
;
375 *widthMax
= GetTextExtent(Format(m_rangeMax
)).x
;
384 return HasFlag(wxSL_LABELS
) ? GetCharHeight() : 0;
387 void wxSlider::DoMoveWindow(int x
, int y
, int width
, int height
)
389 // all complications below are because we need to position the labels,
390 // without them everything is easy
393 wxSliderBase::DoMoveWindow(x
, y
, width
, height
);
397 const int labelHeight
= GetLabelsSize(&m_minLabelWidth
, &m_maxLabelWidth
);
398 const int maxLabelWidth
= wxMax(m_minLabelWidth
, m_maxLabelWidth
);
402 if ( HasFlag(wxSL_TICKS
))
404 if ( HasFlag(wxSL_BOTH
))
407 // be careful to position the slider itself after moving the labels as
408 // otherwise our GetBoundingBox(), which is called from WM_SIZE handler,
409 // would return a wrong result and wrong size would be cached internally
410 if ( HasFlag(wxSL_VERTICAL
) )
416 int xLabel
= (wxMax((THUMB
+ (BORDERPAD
* 2)), maxLabelWidth
) / 2) -
417 (maxLabelWidth
/ 2) + x
;
418 if ( HasFlag(wxSL_LEFT
) )
420 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
423 holdTopWidth
= m_minLabelWidth
;
424 holdBottomX
= xLabel
- ((m_maxLabelWidth
- m_minLabelWidth
) / 2);
425 holdBottomWidth
= m_maxLabelWidth
;
426 if ( HasFlag(wxSL_INVERSE
) )
428 wxSwap(holdTopWidth
, holdBottomWidth
);
429 wxSwap(holdTopX
, holdBottomX
);
431 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Min
],
434 holdTopWidth
, labelHeight
);
435 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Max
],
437 y
+ height
- labelHeight
,
438 holdBottomWidth
, labelHeight
);
440 if ( HasFlag(wxSL_VALUE_LABEL
) )
441 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Value
],
442 x
+ THUMB
+ tickOffset
+ HGAP
,
443 y
+ (height
- labelHeight
)/2,
444 maxLabelWidth
, labelHeight
);
448 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
450 holdTopX
= xLabel
+ maxLabelWidth
+ ((m_maxLabelWidth
- m_minLabelWidth
) / 2);
451 holdTopWidth
= m_minLabelWidth
;
452 holdBottomX
= xLabel
+ maxLabelWidth
;
453 holdBottomWidth
= m_maxLabelWidth
;
454 if ( HasFlag(wxSL_INVERSE
) )
456 wxSwap(holdTopWidth
, holdBottomWidth
);
457 wxSwap(holdTopX
, holdBottomX
);
459 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Min
],
462 holdTopWidth
, labelHeight
);
463 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Max
],
465 y
+ height
- labelHeight
,
466 holdBottomWidth
, labelHeight
);
468 if ( HasFlag(wxSL_VALUE_LABEL
) )
469 labelOffset
= maxLabelWidth
+ HGAP
;
470 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Value
],
472 y
+ (height
- labelHeight
)/2,
473 maxLabelWidth
, labelHeight
);
476 // position the slider itself along the left/right edge
477 wxSliderBase::DoMoveWindow(
480 THUMB
+ tickOffset
+ HGAP
,
481 height
- (labelHeight
* 2));
490 (y
+ ((THUMB
+ tickOffset
) / 2)) - (labelHeight
/ 2);
492 x
+ m_minLabelWidth
+
493 ((width
- (m_minLabelWidth
+ m_maxLabelWidth
)) / 2) -
494 (m_maxLabelWidth
/ 2);
496 if ( HasFlag(wxSL_BOTTOM
) )
498 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
501 holdLeftWidth
= m_minLabelWidth
;
502 holdRightX
= x
+ width
- m_maxLabelWidth
;
503 holdRightWidth
= m_maxLabelWidth
;
504 if ( HasFlag(wxSL_INVERSE
) )
506 wxSwap(holdLeftWidth
, holdRightWidth
);
507 wxSwap(holdLeftX
, holdRightX
);
509 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Min
],
512 holdLeftWidth
, labelHeight
);
513 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Max
],
516 holdRightWidth
, labelHeight
);
518 if ( HasFlag(wxSL_VALUE_LABEL
) )
520 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Value
],
523 maxLabelWidth
, labelHeight
);
528 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
531 holdLeftWidth
= m_minLabelWidth
;
532 holdRightX
= x
+ width
- m_maxLabelWidth
;
533 holdRightWidth
= m_maxLabelWidth
;
534 if ( HasFlag(wxSL_INVERSE
) )
536 wxSwap(holdLeftWidth
, holdRightWidth
);
537 wxSwap(holdLeftX
, holdRightX
);
539 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Min
],
542 holdLeftWidth
, labelHeight
);
543 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Max
],
546 holdRightWidth
, labelHeight
);
548 if ( HasFlag(wxSL_VALUE_LABEL
) )
549 DoMoveSibling((HWND
)(*m_labels
)[SliderLabel_Value
],
551 y
+ THUMB
+ tickOffset
,
552 maxLabelWidth
, labelHeight
);
555 // position the slider itself along the top/bottom edge
556 if ( HasFlag(wxSL_MIN_MAX_LABELS
) || HasFlag(wxSL_VALUE_LABEL
) )
557 labelOffset
= labelHeight
;
558 wxSliderBase::DoMoveWindow(
559 x
+ m_minLabelWidth
+ VGAP
,
561 width
- (m_minLabelWidth
+ m_maxLabelWidth
+ (VGAP
*2)),
566 wxSize
wxSlider::DoGetBestSize() const
568 // this value is arbitrary:
569 static const int length
= 100;
573 if ( HasFlag(wxSL_VERTICAL
) )
583 int hLabel
= GetLabelsSize(&widthMin
, &widthMax
);
585 // account for the labels
586 size
.x
+= HGAP
+ wxMax(widthMin
, widthMax
);
588 // labels are indented relative to the slider itself
600 // labels add extra height
601 int labelSize
= GetLabelsSize();
602 if ( HasFlag(wxSL_MIN_MAX_LABELS
) )
604 if ( HasFlag(wxSL_VALUE_LABEL
) )
605 size
.y
+= labelSize
*2.75;
609 // need extra space to show ticks
610 if ( HasFlag(wxSL_TICKS
) )
613 // and maybe twice as much if we show them on both sides
614 if ( HasFlag(wxSL_BOTH
) )
620 // ----------------------------------------------------------------------------
621 // slider-specific methods
622 // ----------------------------------------------------------------------------
624 int wxSlider::GetValue() const
626 return ValueInvertOrNot(::SendMessage(GetHwnd(), TBM_GETPOS
, 0, 0));
629 void wxSlider::SetValue(int value
)
631 ::SendMessage(GetHwnd(), TBM_SETPOS
, (WPARAM
)TRUE
, (LPARAM
)ValueInvertOrNot(value
));
635 ::SetWindowText((*m_labels
)[SliderLabel_Value
], Format(value
).wx_str());
639 void wxSlider::SetRange(int minValue
, int maxValue
)
641 // Remember the old logical value if we need to update the physical control
642 // value after changing its range in wxSL_INVERSE case (and avoid an
643 // unnecessary call to GetValue() otherwise as it's just not needed).
644 const int valueOld
= HasFlag(wxSL_INVERSE
) ? GetValue() : 0;
646 m_rangeMin
= minValue
;
647 m_rangeMax
= maxValue
;
649 ::SendMessage(GetHwnd(), TBM_SETRANGEMIN
, TRUE
, m_rangeMin
);
650 ::SendMessage(GetHwnd(), TBM_SETRANGEMAX
, TRUE
, m_rangeMax
);
654 ::SetWindowText((*m_labels
)[SliderLabel_Min
],
655 Format(ValueInvertOrNot(m_rangeMin
)).wx_str());
656 ::SetWindowText((*m_labels
)[SliderLabel_Max
],
657 Format(ValueInvertOrNot(m_rangeMax
)).wx_str());
660 // When emulating wxSL_INVERSE style in wxWidgets, we need to update the
661 // value after changing the range to ensure that the value seen by the user
662 // code, i.e. the one returned by GetValue(), does not change.
663 if ( HasFlag(wxSL_INVERSE
) )
665 ::SendMessage(GetHwnd(), TBM_SETPOS
, TRUE
, ValueInvertOrNot(valueOld
));
669 void wxSlider::DoSetTickFreq(int n
)
672 ::SendMessage( GetHwnd(), TBM_SETTICFREQ
, (WPARAM
) n
, (LPARAM
) 0 );
675 void wxSlider::SetPageSize(int pageSize
)
677 ::SendMessage( GetHwnd(), TBM_SETPAGESIZE
, (WPARAM
) 0, (LPARAM
) pageSize
);
678 m_pageSize
= pageSize
;
681 int wxSlider::GetPageSize() const
686 void wxSlider::ClearSel()
688 ::SendMessage(GetHwnd(), TBM_CLEARSEL
, (WPARAM
) TRUE
, (LPARAM
) 0);
691 void wxSlider::ClearTicks()
693 ::SendMessage(GetHwnd(), TBM_CLEARTICS
, (WPARAM
) TRUE
, (LPARAM
) 0);
696 void wxSlider::SetLineSize(int lineSize
)
698 m_lineSize
= lineSize
;
699 ::SendMessage(GetHwnd(), TBM_SETLINESIZE
, (WPARAM
) 0, (LPARAM
) lineSize
);
702 int wxSlider::GetLineSize() const
704 return (int)::SendMessage(GetHwnd(), TBM_GETLINESIZE
, 0, 0);
707 int wxSlider::GetSelEnd() const
709 return (int)::SendMessage(GetHwnd(), TBM_GETSELEND
, 0, 0);
712 int wxSlider::GetSelStart() const
714 return (int)::SendMessage(GetHwnd(), TBM_GETSELSTART
, 0, 0);
717 void wxSlider::SetSelection(int minPos
, int maxPos
)
719 ::SendMessage(GetHwnd(), TBM_SETSEL
,
720 (WPARAM
) TRUE
/* redraw */,
721 (LPARAM
) MAKELONG( minPos
, maxPos
) );
724 void wxSlider::SetThumbLength(int len
)
726 ::SendMessage(GetHwnd(), TBM_SETTHUMBLENGTH
, (WPARAM
) len
, (LPARAM
) 0);
729 int wxSlider::GetThumbLength() const
731 return (int)::SendMessage( GetHwnd(), TBM_GETTHUMBLENGTH
, 0, 0);
734 void wxSlider::SetTick(int tickPos
)
736 ::SendMessage( GetHwnd(), TBM_SETTIC
, (WPARAM
) 0, (LPARAM
) tickPos
);
739 // ----------------------------------------------------------------------------
740 // composite control methods
741 // ----------------------------------------------------------------------------
743 WXHWND
wxSlider::GetStaticMin() const
745 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Min
] : NULL
;
748 WXHWND
wxSlider::GetStaticMax() const
750 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Max
] : NULL
;
753 WXHWND
wxSlider::GetEditValue() const
755 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Value
] : NULL
;
758 WX_FORWARD_STD_METHODS_TO_SUBWINDOWS(wxSlider
, wxSliderBase
, m_labels
)
760 #endif // wxUSE_SLIDER