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 #define USE_DEFERRED_SIZING 1
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 // indices of labels in wxSlider::m_labels
60 // the gap between the slider and the labels, in pixels
61 static const int HGAP
= 5;
63 // ----------------------------------------------------------------------------
65 // ----------------------------------------------------------------------------
67 #if wxUSE_EXTENDED_RTTI
68 WX_DEFINE_FLAGS( wxSliderStyle
)
70 wxBEGIN_FLAGS( wxSliderStyle
)
71 // new style border flags, we put them first to
72 // use them for streaming out
73 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
74 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
75 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
76 wxFLAGS_MEMBER(wxBORDER_RAISED
)
77 wxFLAGS_MEMBER(wxBORDER_STATIC
)
78 wxFLAGS_MEMBER(wxBORDER_NONE
)
80 // old style border flags
81 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
82 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
83 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
84 wxFLAGS_MEMBER(wxRAISED_BORDER
)
85 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
86 wxFLAGS_MEMBER(wxBORDER
)
88 // standard window styles
89 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
90 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
91 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
92 wxFLAGS_MEMBER(wxWANTS_CHARS
)
93 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
94 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
95 wxFLAGS_MEMBER(wxVSCROLL
)
96 wxFLAGS_MEMBER(wxHSCROLL
)
98 wxFLAGS_MEMBER(wxSL_HORIZONTAL
)
99 wxFLAGS_MEMBER(wxSL_VERTICAL
)
100 wxFLAGS_MEMBER(wxSL_AUTOTICKS
)
101 wxFLAGS_MEMBER(wxSL_LABELS
)
102 wxFLAGS_MEMBER(wxSL_LEFT
)
103 wxFLAGS_MEMBER(wxSL_TOP
)
104 wxFLAGS_MEMBER(wxSL_RIGHT
)
105 wxFLAGS_MEMBER(wxSL_BOTTOM
)
106 wxFLAGS_MEMBER(wxSL_BOTH
)
107 wxFLAGS_MEMBER(wxSL_SELRANGE
)
108 wxFLAGS_MEMBER(wxSL_INVERSE
)
110 wxEND_FLAGS( wxSliderStyle
)
112 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSlider
, wxControl
,"wx/scrolbar.h")
114 wxBEGIN_PROPERTIES_TABLE(wxSlider
)
115 wxEVENT_RANGE_PROPERTY( Scroll
, wxEVT_SCROLL_TOP
, wxEVT_SCROLL_ENDSCROLL
, wxScrollEvent
)
116 wxEVENT_PROPERTY( Updated
, wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
)
118 wxPROPERTY( Value
, int , SetValue
, GetValue
, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
119 wxPROPERTY( Minimum
, int , SetMin
, GetMin
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
120 wxPROPERTY( Maximum
, int , SetMax
, GetMax
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
121 wxPROPERTY( PageSize
, int , SetPageSize
, GetLineSize
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
122 wxPROPERTY( LineSize
, int , SetLineSize
, GetLineSize
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
123 wxPROPERTY( ThumbLength
, int , SetThumbLength
, GetThumbLength
, 1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
124 wxPROPERTY_FLAGS( WindowStyle
, wxSliderStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
125 wxEND_PROPERTIES_TABLE()
127 wxBEGIN_HANDLERS_TABLE(wxSlider
)
128 wxEND_HANDLERS_TABLE()
130 wxCONSTRUCTOR_8( wxSlider
, wxWindow
* , Parent
, wxWindowID
, Id
, int , Value
, int , Minimum
, int , Maximum
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
132 IMPLEMENT_DYNAMIC_CLASS(wxSlider
, wxControl
)
135 // ============================================================================
136 // wxSlider implementation
137 // ============================================================================
139 // ----------------------------------------------------------------------------
141 // ----------------------------------------------------------------------------
143 void wxSlider::Init()
155 wxSlider::Create(wxWindow
*parent
,
163 const wxValidator
& validator
,
164 const wxString
& name
)
166 // our styles are redundant: wxSL_LEFT/RIGHT imply wxSL_VERTICAL and
167 // wxSL_TOP/BOTTOM imply wxSL_HORIZONTAL, but for backwards compatibility
168 // reasons we can't really change it, instead try to infer the orientation
169 // from the flags given to us here
170 switch ( style
& (wxSL_LEFT
| wxSL_RIGHT
| wxSL_TOP
| wxSL_BOTTOM
) )
174 style
|= wxSL_VERTICAL
;
179 style
|= wxSL_HORIZONTAL
;
183 // no specific direction, do we have at least the orientation?
184 if ( !(style
& (wxSL_HORIZONTAL
| wxSL_VERTICAL
)) )
186 // no, choose default
187 style
|= wxSL_BOTTOM
| wxSL_HORIZONTAL
;
191 wxASSERT_MSG( !(style
& wxSL_VERTICAL
) | !(style
& wxSL_HORIZONTAL
),
192 _T("incompatible slider direction and orientation") );
195 // initialize everything
196 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
199 // ensure that we have correct values for GetLabelsSize()
200 m_rangeMin
= minValue
;
201 m_rangeMax
= maxValue
;
203 // create the labels first, so that our DoGetBestSize() could take them
206 // note that we could simply create 3 wxStaticTexts here but it could
207 // result in some observable side effects at wx level (e.g. the parent of
208 // wxSlider would have 3 more children than expected) and so we prefer not
209 // to do it like this
210 if ( m_windowStyle
& wxSL_LABELS
)
212 m_labels
= new wxSubwindows(SliderLabel_Last
);
214 HWND hwndParent
= GetHwndOf(parent
);
215 for ( size_t n
= 0; n
< SliderLabel_Last
; n
++ )
217 (*m_labels
)[n
] = ::CreateWindow
221 WS_CHILD
| WS_VISIBLE
| SS_CENTER
,
224 (HMENU
)NewControlId(),
230 m_labels
->SetFont(GetFont());
233 // now create the main control too
234 if ( !MSWCreateControl(TRACKBAR_CLASS
, wxEmptyString
, pos
, size
) )
237 // and initialize everything
238 SetRange(minValue
, maxValue
);
240 SetPageSize((maxValue
- minValue
)/10);
242 // we need to position the labels correctly if we have them and if
243 // SetSize() hadn't been called before (when best size was determined by
244 // MSWCreateControl()) as in this case they haven't been put in place yet
245 if ( m_labels
&& size
.x
!= wxDefaultCoord
&& size
.y
!= wxDefaultCoord
)
253 WXDWORD
wxSlider::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
255 WXDWORD msStyle
= wxControl::MSWGetStyle(style
, exstyle
);
257 // TBS_HORZ, TBS_RIGHT and TBS_BOTTOM are 0 but do include them for clarity
258 msStyle
|= style
& wxSL_VERTICAL
? TBS_VERT
: TBS_HORZ
;
260 if ( style
& wxSL_BOTH
)
262 // this fully specifies the style combined with TBS_VERT/HORZ above
265 else // choose one direction
267 if ( style
& wxSL_LEFT
)
269 else if ( style
& wxSL_RIGHT
)
270 msStyle
|= TBS_RIGHT
;
271 else if ( style
& wxSL_TOP
)
273 else if ( style
& wxSL_BOTTOM
)
274 msStyle
|= TBS_BOTTOM
;
277 if ( style
& wxSL_AUTOTICKS
)
278 msStyle
|= TBS_AUTOTICKS
;
280 msStyle
|= TBS_NOTICKS
;
282 if ( style
& wxSL_SELRANGE
)
283 msStyle
|= TBS_ENABLESELRANGE
;
288 wxSlider::~wxSlider()
293 // ----------------------------------------------------------------------------
295 // ----------------------------------------------------------------------------
297 bool wxSlider::MSWOnScroll(int WXUNUSED(orientation
),
299 WXWORD
WXUNUSED(pos
),
302 wxEventType scrollEvent
;
306 scrollEvent
= wxEVT_SCROLL_TOP
;
310 scrollEvent
= wxEVT_SCROLL_BOTTOM
;
314 scrollEvent
= wxEVT_SCROLL_LINEUP
;
318 scrollEvent
= wxEVT_SCROLL_LINEDOWN
;
322 scrollEvent
= wxEVT_SCROLL_PAGEUP
;
326 scrollEvent
= wxEVT_SCROLL_PAGEDOWN
;
330 scrollEvent
= wxEVT_SCROLL_THUMBTRACK
;
333 case SB_THUMBPOSITION
:
334 scrollEvent
= wxEVT_SCROLL_THUMBRELEASE
;
338 scrollEvent
= wxEVT_SCROLL_ENDSCROLL
;
342 // unknown scroll event?
346 int newPos
= ValueInvertOrNot((int) ::SendMessage((HWND
) control
, TBM_GETPOS
, 0, 0));
347 if ( (newPos
< GetMin()) || (newPos
> GetMax()) )
349 // out of range - but we did process it
355 wxScrollEvent
event(scrollEvent
, m_windowId
);
356 event
.SetPosition(newPos
);
357 event
.SetEventObject( this );
358 GetEventHandler()->ProcessEvent(event
);
360 wxCommandEvent
cevent( wxEVT_COMMAND_SLIDER_UPDATED
, GetId() );
361 cevent
.SetInt( newPos
);
362 cevent
.SetEventObject( this );
364 return GetEventHandler()->ProcessEvent( cevent
);
367 void wxSlider::Command (wxCommandEvent
& event
)
369 SetValue (event
.GetInt());
370 ProcessCommand (event
);
373 // ----------------------------------------------------------------------------
375 // ----------------------------------------------------------------------------
377 wxRect
wxSlider::GetBoundingBox() const
379 // take care not to call our own functions which would call us recursively
381 wxSliderBase::DoGetPosition(&x
, &y
);
382 wxSliderBase::DoGetSize(&w
, &h
);
384 wxRect
rect(x
, y
, w
, h
);
387 wxRect lrect
= m_labels
->GetBoundingBox();
388 GetParent()->ScreenToClient(&lrect
.x
, &lrect
.y
);
395 void wxSlider::DoGetSize(int *width
, int *height
) const
397 wxRect rect
= GetBoundingBox();
402 *height
= rect
.height
;
405 void wxSlider::DoGetPosition(int *x
, int *y
) const
407 wxRect rect
= GetBoundingBox();
415 int wxSlider::GetLabelsSize(int *width
) const
421 // find the max label width
422 int wLabelMin
, wLabelMax
;
423 GetTextExtent(Format(m_rangeMin
), &wLabelMin
, &cy
);
424 GetTextExtent(Format(m_rangeMax
), &wLabelMax
, &cy
);
426 *width
= wxMax(wLabelMin
, wLabelMax
);
430 cy
= GetCharHeight();
433 return EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
436 void wxSlider::DoMoveWindow(int x
, int y
, int width
, int height
)
438 // all complications below are because we need to position the labels,
439 // without them everything is easy
442 wxSliderBase::DoMoveWindow(x
, y
, width
, height
);
446 // if our parent had prepared a defer window handle for us, use it (unless
447 // we are a top level window)
448 wxWindowMSW
*parent
= GetParent();
450 #if USE_DEFERRED_SIZING
451 HDWP hdwp
= parent
&& !IsTopLevel() ? (HDWP
)parent
->m_hDWP
: NULL
;
456 // be careful to position the slider itself after moving the labels as
457 // otherwise our GetBoundingBox(), which is called from WM_SIZE handler,
458 // would return a wrong result and wrong size would be cached internally
459 if ( HasFlag(wxSL_VERTICAL
) )
462 int hLabel
= GetLabelsSize(&wLabel
);
464 int xLabel
= HasFlag(wxSL_LEFT
) ? x
+ width
- wLabel
: x
;
466 // position all labels: min at the top, value in the middle and max at
468 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Min
],
469 xLabel
, y
, wLabel
, hLabel
);
471 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Value
],
472 xLabel
, y
+ (height
- hLabel
)/2, wLabel
, hLabel
);
474 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Max
],
475 xLabel
, y
+ height
- hLabel
, wLabel
, hLabel
);
477 // position the slider itself along the left/right edge
478 wxMoveWindowDeferred(hdwp
, this, GetHwnd(),
479 HasFlag(wxSL_LEFT
) ? x
: x
+ wLabel
+ HGAP
,
481 width
- wLabel
- HGAP
,
487 int hLabel
= GetLabelsSize(&wLabel
);
489 int yLabel
= HasFlag(wxSL_TOP
) ? y
+ height
- hLabel
: y
;
491 // position all labels: min on the left, value in the middle and max to
493 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Min
],
494 x
, yLabel
, wLabel
, hLabel
);
496 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Value
],
497 x
+ (width
- wLabel
)/2, yLabel
, wLabel
, hLabel
);
499 wxMoveWindowDeferred(hdwp
, this, (*m_labels
)[SliderLabel_Max
],
500 x
+ width
- wLabel
, yLabel
, wLabel
, hLabel
);
502 // position the slider itself along the top/bottom edge
503 wxMoveWindowDeferred(hdwp
, this, GetHwnd(),
505 HasFlag(wxSL_TOP
) ? y
: y
+ hLabel
,
511 // Store the size so we can report it accurately
512 wxExtraWindowData
* extraData
= (wxExtraWindowData
*) m_windowReserved
;
515 extraData
= new wxExtraWindowData
;
516 m_windowReserved
= (void*) extraData
;
518 extraData
->m_pos
= wxPoint(x
, y
);
519 extraData
->m_size
= wxSize(width
, height
);
520 extraData
->m_deferring
= true;
522 // hdwp must be updated as it may have been changed
523 parent
->m_hDWP
= (WXHANDLE
)hdwp
;
527 wxSize
wxSlider::DoGetBestSize() const
529 // these values are arbitrary
530 static const int length
= 100;
531 static const int thumb
= 24;
532 static const int ticks
= 8;
536 if ( HasFlag(wxSL_VERTICAL
) )
545 int hLabel
= GetLabelsSize(&wLabel
);
547 // account for the labels
548 size
.x
+= HGAP
+ wLabel
;
550 // labels are indented relative to the slider itself
562 // labels add extra height
563 size
.y
+= GetLabelsSize();
567 // need extra space to show ticks
568 if ( HasFlag(wxSL_TICKS
) )
572 // and maybe twice as much if we show them on both sides
573 if ( HasFlag(wxSL_BOTH
) )
580 // ----------------------------------------------------------------------------
581 // slider-specific methods
582 // ----------------------------------------------------------------------------
584 int wxSlider::GetValue() const
586 return ValueInvertOrNot(::SendMessage(GetHwnd(), TBM_GETPOS
, 0, 0));
589 void wxSlider::SetValue(int value
)
591 ::SendMessage(GetHwnd(), TBM_SETPOS
, (WPARAM
)TRUE
, (LPARAM
)ValueInvertOrNot(value
));
595 ::SetWindowText((*m_labels
)[SliderLabel_Value
], Format(value
));
599 void wxSlider::SetRange(int minValue
, int maxValue
)
601 m_rangeMin
= minValue
;
602 m_rangeMax
= maxValue
;
604 ::SendMessage(GetHwnd(), TBM_SETRANGEMIN
, TRUE
, m_rangeMin
);
605 ::SendMessage(GetHwnd(), TBM_SETRANGEMAX
, TRUE
, m_rangeMax
);
609 ::SetWindowText((*m_labels
)[SliderLabel_Min
], Format(ValueInvertOrNot(m_rangeMin
)));
610 ::SetWindowText((*m_labels
)[SliderLabel_Max
], Format(ValueInvertOrNot(m_rangeMax
)));
614 void wxSlider::SetTickFreq(int n
, int pos
)
617 ::SendMessage( GetHwnd(), TBM_SETTICFREQ
, (WPARAM
) n
, (LPARAM
) pos
);
620 void wxSlider::SetPageSize(int pageSize
)
622 ::SendMessage( GetHwnd(), TBM_SETPAGESIZE
, (WPARAM
) 0, (LPARAM
) pageSize
);
623 m_pageSize
= pageSize
;
626 int wxSlider::GetPageSize() const
631 void wxSlider::ClearSel()
633 ::SendMessage(GetHwnd(), TBM_CLEARSEL
, (WPARAM
) TRUE
, (LPARAM
) 0);
636 void wxSlider::ClearTicks()
638 ::SendMessage(GetHwnd(), TBM_CLEARTICS
, (WPARAM
) TRUE
, (LPARAM
) 0);
641 void wxSlider::SetLineSize(int lineSize
)
643 m_lineSize
= lineSize
;
644 ::SendMessage(GetHwnd(), TBM_SETLINESIZE
, (WPARAM
) 0, (LPARAM
) lineSize
);
647 int wxSlider::GetLineSize() const
649 return (int)::SendMessage(GetHwnd(), TBM_GETLINESIZE
, 0, 0);
652 int wxSlider::GetSelEnd() const
654 return (int)::SendMessage(GetHwnd(), TBM_SETSELEND
, 0, 0);
657 int wxSlider::GetSelStart() const
659 return (int)::SendMessage(GetHwnd(), TBM_GETSELSTART
, 0, 0);
662 void wxSlider::SetSelection(int minPos
, int maxPos
)
664 ::SendMessage(GetHwnd(), TBM_SETSEL
,
665 (WPARAM
) TRUE
/* redraw */,
666 (LPARAM
) MAKELONG( minPos
, maxPos
) );
669 void wxSlider::SetThumbLength(int len
)
671 ::SendMessage(GetHwnd(), TBM_SETTHUMBLENGTH
, (WPARAM
) len
, (LPARAM
) 0);
674 int wxSlider::GetThumbLength() const
676 return (int)::SendMessage( GetHwnd(), TBM_GETTHUMBLENGTH
, 0, 0);
679 void wxSlider::SetTick(int tickPos
)
681 ::SendMessage( GetHwnd(), TBM_SETTIC
, (WPARAM
) 0, (LPARAM
) tickPos
);
684 // ----------------------------------------------------------------------------
685 // composite control methods
686 // ----------------------------------------------------------------------------
688 WXHWND
wxSlider::GetStaticMin() const
690 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Min
] : NULL
;
693 WXHWND
wxSlider::GetStaticMax() const
695 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Max
] : NULL
;
698 WXHWND
wxSlider::GetEditValue() const
700 return m_labels
? (WXHWND
)(*m_labels
)[SliderLabel_Value
] : NULL
;
703 WX_FORWARD_STD_METHODS_TO_SUBWINDOWS(wxSlider
, wxSliderBase
, m_labels
)
705 #endif // wxUSE_SLIDER