Guard against comparing invalid iterators, which produces an assertion

[wxWidgets.git] / src / generic / scrlwing.cpp

diff --git a/src/generic/scrlwing.cpp b/src/generic/scrlwing.cpp
index 2e0fff375165559a7c329a730508cda115adfe1b..e2aced4a81044aa237d39e5d5c6275f34f021f91 100644 (file)
--- a/src/generic/scrlwing.cpp
+++ b/src/generic/scrlwing.cpp
@@ -1,13 +1,13 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        generic/scrolwin.cpp
-// Purpose:     wxGenericScrolledWindow implementation
+// Name:        src/generic/scrlwing.cpp
+// Purpose:     wxScrolledWindow implementation

 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement.
 //              Ron Lee on 10.4.02:  virtual size / auto scrollbars et al.
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement.
 //              Ron Lee on 10.4.02:  virtual size / auto scrollbars et al.
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -18,10 +18,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "genscrolwin.h"
-#endif
-

 #ifdef __VMS
 #define XtDisplay XTDISPLAY
 #endif
 #ifdef __VMS
 #define XtDisplay XTDISPLAY
 #endif


@@ -33,18 +29,23 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)
+#include "wx/scrolwin.h"

 
 

-#include "wx/utils.h"
-#include "wx/dcclient.h"
+#ifndef WX_PRECOMP
+    #include "wx/utils.h"
+    #include "wx/panel.h"
+    #include "wx/dcclient.h"
+    #if wxUSE_TIMER
+        #include "wx/timer.h"
+    #endif
+#endif

 
 

-#include "wx/scrolwin.h"
-#include "wx/panel.h"
-#include "wx/timer.h"

 #include "wx/sizer.h"
 #include "wx/sizer.h"

+#include "wx/recguard.h"

 
 #ifdef __WXMSW__
     #include <windows.h> // for DLGC_WANTARROWS
 
 #ifdef __WXMSW__
     #include <windows.h> // for DLGC_WANTARROWS

+    #include "wx/msw/winundef.h"

 #endif
 
 #ifdef __WXMOTIF__
 #endif
 
 #ifdef __WXMOTIF__


@@ -59,7 +60,10 @@
 #endif
 #endif
 
 #endif
 #endif
 

-IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
+/*
+    TODO PROPERTIES
+        style wxHSCROLL | wxVSCROLL
+*/

 
 // ----------------------------------------------------------------------------
 // wxScrollHelperEvtHandler: intercept the events from the window and forward
 
 // ----------------------------------------------------------------------------
 // wxScrollHelperEvtHandler: intercept the events from the window and forward


@@ -76,14 +80,17 @@ public:
 
     virtual bool ProcessEvent(wxEvent& event);
 
 
     virtual bool ProcessEvent(wxEvent& event);
 

-    void ResetDrawnFlag() { m_hasDrawnWindow = FALSE; }
+    void ResetDrawnFlag() { m_hasDrawnWindow = false; }

 
 private:
     wxScrollHelper *m_scrollHelper;
 
     bool m_hasDrawnWindow;
 
 private:
     wxScrollHelper *m_scrollHelper;
 
     bool m_hasDrawnWindow;

+
+    DECLARE_NO_COPY_CLASS(wxScrollHelperEvtHandler)

 };
 
 };
 

+#if wxUSE_TIMER

 // ----------------------------------------------------------------------------
 // wxAutoScrollTimer: the timer used to generate a stream of scroll events when
 // a captured mouse is held outside the window
 // ----------------------------------------------------------------------------
 // wxAutoScrollTimer: the timer used to generate a stream of scroll events when
 // a captured mouse is held outside the window


@@ -104,6 +111,8 @@ private:
     wxEventType m_eventType;
     int m_pos,
         m_orient;
     wxEventType m_eventType;
     int m_pos,
         m_orient;

+
+    DECLARE_NO_COPY_CLASS(wxAutoScrollTimer)

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -166,6 +175,7 @@ void wxAutoScrollTimer::Notify()
         }
     }
 }
         }
     }
 }

+#endif

 
 // ----------------------------------------------------------------------------
 // wxScrollHelperEvtHandler
 
 // ----------------------------------------------------------------------------
 // wxScrollHelperEvtHandler


@@ -191,7 +201,7 @@ bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
     // anything in the window. We set it to true here but reset it to false in
     // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
     // user code defined OnPaint() in the derived class)
     // anything in the window. We set it to true here but reset it to false in
     // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
     // user code defined OnPaint() in the derived class)

-    m_hasDrawnWindow = TRUE;
+    m_hasDrawnWindow = true;

 
     // pass it on to the real handler
     bool processed = wxEvtHandler::ProcessEvent(event);
 
     // pass it on to the real handler
     bool processed = wxEvtHandler::ProcessEvent(event);


