// 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
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "genscrolwin.h"
#endif
#include "wx/scrolwin.h"
#include "wx/panel.h"
+#if wxUSE_TIMER
#include "wx/timer.h"
+#endif
#include "wx/sizer.h"
+#include "wx/recguard.h"
#ifdef __WXMSW__
#include <windows.h> // for DLGC_WANTARROWS
IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
+/*
+ TODO PROPERTIES
+ style wxHSCROLL | wxVSCROLL
+*/
+
// ----------------------------------------------------------------------------
// wxScrollHelperEvtHandler: intercept the events from the window and forward
// them to wxScrollHelper
virtual bool ProcessEvent(wxEvent& event);
- void ResetDrawnFlag() { m_hasDrawnWindow = FALSE; }
+ void ResetDrawnFlag() { m_hasDrawnWindow = false; }
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
wxEventType m_eventType;
int m_pos,
m_orient;
+
+ DECLARE_NO_COPY_CLASS(wxAutoScrollTimer)
};
// ============================================================================
}
}
}
+#endif
// ----------------------------------------------------------------------------
// wxScrollHelperEvtHandler
// 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);
{
m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
- return TRUE;
+ return true;
}
if ( processed )
// OnDraw() below (from HandleOnPaint)
if ( m_hasDrawnWindow )
{
- 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
- event.Skip(FALSE);
+ event.Skip(false);
if ( evType == wxEVT_PAINT )
{
m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
- return TRUE;
+ return true;
}
if ( evType == wxEVT_SCROLLWIN_TOP ||
return !event.GetSkipped();
}
- return FALSE;
+ return false;
}
// ----------------------------------------------------------------------------
m_yScrollLinesPerPage = 0;
m_xScrollingEnabled =
- m_yScrollingEnabled = TRUE;
+ m_yScrollingEnabled = true;
m_scaleX =
m_scaleY = 1.0;
m_xScrollPosition = xPos;
m_yScrollPosition = yPos;
- m_targetWindow->SetVirtualSizeHints( noUnitsX * pixelsPerUnitX, noUnitsY * pixelsPerUnitY );
+ int w = noUnitsX * pixelsPerUnitX;
+ int h = noUnitsY * pixelsPerUnitY;
- AdjustScrollbars();
+ // 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 );
+
+ // The above should arguably be deprecated, this however we still need.
+
+ m_targetWindow->SetVirtualSize( w, h );
if (do_refresh && !noRefresh)
- m_targetWindow->Refresh(TRUE, GetRect());
+ m_targetWindow->Refresh(true, GetScrollRect());
-#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately() ;
-#endif
+#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__
}
// ----------------------------------------------------------------------------
m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
}
- bool needsRefresh = FALSE;
+ bool needsRefresh = false;
int dx = 0,
dy = 0;
if (orient == wxHORIZONTAL)
}
else
{
- needsRefresh = TRUE;
+ needsRefresh = true;
}
}
else
}
else
{
- needsRefresh = TRUE;
+ needsRefresh = true;
}
}
if ( needsRefresh )
{
- m_targetWindow->Refresh(TRUE, GetRect());
+ m_targetWindow->Refresh(true, GetScrollRect());
}
else
{
- m_targetWindow->ScrollWindow(dx, dy, GetRect());
+ m_targetWindow->ScrollWindow(dx, dy, GetScrollRect());
}
-
-#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately() ;
-#endif
}
int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go
}
else
- m_targetWindow->Refresh(TRUE, GetRect());
+ m_targetWindow->Refresh(true, GetScrollRect());
}
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
- m_targetWindow->Refresh(TRUE, GetRect());
+ {
+ // VZ: why do we do this? (FIXME)
+ m_targetWindow->Refresh(true, GetScrollRect());
+ }
}
return nScrollInc;
// 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 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
+ do
+ {
GetTargetSize(&w, 0);
if (m_xScrollPixelsPerLine == 0)
{
m_xScrollLines = 0;
m_xScrollPosition = 0;
- m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
+ m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, false);
}
else
{
GetTargetSize(0, &h);
- if (m_yScrollPixelsPerLine == 0)
+ // scroll lines per page: if 0, no scrolling is needed
+ int linesPerPage;
+
+ if ( m_yScrollPixelsPerLine == 0 )
{
+ // scrolling is disabled
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;
+ int hVirt = m_targetWindow->GetVirtualSize().GetHeight();
+ m_yScrollLines = hVirt / m_yScrollPixelsPerLine;
// 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;
+ linesPerPage = h / m_yScrollPixelsPerLine;
+ 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;
+ }
+ }
- // 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,
+ linesPerPage, m_yScrollLines);
- m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
- // The amount by which we scroll when paging
- SetScrollPageSize(wxVERTICAL, noPagePositions);
- }
+ // The amount by which we scroll when paging
+ SetScrollPageSize(wxVERTICAL, linesPerPage);
- // If a scrollbar (dis)appeared as a result of this, adjust them again.
+ // If a scrollbar (dis)appeared as a result of this, adjust them again.
oldw = w;
oldh = h;
GetTargetSize( &w, &h );
- } while ( w != oldw && h != oldh );
+ } while ( w != oldw || h != oldh );
#ifdef __WXMOTIF__
// Sorry, some Motif-specific code to implement a backing pixmap
{
if (m_xScrollingEnabled)
m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
- GetRect() );
+ GetScrollRect() );
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),
- GetRect() );
+ GetScrollRect() );
else
- m_targetWindow->Refresh(TRUE, GetRect());
+ m_targetWindow->Refresh(true, GetScrollRect());
}
-
-#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately();
-#endif
}
void wxScrollHelper::DoPrepareDC(wxDC& dc)
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;
GetTargetSize(&w, &h);
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 (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)
// Default OnSize resets scrollbars, if any
void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
{
- if ( m_targetWindow != m_win )
- m_targetWindow->SetVirtualSize( m_targetWindow->GetClientSize() );
+ if( m_win->GetAutoLayout() || m_targetWindow->GetAutoLayout() )
+ {
+ if ( m_targetWindow != m_win )
+ m_targetWindow->FitInside();
- m_win->SetVirtualSize( m_win->GetClientSize() );
+ m_win->FitInside();
- AdjustScrollbars();
-
-#if wxUSE_CONSTRAINTS
- if (m_win->GetAutoLayout())
- m_win->Layout();
-#endif
+ // FIXME: Something is really weird here... This should be
+ // called by FitInside above (and apparently is), yet the
+ // scrollsub sample will get the scrollbar wrong if resized
+ // quickly. This masks the bug, but is surely not the right
+ // answer at all.
+ AdjustScrollbars();
+ }
+ else
+ AdjustScrollbars();
}
// This calls OnDraw, having adjusted the origin according to the current
yScrollOld = m_yScrollPosition;
int dsty;
- switch ( event.KeyCode() )
+ switch ( event.GetKeyCode() )
{
case WXK_PAGEUP:
case WXK_PRIOR:
void wxScrollHelper::StopAutoScrolling()
{
+#if wxUSE_TIMER
if ( m_timerAutoScroll )
{
delete m_timerAutoScroll;
m_timerAutoScroll = (wxTimer *)NULL;
}
+#endif
}
void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
if ( !m_targetWindow->HasScrollbar(orient) )
return;
+#if wxUSE_TIMER
delete m_timerAutoScroll;
m_timerAutoScroll = new wxAutoScrollTimer
(
orient
);
m_timerAutoScroll->Start(50); // FIXME: make configurable
+#else
+ wxUnusedVar(pos);
+#endif
}
}
{
m_targetWindow = this;
- bool ok = wxPanel::Create(parent, id, pos, size, style, name);
+ bool ok = wxPanel::Create(parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name);
return ok;
}
CalcScrolledPosition(0,0, &x,&y);
GetVirtualSize(&w, &h);
GetSizer()->SetDimension(x, y, w, h);
- return TRUE;
+ return true;
}
// fall back to default for LayoutConstraints
return wxPanel::Layout();
}
+void wxGenericScrolledWindow::DoSetVirtualSize(int x, int y)
+{
+ wxPanel::DoSetVirtualSize( x, y );
+ AdjustScrollbars();
+
+ if (GetAutoLayout())
+ Layout();
+}
+
void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
{
// the user code didn't really draw the window if we got here, so set this
}
#ifdef __WXMSW__
-long
+WXLRESULT
wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
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;
}
+#endif
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
projects / wxWidgets.git / blobdiff