src/generic/scrlwing.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/scrolwin.cpp
   3 // Purpose:     wxGenericScrolledWindow implementation
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "genscrolwin.h"
  22 #endif
  23
  24 #ifdef __VMS
  25 #define XtDisplay XTDISPLAY
  26 #endif
  27
  28 // For compilers that support precompilation, includes "wx.h".
  29 #include "wx/wxprec.h"
  30
  31 #ifdef __BORLANDC__
  32     #pragma hdrstop
  33 #endif
  34
  35 #if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)
  36
  37 #include "wx/utils.h"
  38 #include "wx/dcclient.h"
  39
  40 #include "wx/scrolwin.h"
  41 #include "wx/panel.h"
  42 #include "wx/timer.h"
  43
  44 #ifdef __WXMSW__
  45     #include <windows.h> // for DLGC_WANTARROWS
  46 #endif
  47
  48 #ifdef __WXMOTIF__
  49 // For wxRETAINED implementation
  50 #ifdef __VMS__ //VMS's Xm.h is not (yet) compatible with C++
  51                //This code switches off the compiler warnings
  52 # pragma message disable nosimpint
  53 #endif
  54 #include <Xm/Xm.h>
  55 #ifdef __VMS__
  56 # pragma message enable nosimpint
  57 #endif
  58 #endif
  59
  60 IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
  61
  62 // ----------------------------------------------------------------------------
  63 // wxScrollHelperEvtHandler: intercept the events from the window and forward
  64 // them to wxScrollHelper
  65 // ----------------------------------------------------------------------------
  66
  67 class WXDLLEXPORT wxScrollHelperEvtHandler : public wxEvtHandler
  68 {
  69 public:
  70     wxScrollHelperEvtHandler(wxScrollHelper *scrollHelper)
  71     {
  72         m_scrollHelper = scrollHelper;
  73     }
  74
  75     virtual bool ProcessEvent(wxEvent& event);
  76
  77     void ResetDrawnFlag() { m_hasDrawnWindow = FALSE; }
  78
  79 private:
  80     wxScrollHelper *m_scrollHelper;
  81
  82     bool m_hasDrawnWindow;
  83 };
  84
  85 // ----------------------------------------------------------------------------
  86 // wxAutoScrollTimer: the timer used to generate a stream of scroll events when
  87 // a captured mouse is held outside the window
  88 // ----------------------------------------------------------------------------
  89
  90 class wxAutoScrollTimer : public wxTimer
  91 {
  92 public:
  93     wxAutoScrollTimer(wxWindow *winToScroll, wxScrollHelper *scroll,
  94                       wxEventType eventTypeToSend,
  95                       int pos, int orient);
  96
  97     virtual void Notify();
  98
  99 private:
 100     wxWindow *m_win;
 101     wxScrollHelper *m_scrollHelper;
 102     wxEventType m_eventType;
 103     int m_pos,
 104         m_orient;
 105 };
 106
 107 // ============================================================================
 108 // implementation
 109 // ============================================================================
 110
 111 // ----------------------------------------------------------------------------
 112 // wxAutoScrollTimer
 113 // ----------------------------------------------------------------------------
 114
 115 wxAutoScrollTimer::wxAutoScrollTimer(wxWindow *winToScroll,
 116                                      wxScrollHelper *scroll,
 117                                      wxEventType eventTypeToSend,
 118                                      int pos, int orient)
 119 {
 120     m_win = winToScroll;
 121     m_scrollHelper = scroll;
 122     m_eventType = eventTypeToSend;
 123     m_pos = pos;
 124     m_orient = orient;
 125 }
 126
 127 void wxAutoScrollTimer::Notify()
 128 {
 129     // only do all this as long as the window is capturing the mouse
 130     if ( wxWindow::GetCapture() != m_win )
 131     {
 132         Stop();
 133     }
 134     else // we still capture the mouse, continue generating events
 135     {
 136         // first scroll the window if we are allowed to do it
 137         wxScrollWinEvent event1(m_eventType, m_pos, m_orient);
 138         event1.SetEventObject(m_win);
 139         if ( m_scrollHelper->SendAutoScrollEvents(event1) &&
 140                 m_win->GetEventHandler()->ProcessEvent(event1) )
 141         {
 142             // and then send a pseudo mouse-move event to refresh the selection
 143             wxMouseEvent event2(wxEVT_MOTION);
 144             wxGetMousePosition(&event2.m_x, &event2.m_y);
 145
 146             // the mouse event coordinates should be client, not screen as
 147             // returned by wxGetMousePosition
 148             wxWindow *parentTop = m_win;
 149             while ( parentTop->GetParent() )
 150                 parentTop = parentTop->GetParent();
 151             wxPoint ptOrig = parentTop->GetPosition();
 152             event2.m_x -= ptOrig.x;
 153             event2.m_y -= ptOrig.y;
 154
 155             event2.SetEventObject(m_win);
 156
 157             // FIXME: we don't fill in the other members - ok?
 158
 159             m_win->GetEventHandler()->ProcessEvent(event2);
 160         }
 161         else // can't scroll further, stop
 162         {
 163             Stop();
 164         }
 165     }
 166 }
 167
 168 // ----------------------------------------------------------------------------
 169 // wxScrollHelperEvtHandler
 170 // ----------------------------------------------------------------------------
 171
 172 bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
 173 {
 174     wxEventType evType = event.GetEventType();
 175
 176     // the explanation of wxEVT_PAINT processing hack: for historic reasons
 177     // there are 2 ways to process this event in classes deriving from
 178     // wxScrolledWindow. The user code may
 179     //
 180     //  1. override wxScrolledWindow::OnDraw(dc)
 181     //  2. define its own OnPaint() handler
 182     //
 183     // In addition, in wxUniversal wxWindow defines OnPaint() itself and
 184     // always processes the draw event, so we can't just try the window
 185     // OnPaint() first and call our HandleOnPaint() if it doesn't process it
 186     // (the latter would never be called in wxUniversal).
 187     //
 188     // So the solution is to have a flag telling us whether the user code drew
 189     // anything in the window. We set it to true here but reset it to false in
 190     // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
 191     // user code defined OnPaint() in the derived class)
 192     m_hasDrawnWindow = TRUE;
 193
 194     // pass it on to the real handler
 195     bool processed = wxEvtHandler::ProcessEvent(event);
 196
 197     // always process the size events ourselves, even if the user code handles
 198     // them as well, as we need to AdjustScrollbars()
 199     //
 200     // NB: it is important to do it after processing the event in the normal
 201     //     way as HandleOnSize() may generate a wxEVT_SIZE itself if the
 202     //     scrollbar[s] (dis)appear and it should be seen by the user code
 203     //     after this one
 204     if ( evType == wxEVT_SIZE )
 205     {
 206         m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
 207
 208         return TRUE;
 209     }
 210
 211     if ( processed )
 212     {
 213         // normally, nothing more to do here - except if it was a paint event
 214         // which wasn't really processed, then we'll try to call our
 215         // OnDraw() below (from HandleOnPaint)
 216         if ( m_hasDrawnWindow )
 217         {
 218             return TRUE;
 219         }
 220     }
 221
 222     // reset the skipped flag to FALSE as it might have been set to TRUE in
 223     // ProcessEvent() above
 224     event.Skip(FALSE);
 225
 226     if ( evType == wxEVT_PAINT )
 227     {
 228         m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
 229         return TRUE;
 230     }
 231
 232     if ( evType == wxEVT_SCROLLWIN_TOP ||
 233          evType == wxEVT_SCROLLWIN_BOTTOM ||
 234          evType == wxEVT_SCROLLWIN_LINEUP ||
 235          evType == wxEVT_SCROLLWIN_LINEDOWN ||
 236          evType == wxEVT_SCROLLWIN_PAGEUP ||
 237          evType == wxEVT_SCROLLWIN_PAGEDOWN ||
 238          evType == wxEVT_SCROLLWIN_THUMBTRACK ||
 239          evType == wxEVT_SCROLLWIN_THUMBRELEASE )
 240     {
 241             m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
 242             return !event.GetSkipped();
 243     }
 244
 245     if ( evType == wxEVT_ENTER_WINDOW )
 246     {
 247         m_scrollHelper->HandleOnMouseEnter((wxMouseEvent &)event);
 248     }
 249     else if ( evType == wxEVT_LEAVE_WINDOW )
 250     {
 251         m_scrollHelper->HandleOnMouseLeave((wxMouseEvent &)event);
 252     }
 253 #if wxUSE_MOUSEWHEEL
 254     else if ( evType == wxEVT_MOUSEWHEEL )
 255     {
 256         m_scrollHelper->HandleOnMouseWheel((wxMouseEvent &)event);
 257     }
 258 #endif // wxUSE_MOUSEWHEEL
 259     else if ( evType == wxEVT_CHAR )
 260     {
 261         m_scrollHelper->HandleOnChar((wxKeyEvent &)event);
 262         return !event.GetSkipped();
 263     }
 264
 265     return FALSE;
 266 }
 267
 268 // ----------------------------------------------------------------------------
 269 // wxScrollHelper construction
 270 // ----------------------------------------------------------------------------
 271
 272 wxScrollHelper::wxScrollHelper(wxWindow *win)
 273 {
 274     m_xScrollPixelsPerLine =
 275     m_yScrollPixelsPerLine =
 276     m_xScrollPosition =
 277     m_yScrollPosition =
 278     m_xScrollLines =
 279     m_yScrollLines =
 280     m_xScrollLinesPerPage =
 281     m_yScrollLinesPerPage = 0;
 282
 283     m_xScrollingEnabled =
 284     m_yScrollingEnabled = TRUE;
 285
 286     m_scaleX =
 287     m_scaleY = 1.0;
 288 #if wxUSE_MOUSEWHEEL
 289     m_wheelRotation = 0;
 290 #endif
 291
 292     m_win =
 293     m_targetWindow = (wxWindow *)NULL;
 294
 295     m_timerAutoScroll = (wxTimer *)NULL;
 296
 297     m_handler = NULL;
 298
 299     if ( win )
 300         SetWindow(win);
 301 }
 302
 303 wxScrollHelper::~wxScrollHelper()
 304 {
 305     StopAutoScrolling();
 306
 307     DeleteEvtHandler();
 308 }
 309
 310 // ----------------------------------------------------------------------------
 311 // setting scrolling parameters
 312 // ----------------------------------------------------------------------------
 313
 314 void wxScrollHelper::SetScrollbars(int pixelsPerUnitX,
 315                                    int pixelsPerUnitY,
 316                                    int noUnitsX,
 317                                    int noUnitsY,
 318                                    int xPos,
 319                                    int yPos,
 320                                    bool noRefresh)
 321 {
 322     int xpos, ypos;
 323
 324     CalcUnscrolledPosition(xPos, yPos, &xpos, &ypos);
 325     bool do_refresh =
 326     (
 327       (noUnitsX != 0 && m_xScrollLines == 0) ||
 328       (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX*noUnitsX) ||
 329
 330       (noUnitsY != 0 && m_yScrollLines == 0) ||
 331       (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY*noUnitsY) ||
 332       (xPos != m_xScrollPosition) ||
 333       (yPos != m_yScrollPosition)
 334     );
 335
 336     m_xScrollPixelsPerLine = pixelsPerUnitX;
 337     m_yScrollPixelsPerLine = pixelsPerUnitY;
 338     m_xScrollPosition = xPos;
 339     m_yScrollPosition = yPos;
 340     m_xScrollLines = noUnitsX;
 341     m_yScrollLines = noUnitsY;
 342
 343 #ifdef __WXMOTIF__
 344     // Sorry, some Motif-specific code to implement a backing pixmap
 345     // for the wxRETAINED style. Implementing a backing store can't
 346     // be entirely generic because it relies on the wxWindowDC implementation
 347     // to duplicate X drawing calls for the backing pixmap.
 348
 349     if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
 350     {
 351         Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
 352
 353         int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
 354         int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
 355         if (m_targetWindow->GetBackingPixmap() &&
 356            !((m_targetWindow->GetPixmapWidth() == totalPixelWidth) &&
 357              (m_targetWindow->GetPixmapHeight() == totalPixelHeight)))
 358         {
 359             XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
 360             m_targetWindow->SetBackingPixmap((WXPixmap) 0);
 361         }
 362
 363         if (!m_targetWindow->GetBackingPixmap() &&
 364            (noUnitsX != 0) && (noUnitsY != 0))
 365         {
 366             int depth = wxDisplayDepth();
 367             m_targetWindow->SetPixmapWidth(totalPixelWidth);
 368             m_targetWindow->SetPixmapHeight(totalPixelHeight);
 369             m_targetWindow->SetBackingPixmap((WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
 370               m_targetWindow->GetPixmapWidth(), m_targetWindow->GetPixmapHeight(), depth));
 371         }
 372
 373     }
 374 #endif // Motif
 375
 376     AdjustScrollbars();
 377
 378     if (do_refresh && !noRefresh)
 379         m_targetWindow->Refresh(TRUE, GetRect());
 380
 381 #ifdef __WXMAC__
 382     m_targetWindow->MacUpdateImmediately() ;
 383 #endif
 384 }
 385
 386 // ----------------------------------------------------------------------------
 387 // target window handling
 388 // ----------------------------------------------------------------------------
 389
 390 void wxScrollHelper::DeleteEvtHandler()
 391 {
 392     // FIXME: we should search for m_handler in the handler list
 393     if ( m_targetWindow )
 394     {
 395         m_targetWindow->PopEventHandler(TRUE /* Delete old event handler*/);
 396     }
 397 }
 398
 399 void wxScrollHelper::SetWindow(wxWindow *win)
 400 {
 401     wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
 402
 403     m_win = win;
 404
 405     DoSetTargetWindow(win);
 406 }
 407
 408 void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
 409 {
 410     m_targetWindow = target;
 411
 412     // install the event handler which will intercept the events we're
 413     // interested in
 414     m_handler = new wxScrollHelperEvtHandler(this);
 415     m_targetWindow->PushEventHandler(m_handler);
 416 }
 417
 418 void wxScrollHelper::SetTargetWindow( wxWindow *target )
 419 {
 420     wxCHECK_RET( target, wxT("target window must not be NULL") );
 421
 422     if ( target == m_targetWindow )
 423         return;
 424
 425     DeleteEvtHandler();
 426
 427     DoSetTargetWindow(target);
 428 }
 429
 430 wxWindow *wxScrollHelper::GetTargetWindow() const
 431 {
 432     return m_targetWindow;
 433 }
 434
 435 // ----------------------------------------------------------------------------
 436 // scrolling implementation itself
 437 // ----------------------------------------------------------------------------
 438
 439 void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
 440 {
 441     int nScrollInc = CalcScrollInc(event);
 442     if ( nScrollInc == 0 )
 443     {
 444         // can't scroll further
 445         event.Skip();
 446
 447         return;
 448     }
 449
 450     int orient = event.GetOrientation();
 451     if (orient == wxHORIZONTAL)
 452     {
 453         m_xScrollPosition += nScrollInc;
 454         m_targetWindow->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
 455     }
 456     else
 457     {
 458         m_yScrollPosition += nScrollInc;
 459         m_targetWindow->SetScrollPos(wxVERTICAL, m_yScrollPosition);
 460     }
 461
 462     bool needsRefresh = FALSE;
 463     int dx = 0,
 464         dy = 0;
 465     if (orient == wxHORIZONTAL)
 466     {
 467        if ( m_xScrollingEnabled )
 468        {
 469            dx = -m_xScrollPixelsPerLine * nScrollInc;
 470        }
 471        else
 472        {
 473            needsRefresh = TRUE;
 474        }
 475     }
 476     else
 477     {
 478         if ( m_yScrollingEnabled )
 479         {
 480             dy = -m_yScrollPixelsPerLine * nScrollInc;
 481         }
 482         else
 483         {
 484             needsRefresh = TRUE;
 485         }
 486     }
 487
 488     if ( needsRefresh )
 489     {
 490         m_targetWindow->Refresh(TRUE, GetRect());
 491     }
 492     else
 493     {
 494         m_targetWindow->ScrollWindow(dx, dy, GetRect());
 495     }
 496
 497 #ifdef __WXMAC__
 498     m_targetWindow->MacUpdateImmediately() ;
 499 #endif
 500 }
 501
 502 int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
 503 {
 504     int pos = event.GetPosition();
 505     int orient = event.GetOrientation();
 506
 507     int nScrollInc = 0;
 508     if (event.GetEventType() == wxEVT_SCROLLWIN_TOP)
 509     {
 510             if (orient == wxHORIZONTAL)
 511                 nScrollInc = - m_xScrollPosition;
 512             else
 513                 nScrollInc = - m_yScrollPosition;
 514     } else
 515     if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
 516     {
 517             if (orient == wxHORIZONTAL)
 518                 nScrollInc = m_xScrollLines - m_xScrollPosition;
 519             else
 520                 nScrollInc = m_yScrollLines - m_yScrollPosition;
 521     } else
 522     if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
 523     {
 524             nScrollInc = -1;
 525     } else
 526     if (event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN)
 527     {
 528             nScrollInc = 1;
 529     } else
 530     if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEUP)
 531     {
 532             if (orient == wxHORIZONTAL)
 533                 nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
 534             else
 535                 nScrollInc = -GetScrollPageSize(wxVERTICAL);
 536     } else
 537     if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN)
 538     {
 539             if (orient == wxHORIZONTAL)
 540                 nScrollInc = GetScrollPageSize(wxHORIZONTAL);
 541             else
 542                 nScrollInc = GetScrollPageSize(wxVERTICAL);
 543     } else
 544     if ((event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK) ||
 545         (event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE))
 546     {
 547             if (orient == wxHORIZONTAL)
 548                 nScrollInc = pos - m_xScrollPosition;
 549             else
 550                 nScrollInc = pos - m_yScrollPosition;
 551     }
 552
 553     if (orient == wxHORIZONTAL)
 554     {
 555         if (m_xScrollPixelsPerLine > 0)
 556         {
 557             int w, h;
 558             GetTargetSize(&w, &h);
 559
 560             int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
 561             int noPositions = (int) ( ((nMaxWidth - w)/(double)m_xScrollPixelsPerLine) + 0.5 );
 562             if (noPositions < 0)
 563                 noPositions = 0;
 564
 565             if ( (m_xScrollPosition + nScrollInc) < 0 )
 566                 nScrollInc = -m_xScrollPosition; // As -ve as we can go
 567             else if ( (m_xScrollPosition + nScrollInc) > noPositions )
 568                 nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go
 569         }
 570         else
 571             m_targetWindow->Refresh(TRUE, GetRect());
 572     }
 573     else
 574     {
 575         if (m_yScrollPixelsPerLine > 0)
 576         {
 577             int w, h;
 578             GetTargetSize(&w, &h);
 579
 580             int nMaxHeight = m_yScrollLines*m_yScrollPixelsPerLine;
 581             int noPositions = (int) ( ((nMaxHeight - h)/(double)m_yScrollPixelsPerLine) + 0.5 );
 582             if (noPositions < 0)
 583                 noPositions = 0;
 584
 585             if ( (m_yScrollPosition + nScrollInc) < 0 )
 586                 nScrollInc = -m_yScrollPosition; // As -ve as we can go
 587             else if ( (m_yScrollPosition + nScrollInc) > noPositions )
 588                 nScrollInc = noPositions - m_yScrollPosition; // As +ve as we can go
 589         }
 590         else
 591             m_targetWindow->Refresh(TRUE, GetRect());
 592     }
 593
 594     return nScrollInc;
 595 }
 596
 597 // Adjust the scrollbars - new version.
 598 void wxScrollHelper::AdjustScrollbars()
 599 {
 600 #ifdef __WXMAC__
 601     m_targetWindow->MacUpdateImmediately();
 602 #endif
 603
 604     int w, h;
 605     GetTargetSize(&w, &h);
 606
 607     int oldXScroll = m_xScrollPosition;
 608     int oldYScroll = m_yScrollPosition;
 609
 610     if (m_xScrollLines > 0)
 611     {
 612         // Calculate page size i.e. number of scroll units you get on the
 613         // current client window
 614         int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
 615         if (noPagePositions < 1) noPagePositions = 1;
 616         if ( noPagePositions > m_xScrollLines )
 617             noPagePositions = m_xScrollLines;
 618
 619         // Correct position if greater than extent of canvas minus
 620         // the visible portion of it or if below zero
 621         m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition);
 622         m_xScrollPosition = wxMax( 0, m_xScrollPosition );
 623
 624         m_targetWindow->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
 625         // The amount by which we scroll when paging
 626         SetScrollPageSize(wxHORIZONTAL, noPagePositions);
 627     }
 628     else
 629     {
 630         m_xScrollPosition = 0;
 631         m_targetWindow->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
 632     }
 633
 634     if (m_yScrollLines > 0)
 635     {
 636         // Calculate page size i.e. number of scroll units you get on the
 637         // current client window
 638         int noPagePositions = (int) ( (h/(double)m_yScrollPixelsPerLine) + 0.5 );
 639         if (noPagePositions < 1) noPagePositions = 1;
 640         if ( noPagePositions > m_yScrollLines )
 641             noPagePositions = m_yScrollLines;
 642
 643         // Correct position if greater than extent of canvas minus
 644         // the visible portion of it or if below zero
 645         m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
 646         m_yScrollPosition = wxMax( 0, m_yScrollPosition );
 647
 648         m_targetWindow->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
 649         // The amount by which we scroll when paging
 650         SetScrollPageSize(wxVERTICAL, noPagePositions);
 651     }
 652     else
 653     {
 654         m_yScrollPosition = 0;
 655         m_targetWindow->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
 656     }
 657
 658     if (oldXScroll != m_xScrollPosition)
 659     {
 660        if (m_xScrollingEnabled)
 661             m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll-m_xScrollPosition), 0,
 662                                           GetRect() );
 663        else
 664             m_targetWindow->Refresh(TRUE, GetRect());
 665     }
 666
 667     if (oldYScroll != m_yScrollPosition)
 668     {
 669         if (m_yScrollingEnabled)
 670             m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
 671                                           GetRect() );
 672         else
 673             m_targetWindow->Refresh(TRUE, GetRect());
 674     }
 675
 676 #ifdef __WXMAC__
 677     m_targetWindow->MacUpdateImmediately();
 678 #endif
 679 }
 680
 681 void wxScrollHelper::DoPrepareDC(wxDC& dc)
 682 {
 683     wxPoint pt = dc.GetDeviceOrigin();
 684     dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
 685                         pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
 686     dc.SetUserScale( m_scaleX, m_scaleY );
 687 }
 688
 689 void wxScrollHelper::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
 690 {
 691     if ( x_unit )
 692         *x_unit = m_xScrollPixelsPerLine;
 693     if ( y_unit )
 694         *y_unit = m_yScrollPixelsPerLine;
 695 }
 696
 697 int wxScrollHelper::GetScrollPageSize(int orient) const
 698 {
 699     if ( orient == wxHORIZONTAL )
 700         return m_xScrollLinesPerPage;
 701     else
 702         return m_yScrollLinesPerPage;
 703 }
 704
 705 void wxScrollHelper::SetScrollPageSize(int orient, int pageSize)
 706 {
 707     if ( orient == wxHORIZONTAL )
 708         m_xScrollLinesPerPage = pageSize;
 709     else
 710         m_yScrollLinesPerPage = pageSize;
 711 }
 712
 713 /*
 714  * Scroll to given position (scroll position, not pixel position)
 715  */
 716 void wxScrollHelper::Scroll( int x_pos, int y_pos )
 717 {
 718     if (!m_targetWindow)
 719         return;
 720
 721     if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
 722         ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
 723
 724 #ifdef __WXMAC__
 725     m_targetWindow->MacUpdateImmediately();
 726 #endif
 727
 728     int w, h;
 729     GetTargetSize(&w, &h);
 730
 731     if ((x_pos != -1) && (m_xScrollPixelsPerLine))
 732     {
 733         int old_x = m_xScrollPosition;
 734         m_xScrollPosition = x_pos;
 735
 736         // Calculate page size i.e. number of scroll units you get on the
 737         // current client window
 738         int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
 739         if (noPagePositions < 1) noPagePositions = 1;
 740
 741         // Correct position if greater than extent of canvas minus
 742         // the visible portion of it or if below zero
 743         m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition );
 744         m_xScrollPosition = wxMax( 0, m_xScrollPosition );
 745
 746         if (old_x != m_xScrollPosition) {
 747             m_targetWindow->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
 748             m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
 749                                           GetRect() );
 750         }
 751     }
 752     if ((y_pos != -1) && (m_yScrollPixelsPerLine))
 753     {
 754         int old_y = m_yScrollPosition;
 755         m_yScrollPosition = y_pos;
 756
 757         // Calculate page size i.e. number of scroll units you get on the
 758         // current client window
 759         int noPagePositions = (int) ( (h/(double)m_yScrollPixelsPerLine) + 0.5 );
 760         if (noPagePositions < 1) noPagePositions = 1;
 761
 762         // Correct position if greater than extent of canvas minus
 763         // the visible portion of it or if below zero
 764         m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
 765         m_yScrollPosition = wxMax( 0, m_yScrollPosition );
 766
 767         if (old_y != m_yScrollPosition) {
 768             m_targetWindow->SetScrollPos( wxVERTICAL, m_yScrollPosition );
 769             m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
 770                                           GetRect() );
 771         }
 772     }
 773
 774 #ifdef __WXMAC__
 775     m_targetWindow->MacUpdateImmediately();
 776 #endif
 777
 778 }
 779
 780 void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)
 781 {
 782     m_xScrollingEnabled = x_scroll;
 783     m_yScrollingEnabled = y_scroll;
 784 }
 785
 786 void wxScrollHelper::GetVirtualSize (int *x, int *y) const
 787 {
 788     if ( x )
 789         *x = m_xScrollPixelsPerLine * m_xScrollLines;
 790     if ( y )
 791         *y = m_yScrollPixelsPerLine * m_yScrollLines;
 792 }
 793
 794 // Where the current view starts from
 795 void wxScrollHelper::GetViewStart (int *x, int *y) const
 796 {
 797     if ( x )
 798         *x = m_xScrollPosition;
 799     if ( y )
 800         *y = m_yScrollPosition;
 801 }
 802
 803 void wxScrollHelper::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
 804 {
 805     if ( xx )
 806         *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
 807     if ( yy )
 808         *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
 809 }
 810
 811 void wxScrollHelper::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
 812 {
 813     if ( xx )
 814         *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
 815     if ( yy )
 816         *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
 817 }
 818
 819 // ----------------------------------------------------------------------------
 820 // event handlers
 821 // ----------------------------------------------------------------------------
 822
 823 // Default OnSize resets scrollbars, if any
 824 void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
 825 {
 826 #if wxUSE_CONSTRAINTS
 827     if ( m_targetWindow->GetAutoLayout() )
 828         m_targetWindow->Layout();
 829 #endif
 830
 831     AdjustScrollbars();
 832 }
 833
 834 // This calls OnDraw, having adjusted the origin according to the current
 835 // scroll position
 836 void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
 837 {
 838     wxPaintDC dc(m_targetWindow);
 839     DoPrepareDC(dc);
 840
 841     OnDraw(dc);
 842 }
 843
 844 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
 845 // compatibility here - if we used OnKeyDown(), the programs which process
 846 // arrows themselves in their OnChar() would never get the message and like
 847 // this they always have the priority
 848 void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
 849 {
 850     int stx, sty,       // view origin
 851         szx, szy,       // view size (total)
 852         clix, cliy;     // view size (on screen)
 853
 854     GetViewStart(&stx, &sty);
 855     GetTargetSize(&clix, &cliy);
 856     GetVirtualSize(&szx, &szy);
 857
 858     if( m_xScrollPixelsPerLine )
 859     {
 860         clix /= m_xScrollPixelsPerLine;
 861         szx /= m_xScrollPixelsPerLine;
 862     }
 863     else
 864     {
 865         clix = 0;
 866         szx = -1;
 867     }
 868     if( m_yScrollPixelsPerLine )
 869     {
 870         cliy /= m_yScrollPixelsPerLine;
 871         szy /= m_yScrollPixelsPerLine;
 872     }
 873     else
 874     {
 875         cliy = 0;
 876         szy = -1;
 877     }
 878
 879     int xScrollOld = m_xScrollPosition,
 880         yScrollOld = m_yScrollPosition;
 881
 882     int dsty;
 883     switch ( event.KeyCode() )
 884     {
 885         case WXK_PAGEUP:
 886         case WXK_PRIOR:
 887             dsty = sty - (5 * cliy / 6);
 888             Scroll(-1, (dsty == -1) ? 0 : dsty);
 889             break;
 890
 891         case WXK_PAGEDOWN:
 892         case WXK_NEXT:
 893             Scroll(-1, sty + (5 * cliy / 6));
 894             break;
 895
 896         case WXK_HOME:
 897             Scroll(0, event.ControlDown() ? 0 : -1);
 898             break;
 899
 900         case WXK_END:
 901             Scroll(szx - clix, event.ControlDown() ? szy - cliy : -1);
 902             break;
 903
 904         case WXK_UP:
 905             Scroll(-1, sty - 1);
 906             break;
 907
 908         case WXK_DOWN:
 909             Scroll(-1, sty + 1);
 910             break;
 911
 912         case WXK_LEFT:
 913             Scroll(stx - 1, -1);
 914             break;
 915
 916         case WXK_RIGHT:
 917             Scroll(stx + 1, -1);
 918             break;
 919
 920         default:
 921             // not for us
 922             event.Skip();
 923     }
 924
 925     if ( m_xScrollPosition != xScrollOld )
 926     {
 927         wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_xScrollPosition,
 928                                wxHORIZONTAL);
 929         event.SetEventObject(m_win);
 930         m_win->GetEventHandler()->ProcessEvent(event);
 931     }
 932
 933     if ( m_yScrollPosition != yScrollOld )
 934     {
 935         wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_yScrollPosition,
 936                                wxVERTICAL);
 937         event.SetEventObject(m_win);
 938         m_win->GetEventHandler()->ProcessEvent(event);
 939     }
 940 }
 941
 942 // ----------------------------------------------------------------------------
 943 // autoscroll stuff: these functions deal with sending fake scroll events when
 944 // a captured mouse is being held outside the window
 945 // ----------------------------------------------------------------------------
 946
 947 bool wxScrollHelper::SendAutoScrollEvents(wxScrollWinEvent& event) const
 948 {
 949     // only send the event if the window is scrollable in this direction
 950     wxWindow *win = (wxWindow *)event.GetEventObject();
 951     return win->HasScrollbar(event.GetOrientation());
 952 }
 953
 954 void wxScrollHelper::StopAutoScrolling()
 955 {
 956     if ( m_timerAutoScroll )
 957     {
 958         delete m_timerAutoScroll;
 959         m_timerAutoScroll = (wxTimer *)NULL;
 960     }
 961 }
 962
 963 void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
 964 {
 965     StopAutoScrolling();
 966
 967     event.Skip();
 968 }
 969
 970 void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
 971 {
 972     // don't prevent the usual processing of the event from taking place
 973     event.Skip();
 974
 975     // when a captured mouse leave a scrolled window we start generate
 976     // scrolling events to allow, for example, extending selection beyond the
 977     // visible area in some controls
 978     if ( wxWindow::GetCapture() == m_targetWindow )
 979     {
 980         // where is the mouse leaving?
 981         int pos, orient;
 982         wxPoint pt = event.GetPosition();
 983         if ( pt.x < 0 )
 984         {
 985             orient = wxHORIZONTAL;
 986             pos = 0;
 987         }
 988         else if ( pt.y < 0 )
 989         {
 990             orient = wxVERTICAL;
 991             pos = 0;
 992         }
 993         else // we're lower or to the right of the window
 994         {
 995             wxSize size = m_targetWindow->GetClientSize();
 996             if ( pt.x > size.x )
 997             {
 998                 orient = wxHORIZONTAL;
 999                 pos = m_xScrollLines;
1000             }
1001             else if ( pt.y > size.y )
1002             {
1003                 orient = wxVERTICAL;
1004                 pos = m_yScrollLines;
1005             }
1006             else // this should be impossible
1007             {
1008                 // but seems to happen sometimes under wxMSW - maybe it's a bug
1009                 // there but for now just ignore it
1010
1011                 //wxFAIL_MSG( _T("can't understand where has mouse gone") );
1012
1013                 return;
1014             }
1015         }
1016
1017         // only start the auto scroll timer if the window can be scrolled in
1018         // this direction
1019         if ( !m_targetWindow->HasScrollbar(orient) )
1020             return;
1021
1022         delete m_timerAutoScroll;
1023         m_timerAutoScroll = new wxAutoScrollTimer
1024                                 (
1025                                     m_targetWindow, this,
1026                                     pos == 0 ? wxEVT_SCROLLWIN_LINEUP
1027                                              : wxEVT_SCROLLWIN_LINEDOWN,
1028                                     pos,
1029                                     orient
1030                                 );
1031         m_timerAutoScroll->Start(50); // FIXME: make configurable
1032     }
1033 }
1034
1035 #if wxUSE_MOUSEWHEEL
1036
1037 void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
1038 {
1039     m_wheelRotation += event.GetWheelRotation();
1040     int lines = m_wheelRotation / event.GetWheelDelta();
1041     m_wheelRotation -= lines * event.GetWheelDelta();
1042
1043     if (lines != 0)
1044     {
1045         lines *= event.GetLinesPerAction();
1046
1047         wxScrollWinEvent newEvent;
1048
1049         newEvent.SetPosition(0);
1050         newEvent.SetOrientation(wxVERTICAL);
1051         newEvent.m_eventObject = m_win;
1052         if (lines > 0)
1053             newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
1054         else
1055             newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
1056
1057         int times = abs(lines);
1058         for (; times > 0; times --)
1059             m_win->GetEventHandler()->ProcessEvent(newEvent);
1060
1061         /* Old Way */
1062         // int vsx, vsy;
1063         // GetViewStart(&vsx, &vsy);
1064         // Scroll(-1, vsy - lines);
1065     }
1066 }
1067
1068 #endif // wxUSE_MOUSEWHEEL
1069
1070 // ----------------------------------------------------------------------------
1071 // wxGenericScrolledWindow implementation
1072 // ----------------------------------------------------------------------------
1073
1074 IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
1075
1076 BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
1077     EVT_PAINT(wxGenericScrolledWindow::OnPaint)
1078 END_EVENT_TABLE()
1079
1080 bool wxGenericScrolledWindow::Create(wxWindow *parent,
1081                               wxWindowID id,
1082                               const wxPoint& pos,
1083                               const wxSize& size,
1084                               long style,
1085                               const wxString& name)
1086 {
1087     m_targetWindow = this;
1088
1089     bool ok = wxPanel::Create(parent, id, pos, size, style, name);
1090
1091 #ifdef __WXMSW__
1092     // we need to process arrows ourselves for scrolling
1093     m_lDlgCode |= DLGC_WANTARROWS;
1094 #endif // __WXMSW__
1095
1096     return ok;
1097 }
1098
1099 wxGenericScrolledWindow::~wxGenericScrolledWindow()
1100 {
1101 }
1102
1103 void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
1104 {
1105     // the user code didn't really draw the window if we got here, so set this
1106     // flag to try to call OnDraw() later
1107     m_handler->ResetDrawnFlag();
1108
1109     event.Skip();
1110 }
1111
1112 #if WXWIN_COMPATIBILITY
1113
1114 void wxGenericScrolledWindow::GetScrollUnitsPerPage (int *x_page, int *y_page) const
1115 {
1116       *x_page = GetScrollPageSize(wxHORIZONTAL);
1117       *y_page = GetScrollPageSize(wxVERTICAL);
1118 }
1119
1120 void wxGenericScrolledWindow::CalcUnscrolledPosition(int x, int y, float *xx, float *yy) const
1121 {
1122     if ( xx )
1123         *xx = (float)(x + m_xScrollPosition * m_xScrollPixelsPerLine);
1124     if ( yy )
1125         *yy = (float)(y + m_yScrollPosition * m_yScrollPixelsPerLine);
1126 }
1127
1128 #endif // WXWIN_COMPATIBILITY
1129
1130 #endif // !wxGTK
1131