@@ -207,7 +217,7 @@ bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
     {
         m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
 
     {
         m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
 

-        return TRUE;
+        return true;

     }
 
     if ( processed )
     }
 
     if ( processed )


@@ -215,20 +225,20 @@ bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
         // normally, nothing more to do here - except if it was a paint event
         // which wasn't really processed, then we'll try to call our
         // OnDraw() below (from HandleOnPaint)
         // normally, nothing more to do here - except if it was a paint event
         // which wasn't really processed, then we'll try to call our
         // OnDraw() below (from HandleOnPaint)

-        if ( m_hasDrawnWindow )
+        if ( m_hasDrawnWindow || event.IsCommandEvent() )

         {
         {

-            return TRUE;
+            return true;

         }
     }
 
         }
     }
 

-    // reset the skipped flag to FALSE as it might have been set to TRUE in
+    // reset the skipped flag to false as it might have been set to true in

     // ProcessEvent() above
     // ProcessEvent() above

-    event.Skip(FALSE);
+    event.Skip(false);

 
     if ( evType == wxEVT_PAINT )
     {
         m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
 
     if ( evType == wxEVT_PAINT )
     {
         m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);

-        return TRUE;
+        return true;

     }
 
     if ( evType == wxEVT_SCROLLWIN_TOP ||
     }
 
     if ( evType == wxEVT_SCROLLWIN_TOP ||


@@ -264,7 +274,7 @@ bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
         return !event.GetSkipped();
     }
 
         return !event.GetSkipped();
     }
 

-    return FALSE;
+    return false;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -273,6 +283,8 @@ bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
 
 wxScrollHelper::wxScrollHelper(wxWindow *win)
 {
 
 wxScrollHelper::wxScrollHelper(wxWindow *win)
 {

+    wxASSERT_MSG( win, _T("associated window can't be NULL in wxScrollHelper") );
+

     m_xScrollPixelsPerLine =
     m_yScrollPixelsPerLine =
     m_xScrollPosition =
     m_xScrollPixelsPerLine =
     m_yScrollPixelsPerLine =
     m_xScrollPosition =


@@ -283,7 +295,7 @@ wxScrollHelper::wxScrollHelper(wxWindow *win)
     m_yScrollLinesPerPage = 0;
 
     m_xScrollingEnabled =
     m_yScrollLinesPerPage = 0;
 
     m_xScrollingEnabled =

-    m_yScrollingEnabled = TRUE;
+    m_yScrollingEnabled = true;

 
     m_scaleX =
     m_scaleY = 1.0;
 
     m_scaleX =
     m_scaleY = 1.0;


@@ -298,8 +310,10 @@ wxScrollHelper::wxScrollHelper(wxWindow *win)
 
     m_handler = NULL;
 
 
     m_handler = NULL;
 

-    if ( win )
-        SetWindow(win);
+    m_win = win;
+
+    // by default, the associated window is also the target window
+    DoSetTargetWindow(win);

 }
 
 wxScrollHelper::~wxScrollHelper()
 }
 
 wxScrollHelper::~wxScrollHelper()


@@ -340,14 +354,40 @@ void wxScrollHelper::SetScrollbars(int pixelsPerUnitX,
     m_xScrollPosition = xPos;
     m_yScrollPosition = yPos;
 
     m_xScrollPosition = xPos;
     m_yScrollPosition = yPos;
 

-    m_targetWindow->SetVirtualSizeHints( noUnitsX * pixelsPerUnitX, noUnitsY * pixelsPerUnitY );
+    int w = noUnitsX * pixelsPerUnitX;
+    int h = noUnitsY * pixelsPerUnitY;

 
 

-    if (do_refresh && !noRefresh)
-        m_targetWindow->Refresh(TRUE, GetRect());
+    // For better backward compatibility we set persisting limits
+    // here not just the size.  It makes SetScrollbars 'sticky'
+    // emulating the old non-autoscroll behaviour.
+    //   m_targetWindow->SetVirtualSizeHints( w, h );

 
 

-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately() ;
-#endif
+    // The above should arguably be deprecated, this however we still need.
+
+    // take care not to set 0 virtual size, 0 means that we don't have any
+    // scrollbars and hence we should use the real size instead of the virtual
+    // one which is indicated by using wxDefaultCoord
+    m_targetWindow->SetVirtualSize( w ? w : wxDefaultCoord,
+                                    h ? h : wxDefaultCoord);
+
+    if (do_refresh && !noRefresh)
+        m_targetWindow->Refresh(true, GetScrollRect());
+
+#ifndef __WXUNIVERSAL__
+    // If the target is not the same as the window with the scrollbars,
+    // then we need to update the scrollbars here, since they won't have
+    // been updated by SetVirtualSize().
+    if ( m_targetWindow != m_win )
+#endif // !__WXUNIVERSAL__
+    {
+        AdjustScrollbars();
+    }
+#ifndef __WXUNIVERSAL__
+    else
+    {
+        // otherwise this has been done by AdjustScrollbars, above
+    }
+#endif // !__WXUNIVERSAL__

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -370,19 +410,12 @@ void wxScrollHelper::DeleteEvtHandler()
     }
 }
 
     }
 }
 

