// Name: generic/scrolwin.cpp
// Purpose: wxGenericScrolledWindow implementation
// Author: Julian Smart
-// Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement
+// 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
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
wxScrollHelper *m_scrollHelper;
bool m_hasDrawnWindow;
+
+ DECLARE_NO_COPY_CLASS(wxScrollHelperEvtHandler)
};
// ----------------------------------------------------------------------------
wxEventType m_eventType;
int m_pos,
m_orient;
+
+ DECLARE_NO_COPY_CLASS(wxAutoScrollTimer)
};
// ============================================================================
bool do_refresh =
(
(noUnitsX != 0 && m_xScrollLines == 0) ||
- (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX*noUnitsX) ||
+ (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX * noUnitsX) ||
(noUnitsY != 0 && m_yScrollLines == 0) ||
- (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY*noUnitsY) ||
+ (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY * noUnitsY) ||
(xPos != m_xScrollPosition) ||
(yPos != m_yScrollPosition)
);
m_yScrollPixelsPerLine = pixelsPerUnitY;
m_xScrollPosition = xPos;
m_yScrollPosition = yPos;
- m_xScrollLines = noUnitsX;
- m_yScrollLines = noUnitsY;
-
-#ifdef __WXMOTIF__
- // Sorry, some Motif-specific code to implement a backing pixmap
- // for the wxRETAINED style. Implementing a backing store can't
- // be entirely generic because it relies on the wxWindowDC implementation
- // to duplicate X drawing calls for the backing pixmap.
- if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
- {
- Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
+ int w = noUnitsX * pixelsPerUnitX;
+ int h = noUnitsY * pixelsPerUnitY;
- int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
- int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
- if (m_targetWindow->GetBackingPixmap() &&
- !((m_targetWindow->GetPixmapWidth() == totalPixelWidth) &&
- (m_targetWindow->GetPixmapHeight() == totalPixelHeight)))
- {
- XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
- m_targetWindow->SetBackingPixmap((WXPixmap) 0);
- }
+ // For better backward compatibility we set persisting limits
+ // here not just the size. It makes SetScrollbars 'sticky'
+ // emulating the old non-autoscroll behaviour.
- if (!m_targetWindow->GetBackingPixmap() &&
- (noUnitsX != 0) && (noUnitsY != 0))
- {
- int depth = wxDisplayDepth();
- m_targetWindow->SetPixmapWidth(totalPixelWidth);
- m_targetWindow->SetPixmapHeight(totalPixelHeight);
- m_targetWindow->SetBackingPixmap((WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
- m_targetWindow->GetPixmapWidth(), m_targetWindow->GetPixmapHeight(), depth));
- }
+ m_targetWindow->SetVirtualSizeHints( w, h );
- }
-#endif // Motif
+ // The above should arguably be deprecated, this however we still need.
- AdjustScrollbars();
+ m_targetWindow->SetVirtualSize( w, h );
if (do_refresh && !noRefresh)
- m_targetWindow->Refresh(TRUE, GetRect());
-
+ 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
#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately() ;
+ m_targetWindow->Update() ;
#endif
+ }
+#endif // !__WXUNIVERSAL__
}
// ----------------------------------------------------------------------------
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() ;
+ m_targetWindow->Update() ;
#endif
}
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;
void wxScrollHelper::AdjustScrollbars()
{
#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately();
+ m_targetWindow->Update();
#endif
- int w, h;
- GetTargetSize(&w, &h);
+ int w = 0, h = 0;
+ int oldw, oldh;
int oldXScroll = m_xScrollPosition;
int oldYScroll = m_yScrollPosition;
- if (m_xScrollLines > 0)
+ // 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
{
- // 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;
+ GetTargetSize(&w, 0);
- // 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 );
+ if (m_xScrollPixelsPerLine == 0)
+ {
+ m_xScrollLines = 0;
+ m_xScrollPosition = 0;
+ m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
+ }
+ else
+ {
+ m_xScrollLines = m_targetWindow->GetVirtualSize().GetWidth() / m_xScrollPixelsPerLine;
+
+ // 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);
+ }
- m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
- // The amount by which we scroll when paging
- SetScrollPageSize(wxHORIZONTAL, noPagePositions);
- }
- else
- {
- m_xScrollPosition = 0;
- m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
- }
+ GetTargetSize(0, &h);
- if (m_yScrollLines > 0)
- {
- // 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;
+ // scroll lines per page: if 0, no scrolling is needed
+ int linesPerPage;
- // 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 );
+ if ( m_yScrollPixelsPerLine == 0 )
+ {
+ // scrolling is disabled
+ m_yScrollLines = 0;
+ m_yScrollPosition = 0;
+ linesPerPage = 0;
+ }
+ else // might need scrolling
+ {
+ 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
+ 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;
+ }
+ }
+
+ 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);
- }
- else
+ SetScrollPageSize(wxVERTICAL, linesPerPage);
+
+
+ // 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 );
+
+#ifdef __WXMOTIF__
+ // Sorry, some Motif-specific code to implement a backing pixmap
+ // for the wxRETAINED style. Implementing a backing store can't
+ // be entirely generic because it relies on the wxWindowDC implementation
+ // to duplicate X drawing calls for the backing pixmap.
+
+ if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
{
- m_yScrollPosition = 0;
- m_win->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
+ Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
+
+ int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
+ int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
+ if (m_targetWindow->GetBackingPixmap() &&
+ !((m_targetWindow->GetPixmapWidth() == totalPixelWidth) &&
+ (m_targetWindow->GetPixmapHeight() == totalPixelHeight)))
+ {
+ XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
+ m_targetWindow->SetBackingPixmap((WXPixmap) 0);
+ }
+
+ if (!m_targetWindow->GetBackingPixmap() &&
+ (m_xScrollLines != 0) && (m_yScrollLines != 0))
+ {
+ int depth = wxDisplayDepth();
+ m_targetWindow->SetPixmapWidth(totalPixelWidth);
+ m_targetWindow->SetPixmapHeight(totalPixelHeight);
+ m_targetWindow->SetBackingPixmap((WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
+ m_targetWindow->GetPixmapWidth(), m_targetWindow->GetPixmapHeight(), depth));
+ }
+
}
+#endif // Motif
if (oldXScroll != m_xScrollPosition)
{
if (m_xScrollingEnabled)
- m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll-m_xScrollPosition), 0,
- GetRect() );
+ m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
+ 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();
+ m_targetWindow->Update();
#endif
}
dc.SetUserScale( m_scaleX, m_scaleY );
}
+void wxScrollHelper::SetScrollRate( int xstep, int ystep )
+{
+ int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
+ int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+
+ m_xScrollPixelsPerLine = xstep;
+ m_yScrollPixelsPerLine = ystep;
+
+ int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
+ int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+
+ m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
+ m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
+ m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
+
+ AdjustScrollbars();
+}
+
void wxScrollHelper::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
{
if ( x_unit )
((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
#ifdef __WXMAC__
- m_targetWindow->MacUpdateImmediately();
+ m_targetWindow->Update();
#endif
int 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();
+ m_targetWindow->Update();
#endif
}
m_yScrollingEnabled = y_scroll;
}
-void wxScrollHelper::GetVirtualSize (int *x, int *y) const
-{
- if ( x )
- *x = m_xScrollPixelsPerLine * m_xScrollLines;
- if ( y )
- *y = m_yScrollPixelsPerLine * m_yScrollLines;
-}
-
// Where the current view starts from
void wxScrollHelper::GetViewStart (int *x, int *y) const
{
// Default OnSize resets scrollbars, if any
void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
{
- AdjustScrollbars();
+ if( m_win->GetAutoLayout() || m_targetWindow->GetAutoLayout() )
+ {
+ if ( m_targetWindow != m_win )
+ m_targetWindow->FitInside();
+
+ m_win->FitInside();
+
+ // 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
GetViewStart(&stx, &sty);
GetTargetSize(&clix, &cliy);
- GetVirtualSize(&szx, &szy);
+ m_targetWindow->GetVirtualSize(&szx, &szy);
if( m_xScrollPixelsPerLine )
{
yScrollOld = m_yScrollPosition;
int dsty;
- switch ( event.KeyCode() )
+ switch ( event.GetKeyCode() )
{
case WXK_PAGEUP:
case WXK_PRIOR:
if (lines != 0)
{
- lines *= event.GetLinesPerAction();
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;
- int times = abs(lines);
- for (; times > 0; times --)
+ if (event.IsPageScroll())
+ {
+ if (lines > 0)
+ newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEUP;
+ else
+ newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEDOWN;
+
m_win->GetEventHandler()->ProcessEvent(newEvent);
+ }
+ else
+ {
+ lines *= event.GetLinesPerAction();
+ if (lines > 0)
+ newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
+ else
+ newEvent.m_eventType = 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);
+ }
}
}
bool wxGenericScrolledWindow::Layout()
{
- if (GetSizer())
+ if (GetSizer() && m_targetWindow == this)
{
- // Take into account the virtual size and scrolled position of the window
+ // 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);
return wxPanel::Layout();
}
+void wxGenericScrolledWindow::DoSetVirtualSize(int x, int y)
+{
+ wxPanel::DoSetVirtualSize( x, y );
+ AdjustScrollbars();
+
+#if wxUSE_CONSTRAINTS
+ if (GetAutoLayout())
+ Layout();
+#endif
+}
+
void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
{
// the user code didn't really draw the window if we got here, so set this
{
long 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 // !wxGTK
+// vi:sts=4:sw=4:et