src/msw/scrolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/scrolbar.cpp
   3 // Purpose:     wxScrollBar
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_SCROLLBAR
  20
  21 #include "wx/scrolbar.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/utils.h"
  25     #include "wx/settings.h"
  26 #endif
  27
  28 #include "wx/msw/private.h"
  29
  30 #if wxUSE_EXTENDED_RTTI
  31 WX_DEFINE_FLAGS( wxScrollBarStyle )
  32
  33 wxBEGIN_FLAGS( wxScrollBarStyle )
  34     // new style border flags, we put them first to
  35     // use them for streaming out
  36     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  37     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  38     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  39     wxFLAGS_MEMBER(wxBORDER_RAISED)
  40     wxFLAGS_MEMBER(wxBORDER_STATIC)
  41     wxFLAGS_MEMBER(wxBORDER_NONE)
  42
  43     // old style border flags
  44     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  45     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  46     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  47     wxFLAGS_MEMBER(wxRAISED_BORDER)
  48     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  49     wxFLAGS_MEMBER(wxBORDER)
  50
  51     // standard window styles
  52     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  53     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  54     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  55     wxFLAGS_MEMBER(wxWANTS_CHARS)
  56     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  57     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  58     wxFLAGS_MEMBER(wxVSCROLL)
  59     wxFLAGS_MEMBER(wxHSCROLL)
  60
  61     wxFLAGS_MEMBER(wxSB_HORIZONTAL)
  62     wxFLAGS_MEMBER(wxSB_VERTICAL)
  63
  64 wxEND_FLAGS( wxScrollBarStyle )
  65
  66 IMPLEMENT_DYNAMIC_CLASS_XTI(wxScrollBar, wxControl,"wx/scrolbar.h")
  67
  68 wxBEGIN_PROPERTIES_TABLE(wxScrollBar)
  69     wxEVENT_RANGE_PROPERTY( Scroll , wxEVT_SCROLL_TOP , wxEVT_SCROLL_CHANGED , wxScrollEvent )
  70
  71     wxPROPERTY( ThumbPosition , int , SetThumbPosition, GetThumbPosition, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  72     wxPROPERTY( Range , int , SetRange, GetRange, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  73     wxPROPERTY( ThumbSize , int , SetThumbSize, GetThumbSize, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  74     wxPROPERTY( PageSize , int , SetPageSize, GetPageSize, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  75     wxPROPERTY_FLAGS( WindowStyle , wxScrollBarStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  76 wxEND_PROPERTIES_TABLE()
  77
  78 wxBEGIN_HANDLERS_TABLE(wxScrollBar)
  79 wxEND_HANDLERS_TABLE()
  80
  81 wxCONSTRUCTOR_5( wxScrollBar , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
  82 #else
  83 IMPLEMENT_DYNAMIC_CLASS(wxScrollBar, wxControl)
  84 #endif
  85
  86 // Scrollbar
  87 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
  88            const wxPoint& pos,
  89            const wxSize& size, long style,
  90            const wxValidator& validator,
  91            const wxString& name)
  92 {
  93     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
  94         return false;
  95
  96     if (!MSWCreateControl(wxT("ScrollBar"), wxEmptyString, pos, size))
  97         return false;
  98
  99     SetScrollbar(0, 1, 2, 1, false);
 100
 101     return true;
 102 }
 103
 104 wxScrollBar::~wxScrollBar(void)
 105 {
 106 }
 107
 108 bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
 109                               WXWORD WXUNUSED(pos), WXHWND WXUNUSED(control))
 110 {
 111     // don't use pos parameter because it is limited to 16 bits, get the full
 112     // 32 bit position from the control itself instead
 113     WinStruct<SCROLLINFO> scrollInfo;
 114     scrollInfo.fMask = SIF_RANGE | SIF_POS | SIF_TRACKPOS;
 115
 116     if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
 117     {
 118         wxLogLastError(wxT("GetScrollInfo"));
 119         return false;
 120     }
 121
 122     int maxPos = scrollInfo.nMax;
 123
 124     // A page size greater than one has the effect of reducing the effective
 125     // range, therefore the range has already been boosted artificially - so
 126     // reduce it again.
 127     if ( m_pageSize > 1 )
 128         maxPos -= (m_pageSize - 1);
 129
 130     int position = scrollInfo.nPos;
 131     wxEventType scrollEvent = wxEVT_NULL;
 132     switch ( wParam )
 133     {
 134         case SB_TOP:
 135             position = 0;
 136             scrollEvent = wxEVT_SCROLL_TOP;
 137             break;
 138
 139         case SB_BOTTOM:
 140             position = maxPos;
 141             scrollEvent = wxEVT_SCROLL_BOTTOM;
 142             break;
 143
 144         case SB_LINEUP:
 145             position--;
 146             scrollEvent = wxEVT_SCROLL_LINEUP;
 147             break;
 148
 149         case SB_LINEDOWN:
 150             position++;
 151             scrollEvent = wxEVT_SCROLL_LINEDOWN;
 152             break;
 153
 154         case SB_PAGEUP:
 155             position -= GetPageSize();
 156             scrollEvent = wxEVT_SCROLL_PAGEUP;
 157             break;
 158
 159         case SB_PAGEDOWN:
 160             position += GetPageSize();
 161             scrollEvent = wxEVT_SCROLL_PAGEDOWN;
 162             break;
 163
 164         case SB_THUMBPOSITION:
 165         case SB_THUMBTRACK:
 166             position = scrollInfo.nTrackPos;
 167             scrollEvent = wParam == SB_THUMBPOSITION ? wxEVT_SCROLL_THUMBRELEASE
 168                                                      : wxEVT_SCROLL_THUMBTRACK;
 169             break;
 170
 171         case SB_ENDSCROLL:
 172             scrollEvent = wxEVT_SCROLL_CHANGED;
 173             break;
 174     }
 175
 176     if ( position != scrollInfo.nPos )
 177     {
 178         if ( position < 0 )
 179             position = 0;
 180         if ( position > maxPos )
 181             position = maxPos;
 182
 183         SetThumbPosition(position);
 184     }
 185     else if ( scrollEvent != wxEVT_SCROLL_THUMBRELEASE &&
 186                 scrollEvent != wxEVT_SCROLL_CHANGED )
 187     {
 188         // don't process the event if there is no displacement,
 189         // unless this is a thumb release or end scroll event.
 190         return false;
 191     }
 192
 193     wxScrollEvent event(scrollEvent, m_windowId);
 194     event.SetOrientation(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
 195     event.SetPosition(position);
 196     event.SetEventObject( this );
 197
 198     return HandleWindowEvent(event);
 199 }
 200
 201 void wxScrollBar::SetThumbPosition(int viewStart)
 202 {
 203     SCROLLINFO info;
 204     info.cbSize = sizeof(SCROLLINFO);
 205     info.nPage = 0;
 206     info.nMin = 0;
 207     info.nPos = viewStart;
 208     info.fMask = SIF_POS ;
 209
 210     ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
 211 }
 212
 213 int wxScrollBar::GetThumbPosition(void) const
 214 {
 215     SCROLLINFO scrollInfo;
 216     wxZeroMemory(scrollInfo);
 217     scrollInfo.cbSize = sizeof(SCROLLINFO);
 218     scrollInfo.fMask = SIF_POS;
 219
 220     if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
 221     {
 222         wxLogLastError(wxT("GetScrollInfo"));
 223     }
 224     return scrollInfo.nPos;
 225 }
 226
 227 void wxScrollBar::SetScrollbar(int position, int thumbSize, int range, int pageSize,
 228     bool refresh)
 229 {
 230     m_viewSize = pageSize;
 231     m_pageSize = thumbSize;
 232     m_objectSize = range;
 233
 234     // The range (number of scroll steps) is the
 235     // object length minus the page size.
 236     int range1 = wxMax((m_objectSize - m_pageSize), 0) ;
 237
 238     // Try to adjust the range to cope with page size > 1
 239     // (see comment for SetPageLength)
 240     if ( m_pageSize > 1 )
 241     {
 242         range1 += (m_pageSize - 1);
 243     }
 244
 245     SCROLLINFO info;
 246     info.cbSize = sizeof(SCROLLINFO);
 247     info.nPage = m_pageSize;
 248     info.nMin = 0;
 249     info.nMax = range1;
 250     info.nPos = position;
 251
 252     info.fMask = SIF_PAGE | SIF_RANGE | SIF_POS;
 253
 254     ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, refresh);
 255 }
 256
 257 void wxScrollBar::Command(wxCommandEvent& event)
 258 {
 259     SetThumbPosition(event.GetInt());
 260     ProcessCommand(event);
 261 }
 262
 263 wxSize wxScrollBar::DoGetBestSize() const
 264 {
 265     int w = 100;
 266     int h = 100;
 267
 268     if ( IsVertical() )
 269     {
 270         w = wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 271     }
 272     else
 273     {
 274         h = wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
 275     }
 276
 277     wxSize best(w, h);
 278     CacheBestSize(best);
 279     return best;
 280 }
 281
 282 WXDWORD wxScrollBar::MSWGetStyle(long style, WXDWORD *exstyle) const
 283 {
 284     // we never have an external border
 285     WXDWORD msStyle = wxControl::MSWGetStyle
 286                       (
 287                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 288                       );
 289
 290     // SBS_HORZ is 0 anyhow, but do mention it explicitly for clarity
 291     msStyle |= style & wxSB_HORIZONTAL ? SBS_HORZ : SBS_VERT;
 292
 293     return msStyle;
 294 }
 295
 296 WXHBRUSH wxScrollBar::MSWControlColor(WXHDC pDC, WXHWND hWnd)
 297 {
 298     // unless we have an explicitly set bg colour, use default (gradient under
 299     // XP) brush instead of GetBackgroundColour() one as the base class would
 300     //
 301     // note that fg colour isn't used for a scrollbar
 302     return UseBgCol() ? wxControl::MSWControlColor(pDC, hWnd) : NULL;
 303 }
 304
 305 #endif // wxUSE_SCROLLBAR