-void wxScrollHelper::SetWindow(wxWindow *win)
-{
-    wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
-
-    m_win = win;
-
-    // by default, the associated window is also the target window
-    DoSetTargetWindow(win);
-}
-

 void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
 {
     m_targetWindow = target;
 void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
 {
     m_targetWindow = target;

+#ifdef __WXMAC__
+    target->MacSetClipChildren( true ) ;
+#endif

 
     // install the event handler which will intercept the events we're
     // interested in (but only do it for our real window, not the target window
 
     // install the event handler which will intercept the events we're
     // interested in (but only do it for our real window, not the target window


@@ -439,7 +472,7 @@ void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
         m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
     }
 
         m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
     }
 

-    bool needsRefresh = FALSE;
+    bool needsRefresh = false;

     int dx = 0,
         dy = 0;
     if (orient == wxHORIZONTAL)
     int dx = 0,
         dy = 0;
     if (orient == wxHORIZONTAL)


@@ -450,7 +483,7 @@ void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
        }
        else
        {
        }
        else
        {

-           needsRefresh = TRUE;
+           needsRefresh = true;

        }
     }
     else
        }
     }
     else


@@ -461,22 +494,18 @@ void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
         }
         else
         {
         }
         else
         {

-            needsRefresh = TRUE;
+            needsRefresh = true;

         }
     }
 
     if ( needsRefresh )
     {
         }
     }
 
     if ( needsRefresh )
     {

-        m_targetWindow->Refresh(TRUE, GetRect());
+        m_targetWindow->Refresh(true, GetScrollRect());

     }
     else
     {
     }
     else
     {

-        m_targetWindow->ScrollWindow(dx, dy, GetRect());
+        m_targetWindow->ScrollWindow(dx, dy, GetScrollRect());

     }
     }

-
-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately() ;
-#endif

 }
 
 int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
 }
 
 int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)


@@ -534,41 +563,48 @@ int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
     {
         if (m_xScrollPixelsPerLine > 0)
         {
     {
         if (m_xScrollPixelsPerLine > 0)
         {

-            int w, h;
-            GetTargetSize(&w, &h);
-
-            int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
-            int noPositions = (int) ( ((nMaxWidth - w)/(double)m_xScrollPixelsPerLine) + 0.5 );
-            if (noPositions < 0)
-                noPositions = 0;
-
-            if ( (m_xScrollPosition + nScrollInc) < 0 )
-                nScrollInc = -m_xScrollPosition; // As -ve as we can go
-            else if ( (m_xScrollPosition + nScrollInc) > noPositions )
-                nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go
+            if ( m_xScrollPosition + nScrollInc < 0 )
+            {
+                // As -ve as we can go
+                nScrollInc = -m_xScrollPosition;
+            }
+            else // check for the other bound
+            {
+                const int posMax = m_xScrollLines - m_xScrollLinesPerPage;
+                if ( m_xScrollPosition + nScrollInc > posMax )
+                {
+                    // As +ve as we can go
+                    nScrollInc = posMax - m_xScrollPosition;
+                }
+            }

         }
         else
         }
         else

-            m_targetWindow->Refresh(TRUE, GetRect());
+            m_targetWindow->Refresh(true, GetScrollRect());

     }
     else
     {
     }
     else
     {

-        if (m_yScrollPixelsPerLine > 0)
+        if ( m_yScrollPixelsPerLine > 0 )

         {
         {

-            int w, h;
-            GetTargetSize(&w, &h);
-
-            int nMaxHeight = m_yScrollLines*m_yScrollPixelsPerLine;
-            int noPositions = (int) ( ((nMaxHeight - h)/(double)m_yScrollPixelsPerLine) + 0.5 );
-            if (noPositions < 0)
-                noPositions = 0;
-
-            if ( (m_yScrollPosition + nScrollInc) < 0 )
-                nScrollInc = -m_yScrollPosition; // As -ve as we can go
-            else if ( (m_yScrollPosition + nScrollInc) > noPositions )
-                nScrollInc = noPositions - m_yScrollPosition; // As +ve as we can go
+            if ( m_yScrollPosition + nScrollInc < 0 )
+            {
+                // As -ve as we can go
+                nScrollInc = -m_yScrollPosition;
+            }
+            else // check for the other bound
+            {
+                const int posMax = m_yScrollLines - m_yScrollLinesPerPage;
+                if ( m_yScrollPosition + nScrollInc > posMax )
+                {
+                    // As +ve as we can go
+                    nScrollInc = posMax - m_yScrollPosition;
+                }
+            }

         }
         else
         }
         else

-            m_targetWindow->Refresh(TRUE, GetRect());
+        {
+            // VZ: why do we do this? (FIXME)
+            m_targetWindow->Refresh(true, GetScrollRect());
+        }

     }
 
     return nScrollInc;
     }
 
     return nScrollInc;


