// 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
#include "wx/scrolwin.h"
#include "wx/panel.h"
#include "wx/timer.h"
+#include "wx/sizer.h"
#ifdef __WXMSW__
#include <windows.h> // for DLGC_WANTARROWS
// them to wxScrollHelper
// ----------------------------------------------------------------------------
-class wxScrollHelperEvtHandler : public wxEvtHandler
+class WXDLLEXPORT wxScrollHelperEvtHandler : public wxEvtHandler
{
public:
wxScrollHelperEvtHandler(wxScrollHelper *scrollHelper)
virtual bool ProcessEvent(wxEvent& event);
+ void ResetDrawnFlag() { m_hasDrawnWindow = FALSE; }
+
private:
wxScrollHelper *m_scrollHelper;
+
+ bool m_hasDrawnWindow;
};
// ----------------------------------------------------------------------------
{
wxEventType evType = event.GetEventType();
+ // the explanation of wxEVT_PAINT processing hack: for historic reasons
+ // there are 2 ways to process this event in classes deriving from
+ // wxScrolledWindow. The user code may
+ //
+ // 1. override wxScrolledWindow::OnDraw(dc)
+ // 2. define its own OnPaint() handler
+ //
+ // In addition, in wxUniversal wxWindow defines OnPaint() itself and
+ // always processes the draw event, so we can't just try the window
+ // OnPaint() first and call our HandleOnPaint() if it doesn't process it
+ // (the latter would never be called in wxUniversal).
+ //
+ // So the solution is to have a flag telling us whether the user code drew
+ // 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;
+
+ // pass it on to the real handler
+ bool processed = wxEvtHandler::ProcessEvent(event);
+
+ // always process the size events ourselves, even if the user code handles
+ // them as well, as we need to AdjustScrollbars()
+ //
+ // NB: it is important to do it after processing the event in the normal
+ // way as HandleOnSize() may generate a wxEVT_SIZE itself if the
+ // scrollbar[s] (dis)appear and it should be seen by the user code
+ // after this one
if ( evType == wxEVT_SIZE )
{
m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
- }
- if ( wxEvtHandler::ProcessEvent(event) )
return TRUE;
+ }
+
+ if ( processed )
+ {
+ // 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 )
+ {
+ return TRUE;
+ }
+ }
// reset the skipped flag to FALSE as it might have been set to TRUE in
// ProcessEvent() above
m_timerAutoScroll = (wxTimer *)NULL;
+ m_handler = NULL;
+
if ( win )
SetWindow(win);
}
-void wxScrollHelper::SetWindow(wxWindow *win)
-{
- wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
-
- m_targetWindow = m_win = win;
-
- // install the event handler which will intercept the events we're
- // interested in
- m_win->PushEventHandler(new wxScrollHelperEvtHandler(this));
-}
-
wxScrollHelper::~wxScrollHelper()
{
StopAutoScrolling();
- if ( m_targetWindow )
- m_targetWindow->PopEventHandler(TRUE /* do delete it */);
- if ( m_win && m_win != m_targetWindow)
- m_win->PopEventHandler(TRUE /* do delete it */);
+ DeleteEvtHandler();
}
// ----------------------------------------------------------------------------
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 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() &&
- (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));
- }
-
- }
-#endif // Motif
- AdjustScrollbars();
+ m_targetWindow->SetVirtualSizeHints( noUnitsX * pixelsPerUnitX, noUnitsY * pixelsPerUnitY );
if (do_refresh && !noRefresh)
m_targetWindow->Refresh(TRUE, GetRect());
}
// ----------------------------------------------------------------------------
-// target window handling
+// [target] window handling
// ----------------------------------------------------------------------------
-void wxScrollHelper::SetTargetWindow( wxWindow *target )
+void wxScrollHelper::DeleteEvtHandler()
+{
+ // search for m_handler in the handler list
+ if ( m_win && m_handler )
+ {
+ if ( m_win->RemoveEventHandler(m_handler) )
+ {
+ delete m_handler;
+ }
+ //else: something is very wrong, so better [maybe] leak memory than
+ // risk a crash because of double deletion
+
+ m_handler = NULL;
+ }
+}
+
+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)
{
- wxASSERT_MSG( target, wxT("target window must not be NULL") );
- // FIXME: There is a potential problem with this way of deleting
- // event handlers, basically you can not be sure that you delete
- // the event handler that was create by this wxScrollHelper.
- // Remove the old event handler from the previous target scroll window.
- if (m_targetWindow && m_targetWindow != m_win)
- m_targetWindow->PopEventHandler(TRUE /* Delete old event handler*/);
m_targetWindow = target;
- // Install a new event handler, which will intercept the events we're
- // interested in from the target scroll window.
- if (m_targetWindow != m_win)
- m_targetWindow->PushEventHandler(new wxScrollHelperEvtHandler(this));
+
+ // 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
+ // which we scroll - we don't need to hijack its events)
+ if ( m_targetWindow == m_win )
+ {
+ // if we already have a handler, delete it first
+ DeleteEvtHandler();
+
+ m_handler = new wxScrollHelperEvtHandler(this);
+ m_targetWindow->PushEventHandler(m_handler);
+ }
+}
+
+void wxScrollHelper::SetTargetWindow(wxWindow *target)
+{
+ wxCHECK_RET( target, wxT("target window must not be NULL") );
+
+ if ( target == m_targetWindow )
+ return;
+
+ DoSetTargetWindow(target);
}
wxWindow *wxScrollHelper::GetTargetWindow() const
if (orient == wxHORIZONTAL)
{
m_xScrollPosition += nScrollInc;
- m_targetWindow->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
+ m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
}
else
{
m_yScrollPosition += nScrollInc;
- m_targetWindow->SetScrollPos(wxVERTICAL, m_yScrollPosition);
+ m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
}
bool needsRefresh = FALSE;
m_targetWindow->MacUpdateImmediately();
#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)
- {
- // 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;
+ do {
+ 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_targetWindow->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
- // The amount by which we scroll when paging
- SetScrollPageSize(wxHORIZONTAL, noPagePositions);
- }
- else
- {
- m_xScrollPosition = 0;
- m_targetWindow->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;
+ if (m_yScrollPixelsPerLine == 0)
+ {
+ m_yScrollLines = 0;
+ m_yScrollPosition = 0;
+ m_win->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
+ }
+ else
+ {
+ m_yScrollLines = m_targetWindow->GetVirtualSize().GetHeight() / 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;
+
+ // 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);
+ }
- // 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 a scrollbar (dis)appeared as a result of this, adjust them again.
- m_targetWindow->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
- // The amount by which we scroll when paging
- SetScrollPageSize(wxVERTICAL, noPagePositions);
- }
- else
+ 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_targetWindow->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,
+ m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
GetRect() );
else
m_targetWindow->Refresh(TRUE, GetRect());
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 )
m_xScrollPosition = wxMax( 0, m_xScrollPosition );
if (old_x != m_xScrollPosition) {
- m_targetWindow->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
+ m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
GetRect() );
}
m_yScrollPosition = wxMax( 0, m_yScrollPosition );
if (old_y != m_yScrollPosition) {
- m_targetWindow->SetScrollPos( wxVERTICAL, m_yScrollPosition );
+ m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
GetRect() );
}
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
{
*y = m_yScrollPosition;
}
-void wxScrollHelper::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
+void wxScrollHelper::DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const
{
if ( xx )
*xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
*yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
}
-void wxScrollHelper::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
+void wxScrollHelper::DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
{
if ( xx )
*xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
// Default OnSize resets scrollbars, if any
void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
{
+ if( m_targetWindow != m_win )
+ m_targetWindow->SetVirtualSize( m_targetWindow->GetClientSize() );
+
+ m_win->SetVirtualSize( m_win->GetClientSize() );
+
#if wxUSE_CONSTRAINTS
- if ( m_targetWindow->GetAutoLayout() )
- m_targetWindow->Layout();
+ if (m_win->GetAutoLayout())
+ m_win->Layout();
#endif
-
- AdjustScrollbars();
}
// This calls OnDraw, having adjusted the origin according to the current
// scroll position
void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
{
- wxPaintDC dc(m_targetWindow);
+ // don't use m_targetWindow here, this is always called for ourselves
+ wxPaintDC dc(m_win);
DoPrepareDC(dc);
OnDraw(dc);
GetViewStart(&stx, &sty);
GetTargetSize(&clix, &cliy);
- GetVirtualSize(&szx, &szy);
+ m_targetWindow->GetVirtualSize(&szx, &szy);
if( m_xScrollPixelsPerLine )
{
IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
+BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
+ EVT_PAINT(wxGenericScrolledWindow::OnPaint)
+END_EVENT_TABLE()
+
bool wxGenericScrolledWindow::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
bool ok = wxPanel::Create(parent, id, pos, size, style, name);
-#ifdef __WXMSW__
- // we need to process arrows ourselves for scrolling
- m_lDlgCode |= DLGC_WANTARROWS;
-#endif // __WXMSW__
-
return ok;
}
{
}
+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)
+{
+ // the user code didn't really draw the window if we got here, so set this
+ // flag to try to call OnDraw() later
+ m_handler->ResetDrawnFlag();
+
+ event.Skip();
+}
+
+#ifdef __WXMSW__
+long
+wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
+ WXWPARAM wParam,
+ WXLPARAM lParam)
+{
+ long rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);
+
+ // we need to process arrows ourselves for scrolling
+ if ( nMsg == WM_GETDLGCODE )
+ {
+ rc |= DLGC_WANTARROWS;
+ }
+
+ return rc;
+}
+
+#endif // __WXMSW__
+
#if WXWIN_COMPATIBILITY
+
void wxGenericScrolledWindow::GetScrollUnitsPerPage (int *x_page, int *y_page) const
{
*x_page = GetScrollPageSize(wxHORIZONTAL);
if ( yy )
*yy = (float)(y + m_yScrollPosition * m_yScrollPixelsPerLine);
}
+
#endif // WXWIN_COMPATIBILITY
#endif // !wxGTK
+// vi:sts=4:sw=4:et
projects / wxWidgets.git / blobdiff