/////////////////////////////////////////////////////////////////////////////
-// Name: scrolbar.cpp
+// Name: src/msw/scrolbar.cpp
// Purpose: wxScrollBar
// Author: Julian Smart
// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "scrolbar.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
+#if wxUSE_SCROLLBAR
+
+#include "wx/scrolbar.h"
+
#ifndef WX_PRECOMP
-#include "wx/defs.h"
-#include "wx/utils.h"
+ #include "wx/utils.h"
+ #include "wx/settings.h"
#endif
-#include "wx/scrolbar.h"
#include "wx/msw/private.h"
-// extern wxList wxScrollBarList;
-extern void wxFindMaxSize(HWND hwnd, RECT *rect);
-
-#if !USE_SHARED_LIBRARY
+#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxScrollBarStyle )
+
+wxBEGIN_FLAGS( wxScrollBarStyle )
+ // new style border flags, we put them first to
+ // use them for streaming out
+ wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+ wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+ wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+ wxFLAGS_MEMBER(wxBORDER_RAISED)
+ wxFLAGS_MEMBER(wxBORDER_STATIC)
+ wxFLAGS_MEMBER(wxBORDER_NONE)
+
+ // old style border flags
+ wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+ wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+ wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+ wxFLAGS_MEMBER(wxRAISED_BORDER)
+ wxFLAGS_MEMBER(wxSTATIC_BORDER)
+ wxFLAGS_MEMBER(wxBORDER)
+
+ // standard window styles
+ wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+ wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+ wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+ wxFLAGS_MEMBER(wxWANTS_CHARS)
+ wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+ wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+ wxFLAGS_MEMBER(wxVSCROLL)
+ wxFLAGS_MEMBER(wxHSCROLL)
+
+ wxFLAGS_MEMBER(wxSB_HORIZONTAL)
+ wxFLAGS_MEMBER(wxSB_VERTICAL)
+
+wxEND_FLAGS( wxScrollBarStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxScrollBar, wxControl,"wx/scrolbar.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxScrollBar)
+ wxEVENT_RANGE_PROPERTY( Scroll , wxEVT_SCROLL_TOP , wxEVT_SCROLL_CHANGED , wxScrollEvent )
+
+ wxPROPERTY( ThumbPosition , int , SetThumbPosition, GetThumbPosition, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY( Range , int , SetRange, GetRange, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY( ThumbSize , int , SetThumbSize, GetThumbSize, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY( PageSize , int , SetPageSize, GetPageSize, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY_FLAGS( WindowStyle , wxScrollBarStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxScrollBar)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_5( wxScrollBar , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
+#else
IMPLEMENT_DYNAMIC_CLASS(wxScrollBar, wxControl)
-
-BEGIN_EVENT_TABLE(wxScrollBar, wxControl)
-#if WXWIN_COMPATIBILITY
- EVT_SCROLL(wxScrollBar::OnScroll)
-#endif
-END_EVENT_TABLE()
-
#endif
// Scrollbar
const wxValidator& validator,
const wxString& name)
{
- if (!parent)
- return FALSE;
- parent->AddChild(this);
- SetName(name);
- SetValidator(validator);
-
- SetBackgroundColour(parent->GetBackgroundColour()) ;
- SetForegroundColour(parent->GetForegroundColour()) ;
- m_windowStyle = style;
-
- if ( id == -1 )
- m_windowId = (int)NewControlId();
- else
- m_windowId = id;
-
- int x = pos.x;
- int y = pos.y;
- int width = size.x;
- int height = size.y;
-
- if (width == -1)
- {
- if (style & wxHORIZONTAL)
- width = 140;
- else
- width = 14;
- }
- if (height == -1)
- {
- if (style & wxVERTICAL)
- height = 140;
- else
- height = 14;
- }
-
- // Now create scrollbar
- DWORD _direction = (style & wxHORIZONTAL) ?
- SBS_HORZ: SBS_VERT;
- HWND scroll_bar = CreateWindowEx(MakeExtendedStyle(style), "SCROLLBAR", "scrollbar",
- _direction | WS_CHILD | WS_VISIBLE,
- 0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
- wxGetInstance(), NULL);
-
- m_pageSize = 1;
- m_viewSize = 1;
- m_objectSize = 1;
+ if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+ return false;
- ::SetScrollRange(scroll_bar, SB_CTL, 0, 1, FALSE);
- ::SetScrollPos(scroll_bar, SB_CTL, 0, FALSE);
- ShowWindow(scroll_bar, SW_SHOW);
+ if (!MSWCreateControl(wxT("ScrollBar"), wxEmptyString, pos, size))
+ return false;
- SetFont(* parent->GetFont());
+ SetScrollbar(0, 1, 2, 1, false);
- m_hWnd = (WXHWND)scroll_bar;
-
- // Subclass again for purposes of dialog editing mode
- SubclassWin((WXHWND) scroll_bar);
-
- SetSize(x, y, width, height);
-
- return TRUE;
+ return true;
}
wxScrollBar::~wxScrollBar(void)
{
}
-void wxScrollBar::MSWOnVScroll(WXWORD wParam, WXWORD pos, WXHWND control)
+bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
+ WXWORD pos, WXHWND WXUNUSED(control))
{
- int position = ::GetScrollPos((HWND) control, SB_CTL);
- int minPos, maxPos;
- ::GetScrollRange((HWND) control, SB_CTL, &minPos, &maxPos);
-#if defined(__WIN95__)
- // A page size greater than one has the effect of reducing the
- // effective range, therefore the range has already been
- // boosted artificially - so reduce it again.
- if ( m_pageSize > 1 )
- maxPos -= (m_pageSize - 1);
+ // current and max positions
+ int position,
+ maxPos, trackPos = pos;
+
+ wxUnusedVar(trackPos);
+
+ // when we're dragging the scrollbar we can't use pos parameter because it
+ // is limited to 16 bits
+ // JACS: now always using GetScrollInfo, since there's no reason
+ // not to
+// if ( wParam == SB_THUMBPOSITION || wParam == SB_THUMBTRACK )
+ {
+ SCROLLINFO scrollInfo;
+ wxZeroMemory(scrollInfo);
+ scrollInfo.cbSize = sizeof(SCROLLINFO);
+
+ // also get the range if we call GetScrollInfo() anyhow -- this is less
+ // expensive than call it once here and then call GetScrollRange()
+ // below
+ scrollInfo.fMask = SIF_RANGE | SIF_POS | SIF_TRACKPOS;
+
+ if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
+ {
+ wxLogLastError(_T("GetScrollInfo"));
+ }
+
+ trackPos = scrollInfo.nTrackPos;
+ position = scrollInfo.nPos;
+ maxPos = scrollInfo.nMax;
+ }
+#if 0
+ else
+ {
+ position = ::GetScrollPos((HWND) control, SB_CTL);
+ int minPos;
+ ::GetScrollRange((HWND) control, SB_CTL, &minPos, &maxPos);
+ }
#endif
+ // A page size greater than one has the effect of reducing the effective
+ // range, therefore the range has already been boosted artificially - so
+ // reduce it again.
+ if ( m_pageSize > 1 )
+ maxPos -= (m_pageSize - 1);
+
wxEventType scrollEvent = wxEVT_NULL;
int nScrollInc;
switch ( wParam )
{
- case SB_TOP:
- nScrollInc = maxPos - position;
- scrollEvent = wxEVT_SCROLL_TOP;
- break;
-
- case SB_BOTTOM:
- nScrollInc = - position;
- scrollEvent = wxEVT_SCROLL_BOTTOM;
- break;
-
- case SB_LINEUP:
- nScrollInc = -1;
- scrollEvent = wxEVT_SCROLL_LINEUP;
- break;
-
- case SB_LINEDOWN:
- nScrollInc = 1;
- scrollEvent = wxEVT_SCROLL_LINEDOWN;
- break;
-
- case SB_PAGEUP:
- nScrollInc = -GetPageSize();
- scrollEvent = wxEVT_SCROLL_PAGEUP;
- break;
-
- case SB_PAGEDOWN:
- nScrollInc = GetPageSize();
- scrollEvent = wxEVT_SCROLL_PAGEDOWN;
- break;
-
- case SB_THUMBTRACK:
- case SB_THUMBPOSITION:
- nScrollInc = pos - position;
- scrollEvent = wxEVT_SCROLL_THUMBTRACK;
- break;
-
- default:
- nScrollInc = 0;
+ case SB_TOP:
+ nScrollInc = maxPos - position;
+ scrollEvent = wxEVT_SCROLL_TOP;
+ break;
+
+ case SB_BOTTOM:
+ nScrollInc = -position;
+ scrollEvent = wxEVT_SCROLL_BOTTOM;
+ break;
+
+ case SB_LINEUP:
+ nScrollInc = -1;
+ scrollEvent = wxEVT_SCROLL_LINEUP;
+ break;
+
+ case SB_LINEDOWN:
+ nScrollInc = 1;
+ scrollEvent = wxEVT_SCROLL_LINEDOWN;
+ break;
+
+ case SB_PAGEUP:
+ nScrollInc = -GetPageSize();
+ scrollEvent = wxEVT_SCROLL_PAGEUP;
+ break;
+
+ case SB_PAGEDOWN:
+ nScrollInc = GetPageSize();
+ scrollEvent = wxEVT_SCROLL_PAGEDOWN;
+ break;
+
+ case SB_THUMBPOSITION:
+ nScrollInc = trackPos - position;
+ scrollEvent = wxEVT_SCROLL_THUMBRELEASE;
+ break;
+
+ case SB_THUMBTRACK:
+ nScrollInc = trackPos - position;
+ scrollEvent = wxEVT_SCROLL_THUMBTRACK;
+ break;
+
+ case SB_ENDSCROLL:
+ nScrollInc = 0;
+ scrollEvent = wxEVT_SCROLL_CHANGED;
+ break;
+
+ default:
+ nScrollInc = 0;
}
- if (nScrollInc != 0)
+ if ( nScrollInc )
{
- int new_pos = position + nScrollInc;
-
- if (new_pos < 0)
- new_pos = 0;
- if (new_pos > maxPos)
- new_pos = maxPos;
-
- SetThumbPosition(new_pos);
- wxScrollEvent event(scrollEvent, m_windowId);
- event.SetPosition(new_pos);
- event.SetEventObject( this );
- GetEventHandler()->ProcessEvent(event);
+ position += nScrollInc;
+
+ if ( position < 0 )
+ position = 0;
+ if ( position > maxPos )
+ position = maxPos;
+
+ SetThumbPosition(position);
+ }
+ else if ( scrollEvent != wxEVT_SCROLL_THUMBRELEASE &&
+ scrollEvent != wxEVT_SCROLL_CHANGED )
+ {
+ // don't process the event if there is no displacement,
+ // unless this is a thumb release or end scroll event.
+ return false;
}
-}
-void wxScrollBar::MSWOnHScroll(WXWORD wParam, WXWORD pos, WXHWND control)
-{
- MSWOnVScroll(wParam, pos, control);
+ wxScrollEvent event(scrollEvent, m_windowId);
+ event.SetOrientation(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
+ event.SetPosition(position);
+ event.SetEventObject( this );
+
+ return GetEventHandler()->ProcessEvent(event);
}
void wxScrollBar::SetThumbPosition(int viewStart)
{
-#if defined(__WIN95__)
- SCROLLINFO info;
- info.cbSize = sizeof(SCROLLINFO);
- info.nPage = 0;
- info.nMin = 0;
- info.nPos = viewStart;
- info.fMask = SIF_POS ;
-
- ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
-#else
- ::SetScrollPos((HWND) GetHWND(), SB_CTL, viewStart, TRUE);
-#endif
+ SCROLLINFO info;
+ info.cbSize = sizeof(SCROLLINFO);
+ info.nPage = 0;
+ info.nMin = 0;
+ info.nPos = viewStart;
+ info.fMask = SIF_POS ;
+
+ ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
}
int wxScrollBar::GetThumbPosition(void) const
{
- return ::GetScrollPos((HWND)m_hWnd, SB_CTL);
+ SCROLLINFO scrollInfo;
+ wxZeroMemory(scrollInfo);
+ scrollInfo.cbSize = sizeof(SCROLLINFO);
+ scrollInfo.fMask = SIF_POS;
+
+ if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
+ {
+ wxLogLastError(_T("GetScrollInfo"));
+ }
+ return scrollInfo.nPos;
+// return ::GetScrollPos((HWND)m_hWnd, SB_CTL);
}
void wxScrollBar::SetScrollbar(int position, int thumbSize, int range, int pageSize,
bool refresh)
{
- m_viewSize = pageSize;
- m_pageSize = thumbSize;
- m_objectSize = range;
-
- // The range (number of scroll steps) is the
- // object length minus the page size.
- int range1 = wxMax((m_objectSize - m_pageSize), 0) ;
-
-#if defined(__WIN95__)
- // Try to adjust the range to cope with page size > 1
- // (see comment for SetPageLength)
- if ( m_pageSize > 1 )
- {
- range1 += (m_pageSize - 1);
- }
-
- SCROLLINFO info;
- info.cbSize = sizeof(SCROLLINFO);
- info.nPage = m_pageSize;
- info.nMin = 0;
- info.nMax = range1;
- info.nPos = position;
-
- info.fMask = SIF_PAGE | SIF_RANGE | SIF_POS;
-
- ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, refresh);
-#else
- ::SetScrollPos((HWND)m_hWnd, SB_CTL, position, TRUE);
- ::SetScrollRange((HWND)m_hWnd, SB_CTL, 0, range1, TRUE);
-#endif
-}
+ m_viewSize = pageSize;
+ m_pageSize = thumbSize;
+ m_objectSize = range;
+ // The range (number of scroll steps) is the
+ // object length minus the page size.
+ int range1 = wxMax((m_objectSize - m_pageSize), 0) ;
-/* From the WIN32 documentation:
-In version 4.0 or later, the maximum value that a scroll bar can report
-(that is, the maximum scrolling position) depends on the page size.
-If the scroll bar has a page size greater than one, the maximum scrolling position
-is less than the maximum range value. You can use the following formula to calculate
-the maximum scrolling position:
-
-MaxScrollPos = MaxRangeValue - (PageSize - 1)
-*/
+ // Try to adjust the range to cope with page size > 1
+ // (see comment for SetPageLength)
+ if ( m_pageSize > 1 )
+ {
+ range1 += (m_pageSize - 1);
+ }
-#if WXWIN_COMPATIBILITY
-void wxScrollBar::SetPageSize(int pageLength)
-{
- m_pageSize = pageLength;
+ SCROLLINFO info;
+ info.cbSize = sizeof(SCROLLINFO);
+ info.nPage = m_pageSize;
+ info.nMin = 0;
+ info.nMax = range1;
+ info.nPos = position;
-#if defined(__WIN95__)
- SCROLLINFO info;
- info.cbSize = sizeof(SCROLLINFO);
- info.nPage = pageLength;
- info.fMask = SIF_PAGE ;
+ info.fMask = SIF_PAGE | SIF_RANGE | SIF_POS;
- ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
-#endif
+ ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, refresh);
}
-void wxScrollBar::SetObjectLength(int objectLength)
+void wxScrollBar::Command(wxCommandEvent& event)
{
- m_objectSize = objectLength;
-
- // The range (number of scroll steps) is the
- // object length minus the view size.
- int range = wxMax((objectLength - m_viewSize), 0) ;
-
-#if defined(__WIN95__)
- // Try to adjust the range to cope with page size > 1
- // (see comment for SetPageLength)
- if ( m_pageSize > 1 )
- {
- range += (m_pageSize - 1);
- }
-
- SCROLLINFO info;
- info.cbSize = sizeof(SCROLLINFO);
- info.nPage = 0;
- info.nMin = 0;
- info.nMax = range;
- info.nPos = 0;
- info.fMask = SIF_RANGE ;
-
- ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
-#else
- ::SetScrollRange((HWND)m_hWnd, SB_CTL, 0, range, TRUE);
-#endif
+ SetThumbPosition(event.GetInt());
+ ProcessCommand(event);
}
-void wxScrollBar::SetViewLength(int viewLength)
+wxSize wxScrollBar::DoGetBestSize() const
{
- m_viewSize = viewLength;
-}
+ int w = 100;
+ int h = 100;
-void wxScrollBar::GetValues(int *viewStart, int *viewLength, int *objectLength,
- int *pageLength) const
-{
- *viewStart = ::GetScrollPos((HWND)m_hWnd, SB_CTL);
- *viewLength = m_viewSize;
- *objectLength = m_objectSize;
- *pageLength = m_pageSize;
-}
-#endif
+ if ( IsVertical() )
+ {
+ w = wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
+ }
+ else
+ {
+ h = wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
+ }
-WXHBRUSH wxScrollBar::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
- WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
-{
- return 0;
+ wxSize best(w, h);
+ CacheBestSize(best);
+ return best;
}
-void wxScrollBar::Command(wxCommandEvent& event)
+WXDWORD wxScrollBar::MSWGetStyle(long style, WXDWORD *exstyle) const
{
- SetThumbPosition(event.m_commandInt);
- ProcessCommand(event);
+ // we never have an external border
+ WXDWORD msStyle = wxControl::MSWGetStyle
+ (
+ (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
+ );
+
+ // SBS_HORZ is 0 anyhow, but do mention it explicitly for clarity
+ msStyle |= style & wxSB_HORIZONTAL ? SBS_HORZ : SBS_VERT;
+
+ return msStyle;
}
-#if WXWIN_COMPATIBILITY
-// Backward compatibility
-void wxScrollBar::OnScroll(wxScrollEvent& event)
+WXHBRUSH wxScrollBar::MSWControlColor(WXHDC pDC, WXHWND hWnd)
{
- wxEventType oldEvent = event.GetEventType();
- event.SetEventType( wxEVT_COMMAND_SCROLLBAR_UPDATED );
- if ( !GetEventHandler()->ProcessEvent(event) )
- {
- event.SetEventType( oldEvent );
- if (!GetParent()->GetEventHandler()->ProcessEvent(event))
- event.Skip();
- }
+ // unless we have an explicitly set bg colour, use default (gradient under
+ // XP) brush instead of GetBackgroundColour() one as the base class would
+ //
+ // note that fg colour isn't used for a scrollbar
+ return UseBgCol() ? wxControl::MSWControlColor(pDC, hWnd) : NULL;
}
-#endif
+
+#endif // wxUSE_SCROLLBAR