@@ -577,9 +613,18 @@ int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
 // Adjust the scrollbars - new version.
 void wxScrollHelper::AdjustScrollbars()
 {
 // Adjust the scrollbars - new version.
 void wxScrollHelper::AdjustScrollbars()
 {

-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately();
-#endif
+    static wxRecursionGuardFlag s_flagReentrancy;
+    wxRecursionGuard guard(s_flagReentrancy);
+    if ( guard.IsInside() )
+    {
+        // don't reenter AdjustScrollbars() while another call to
+        // AdjustScrollbars() is in progress because this may lead to calling
+        // ScrollWindow() twice and this can really happen under MSW if
+        // SetScrollbar() call below adds or removes the scrollbar which
+        // changes the window size and hence results in another
+        // AdjustScrollbars() call
+        return;
+    }

 
     int w = 0, h = 0;
     int oldw, oldh;
 
     int w = 0, h = 0;
     int oldw, oldh;


@@ -587,72 +632,131 @@ void wxScrollHelper::AdjustScrollbars()
     int oldXScroll = m_xScrollPosition;
     int oldYScroll = m_yScrollPosition;
 
     int oldXScroll = m_xScrollPosition;
     int oldYScroll = m_yScrollPosition;
 

-    do {
+    // VZ: at least under Windows this loop is useless because when scrollbars
+    //     [dis]appear we get a WM_SIZE resulting in another call to
+    //     AdjustScrollbars() anyhow. As it doesn't seem to do any harm I leave
+    //     it here for now but it would be better to ensure that all ports
+    //     generate EVT_SIZE when scrollbars [dis]appear, emulating it if
+    //     necessary, and remove it later
+    // JACS: Stop potential infinite loop by limiting number of iterations
+    int iterationCount = 0;
+    const int iterationMax = 5;
+    do
+    {
+        iterationCount ++;
+

         GetTargetSize(&w, 0);
 
         GetTargetSize(&w, 0);
 

-        if (m_xScrollPixelsPerLine == 0)
+        // scroll lines per page: if 0, no scrolling is needed
+        int linesPerPage;
+
+        if ( m_xScrollPixelsPerLine == 0 )

         {
         {

+            // scrolling is disabled

             m_xScrollLines = 0;
             m_xScrollPosition = 0;
             m_xScrollLines = 0;
             m_xScrollPosition = 0;

-            m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
+            linesPerPage = 0;

         }
         }

-        else
+        else // might need scrolling

         {
         {

-            m_xScrollLines = m_targetWindow->GetVirtualSize().GetWidth() / m_xScrollPixelsPerLine;
+            // Round up integer division to catch any "leftover" client space.
+            const int wVirt = m_targetWindow->GetVirtualSize().GetWidth();
+            m_xScrollLines = (wVirt + m_xScrollPixelsPerLine - 1) / m_xScrollPixelsPerLine;

 
             // Calculate page size i.e. number of scroll units you get on the
 
             // Calculate page size i.e. number of scroll units you get on the

-            // current client window
-            int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
-            if (noPagePositions < 1) noPagePositions = 1;
-            if ( noPagePositions > m_xScrollLines )
-                noPagePositions = m_xScrollLines;
-
-            // Correct position if greater than extent of canvas minus
-            // the visible portion of it or if below zero
-            m_xScrollPosition = wxMin( m_xScrollLines - noPagePositions, m_xScrollPosition);
-            m_xScrollPosition = wxMax( 0, m_xScrollPosition );
-
-            m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
-            // The amount by which we scroll when paging
-            SetScrollPageSize(wxHORIZONTAL, noPagePositions);
+            // current client window.
+            linesPerPage = w / m_xScrollPixelsPerLine;
+
+            // Special case. When client and virtual size are very close but
+            // the client is big enough, kill scrollbar.
+            if ((linesPerPage < m_xScrollLines) && (w >= wVirt)) ++linesPerPage;
+
+            if (linesPerPage >= m_xScrollLines)
+            {
+                // we're big enough to not need scrolling
+                linesPerPage =
+                m_xScrollLines =
+                m_xScrollPosition = 0;
+            }
+            else // we do need a scrollbar
+            {
+                if ( linesPerPage < 1 )
+                    linesPerPage = 1;
+
+                // Correct position if greater than extent of canvas minus
+                // the visible portion of it or if below zero
+                const int posMax = m_xScrollLines - linesPerPage;
+                if ( m_xScrollPosition > posMax )
+                    m_xScrollPosition = posMax;
+                else if ( m_xScrollPosition < 0 )
+                    m_xScrollPosition = 0;
+            }

         }
 
         }
 

+        m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition,
+                            linesPerPage, m_xScrollLines);
+
+        // The amount by which we scroll when paging
+        SetScrollPageSize(wxHORIZONTAL, linesPerPage);
+

         GetTargetSize(0, &h);
 
         GetTargetSize(0, &h);
 

-        if (m_yScrollPixelsPerLine == 0)
+        if ( m_yScrollPixelsPerLine == 0 )

         {
         {

+            // scrolling is disabled

             m_yScrollLines = 0;
             m_yScrollPosition = 0;
             m_yScrollLines = 0;
             m_yScrollPosition = 0;

-            m_win->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
+            linesPerPage = 0;

         }
         }

-        else
+        else // might need scrolling

         {
         {

-            m_yScrollLines = m_targetWindow->GetVirtualSize().GetHeight() / m_yScrollPixelsPerLine;
+            // Round up integer division to catch any "leftover" client space.
+            const int hVirt = m_targetWindow->GetVirtualSize().GetHeight();
+            m_yScrollLines = ( hVirt + m_yScrollPixelsPerLine - 1 ) / m_yScrollPixelsPerLine;

 
             // Calculate page size i.e. number of scroll units you get on the
 
             // Calculate page size i.e. number of scroll units you get on the

-            // current client window
-            int noPagePositions = (int) ( (h/(double)m_yScrollPixelsPerLine) + 0.5 );
-            if (noPagePositions < 1) noPagePositions = 1;
-            if ( noPagePositions > m_yScrollLines )
-                noPagePositions = m_yScrollLines;
-
-            // Correct position if greater than extent of canvas minus
-            // the visible portion of it or if below zero
-            m_yScrollPosition = wxMin( m_yScrollLines - noPagePositions, m_yScrollPosition );
-            m_yScrollPosition = wxMax( 0, m_yScrollPosition );
-
-            m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
-            // The amount by which we scroll when paging
-            SetScrollPageSize(wxVERTICAL, noPagePositions);
+            // current client window.
+            linesPerPage = h / m_yScrollPixelsPerLine;
+
+            // Special case. When client and virtual size are very close but
+            // the client is big enough, kill scrollbar.
+            if ((linesPerPage < m_yScrollLines) && (h >= hVirt)) ++linesPerPage;
+
+            if (linesPerPage >= m_yScrollLines)
+            {
+                // we're big enough to not need scrolling
+                linesPerPage =
+                m_yScrollLines =
+                m_yScrollPosition = 0;
+            }
+            else // we do need a scrollbar
+            {
+                if ( linesPerPage < 1 )
+                    linesPerPage = 1;
+
+                // Correct position if greater than extent of canvas minus
+                // the visible portion of it or if below zero
+                const int posMax = m_yScrollLines - linesPerPage;
+                if ( m_yScrollPosition > posMax )
+                    m_yScrollPosition = posMax;
+                else if ( m_yScrollPosition < 0 )
+                    m_yScrollPosition = 0;
+            }

         }
 
         }
 

-        // If a scrollbar (dis)appeared as a result of this, adjust them again.
+        m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition,
+                            linesPerPage, m_yScrollLines);

 
 

+        // The amount by which we scroll when paging
+        SetScrollPageSize(wxVERTICAL, linesPerPage);
+
+
+        // If a scrollbar (dis)appeared as a result of this, adjust them again.

         oldw = w;
         oldh = h;
 
         GetTargetSize( &w, &h );
         oldw = w;
         oldh = h;
 
         GetTargetSize( &w, &h );

-    } while ( w != oldw && h != oldh );
+    } while ( (w != oldw || h != oldh) && (iterationCount < iterationMax) );

 
 #ifdef __WXMOTIF__
     // Sorry, some Motif-specific code to implement a backing pixmap
 
 #ifdef __WXMOTIF__
     // Sorry, some Motif-specific code to implement a backing pixmap


