1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
18 #pragma implementation "slider95.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
25 // For compilers that support precompilation, includes "wx.h".
26 #include "wx/wxprec.h"
38 #include "wx/slider.h"
39 #include "wx/msw/subwin.h"
41 #if !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 // indices of labels in wxSlider::m_labels
58 // the gap between the slider and the labels, in pixels
59 static const int HGAP
= 5;
61 // ----------------------------------------------------------------------------
63 // ----------------------------------------------------------------------------
65 #if wxUSE_EXTENDED_RTTI
66 WX_DEFINE_FLAGS( wxSliderStyle
)
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
)
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
)
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
)
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 wxFLAGS_MEMBER(wxSL_INVERSE
)
108 wxEND_FLAGS( wxSliderStyle
)
110 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSlider
, wxControl
,"wx/scrolbar.h")
112 wxBEGIN_PROPERTIES_TABLE(wxSlider
)
113 wxEVENT_RANGE_PROPERTY( Scroll
, wxEVT_SCROLL_TOP
, wxEVT_SCROLL_ENDSCROLL
, wxScrollEvent
)
114 wxEVENT_PROPERTY( Updated
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
)
116 wxPROPERTY( Value
, int , SetValue
, GetValue
, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
117 wxPROPERTY( Minimum
, int , SetMin
, GetMin
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
118 wxPROPERTY( Maximum
, int , SetMax
, GetMax
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
119 wxPROPERTY( PageSize
, int , SetPageSize
, GetLineSize
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
120 wxPROPERTY( LineSize
, int , SetLineSize
, GetLineSize
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
121 wxPROPERTY( ThumbLength
, int , SetThumbLength
, GetThumbLength
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
122 wxPROPERTY_FLAGS( WindowStyle
, wxSliderStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
123 wxEND_PROPERTIES_TABLE()
125 wxBEGIN_HANDLERS_TABLE(wxSlider
)
126 wxEND_HANDLERS_TABLE()
128 wxCONSTRUCTOR_8( wxSlider
, wxWindow
* , Parent
, wxWindowID
, Id
, int , Value
, int , Minimum
, int , Maximum
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
130 IMPLEMENT_DYNAMIC_CLASS(wxSlider
, wxControl
)
133 // ============================================================================
134 // wxSlider implementation
135 // ============================================================================
137 // ----------------------------------------------------------------------------
139 // ----------------------------------------------------------------------------
141 void wxSlider::Init()
153 wxSlider::Create(wxWindow
*parent
,
161 const wxValidator
& validator
,
162 const wxString
& name
)
164 // our styles are redundant: wxSL_LEFT/RIGHT imply wxSL_VERTICAL and
165 // wxSL_TOP/BOTTOM imply wxSL_HORIZONTAL, but for backwards compatibility
166 // reasons we can't really change it, instead try to infer the orientation
167 // from the flags given to us here
168 switch ( style
& (wxSL_LEFT
| wxSL_RIGHT
| wxSL_TOP
| wxSL_BOTTOM
) )
172 style
|= wxSL_VERTICAL
;
177 style
|= wxSL_HORIZONTAL
;
181 // no specific direction, do we have at least the orientation?
182 if ( !(style
& (wxSL_HORIZONTAL
| wxSL_VERTICAL
)) )
184 // no, choose default
185 style
|= wxSL_BOTTOM
| wxSL_HORIZONTAL
;
189 wxASSERT_MSG( !(style
& wxSL_VERTICAL
) | !(style
& wxSL_HORIZONTAL
),
190 _T("incompatible slider direction and orientation") );
193 // initialize everything
194 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
197 // ensure that we have correct values for GetLabelsSize()
198 m_rangeMin
= minValue
;
199 m_rangeMax
= maxValue
;
201 // create the labels first, so that our DoGetBestSize() could take them
204 // note that we could simply create 3 wxStaticTexts here but it could
205 // result in some observable side effects at wx level (e.g. the parent of
206 // wxSlider would have 3 more children than expected) and so we prefer not
207 // to do it like this
208 if ( m_windowStyle
& wxSL_LABELS
)
210 m_labels
= new wxSubwindows(SliderLabel_Last
);
212 HWND hwndParent
= GetHwndOf(parent
);
213 for ( size_t n
= 0; n
< SliderLabel_Last
; n
++ )
215 (*m_labels
)[n
] = ::CreateWindow
219 WS_CHILD
| WS_VISIBLE
| SS_CENTER
,
222 (HMENU
)NewControlId(),
228 m_labels
->SetFont(GetFont());
231 // now create the main control too
232 if ( !MSWCreateControl(TRACKBAR_CLASS
, wxEmptyString
, pos
, size
) )
235 // and initialize everything
236 SetRange(minValue
, maxValue
);
238 SetPageSize((maxValue
- minValue
)/10);
240 // we need to position the labels correctly if we have them and if
241 // SetSize() hadn't been called before (when best size was determined by
242 // MSWCreateControl()) as in this case they haven't been put in place yet
243 if ( m_labels
&& size
.x
!= wxDefaultCoord
&& size
.y
!= wxDefaultCoord
)
251 WXDWORD
wxSlider::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
253 WXDWORD msStyle
= wxControl::MSWGetStyle(style
, exstyle
);
255 // TBS_HORZ, TBS_RIGHT and TBS_BOTTOM are 0 but do include them for clarity
256 msStyle
|= style
& wxSL_VERTICAL
? TBS_VERT
: TBS_HORZ
;
258 if ( style
& wxSL_BOTH
)
260 // this fully specifies the style combined with TBS_VERT/HORZ above
263 else // choose one direction
265 if ( style
& wxSL_LEFT
)
267 else if ( style
& wxSL_RIGHT
)
268 msStyle
|= TBS_RIGHT
;
269 else if ( style
& wxSL_TOP
)
271 else if ( style
& wxSL_BOTTOM
)
272 msStyle
|= TBS_BOTTOM
;
275 if ( style
& wxSL_AUTOTICKS
)
276 msStyle
|= TBS_AUTOTICKS
;
278 msStyle
|= TBS_NOTICKS
;
280 if ( style
& wxSL_SELRANGE
)
281 msStyle
|= TBS_ENABLESELRANGE
;
286 wxSlider::~wxSlider()
291 // ----------------------------------------------------------------------------
293 // ----------------------------------------------------------------------------
295 bool wxSlider::MSWOnScroll(int WXUNUSED(orientation
),
297 WXWORD
WXUNUSED(pos
),
300 wxEventType scrollEvent
;
304 scrollEvent
= wxEVT_SCROLL_TOP
;
308 scrollEvent
= wxEVT_SCROLL_BOTTOM
;
312 scrollEvent
= wxEVT_SCROLL_LINEUP
;
316 scrollEvent
= wxEVT_SCROLL_LINEDOWN
;
320 scrollEvent
= wxEVT_SCROLL_PAGEUP
;
324 scrollEvent
= wxEVT_SCROLL_PAGEDOWN
;
328 scrollEvent
= wxEVT_SCROLL_THUMBTRACK
;
331 case SB_THUMBPOSITION
:
332 scrollEvent
= wxEVT_SCROLL_THUMBRELEASE
;
336 scrollEvent
= wxEVT_SCROLL_ENDSCROLL
;
340 // unknown scroll event?
344 int newPos
= ValueInvertOrNot((int) ::SendMessage((HWND
) control
, TBM_GETPOS
, 0, 0));
345 if ( (newPos
< GetMin()) || (newPos
> GetMax()) )
347 // out of range - but we did process it
353 wxScrollEvent
event(scrollEvent
, m_windowId
);
354 event
.SetPosition(newPos
);
355 event
.SetEventObject( this );
356 GetEventHandler()->ProcessEvent(event
);
358 wxCommandEvent
cevent( wxEVT_COMMAND_SLIDER_UPDATED
, GetId() );
359 cevent
.SetInt( newPos
);
360 cevent
.SetEventObject( this );
362 return GetEventHandler()->ProcessEvent( cevent
);
365 void wxSlider::Command (wxCommandEvent
& event
)
367 SetValue (event
.GetInt());
368 ProcessCommand (event
);
371 // ----------------------------------------------------------------------------
373 // ----------------------------------------------------------------------------
375 wxRect
wxSlider::GetBoundingBox() const
377 // take care not to call our own functions which would call us recursively
379 wxSliderBase::DoGetPosition(&x
, &y
);
380 wxSliderBase::DoGetSize(&w
, &h
);
382 wxRect
rect(x
, y
, w
, h
);
385 wxRect lrect
= m_labels
->GetBoundingBox();
386 GetParent()->ScreenToClient(&lrect
.x
, &lrect
.y
);
393 void wxSlider::DoGetSize(int *width
, int *height
) const
395 wxRect rect
= GetBoundingBox();
400 *height
= rect
.height
;
403 void wxSlider::DoGetPosition(int *x
, int *y
) const
405 wxRect rect
= GetBoundingBox();
413 int wxSlider::GetLabelsSize(int *width
) const
419 // find the max label width
420 int wLabelMin
, wLabelMax
;
421 GetTextExtent(Format(m_rangeMin
), &wLabelMin
, &cy
);
422 GetTextExtent(Format(m_rangeMax
), &wLabelMax
, &cy
);
424 *width
= wxMax(wLabelMin
, wLabelMax
);
428 cy
= GetCharHeight();
431 return EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
434 void wxSlider::DoMoveWindow(int x
, int y
, int width
, int height
)
436 // all complications below are because we need to position the labels,
437 // without them everything is easy
440 wxSliderBase::DoMoveWindow(x
, y
, width
, height
);
444 // be careful to position the slider itself after moving the labels as
445 // otherwise our GetBoundingBox(), which is called from WM_SIZE handler,
446 // would return a wrong result and wrong size would be cached internally
447 if ( HasFlag(wxSL_VERTICAL
) )
450 int hLabel
= GetLabelsSize(&wLabel
);
452 int xLabel
= HasFlag(wxSL_LEFT
) ? x
+ width
- wLabel
: x
;
454 // position all labels: min at the top, value in the middle and max at
456 ::MoveWindow((*m_labels
)[SliderLabel_Min
],
457 xLabel
, y
, wLabel
, hLabel
, TRUE
);
459 ::MoveWindow((*m_labels
)[SliderLabel_Value
],
460 xLabel
, y
+ (height
- hLabel
)/2, wLabel
, hLabel
, TRUE
);
462 ::MoveWindow((*m_labels
)[SliderLabel_Max
],
463 xLabel
, y
+ height
- hLabel
, wLabel
, hLabel
, TRUE
);
465 // position the slider itself along the left/right edge
466 ::MoveWindow(GetHwnd(),
467 HasFlag(wxSL_LEFT
) ? x
: x
+ wLabel
+ HGAP
,
469 width
- wLabel
- HGAP
,
476 int hLabel
= GetLabelsSize(&wLabel
);
478 int yLabel
= HasFlag(wxSL_TOP
) ? y
+ height
- hLabel
: y
;
480 // position all labels: min on the left, value in the middle and max to
482 ::MoveWindow((*m_labels
)[SliderLabel_Min
],
483 x
, yLabel
, wLabel
, hLabel
, TRUE
);
485 ::MoveWindow((*m_labels
)[SliderLabel_Value
],
486 x
+ (width
- wLabel
)/2, yLabel
, wLabel
, hLabel
, TRUE
);
488 ::MoveWindow((*m_labels
)[SliderLabel_Max
],
489 x
+ width
- wLabel
, yLabel
, wLabel
, hLabel
, TRUE
);
491 // position the slider itself along the top/bottom edge
492 ::MoveWindow(GetHwnd(),
494 HasFlag(wxSL_TOP
) ? y
: y
+ hLabel
,
501 wxSize
wxSlider::DoGetBestSize() const
503 // these values are arbitrary
504 static const int length
= 100;
505 static const int thumb
= 24;
506 static const int ticks
= 8;
510 if ( HasFlag(wxSL_VERTICAL
) )
519 int hLabel
= GetLabelsSize(&wLabel
);
521 // account for the labels
522 size
.x
+= HGAP
+ wLabel
;
524 // labels are indented relative to the slider itself
536 // labels add extra height
537 size
.y
+= GetLabelsSize();
541 // need extra space to show ticks
542 if ( HasFlag(wxSL_TICKS
) )
546 // and maybe twice as much if we show them on both sides
547 if ( HasFlag(wxSL_BOTH
) )
554 // ----------------------------------------------------------------------------
555 // slider-specific methods
556 // ----------------------------------------------------------------------------
558 int wxSlider::GetValue() const
560 return ValueInvertOrNot(::SendMessage(GetHwnd(), TBM_GETPOS
, 0, 0));
563 void wxSlider::SetValue(int value
)
565 ::SendMessage(GetHwnd(), TBM_SETPOS
, (WPARAM
)TRUE
, (LPARAM
)ValueInvertOrNot(value
));
569 ::SetWindowText((*m_labels
)[SliderLabel_Value
], Format(value
));
573 void wxSlider::SetRange(int minValue
, int maxValue
)
575 m_rangeMin
= minValue
;
576 m_rangeMax
= maxValue
;
578 ::SendMessage(GetHwnd(), TBM_SETRANGEMIN
, TRUE
, m_rangeMin
);
579 ::SendMessage(GetHwnd(), TBM_SETRANGEMAX
, TRUE
, m_rangeMax
);
583 ::SetWindowText((*m_labels
)[SliderLabel_Min
], Format(ValueInvertOrNot(m_rangeMin
)));
584 ::SetWindowText((*m_labels
)[SliderLabel_Max
], Format(ValueInvertOrNot(m_rangeMax
)));
588 void wxSlider::SetTickFreq(int n
, int pos
)
591 ::SendMessage( GetHwnd(), TBM_SETTICFREQ
, (WPARAM
) n
, (LPARAM
) pos
);
594 void wxSlider::SetPageSize(int pageSize
)
596 ::SendMessage( GetHwnd(), TBM_SETPAGESIZE
, (WPARAM
) 0, (LPARAM
) pageSize
);
597 m_pageSize
= pageSize
;
600 int wxSlider::GetPageSize() const
605 void wxSlider::ClearSel()
607 ::SendMessage(GetHwnd(), TBM_CLEARSEL
, (WPARAM
) TRUE
, (LPARAM
) 0);
610 void wxSlider::ClearTicks()
612 ::SendMessage(GetHwnd(), TBM_CLEARTICS
, (WPARAM
) TRUE
, (LPARAM
) 0);
615 void wxSlider::SetLineSize(int lineSize
)
617 m_lineSize
= lineSize
;
618 ::SendMessage(GetHwnd(), TBM_SETLINESIZE
, (WPARAM
) 0, (LPARAM
) lineSize
);
621 int wxSlider::GetLineSize() const
623 return (int)::SendMessage(GetHwnd(), TBM_GETLINESIZE
, 0, 0);
626 int wxSlider::GetSelEnd() const
628 return (int)::SendMessage(GetHwnd(), TBM_SETSELEND
, 0, 0);
631 int wxSlider::GetSelStart() const
633 return (int)::SendMessage(GetHwnd(), TBM_GETSELSTART
, 0, 0);
636 void wxSlider::SetSelection(int minPos
, int maxPos
)
638 ::SendMessage(GetHwnd(), TBM_SETSEL
,
639 (WPARAM
) TRUE
/* redraw */,
640 (LPARAM
) MAKELONG( minPos
, maxPos
) );
643 void wxSlider::SetThumbLength(int len
)
645 ::SendMessage(GetHwnd(), TBM_SETTHUMBLENGTH
, (WPARAM
) len
, (LPARAM
) 0);
648 int wxSlider::GetThumbLength() const
650 return (int)::SendMessage( GetHwnd(), TBM_GETTHUMBLENGTH
, 0, 0);
653 void wxSlider::SetTick(int tickPos
)
655 ::SendMessage( GetHwnd(), TBM_SETTIC
, (WPARAM
) 0, (LPARAM
) tickPos
);
658 // ----------------------------------------------------------------------------
659 // composite control methods
660 // ----------------------------------------------------------------------------
662 WXHWND
wxSlider::GetStaticMin() const
664 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Min
] : NULL
;
667 WXHWND
wxSlider::GetStaticMax() const
669 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Max
] : NULL
;
672 WXHWND
wxSlider::GetEditValue() const
674 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Value
] : NULL
;
677 WX_FORWARD_STD_METHODS_TO_SUBWINDOWS(wxSlider
, wxSliderBase
, m_labels
)
679 #endif // wxUSE_SLIDER