src/msw/scrolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13     #pragma implementation "scrolbar.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20     #pragma hdrstop
  21 #endif
  22
  23 #if wxUSE_SCROLLBAR
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/utils.h"
  27 #endif
  28
  29 #include "wx/scrolbar.h"
  30 #include "wx/msw/private.h"
  31 #include "wx/settings.h"
  32
  33 #if wxUSE_EXTENDED_RTTI
  34 WX_DEFINE_FLAGS( wxScrollBarStyle )
  35
  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)
  45
  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)
  53
  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)
  63
  64     wxFLAGS_MEMBER(wxSB_HORIZONTAL)
  65     wxFLAGS_MEMBER(wxSB_VERTICAL)
  66
  67 wxEND_FLAGS( wxScrollBarStyle )
  68
  69 IMPLEMENT_DYNAMIC_CLASS_XTI(wxScrollBar, wxControl,"wx/scrolbar.h")
  70
  71 wxBEGIN_PROPERTIES_TABLE(wxScrollBar)
  72     wxEVENT_RANGE_PROPERTY( Scroll , wxEVT_SCROLL_TOP , wxEVT_SCROLL_ENDSCROLL , wxScrollEvent )
  73
  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()
  80
  81 wxBEGIN_HANDLERS_TABLE(wxScrollBar)
  82 wxEND_HANDLERS_TABLE()
  83
  84 wxCONSTRUCTOR_5( wxScrollBar , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
  85 #else
  86 IMPLEMENT_DYNAMIC_CLASS(wxScrollBar, wxControl)
  87 #endif
  88
  89 // Scrollbar
  90 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
  91            const wxPoint& pos,
  92            const wxSize& size, long style,
  93            const wxValidator& wxVALIDATOR_PARAM(validator),
  94            const wxString& name)
  95 {
  96     if (!parent)
  97         return false;
  98     parent->AddChild(this);
  99     SetName(name);
 100 #if wxUSE_VALIDATORS
 101     SetValidator(validator);
 102 #endif // wxUSE_VALIDATORS
 103
 104     if ((style & wxBORDER_MASK) == wxBORDER_DEFAULT)
 105         style |= wxNO_BORDER;
 106
 107     SetBackgroundColour(parent->GetBackgroundColour()) ;
 108     SetForegroundColour(parent->GetForegroundColour()) ;
 109     m_windowStyle = style;
 110
 111     if ( id == wxID_ANY )
 112         m_windowId = (int)NewControlId();
 113     else
 114       m_windowId = id;
 115
 116     int x = pos.x;
 117     int y = pos.y;
 118     int width = size.x;
 119     int height = size.y;
 120
 121     if (width == wxDefaultCoord)
 122     {
 123       if (style & wxHORIZONTAL)
 124         width = 140;
 125       else
 126         width = 14;
 127     }
 128     if (height == wxDefaultCoord)
 129     {
 130       if (style & wxVERTICAL)
 131         height = 140;
 132       else
 133         height = 14;
 134     }
 135
 136     WXDWORD exStyle = 0;
 137     WXDWORD wstyle = MSWGetStyle(style, & exStyle) ;
 138
 139     // Now create scrollbar
 140     DWORD _direction = (style & wxHORIZONTAL) ?
 141                         SBS_HORZ: SBS_VERT;
 142     HWND scroll_bar = CreateWindowEx(exStyle, wxT("SCROLLBAR"), wxT("scrollbar"),
 143                          _direction | wstyle,
 144                          0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
 145                          wxGetInstance(), NULL);
 146
 147     m_pageSize = 1;
 148     m_viewSize = 1;
 149     m_objectSize = 1;
 150
 151     ::SetScrollRange(scroll_bar, SB_CTL, 0, 1, FALSE);
 152     ::SetScrollPos(scroll_bar, SB_CTL, 0, FALSE);
 153     ShowWindow(scroll_bar, SW_SHOW);
 154
 155     m_hWnd = (WXHWND)scroll_bar;
 156
 157     // Subclass again for purposes of dialog editing mode
 158     SubclassWin((WXHWND) scroll_bar);
 159
 160     SetSize(x, y, width, height);
 161
 162     return true;
 163 }
 164
 165 wxScrollBar::~wxScrollBar(void)
 166 {
 167 }
 168
 169 bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
 170                               WXWORD pos, WXHWND WXUNUSED(control))
 171 {
 172     // current and max positions
 173     int position,
 174         maxPos, trackPos = pos;
 175
 176     wxUnusedVar(trackPos);
 177
 178     // when we're dragging the scrollbar we can't use pos parameter because it
 179     // is limited to 16 bits
 180     // JACS: now always using GetScrollInfo, since there's no reason
 181     // not to
 182 //    if ( wParam == SB_THUMBPOSITION || wParam == SB_THUMBTRACK )
 183     {
 184         SCROLLINFO scrollInfo;
 185         wxZeroMemory(scrollInfo);
 186         scrollInfo.cbSize = sizeof(SCROLLINFO);
 187
 188         // also get the range if we call GetScrollInfo() anyhow -- this is less
 189         // expensive than call it once here and then call GetScrollRange()
 190         // below
 191         scrollInfo.fMask = SIF_RANGE | SIF_POS | SIF_TRACKPOS;
 192
 193         if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
 194         {
 195             wxLogLastError(_T("GetScrollInfo"));
 196         }
 197
 198         trackPos = scrollInfo.nTrackPos;
 199         position = scrollInfo.nPos;
 200         maxPos = scrollInfo.nMax;
 201     }
 202 #if 0
 203     else
 204     {
 205         position = ::GetScrollPos((HWND) control, SB_CTL);
 206         int minPos;
 207         ::GetScrollRange((HWND) control, SB_CTL, &minPos, &maxPos);
 208     }
 209 #endif
 210
 211 #if defined(__WIN95__)
 212     // A page size greater than one has the effect of reducing the effective
 213     // range, therefore the range has already been boosted artificially - so
 214     // reduce it again.
 215     if ( m_pageSize > 1 )
 216         maxPos -= (m_pageSize - 1);
 217 #endif // __WIN95__
 218
 219     wxEventType scrollEvent = wxEVT_NULL;
 220
 221     int nScrollInc;
 222     switch ( wParam )
 223     {
 224         case SB_BOTTOM:
 225             nScrollInc = maxPos - position;
 226             scrollEvent = wxEVT_SCROLL_TOP;
 227             break;
 228
 229         case SB_TOP:
 230             nScrollInc = -position;
 231             scrollEvent = wxEVT_SCROLL_BOTTOM;
 232             break;
 233
 234         case SB_LINEUP:
 235             nScrollInc = -1;
 236             scrollEvent = wxEVT_SCROLL_LINEUP;
 237             break;
 238
 239         case SB_LINEDOWN:
 240             nScrollInc = 1;
 241             scrollEvent = wxEVT_SCROLL_LINEDOWN;
 242             break;
 243
 244         case SB_PAGEUP:
 245             nScrollInc = -GetPageSize();
 246             scrollEvent = wxEVT_SCROLL_PAGEUP;
 247             break;
 248
 249         case SB_PAGEDOWN:
 250             nScrollInc = GetPageSize();
 251             scrollEvent = wxEVT_SCROLL_PAGEDOWN;
 252             break;
 253
 254         case SB_THUMBPOSITION:
 255             nScrollInc = trackPos - position;
 256             scrollEvent = wxEVT_SCROLL_THUMBRELEASE;
 257             break;
 258
 259         case SB_THUMBTRACK:
 260             nScrollInc = trackPos - position;
 261             scrollEvent = wxEVT_SCROLL_THUMBTRACK;
 262             break;
 263
 264         case SB_ENDSCROLL:
 265             nScrollInc = 0;
 266             scrollEvent = wxEVT_SCROLL_ENDSCROLL;
 267             break;
 268
 269         default:
 270             nScrollInc = 0;
 271     }
 272
 273     if ( nScrollInc )
 274     {
 275         position += nScrollInc;
 276
 277         if ( position < 0 )
 278             position = 0;
 279         if ( position > maxPos )
 280             position = maxPos;
 281
 282         SetThumbPosition(position);
 283     }
 284     else if ( scrollEvent != wxEVT_SCROLL_THUMBRELEASE &&
 285                 scrollEvent != wxEVT_SCROLL_ENDSCROLL )
 286     {
 287         // don't process the event if there is no displacement,
 288         // unless this is a thumb release or end scroll event.
 289         return false;
 290     }
 291
 292     wxScrollEvent event(scrollEvent, m_windowId);
 293     event.SetOrientation(IsVertical() ? wxVERTICAL : wxHORIZONTAL);
 294     event.SetPosition(position);
 295     event.SetEventObject( this );
 296
 297     return GetEventHandler()->ProcessEvent(event);
 298 }
 299
 300 void wxScrollBar::SetThumbPosition(int viewStart)
 301 {
 302 #if defined(__WIN95__)
 303     SCROLLINFO info;
 304     info.cbSize = sizeof(SCROLLINFO);
 305     info.nPage = 0;
 306     info.nMin = 0;
 307     info.nPos = viewStart;
 308     info.fMask = SIF_POS ;
 309
 310     ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, TRUE);
 311 #else
 312     ::SetScrollPos((HWND) GetHWND(), SB_CTL, viewStart, TRUE);
 313 #endif
 314 }
 315
 316 int wxScrollBar::GetThumbPosition(void) const
 317 {
 318     SCROLLINFO scrollInfo;
 319     wxZeroMemory(scrollInfo);
 320     scrollInfo.cbSize = sizeof(SCROLLINFO);
 321     scrollInfo.fMask = SIF_POS;
 322
 323     if ( !::GetScrollInfo(GetHwnd(), SB_CTL, &scrollInfo) )
 324     {
 325         wxLogLastError(_T("GetScrollInfo"));
 326     }
 327     return scrollInfo.nPos;
 328 //    return ::GetScrollPos((HWND)m_hWnd, SB_CTL);
 329 }
 330
 331 void wxScrollBar::SetScrollbar(int position, int thumbSize, int range, int pageSize,
 332     bool refresh)
 333 {
 334   m_viewSize = pageSize;
 335   m_pageSize = thumbSize;
 336   m_objectSize = range;
 337
 338   // The range (number of scroll steps) is the
 339   // object length minus the page size.
 340   int range1 = wxMax((m_objectSize - m_pageSize), 0) ;
 341
 342 #if defined(__WIN95__)
 343   // Try to adjust the range to cope with page size > 1
 344   // (see comment for SetPageLength)
 345   if ( m_pageSize > 1 )
 346   {
 347     range1 += (m_pageSize - 1);
 348   }
 349
 350   SCROLLINFO info;
 351   info.cbSize = sizeof(SCROLLINFO);
 352   info.nPage = m_pageSize;
 353   info.nMin = 0;
 354   info.nMax = range1;
 355   info.nPos = position;
 356
 357   info.fMask = SIF_PAGE | SIF_RANGE | SIF_POS;
 358
 359   ::SetScrollInfo((HWND) GetHWND(), SB_CTL, &info, refresh);
 360 #else
 361   ::SetScrollPos((HWND)m_hWnd, SB_CTL, position, TRUE);
 362   ::SetScrollRange((HWND)m_hWnd, SB_CTL, 0, range1, TRUE);
 363 #endif
 364 }
 365
 366 void wxScrollBar::Command(wxCommandEvent& event)
 367 {
 368     SetThumbPosition(event.m_commandInt);
 369     ProcessCommand(event);
 370 }
 371
 372 wxSize wxScrollBar::DoGetBestSize() const
 373 {
 374     int w = 100;
 375     int h = 100;
 376
 377     if ( IsVertical() )
 378     {
 379         w = wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 380     }
 381     else
 382     {
 383         h = wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
 384     }
 385
 386     return wxSize(w, h);
 387 }
 388
 389 #endif // wxUSE_SCROLLBAR