@@ -691,23 +795,19 @@ void wxScrollHelper::AdjustScrollbars()
     {
        if (m_xScrollingEnabled)
             m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
     {
        if (m_xScrollingEnabled)
             m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,

-                                          GetRect() );
+                                          GetScrollRect() );

        else
        else

-            m_targetWindow->Refresh(TRUE, GetRect());
+            m_targetWindow->Refresh(true, GetScrollRect());

     }
 
     if (oldYScroll != m_yScrollPosition)
     {
         if (m_yScrollingEnabled)
             m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
     }
 
     if (oldYScroll != m_yScrollPosition)
     {
         if (m_yScrollingEnabled)
             m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),

-                                          GetRect() );
+                                          GetScrollRect() );

         else
         else

-            m_targetWindow->Refresh(TRUE, GetRect());
+            m_targetWindow->Refresh(true, GetScrollRect());

     }
     }

-
-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately();
-#endif

 }
 
 void wxScrollHelper::DoPrepareDC(wxDC& dc)
 }
 
 void wxScrollHelper::DoPrepareDC(wxDC& dc)


@@ -771,11 +871,7 @@ void wxScrollHelper::Scroll( int x_pos, int y_pos )
     if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
         ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
 
     if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
         ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
 

-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately();
-#endif
-
-    int w, h;
+    int w = 0, h = 0;

     GetTargetSize(&w, &h);
 
     if ((x_pos != -1) && (m_xScrollPixelsPerLine))
     GetTargetSize(&w, &h);
 
     if ((x_pos != -1) && (m_xScrollPixelsPerLine))


