/////////////////////////////////////////////////////////////////////////////
-// Name: scrolwin.cpp
-// Purpose: wxScrolledWindow implementation
+// Name: generic/scrolwin.cpp
+// Purpose: wxGenericScrolledWindow implementation
// Author: Julian Smart
-// Modified by:
+// Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) wxWindows team
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
#ifdef __GNUG__
-#pragma implementation
-#pragma implementation "scrolwin.h"
+ #pragma implementation "scrolwin.h"
+#endif
+
+#ifdef __VMS
+#define XtDisplay XTDISPLAY
#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
+#ifdef __BORLANDC__
+ #pragma hdrstop
+#endif
+
#include "wx/utils.h"
#include "wx/dcclient.h"
+#include "wx/scrolwin.h"
+#include "wx/panel.h"
+#include "wx/timer.h"
+
#ifdef __WXMSW__
-#include "windows.h"
+ #include <windows.h> // for DLGC_WANTARROWS
#endif
-#ifdef __BORLANDC__
-#pragma hdrstop
+#ifdef __WXMOTIF__
+// For wxRETAINED implementation
+#ifdef __VMS__ //VMS's Xm.h is not (yet) compatible with C++
+ //This code switches off the compiler warnings
+# pragma message disable nosimpint
+#endif
+#include <Xm/Xm.h>
+#ifdef __VMS__
+# pragma message enable nosimpint
+#endif
#endif
-#include "wx/generic/scrolwin.h"
+#ifndef __WXGTK__
+IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
+#endif
-#if !USE_SHARED_LIBRARY
-BEGIN_EVENT_TABLE(wxScrolledWindow, wxWindow)
- EVT_SCROLL(wxScrolledWindow::OnScroll)
- EVT_SIZE(wxScrolledWindow::OnSize)
- EVT_PAINT(wxScrolledWindow::OnPaint)
-END_EVENT_TABLE()
+// ----------------------------------------------------------------------------
+// wxScrollHelperEvtHandler: intercept the events from the window and forward
+// them to wxScrollHelper
+// ----------------------------------------------------------------------------
-IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxWindow)
-#endif
+class wxScrollHelperEvtHandler : public wxEvtHandler
+{
+public:
+ wxScrollHelperEvtHandler(wxScrollHelper *scrollHelper)
+ {
+ m_scrollHelper = scrollHelper;
+ }
+
+ virtual bool ProcessEvent(wxEvent& event);
+
+private:
+ wxScrollHelper *m_scrollHelper;
+};
+
+// ----------------------------------------------------------------------------
+// wxAutoScrollTimer: the timer used to generate a stream of scroll events when
+// a captured mouse is held outside the window
+// ----------------------------------------------------------------------------
-wxScrolledWindow::wxScrolledWindow(void)
-{
- m_xScrollPixelsPerLine = 0;
- m_yScrollPixelsPerLine = 0;
- m_xScrollingEnabled = TRUE;
- m_yScrollingEnabled = TRUE;
- m_xScrollPosition = 0;
- m_yScrollPosition = 0;
- m_xScrollLines = 0;
- m_yScrollLines = 0;
- m_xScrollLinesPerPage = 0;
- m_yScrollLinesPerPage = 0;
- m_scaleX = 1.0;
- m_scaleY = 1.0;
-}
-
-bool wxScrolledWindow::Create(wxWindow *parent, wxWindowID id,
- const wxPoint& pos,
- const wxSize& size,
- long style,
- const wxString& name)
-{
- m_xScrollPixelsPerLine = 0;
- m_yScrollPixelsPerLine = 0;
- m_xScrollingEnabled = TRUE;
- m_yScrollingEnabled = TRUE;
- m_xScrollPosition = 0;
- m_yScrollPosition = 0;
- m_xScrollLines = 0;
- m_yScrollLines = 0;
- m_xScrollLinesPerPage = 0;
- m_yScrollLinesPerPage = 0;
- m_scaleX = 1.0;
- m_scaleY = 1.0;
-
- return wxWindow::Create(parent, id, pos, size, style, name);
+class wxAutoScrollTimer : public wxTimer
+{
+public:
+ wxAutoScrollTimer(wxWindow *winToScroll, wxScrollHelper *scroll,
+ wxEventType eventTypeToSend,
+ int pos, int orient);
+
+ virtual void Notify();
+
+private:
+ wxWindow *m_win;
+ wxScrollHelper *m_scrollHelper;
+ wxEventType m_eventType;
+ int m_pos,
+ m_orient;
+};
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxAutoScrollTimer
+// ----------------------------------------------------------------------------
+
+wxAutoScrollTimer::wxAutoScrollTimer(wxWindow *winToScroll,
+ wxScrollHelper *scroll,
+ wxEventType eventTypeToSend,
+ int pos, int orient)
+{
+ m_win = winToScroll;
+ m_scrollHelper = scroll;
+ m_eventType = eventTypeToSend;
+ m_pos = pos;
+ m_orient = orient;
}
-/*
- * pixelsPerUnitX/pixelsPerUnitY: number of pixels per unit (e.g. pixels per text line)
- * noUnitsX/noUnitsY: : no. units per scrollbar
- */
-void wxScrolledWindow::SetScrollbars (int pixelsPerUnitX, int pixelsPerUnitY,
- int noUnitsX, int noUnitsY,
- int xPos, int yPos, bool noRefresh )
+void wxAutoScrollTimer::Notify()
{
- bool do_refresh =
- (
- (noUnitsX != 0 && m_xScrollLines == 0) ||
- (noUnitsX < m_xScrollPosition) ||
- (noUnitsY != 0 && m_yScrollLines == 0) ||
- (noUnitsY < m_yScrollPosition) ||
- (xPos != m_xScrollPosition) ||
- (yPos != m_yScrollPosition) ||
- (pixelsPerUnitX != m_xScrollPixelsPerLine) ||
- (pixelsPerUnitY != m_yScrollPixelsPerLine)
- );
-
- m_xScrollPixelsPerLine = pixelsPerUnitX;
- m_yScrollPixelsPerLine = pixelsPerUnitY;
- m_xScrollPosition = xPos;
- m_yScrollPosition = yPos;
- m_xScrollLines = noUnitsX;
- m_yScrollLines = noUnitsY;
-
- AdjustScrollbars();
-
- if (do_refresh && !noRefresh) Refresh();
-
-#ifdef __WXMSW__
- UpdateWindow ((HWND) GetHWND());
+ // only do all this as long as the window is capturing the mouse
+ if ( wxWindow::GetCapture() != m_win )
+ {
+ Stop();
+ }
+ else // we still capture the mouse, continue generating events
+ {
+ // first scroll the window if we are allowed to do it
+ wxScrollWinEvent event1(m_eventType, m_pos, m_orient);
+ event1.SetEventObject(m_win);
+ if ( m_scrollHelper->SendAutoScrollEvents(event1) &&
+ m_win->GetEventHandler()->ProcessEvent(event1) )
+ {
+ // and then send a pseudo mouse-move event to refresh the selection
+ wxMouseEvent event2(wxEVT_MOTION);
+ wxGetMousePosition(&event2.m_x, &event2.m_y);
+
+ // the mouse event coordinates should be client, not screen as
+ // returned by wxGetMousePosition
+ wxWindow *parentTop = m_win;
+ while ( parentTop->GetParent() )
+ parentTop = parentTop->GetParent();
+ wxPoint ptOrig = parentTop->GetPosition();
+ event2.m_x -= ptOrig.x;
+ event2.m_y -= ptOrig.y;
+
+ event2.SetEventObject(m_win);
+
+ // FIXME: we don't fill in the other members - ok?
+
+ m_win->GetEventHandler()->ProcessEvent(event2);
+ }
+ else // can't scroll further, stop
+ {
+ Stop();
+ }
+ }
+}
+
+// ----------------------------------------------------------------------------
+// wxScrollHelperEvtHandler
+// ----------------------------------------------------------------------------
+
+bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
+{
+ if ( wxEvtHandler::ProcessEvent(event) )
+ return TRUE;
+
+ // reset the skipped flag to FALSE as it might have been set to TRUE in
+ // ProcessEvent() above
+ event.Skip(FALSE);
+
+ wxEventType evType = event.GetEventType();
+
+ if ( evType == wxEVT_PAINT )
+ {
+ m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
+ return TRUE;
+ }
+
+ if ( evType == wxEVT_SCROLLWIN_TOP ||
+ evType == wxEVT_SCROLLWIN_BOTTOM ||
+ evType == wxEVT_SCROLLWIN_LINEUP ||
+ evType == wxEVT_SCROLLWIN_LINEDOWN ||
+ evType == wxEVT_SCROLLWIN_PAGEUP ||
+ evType == wxEVT_SCROLLWIN_PAGEDOWN ||
+ evType == wxEVT_SCROLLWIN_THUMBTRACK ||
+ evType == wxEVT_SCROLLWIN_THUMBRELEASE )
+ {
+ m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
+ return !event.GetSkipped();
+ }
+
+ if ( evType == wxEVT_ENTER_WINDOW )
+ {
+ m_scrollHelper->HandleOnMouseEnter((wxMouseEvent &)event);
+ }
+ else if ( evType == wxEVT_LEAVE_WINDOW )
+ {
+ m_scrollHelper->HandleOnMouseLeave((wxMouseEvent &)event);
+ }
+#if wxUSE_MOUSEWHEEL
+ else if ( evType == wxEVT_MOUSEWHEEL )
+ {
+ m_scrollHelper->HandleOnMouseWheel((wxMouseEvent &)event);
+ }
+#endif // wxUSE_MOUSEWHEEL
+ else if ( evType == wxEVT_SIZE )
+ {
+ m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
+ }
+ else if ( evType == wxEVT_CHAR )
+ {
+ m_scrollHelper->HandleOnChar((wxKeyEvent &)event);
+ return !event.GetSkipped();
+ }
+
+ return FALSE;
+}
+
+// ----------------------------------------------------------------------------
+// wxScrollHelper construction
+// ----------------------------------------------------------------------------
+
+wxScrollHelper::wxScrollHelper(wxWindow *win)
+{
+ m_xScrollPixelsPerLine =
+ m_yScrollPixelsPerLine =
+ m_xScrollPosition =
+ m_yScrollPosition =
+ m_xScrollLines =
+ m_yScrollLines =
+ m_xScrollLinesPerPage =
+ m_yScrollLinesPerPage = 0;
+
+ m_xScrollingEnabled =
+ m_yScrollingEnabled = TRUE;
+
+ m_scaleX =
+ m_scaleY = 1.0;
+#if wxUSE_MOUSEWHEEL
+ m_wheelRotation = 0;
#endif
+
+ m_win =
+ m_targetWindow = (wxWindow *)NULL;
+
+ m_timerAutoScroll = (wxTimer *)NULL;
+
+ if ( win )
+ SetWindow(win);
}
-void wxScrolledWindow::OnScroll(wxScrollEvent& event)
+void wxScrollHelper::SetWindow(wxWindow *win)
{
- int orient = event.GetOrientation();
+ wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
- int nScrollInc = CalcScrollInc(event);
- if (nScrollInc == 0)
- return;
+ m_targetWindow = m_win = win;
- // TODO: should we store the scroll position here as well as in wxWindow?
- if (orient == wxHORIZONTAL)
- {
- int newPos = m_xScrollPosition + nScrollInc;
- SetScrollPos(wxHORIZONTAL, newPos, TRUE );
- }
- else
- {
- int newPos = m_yScrollPosition + nScrollInc;
- SetScrollPos(wxVERTICAL, newPos, TRUE );
- }
+ // install the event handler which will intercept the events we're
+ // interested in
+ m_win->PushEventHandler(new wxScrollHelperEvtHandler(this));
+}
-/*
- // TODO We need to multiply the ScrollWindow amount by the scaling
- // factor, but how do we know what this is in wxWin 2.0???
- float scaleX = 1.0;
- float scaleY = 1.0;
-
- if ( this->IsKindOf(CLASSINFO(wxCanvas)) )
- {
- wxDC* dc = ((wxCanvas *)this)->GetDC();
- dc->GetUserScale(&scaleX, &scaleY);
- }
-*/
-
- if (orient == wxHORIZONTAL)
- {
- m_xScrollPosition += nScrollInc;
- }
- else
- {
- m_yScrollPosition += nScrollInc;
- }
-
- if (orient == wxHORIZONTAL)
- {
- if (m_xScrollingEnabled)
- ScrollWindow(-m_xScrollPixelsPerLine * nScrollInc, 0, (const wxRect *) NULL);
- else
- Refresh();
- }
- else
- {
- if (m_yScrollingEnabled)
- ScrollWindow(0, -m_yScrollPixelsPerLine * nScrollInc, (const wxRect *) NULL);
- else
- Refresh();
- }
+wxScrollHelper::~wxScrollHelper()
+{
+ StopAutoScrolling();
+ if ( m_targetWindow )
+ m_targetWindow->PopEventHandler(TRUE /* do delete it */);
}
-int wxScrolledWindow::CalcScrollInc(wxScrollEvent& event)
+// ----------------------------------------------------------------------------
+// setting scrolling parameters
+// ----------------------------------------------------------------------------
+
+void wxScrollHelper::SetScrollbars(int pixelsPerUnitX,
+ int pixelsPerUnitY,
+ int noUnitsX,
+ int noUnitsY,
+ int xPos,
+ int yPos,
+ bool noRefresh)
{
- int pos = event.GetPosition();
- int orient = event.GetOrientation();
+ int xpos, ypos;
+
+ CalcUnscrolledPosition(xPos, yPos, &xpos, &ypos);
+ bool do_refresh =
+ (
+ (noUnitsX != 0 && m_xScrollLines == 0) ||
+ (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX*noUnitsX) ||
- int nScrollInc = 0;
- switch (event.GetEventType())
- {
- case wxEVENT_TYPE_SCROLL_TOP:
+ (noUnitsY != 0 && m_yScrollLines == 0) ||
+ (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY*noUnitsY) ||
+ (xPos != m_xScrollPosition) ||
+ (yPos != m_yScrollPosition)
+ );
+
+ m_xScrollPixelsPerLine = pixelsPerUnitX;
+ 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 )
{
- if (orient == wxHORIZONTAL)
- nScrollInc = - m_xScrollPosition;
- else
- nScrollInc = - m_yScrollPosition;
- break;
+ Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
+
+ int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
+ int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
+ if (m_targetWindow->m_backingPixmap &&
+ !((m_targetWindow->m_pixmapWidth == totalPixelWidth) &&
+ (m_targetWindow->m_pixmapHeight == totalPixelHeight)))
+ {
+ XFreePixmap (dpy, (Pixmap) m_targetWindow->m_backingPixmap);
+ m_targetWindow->m_backingPixmap = (WXPixmap) 0;
+ }
+
+ if (!m_targetWindow->m_backingPixmap &&
+ (noUnitsX != 0) && (noUnitsY != 0))
+ {
+ int depth = wxDisplayDepth();
+ m_pixmapWidth = totalPixelWidth;
+ m_pixmapHeight = totalPixelHeight;
+ m_backingPixmap = (WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
+ m_pixmapWidth, m_pixmapHeight, depth);
+ }
+
}
- case wxEVENT_TYPE_SCROLL_BOTTOM:
+#endif // Motif
+
+ AdjustScrollbars();
+
+ if (do_refresh && !noRefresh)
+ m_targetWindow->Refresh(TRUE, GetRect());
+
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately() ;
+#endif
+}
+
+// ----------------------------------------------------------------------------
+// target window handling
+// ----------------------------------------------------------------------------
+
+void wxScrollHelper::SetTargetWindow( wxWindow *target )
+{
+ wxASSERT_MSG( target, wxT("target window must not be NULL") );
+ m_targetWindow = target;
+}
+
+wxWindow *wxScrollHelper::GetTargetWindow() const
+{
+ return m_targetWindow;
+}
+
+// ----------------------------------------------------------------------------
+// scrolling implementation itself
+// ----------------------------------------------------------------------------
+
+void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
+{
+ int nScrollInc = CalcScrollInc(event);
+ if ( nScrollInc == 0 )
{
- if (orient == wxHORIZONTAL)
- nScrollInc = m_xScrollLines - m_xScrollPosition;
- else
- nScrollInc = m_yScrollLines - m_yScrollPosition;
- break;
+ // can't scroll further
+ event.Skip();
+
+ return;
}
- case wxEVENT_TYPE_SCROLL_LINEUP:
+
+ int orient = event.GetOrientation();
+ if (orient == wxHORIZONTAL)
{
- nScrollInc = -1;
- break;
+ m_xScrollPosition += nScrollInc;
+ m_targetWindow->SetScrollPos(wxHORIZONTAL, m_xScrollPosition, FALSE);
}
- case wxEVENT_TYPE_SCROLL_LINEDOWN:
+ else
{
- nScrollInc = 1;
- break;
+ m_yScrollPosition += nScrollInc;
+ m_targetWindow->SetScrollPos(wxVERTICAL, m_yScrollPosition, FALSE);
}
- case wxEVENT_TYPE_SCROLL_PAGEUP:
+
+ bool needsRefresh = FALSE;
+ int dx = 0,
+ dy = 0;
+ if (orient == wxHORIZONTAL)
{
- if (orient == wxHORIZONTAL)
- nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
- else
- nScrollInc = -GetScrollPageSize(wxVERTICAL);
- break;
+ if ( m_xScrollingEnabled )
+ {
+ dx = -m_xScrollPixelsPerLine * nScrollInc;
+ }
+ else
+ {
+ needsRefresh = TRUE;
+ }
}
- case wxEVENT_TYPE_SCROLL_PAGEDOWN:
+ else
{
- if (orient == wxHORIZONTAL)
- nScrollInc = GetScrollPageSize(wxHORIZONTAL);
- else
- nScrollInc = GetScrollPageSize(wxVERTICAL);
- break;
+ if ( m_yScrollingEnabled )
+ {
+ dy = -m_yScrollPixelsPerLine * nScrollInc;
+ }
+ else
+ {
+ needsRefresh = TRUE;
+ }
}
- case wxEVENT_TYPE_SCROLL_THUMBTRACK:
+
+ if ( needsRefresh )
{
- if (orient == wxHORIZONTAL)
- nScrollInc = pos - m_xScrollPosition;
- else
- nScrollInc = pos - m_yScrollPosition;
- break;
+ m_targetWindow->Refresh(TRUE, GetRect());
}
- default:
+ else
{
- break;
+ m_targetWindow->ScrollWindow(dx, dy, GetRect());
}
- }
- if (orient == wxHORIZONTAL)
- {
- int w, h;
- GetClientSize(&w, &h);
-
- int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
- int noPositions = (int) ( ((nMaxWidth - w)/(float)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
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately() ;
+#endif
+}
- return nScrollInc;
- }
- else
- {
- int w, h;
- GetClientSize(&w, &h);
+int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
+{
+ int pos = event.GetPosition();
+ int orient = event.GetOrientation();
- int nMaxHeight = m_yScrollLines*m_yScrollPixelsPerLine;
- int noPositions = (int) ( ((nMaxHeight - h)/(float)m_yScrollPixelsPerLine) + 0.5 );
- if (noPositions < 0)
- noPositions = 0;
+ int nScrollInc = 0;
+ if (event.GetEventType() == wxEVT_SCROLLWIN_TOP)
+ {
+ if (orient == wxHORIZONTAL)
+ nScrollInc = - m_xScrollPosition;
+ else
+ nScrollInc = - m_yScrollPosition;
+ } else
+ if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
+ {
+ if (orient == wxHORIZONTAL)
+ nScrollInc = m_xScrollLines - m_xScrollPosition;
+ else
+ nScrollInc = m_yScrollLines - m_yScrollPosition;
+ } else
+ if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
+ {
+ nScrollInc = -1;
+ } else
+ if (event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN)
+ {
+ nScrollInc = 1;
+ } else
+ if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEUP)
+ {
+ if (orient == wxHORIZONTAL)
+ nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
+ else
+ nScrollInc = -GetScrollPageSize(wxVERTICAL);
+ } else
+ if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN)
+ {
+ if (orient == wxHORIZONTAL)
+ nScrollInc = GetScrollPageSize(wxHORIZONTAL);
+ else
+ nScrollInc = GetScrollPageSize(wxVERTICAL);
+ } else
+ if ((event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK) ||
+ (event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE))
+ {
+ if (orient == wxHORIZONTAL)
+ nScrollInc = pos - m_xScrollPosition;
+ else
+ nScrollInc = pos - m_yScrollPosition;
+ }
- 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 (orient == wxHORIZONTAL)
+ {
+ 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
+ }
+ else
+ m_targetWindow->Refresh(TRUE, GetRect());
+ }
+ else
+ {
+ 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
+ }
+ else
+ m_targetWindow->Refresh(TRUE, GetRect());
+ }
- return nScrollInc;
- }
+ return nScrollInc;
}
// Adjust the scrollbars - new version.
-void wxScrolledWindow::AdjustScrollbars(void)
-{
- int w, h;
- GetClientSize(&w, &h);
-
- // Recalculate scroll bar range and position
- if (m_xScrollLines > 0)
- {
- int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
- int newRange = (int) ( ((nMaxWidth)/(float)m_xScrollPixelsPerLine) + 0.5 );
- if (newRange < 0)
- newRange = 0;
-
- m_xScrollPosition = wxMin(newRange, m_xScrollPosition);
-
- // Calculate page size i.e. number of scroll units you get on the
- // current client window
- int noPagePositions = (int) ( (w/(float)m_xScrollPixelsPerLine) + 0.5 );
- if (noPagePositions < 1)
- noPagePositions = 1;
-
- SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, newRange);
- SetScrollPageSize(wxHORIZONTAL, noPagePositions);
- }
- // Robert Roebling
- else
- {
- m_xScrollPosition = 0;
- SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
- }
-
- if (m_yScrollLines > 0)
- {
- int nMaxHeight = m_yScrollLines*m_yScrollPixelsPerLine;
- int newRange = (int) ( ((nMaxHeight)/(float)m_yScrollPixelsPerLine) + 0.5 );
- if (newRange < 0)
- newRange = 0;
-
- m_yScrollPosition = wxMin(newRange, m_yScrollPosition);
-
- // Calculate page size i.e. number of scroll units you get on the
- // current client window
- int noPagePositions = (int) ( (h/(float)m_yScrollPixelsPerLine) + 0.5 );
- if (noPagePositions < 1)
- noPagePositions = 1;
-
- SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, newRange);
- SetScrollPageSize(wxVERTICAL, noPagePositions);
- }
- else
- {
- m_yScrollPosition = 0;
- SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE); // Robert Roebling
- }
-
-}
-
-// Default OnSize resets scrollbars, if any
-void wxScrolledWindow::OnSize(wxSizeEvent& WXUNUSED(event))
+void wxScrollHelper::AdjustScrollbars()
{
-#if USE_CONSTRAINTS
- if (GetAutoLayout())
- Layout();
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately();
#endif
- AdjustScrollbars();
-}
+ int w, h;
+ GetTargetSize(&w, &h);
-// This calls OnDraw, having adjusted the origin according to the current
-// scroll position
-void wxScrolledWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
-{
- wxPaintDC dc(this);
- PrepareDC(dc);
+ int oldXScroll = m_xScrollPosition;
+ int oldYScroll = m_yScrollPosition;
- OnDraw(dc);
-}
+ 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;
+
+ // 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_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);
+ }
-// Override this function if you don't want to have wxScrolledWindow
-// automatically change the origin according to the scroll position.
-void wxScrolledWindow::PrepareDC(wxDC& dc)
-{
- dc.SetDeviceOrigin(- m_xScrollPosition * m_xScrollPixelsPerLine, - m_yScrollPosition * m_yScrollPixelsPerLine);
- dc.SetUserScale(m_scaleX, m_scaleY);
+ 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;
+
+ // 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_targetWindow->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
+ // The amount by which we scroll when paging
+ SetScrollPageSize(wxVERTICAL, noPagePositions);
+ }
+ else
+ {
+ m_yScrollPosition = 0;
+ m_targetWindow->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
+ }
+
+ if (oldXScroll != m_xScrollPosition)
+ {
+ if (m_xScrollingEnabled)
+ m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll-m_xScrollPosition), 0,
+ GetRect() );
+ else
+ m_targetWindow->Refresh(TRUE, GetRect());
+ }
+
+ if (oldYScroll != m_yScrollPosition)
+ {
+ if (m_yScrollingEnabled)
+ m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
+ GetRect() );
+ else
+ m_targetWindow->Refresh(TRUE, GetRect());
+ }
+
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately();
+#endif
}
-#if WXWIN_COMPATIBILITY
-void wxScrolledWindow::GetScrollUnitsPerPage (int *x_page, int *y_page) const
+void wxScrollHelper::DoPrepareDC(wxDC& dc)
{
- *x_page = GetScrollPageSize(wxHORIZONTAL);
- *y_page = GetScrollPageSize(wxVERTICAL);
+ wxPoint pt = dc.GetDeviceOrigin();
+ dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
+ pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
+ dc.SetUserScale( m_scaleX, m_scaleY );
}
-#endif
-void wxScrolledWindow::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
+void wxScrollHelper::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
{
- *x_unit = m_xScrollPixelsPerLine;
- *y_unit = m_yScrollPixelsPerLine;
+ if ( x_unit )
+ *x_unit = m_xScrollPixelsPerLine;
+ if ( y_unit )
+ *y_unit = m_yScrollPixelsPerLine;
}
-int wxScrolledWindow::GetScrollPageSize(int orient) const
+int wxScrollHelper::GetScrollPageSize(int orient) const
{
if ( orient == wxHORIZONTAL )
return m_xScrollLinesPerPage;
return m_yScrollLinesPerPage;
}
-void wxScrolledWindow::SetScrollPageSize(int orient, int pageSize)
+void wxScrollHelper::SetScrollPageSize(int orient, int pageSize)
{
if ( orient == wxHORIZONTAL )
m_xScrollLinesPerPage = pageSize;
/*
* Scroll to given position (scroll position, not pixel position)
*/
-void wxScrolledWindow::Scroll (int x_pos, int y_pos)
+void wxScrollHelper::Scroll( int x_pos, int y_pos )
{
- int old_x, old_y;
- ViewStart (&old_x, &old_y);
- if (((x_pos == -1) || (x_pos == old_x)) && ((y_pos == -1) || (y_pos == old_y)))
- return;
+ if (!m_targetWindow)
+ return;
+
+ if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
+ ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
- if (x_pos > -1)
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately();
+#endif
+
+ int w, h;
+ GetTargetSize(&w, &h);
+
+ if ((x_pos != -1) && (m_xScrollPixelsPerLine))
{
- m_xScrollPosition = x_pos;
- SetScrollPos (wxHORIZONTAL, x_pos, TRUE);
+ int old_x = m_xScrollPosition;
+ m_xScrollPosition = x_pos;
+
+ // 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;
+
+ // 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 (old_x != m_xScrollPosition) {
+ m_targetWindow->SetScrollPos( wxHORIZONTAL, m_xScrollPosition, FALSE );
+ m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
+ GetRect() );
+ }
}
- if (y_pos > -1)
+ if ((y_pos != -1) && (m_yScrollPixelsPerLine))
{
- m_yScrollPosition = y_pos;
- SetScrollPos (wxVERTICAL, y_pos, TRUE);
+ int old_y = m_yScrollPosition;
+ m_yScrollPosition = y_pos;
+
+ // 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;
+
+ // 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 (old_y != m_yScrollPosition) {
+ m_targetWindow->SetScrollPos( wxVERTICAL, m_yScrollPosition, FALSE );
+ m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
+ GetRect() );
+ }
}
- Refresh();
-#ifdef __WXMSW__
- ::UpdateWindow ((HWND) GetHWND());
+
+#ifdef __WXMAC__
+ m_targetWindow->MacUpdateImmediately();
#endif
+
}
-void wxScrolledWindow::EnableScrolling (bool x_scroll, bool y_scroll)
+void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)
{
- m_xScrollingEnabled = x_scroll;
- m_yScrollingEnabled = y_scroll;
+ m_xScrollingEnabled = x_scroll;
+ m_yScrollingEnabled = y_scroll;
}
-void wxScrolledWindow::GetVirtualSize (int *x, int *y) const
+void wxScrollHelper::GetVirtualSize (int *x, int *y) const
{
- *x = m_xScrollPixelsPerLine * m_xScrollLines;
- *y = m_yScrollPixelsPerLine * m_yScrollLines;
+ if ( x )
+ *x = m_xScrollPixelsPerLine * m_xScrollLines;
+ if ( y )
+ *y = m_yScrollPixelsPerLine * m_yScrollLines;
}
// Where the current view starts from
-void wxScrolledWindow::ViewStart (int *x, int *y) const
+void wxScrollHelper::GetViewStart (int *x, int *y) const
+{
+ if ( x )
+ *x = m_xScrollPosition;
+ if ( y )
+ *y = m_yScrollPosition;
+}
+
+void wxScrollHelper::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
+{
+ if ( xx )
+ *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
+ if ( yy )
+ *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
+}
+
+void wxScrollHelper::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
+{
+ if ( xx )
+ *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
+ if ( yy )
+ *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
+}
+
+// ----------------------------------------------------------------------------
+// event handlers
+// ----------------------------------------------------------------------------
+
+// Default OnSize resets scrollbars, if any
+void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
+{
+#if wxUSE_CONSTRAINTS
+ if ( m_targetWindow->GetAutoLayout() )
+ m_targetWindow->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);
+ DoPrepareDC(dc);
+
+ OnDraw(dc);
+}
+
+// kbd handling: notice that we use OnChar() and not OnKeyDown() for
+// compatibility here - if we used OnKeyDown(), the programs which process
+// arrows themselves in their OnChar() would never get the message and like
+// this they always have the priority
+void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
{
- *x = m_xScrollPosition;
- *y = m_yScrollPosition;
+ int stx, sty, // view origin
+ szx, szy, // view size (total)
+ clix, cliy; // view size (on screen)
+
+ GetViewStart(&stx, &sty);
+ GetTargetSize(&clix, &cliy);
+ GetVirtualSize(&szx, &szy);
+
+ if( m_xScrollPixelsPerLine )
+ {
+ clix /= m_xScrollPixelsPerLine;
+ szx /= m_xScrollPixelsPerLine;
+ }
+ else
+ {
+ clix = 0;
+ szx = -1;
+ }
+ if( m_yScrollPixelsPerLine )
+ {
+ cliy /= m_yScrollPixelsPerLine;
+ szy /= m_yScrollPixelsPerLine;
+ }
+ else
+ {
+ cliy = 0;
+ szy = -1;
+ }
+
+ int dsty;
+ switch ( event.KeyCode() )
+ {
+ case WXK_PAGEUP:
+ case WXK_PRIOR:
+ 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;
+
+ case WXK_HOME:
+ Scroll(0, event.ControlDown() ? 0 : -1);
+ break;
+
+ case WXK_END:
+ Scroll(szx - clix, event.ControlDown() ? szy - cliy : -1);
+ break;
+
+ case WXK_UP:
+ Scroll(-1, sty - 1);
+ break;
+
+ case WXK_DOWN:
+ Scroll(-1, sty + 1);
+ break;
+
+ case WXK_LEFT:
+ Scroll(stx - 1, -1);
+ break;
+
+ case WXK_RIGHT:
+ Scroll(stx + 1, -1);
+ break;
+
+ default:
+ // not for us
+ event.Skip();
+ }
}
-void wxScrolledWindow::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
+// ----------------------------------------------------------------------------
+// autoscroll stuff: these functions deal with sending fake scroll events when
+// a captured mouse is being held outside the window
+// ----------------------------------------------------------------------------
+
+bool wxScrollHelper::SendAutoScrollEvents(wxScrollWinEvent& event) const
+{
+ // only send the event if the window is scrollable in this direction
+ wxWindow *win = (wxWindow *)event.GetEventObject();
+ return win->HasScrollbar(event.GetOrientation());
+}
+
+void wxScrollHelper::StopAutoScrolling()
+{
+ if ( m_timerAutoScroll )
+ {
+ delete m_timerAutoScroll;
+ m_timerAutoScroll = (wxTimer *)NULL;
+ }
+}
+
+void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
{
- *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
- *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
+ StopAutoScrolling();
+
+ event.Skip();
}
-void wxScrolledWindow::CalcUnscrolledPosition(int x, int y, float *xx, float *yy) const
+void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
{
- *xx = (float)(x + m_xScrollPosition * m_xScrollPixelsPerLine);
- *yy = (float)(y + m_yScrollPosition * m_yScrollPixelsPerLine);
+ // don't prevent the usual processing of the event from taking place
+ event.Skip();
+
+ // when a captured mouse leave a scrolled window we start generate
+ // scrolling events to allow, for example, extending selection beyond the
+ // visible area in some controls
+ if ( wxWindow::GetCapture() == m_targetWindow )
+ {
+ // where is the mouse leaving?
+ int pos, orient;
+ wxPoint pt = event.GetPosition();
+ if ( pt.x < 0 )
+ {
+ orient = wxHORIZONTAL;
+ pos = 0;
+ }
+ else if ( pt.y < 0 )
+ {
+ orient = wxVERTICAL;
+ pos = 0;
+ }
+ else // we're lower or to the right of the window
+ {
+ wxSize size = m_targetWindow->GetClientSize();
+ if ( pt.x > size.x )
+ {
+ orient = wxHORIZONTAL;
+ pos = m_xScrollLines;
+ }
+ else if ( pt.y > size.y )
+ {
+ orient = wxVERTICAL;
+ pos = m_yScrollLines;
+ }
+ else // this should be impossible
+ {
+ // but seems to happen sometimes under wxMSW - maybe it's a bug
+ // there but for now just ignore it
+
+ //wxFAIL_MSG( _T("can't understand where has mouse gone") );
+
+ return;
+ }
+ }
+
+ // only start the auto scroll timer if the window can be scrolled in
+ // this direction
+ if ( !m_targetWindow->HasScrollbar(orient) )
+ return;
+
+ delete m_timerAutoScroll;
+ m_timerAutoScroll = new wxAutoScrollTimer
+ (
+ m_targetWindow, this,
+ pos == 0 ? wxEVT_SCROLLWIN_LINEUP
+ : wxEVT_SCROLLWIN_LINEDOWN,
+ pos,
+ orient
+ );
+ m_timerAutoScroll->Start(50); // FIXME: make configurable
+ }
}
+#if wxUSE_MOUSEWHEEL
+
+void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
+{
+ m_wheelRotation += event.GetWheelRotation();
+ int lines = m_wheelRotation / event.GetWheelDelta();
+ m_wheelRotation -= lines * event.GetWheelDelta();
+
+ if (lines != 0)
+ {
+ lines *= event.GetLinesPerAction();
+
+ int vsx, vsy;
+ GetViewStart(&vsx, &vsy);
+ Scroll(-1, vsy - lines);
+ }
+}
+
+#endif // wxUSE_MOUSEWHEEL
+
+// ----------------------------------------------------------------------------
+// wxGenericScrolledWindow implementation
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
+
+bool wxGenericScrolledWindow::Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ long style,
+ const wxString& name)
+{
+ m_targetWindow = this;
+
+ 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;
+}
+
+wxGenericScrolledWindow::~wxGenericScrolledWindow()
+{
+}
+
+#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
projects / wxWidgets.git / blobdiff