1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/scrolbar.cpp
3 // Purpose: wxScrollBar
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 #pragma implementation "scrolbar.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
29 #include "wx/scrolbar.h"
30 #include "wx/msw/private.h"
31 #include "wx/settings.h"
33 #if wxUSE_EXTENDED_RTTI
34 WX_DEFINE_FLAGS( wxScrollBarStyle
)
36 wxBEGIN_FLAGS( wxScrollBarStyle
)
37 // new style border flags, we put them first to
38 // use them for streaming out
39 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
40 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
41 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
42 wxFLAGS_MEMBER(wxBORDER_RAISED
)
43 wxFLAGS_MEMBER(wxBORDER_STATIC
)
44 wxFLAGS_MEMBER(wxBORDER_NONE
)
46 // old style border flags
47 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
48 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
49 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
50 wxFLAGS_MEMBER(wxRAISED_BORDER
)
51 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
52 wxFLAGS_MEMBER(wxBORDER
)
54 // standard window styles
55 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
56 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
57 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
58 wxFLAGS_MEMBER(wxWANTS_CHARS
)
59 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
60 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
61 wxFLAGS_MEMBER(wxVSCROLL
)
62 wxFLAGS_MEMBER(wxHSCROLL
)
64 wxFLAGS_MEMBER(wxSB_HORIZONTAL
)
65 wxFLAGS_MEMBER(wxSB_VERTICAL
)
67 wxEND_FLAGS( wxScrollBarStyle
)
69 IMPLEMENT_DYNAMIC_CLASS_XTI(wxScrollBar
, wxControl
,"wx/scrolbar.h")
71 wxBEGIN_PROPERTIES_TABLE(wxScrollBar
)
72 wxEVENT_RANGE_PROPERTY( Scroll
, wxEVT_SCROLL_TOP
, wxEVT_SCROLL_ENDSCROLL
, wxScrollEvent
)
74 wxPROPERTY( ThumbPosition
, int , SetThumbPosition
, GetThumbPosition
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
75 wxPROPERTY( Range
, int , SetRange
, GetRange
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
76 wxPROPERTY( ThumbSize
, int , SetThumbSize
, GetThumbSize
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
77 wxPROPERTY( PageSize
, int , SetPageSize
, GetPageSize
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
78 wxPROPERTY_FLAGS( WindowStyle
, wxScrollBarStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
79 wxEND_PROPERTIES_TABLE()
81 wxBEGIN_HANDLERS_TABLE(wxScrollBar
)
82 wxEND_HANDLERS_TABLE()
84 wxCONSTRUCTOR_5( wxScrollBar
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
86 IMPLEMENT_DYNAMIC_CLASS(wxScrollBar
, wxControl
)
90 bool wxScrollBar::Create(wxWindow
*parent
, wxWindowID id
,
92 const wxSize
& size
, long style
,
93 const wxValidator
& validator
,
96 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
99 if (!MSWCreateControl(wxT("ScrollBar"), wxEmptyString
, pos
, size
))
102 SetScrollbar(0, 1, 2, 1, false);
107 wxScrollBar::~wxScrollBar(void)
111 bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation
), WXWORD wParam
,
112 WXWORD pos
, WXHWND
WXUNUSED(control
))
114 // current and max positions
116 maxPos
, trackPos
= pos
;
118 wxUnusedVar(trackPos
);
120 // when we're dragging the scrollbar we can't use pos parameter because it
121 // is limited to 16 bits
122 // JACS: now always using GetScrollInfo, since there's no reason
124 // if ( wParam == SB_THUMBPOSITION || wParam == SB_THUMBTRACK )
126 SCROLLINFO scrollInfo
;
127 wxZeroMemory(scrollInfo
);
128 scrollInfo
.cbSize
= sizeof(SCROLLINFO
);
130 // also get the range if we call GetScrollInfo() anyhow -- this is less
131 // expensive than call it once here and then call GetScrollRange()
133 scrollInfo
.fMask
= SIF_RANGE
| SIF_POS
| SIF_TRACKPOS
;
135 if ( !::GetScrollInfo(GetHwnd(), SB_CTL
, &scrollInfo
) )
137 wxLogLastError(_T("GetScrollInfo"));
140 trackPos
= scrollInfo
.nTrackPos
;
141 position
= scrollInfo
.nPos
;
142 maxPos
= scrollInfo
.nMax
;
147 position
= ::GetScrollPos((HWND
) control
, SB_CTL
);
149 ::GetScrollRange((HWND
) control
, SB_CTL
, &minPos
, &maxPos
);
153 #if defined(__WIN95__)
154 // A page size greater than one has the effect of reducing the effective
155 // range, therefore the range has already been boosted artificially - so
157 if ( m_pageSize
> 1 )
158 maxPos
-= (m_pageSize
- 1);
161 wxEventType scrollEvent
= wxEVT_NULL
;
167 nScrollInc
= maxPos
- position
;
168 scrollEvent
= wxEVT_SCROLL_TOP
;
172 nScrollInc
= -position
;
173 scrollEvent
= wxEVT_SCROLL_BOTTOM
;
178 scrollEvent
= wxEVT_SCROLL_LINEUP
;
183 scrollEvent
= wxEVT_SCROLL_LINEDOWN
;
187 nScrollInc
= -GetPageSize();
188 scrollEvent
= wxEVT_SCROLL_PAGEUP
;
192 nScrollInc
= GetPageSize();
193 scrollEvent
= wxEVT_SCROLL_PAGEDOWN
;
196 case SB_THUMBPOSITION
:
197 nScrollInc
= trackPos
- position
;
198 scrollEvent
= wxEVT_SCROLL_THUMBRELEASE
;
202 nScrollInc
= trackPos
- position
;
203 scrollEvent
= wxEVT_SCROLL_THUMBTRACK
;
208 scrollEvent
= wxEVT_SCROLL_ENDSCROLL
;
217 position
+= nScrollInc
;
221 if ( position
> maxPos
)
224 SetThumbPosition(position
);
226 else if ( scrollEvent
!= wxEVT_SCROLL_THUMBRELEASE
&&
227 scrollEvent
!= wxEVT_SCROLL_ENDSCROLL
)
229 // don't process the event if there is no displacement,
230 // unless this is a thumb release or end scroll event.
234 wxScrollEvent
event(scrollEvent
, m_windowId
);
235 event
.SetOrientation(IsVertical() ? wxVERTICAL
: wxHORIZONTAL
);
236 event
.SetPosition(position
);
237 event
.SetEventObject( this );
239 return GetEventHandler()->ProcessEvent(event
);
242 void wxScrollBar::SetThumbPosition(int viewStart
)
244 #if defined(__WIN95__)
246 info
.cbSize
= sizeof(SCROLLINFO
);
249 info
.nPos
= viewStart
;
250 info
.fMask
= SIF_POS
;
252 ::SetScrollInfo((HWND
) GetHWND(), SB_CTL
, &info
, TRUE
);
254 ::SetScrollPos((HWND
) GetHWND(), SB_CTL
, viewStart
, TRUE
);
258 int wxScrollBar::GetThumbPosition(void) const
260 SCROLLINFO scrollInfo
;
261 wxZeroMemory(scrollInfo
);
262 scrollInfo
.cbSize
= sizeof(SCROLLINFO
);
263 scrollInfo
.fMask
= SIF_POS
;
265 if ( !::GetScrollInfo(GetHwnd(), SB_CTL
, &scrollInfo
) )
267 wxLogLastError(_T("GetScrollInfo"));
269 return scrollInfo
.nPos
;
270 // return ::GetScrollPos((HWND)m_hWnd, SB_CTL);
273 void wxScrollBar::SetScrollbar(int position
, int thumbSize
, int range
, int pageSize
,
276 m_viewSize
= pageSize
;
277 m_pageSize
= thumbSize
;
278 m_objectSize
= range
;
280 // The range (number of scroll steps) is the
281 // object length minus the page size.
282 int range1
= wxMax((m_objectSize
- m_pageSize
), 0) ;
284 #if defined(__WIN95__)
285 // Try to adjust the range to cope with page size > 1
286 // (see comment for SetPageLength)
287 if ( m_pageSize
> 1 )
289 range1
+= (m_pageSize
- 1);
293 info
.cbSize
= sizeof(SCROLLINFO
);
294 info
.nPage
= m_pageSize
;
297 info
.nPos
= position
;
299 info
.fMask
= SIF_PAGE
| SIF_RANGE
| SIF_POS
;
301 ::SetScrollInfo((HWND
) GetHWND(), SB_CTL
, &info
, refresh
);
303 ::SetScrollPos((HWND
)m_hWnd
, SB_CTL
, position
, refresh
);
304 ::SetScrollRange((HWND
)m_hWnd
, SB_CTL
, 0, range1
, refresh
);
308 void wxScrollBar::Command(wxCommandEvent
& event
)
310 SetThumbPosition(event
.GetInt());
311 ProcessCommand(event
);
314 wxSize
wxScrollBar::DoGetBestSize() const
321 w
= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
325 h
= wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
333 WXDWORD
wxScrollBar::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
335 // we never have an external border
336 WXDWORD msStyle
= wxControl::MSWGetStyle
338 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
341 // SBS_HORZ is 0 anyhow, but do mention it explicitly for clarity
342 msStyle
|= style
& wxSB_HORIZONTAL
? SBS_HORZ
: SBS_VERT
;
347 WXHBRUSH
wxScrollBar::MSWControlColor(WXHDC pDC
, WXHWND hWnd
)
349 // unless we have an explicitly set bg colour, use default (gradient under
350 // XP) brush instead of GetBackgroundColour() one as the base class would
352 // note that fg colour isn't used for a scrollbar
353 return UseBgCol() ? wxControl::MSWControlColor(pDC
, hWnd
) : NULL
;
356 #endif // wxUSE_SCROLLBAR