@@ -796,7 +892,7 @@ void wxScrollHelper::Scroll( int x_pos, int y_pos )
         if (old_x != m_xScrollPosition) {
             m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
             m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
         if (old_x != m_xScrollPosition) {
             m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
             m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,

-                                          GetRect() );
+                                          GetScrollRect() );

         }
     }
     if ((y_pos != -1) && (m_yScrollPixelsPerLine))
         }
     }
     if ((y_pos != -1) && (m_yScrollPixelsPerLine))


@@ -817,14 +913,9 @@ void wxScrollHelper::Scroll( int x_pos, int y_pos )
         if (old_y != m_yScrollPosition) {
             m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
             m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
         if (old_y != m_yScrollPosition) {
             m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
             m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,

-                                          GetRect() );
+                                          GetScrollRect() );

         }
     }
         }
     }

-
-#ifdef __WXMAC__
-    m_targetWindow->MacUpdateImmediately();
-#endif
-

 }
 
 void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)
 }
 
 void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)


@@ -859,21 +950,88 @@ void wxScrollHelper::DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) co
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// event handlers
+// geometry

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// Default OnSize resets scrollbars, if any
-void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
+bool wxScrollHelper::ScrollLayout()

 {
 {

-    if( m_targetWindow != m_win )
-        m_targetWindow->SetVirtualSize( m_targetWindow->GetClientSize() );
+    if ( m_win->GetSizer() && m_targetWindow == m_win )
+    {
+        // If we're the scroll target, take into account the
+        // virtual size and scrolled position of the window.

 
 

-    m_win->SetVirtualSize( m_win->GetClientSize() );
+        int x = 0, y = 0, w = 0, h = 0;
+        CalcScrolledPosition(0,0, &x,&y);
+        m_win->GetVirtualSize(&w, &h);
+        m_win->GetSizer()->SetDimension(x, y, w, h);
+        return true;
+    }
+
+    // fall back to default for LayoutConstraints
+    return m_win->wxWindow::Layout();
+}
+
+void wxScrollHelper::ScrollDoSetVirtualSize(int x, int y)
+{
+    m_win->wxWindow::DoSetVirtualSize( x, y );
+    AdjustScrollbars();

 
 

-#if wxUSE_CONSTRAINTS

     if (m_win->GetAutoLayout())
         m_win->Layout();
     if (m_win->GetAutoLayout())
         m_win->Layout();

-#endif
+}
+
+// wxWindow's GetBestVirtualSize returns the actual window size,
+// whereas we want to return the virtual size
+wxSize wxScrollHelper::ScrollGetBestVirtualSize() const
+{
+    wxSize clientSize(m_win->GetClientSize());
+    if ( m_win->GetSizer() )
+        clientSize.IncTo(m_win->GetSizer()->CalcMin());
+
+    return clientSize;
+}
+
+// return the window best size from the given best virtual size
+wxSize
+wxScrollHelper::ScrollGetWindowSizeForVirtualSize(const wxSize& size) const
+{
+    // Only use the content to set the window size in the direction
+    // where there's no scrolling; otherwise we're going to get a huge
+    // window in the direction in which scrolling is enabled
+    int ppuX, ppuY;
+    GetScrollPixelsPerUnit(&ppuX, &ppuY);
+
+    wxSize minSize = m_win->GetMinSize();
+    if ( !minSize.IsFullySpecified() )
+        minSize = m_win->GetSize();
+
+    wxSize best(size);
+    if (ppuX > 0)
+        best.x = minSize.x;
+    if (ppuY > 0)
+        best.y = minSize.y;
+
+    return best;
+}
+
+// ----------------------------------------------------------------------------
+// event handlers
+// ----------------------------------------------------------------------------
+
+// Default OnSize resets scrollbars, if any
+void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
+{
+    if ( m_targetWindow->GetAutoLayout() )
+    {
+        wxSize size = m_targetWindow->GetBestVirtualSize();
+
+        // This will call ::Layout() and ::AdjustScrollbars()
+        m_win->SetVirtualSize( size );
+    }
+    else
+    {
+        AdjustScrollbars();
+    }

 }
 
 // This calls OnDraw, having adjusted the origin according to the current
 }
 
 // This calls OnDraw, having adjusted the origin according to the current


@@ -893,9 +1051,9 @@ void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
 // this they always have the priority
 void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
 {
 // this they always have the priority
 void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
 {

-    int stx, sty,       // view origin
-        szx, szy,       // view size (total)
-        clix, cliy;     // view size (on screen)
+    int stx = 0, sty = 0,       // view origin
+        szx = 0, szy = 0,       // view size (total)
+        clix = 0, cliy = 0;     // view size (on screen)

 
     GetViewStart(&stx, &sty);
     GetTargetSize(&clix, &cliy);
 
     GetViewStart(&stx, &sty);
     GetTargetSize(&clix, &cliy);


@@ -926,16 +1084,14 @@ void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
         yScrollOld = m_yScrollPosition;
 
     int dsty;
         yScrollOld = m_yScrollPosition;
 
     int dsty;

-    switch ( event.KeyCode() )
+    switch ( event.GetKeyCode() )

     {
         case WXK_PAGEUP:
     {
         case WXK_PAGEUP:

-        case WXK_PRIOR:

             dsty = sty - (5 * cliy / 6);
             Scroll(-1, (dsty == -1) ? 0 : dsty);
             break;
 
         case WXK_PAGEDOWN:
             dsty = sty - (5 * cliy / 6);
             Scroll(-1, (dsty == -1) ? 0 : dsty);
             break;
 
         case WXK_PAGEDOWN:

-        case WXK_NEXT:

             Scroll(-1, sty + (5 * cliy / 6));
             break;
 
             Scroll(-1, sty + (5 * cliy / 6));
             break;
 


@@ -999,11 +1155,13 @@ bool wxScrollHelper::SendAutoScrollEvents(wxScrollWinEvent& event) const
 
 void wxScrollHelper::StopAutoScrolling()
 {
 
 void wxScrollHelper::StopAutoScrolling()
 {

+#if wxUSE_TIMER

     if ( m_timerAutoScroll )
     {
         delete m_timerAutoScroll;
         m_timerAutoScroll = (wxTimer *)NULL;
     }
     if ( m_timerAutoScroll )
     {
         delete m_timerAutoScroll;
         m_timerAutoScroll = (wxTimer *)NULL;
     }

+#endif

 }
 
 void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
 }
 
 void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)


@@ -1065,6 +1223,7 @@ void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
         if ( !m_targetWindow->HasScrollbar(orient) )
             return;
 
         if ( !m_targetWindow->HasScrollbar(orient) )
             return;
 

+#if wxUSE_TIMER

         delete m_timerAutoScroll;
         m_timerAutoScroll = new wxAutoScrollTimer
                                 (
         delete m_timerAutoScroll;
         m_timerAutoScroll = new wxAutoScrollTimer
                                 (


@@ -1075,6 +1234,9 @@ void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
                                     orient
                                 );
         m_timerAutoScroll->Start(50); // FIXME: make configurable
                                     orient
                                 );
         m_timerAutoScroll->Start(50); // FIXME: make configurable

+#else
+        wxUnusedVar(pos);
+#endif

     }
 }
 
     }
 }
 


@@ -1088,42 +1250,50 @@ void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
 
     if (lines != 0)
     {
 
     if (lines != 0)
     {

-        lines *= event.GetLinesPerAction();

 
         wxScrollWinEvent newEvent;
 
         newEvent.SetPosition(0);
         newEvent.SetOrientation(wxVERTICAL);
 
         wxScrollWinEvent newEvent;
 
         newEvent.SetPosition(0);
         newEvent.SetOrientation(wxVERTICAL);

-        newEvent.m_eventObject = m_win;
-        if (lines > 0)
-            newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
-        else
-            newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
+        newEvent.SetEventObject(m_win);
+
+        if (event.IsPageScroll())
+        {
+            if (lines > 0)
+                newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEUP);
+            else
+                newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN);

 
 

-        int times = abs(lines);
-        for (; times > 0; times --)

             m_win->GetEventHandler()->ProcessEvent(newEvent);
             m_win->GetEventHandler()->ProcessEvent(newEvent);

+        }
+        else
+        {
+            lines *= event.GetLinesPerAction();
+            if (lines > 0)
+                newEvent.SetEventType(wxEVT_SCROLLWIN_LINEUP);
+            else
+                newEvent.SetEventType(wxEVT_SCROLLWIN_LINEDOWN);

 
 

-        /* Old Way */
-        // int vsx, vsy;
-        // GetViewStart(&vsx, &vsy);
-        // Scroll(-1, vsy - lines);
+            int times = abs(lines);
+            for (; times > 0; times--)
+                m_win->GetEventHandler()->ProcessEvent(newEvent);
+        }

     }
 }
 
 #endif // wxUSE_MOUSEWHEEL
 
 // ----------------------------------------------------------------------------
     }
 }
 
 #endif // wxUSE_MOUSEWHEEL
 
 // ----------------------------------------------------------------------------

-// wxGenericScrolledWindow implementation
+// wxScrolledWindow implementation

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
+IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel)

 
 

-BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
-    EVT_PAINT(wxGenericScrolledWindow::OnPaint)
+BEGIN_EVENT_TABLE(wxScrolledWindow, wxPanel)
+    EVT_PAINT(wxScrolledWindow::OnPaint)

 END_EVENT_TABLE()
 
 END_EVENT_TABLE()
 

-bool wxGenericScrolledWindow::Create(wxWindow *parent,
+bool wxScrolledWindow::Create(wxWindow *parent,

                               wxWindowID id,
                               const wxPoint& pos,
                               const wxSize& size,
                               wxWindowID id,
                               const wxPoint& pos,
                               const wxSize& size,


@@ -1131,41 +1301,20 @@ bool wxGenericScrolledWindow::Create(wxWindow *parent,
                               const wxString& name)
 {
     m_targetWindow = this;
                               const wxString& name)
 {
     m_targetWindow = this;

+#ifdef __WXMAC__
+    MacSetClipChildren( true ) ;
+#endif

 
 

-    bool ok = wxPanel::Create(parent, id, pos, size, style, name);
+    bool ok = wxPanel::Create(parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name);

 
     return ok;
 }
 
 
     return ok;
 }
 

-wxGenericScrolledWindow::~wxGenericScrolledWindow()
+wxScrolledWindow::~wxScrolledWindow()

 {
 }
 
 {
 }
 

-bool wxGenericScrolledWindow::Layout()
-{
-    if (GetSizer() && m_targetWindow == this)
-    {
-        // If we're the scroll target, take into account the
-        // virtual size and scrolled position of the window.
-
-        int x, y, w, h;
-        CalcScrolledPosition(0,0, &x,&y);
-        GetVirtualSize(&w, &h);
-        GetSizer()->SetDimension(x, y, w, h);
-        return TRUE;
-    }
-
-    // fall back to default for LayoutConstraints
-    return wxPanel::Layout();
-}
-
-void wxGenericScrolledWindow::DoSetVirtualSize( int x, int y )
-{
-    wxPanel::DoSetVirtualSize( x, y );
-    AdjustScrollbars();
-}
-
-void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
+void wxScrolledWindow::OnPaint(wxPaintEvent& event)

 {
     // the user code didn't really draw the window if we got here, so set this
     // flag to try to call OnDraw() later
 {
     // the user code didn't really draw the window if we got here, so set this
     // flag to try to call OnDraw() later


@@ -1175,42 +1324,21 @@ void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
 }
 
 #ifdef __WXMSW__
 }
 
 #ifdef __WXMSW__

-long
-wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
+WXLRESULT wxScrolledWindow::MSWWindowProc(WXUINT nMsg,

                                        WXWPARAM wParam,
                                        WXLPARAM lParam)
 {
                                        WXWPARAM wParam,
                                        WXLPARAM lParam)
 {

-    long rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);
+    WXLRESULT rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);

 
 

+#ifndef __WXWINCE__

     // we need to process arrows ourselves for scrolling
     if ( nMsg == WM_GETDLGCODE )
     {
         rc |= DLGC_WANTARROWS;
     }
     // we need to process arrows ourselves for scrolling
     if ( nMsg == WM_GETDLGCODE )
     {
         rc |= DLGC_WANTARROWS;
     }

+#endif

 
     return rc;
 }
 
 #endif // __WXMSW__
 
     return rc;
 }
 
 #endif // __WXMSW__

-
-#if WXWIN_COMPATIBILITY
-
-void wxGenericScrolledWindow::GetScrollUnitsPerPage (int *x_page, int *y_page) const
-{
-      *x_page = GetScrollPageSize(wxHORIZONTAL);
-      *y_page = GetScrollPageSize(wxVERTICAL);
-}
-
-void wxGenericScrolledWindow::CalcUnscrolledPosition(int x, int y, float *xx, float *yy) const
-{
-    if ( xx )
-        *xx = (float)(x + m_xScrollPosition * m_xScrollPixelsPerLine);
-    if ( yy )
-        *yy = (float)(y + m_yScrollPosition * m_yScrollPixelsPerLine);
-}
-
-#endif // WXWIN_COMPATIBILITY
-
-#endif // !wxGTK
-
-// vi:sts=4:sw=4:et