/////////////////////////////////////////////////////////////////////////////
-// 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.
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "genscrolwin.h"
-#endif
-
#ifdef __VMS
#define XtDisplay XTDISPLAY
#endif
#pragma hdrstop
#endif
-#if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)
-
-#include "wx/utils.h"
-#include "wx/dcclient.h"
-
#include "wx/scrolwin.h"
-#include "wx/panel.h"
-#if wxUSE_TIMER
-#include "wx/timer.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/utils.h"
+ #include "wx/panel.h"
+ #include "wx/dcclient.h"
+ #if wxUSE_TIMER
+ #include "wx/timer.h"
+ #endif
+ #include "wx/sizer.h"
#endif
-#include "wx/sizer.h"
+
#include "wx/recguard.h"
#ifdef __WXMSW__
#include <windows.h> // for DLGC_WANTARROWS
+ #include "wx/msw/winundef.h"
#endif
#ifdef __WXMOTIF__
#endif
#endif
-IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
-
/*
TODO PROPERTIES
style wxHSCROLL | wxVSCROLL
// 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;
}
wxScrollHelper::wxScrollHelper(wxWindow *win)
{
+ wxASSERT_MSG( win, _T("associated window can't be NULL in wxScrollHelper") );
+
m_xScrollPixelsPerLine =
m_yScrollPixelsPerLine =
m_xScrollPosition =
m_handler = NULL;
- if ( win )
- SetWindow(win);
+ m_win = win;
+
+ m_win->SetScrollHelper( this );
+
+ // by default, the associated window is also the target window
+ DoSetTargetWindow(win);
}
wxScrollHelper::~wxScrollHelper()
// 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 );
+ // m_targetWindow->SetVirtualSizeHints( w, h );
// The above should arguably be deprecated, this however we still need.
- m_targetWindow->SetVirtualSize( w, h );
+ // 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());
}
}
-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;
+#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
{
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
m_targetWindow->Refresh(true, GetScrollRect());
// 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);
- 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_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
- // 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;
+ }
}
- GetTargetSize(0, &h);
+ m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition,
+ linesPerPage, m_xScrollLines);
- // scroll lines per page: if 0, no scrolling is needed
- int linesPerPage;
+ // The amount by which we scroll when paging
+ SetScrollPageSize(wxHORIZONTAL, linesPerPage);
+
+ GetTargetSize(0, &h);
if ( m_yScrollPixelsPerLine == 0 )
{
}
else // might need scrolling
{
- int hVirt = m_targetWindow->GetVirtualSize().GetHeight();
- m_yScrollLines = hVirt / 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
- // current client window
+ // current client window.
linesPerPage = h / m_yScrollPixelsPerLine;
- if ( linesPerPage >= m_yScrollLines )
+
+ // 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 =
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
void wxScrollHelper::DoPrepareDC(wxDC& dc)
{
wxPoint pt = dc.GetDeviceOrigin();
- dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
- pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
+#ifdef __WXGTK__
+ // It may actually be correct to always query
+ // the m_sign from the DC here, but I leve the
+ // #ifdef GTK for now.
+ if (m_win->GetLayoutDirection() == wxLayout_RightToLeft)
+ dc.SetDeviceOrigin( pt.x + m_xScrollPosition * m_xScrollPixelsPerLine,
+ pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
+ else
+#endif
+ dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
+ pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
dc.SetUserScale( m_scaleX, m_scaleY );
}
*y_unit = m_yScrollPixelsPerLine;
}
+
+int wxScrollHelper::GetScrollLines( int orient ) const
+{
+ if ( orient == wxHORIZONTAL )
+ return m_xScrollLines;
+ else
+ return m_yScrollLines;
+}
+
int wxScrollHelper::GetScrollPageSize(int orient) const
{
if ( orient == wxHORIZONTAL )
if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
- int w, h;
+ int w = 0, h = 0;
GetTargetSize(&w, &h);
if ((x_pos != -1) && (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 );
+ int noPagePositions = w/m_xScrollPixelsPerLine;
if (noPagePositions < 1) noPagePositions = 1;
// Correct position if greater than extent of canvas minus
m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition );
m_xScrollPosition = wxMax( 0, m_xScrollPosition );
- if (old_x != m_xScrollPosition) {
+ if (old_x != m_xScrollPosition)
+ {
m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
GetScrollRect() );
// 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 );
+ int noPagePositions = h/m_yScrollPixelsPerLine;
if (noPagePositions < 1) noPagePositions = 1;
// Correct position if greater than extent of canvas minus
m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
m_yScrollPosition = wxMax( 0, m_yScrollPosition );
- if (old_y != m_yScrollPosition) {
+ if (old_y != m_yScrollPosition)
+ {
m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
GetScrollRect() );
*yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
}
+// ----------------------------------------------------------------------------
+// geometry
+// ----------------------------------------------------------------------------
+
+bool wxScrollHelper::ScrollLayout()
+{
+ 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.
+
+ 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 (m_win->GetAutoLayout())
+ m_win->Layout();
+}
+
+// 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_win->GetAutoLayout() || m_targetWindow->GetAutoLayout() )
+ if ( m_targetWindow->GetAutoLayout() )
{
- if ( m_targetWindow != m_win )
- m_targetWindow->FitInside();
-
- m_win->FitInside();
+ wxSize size = m_targetWindow->GetBestVirtualSize();
- // 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();
+ // This will call ::Layout() and ::AdjustScrollbars()
+ m_win->SetVirtualSize( size );
}
else
+ {
AdjustScrollbars();
+ }
}
// This calls OnDraw, having adjusted the origin according to the current
// 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);
switch ( event.GetKeyCode() )
{
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;
newEvent.SetPosition(0);
newEvent.SetOrientation(wxVERTICAL);
- newEvent.m_eventObject = m_win;
+ newEvent.SetEventObject(m_win);
if (event.IsPageScroll())
{
if (lines > 0)
- newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEUP;
+ newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEUP);
else
- newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEDOWN;
+ newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN);
m_win->GetEventHandler()->ProcessEvent(newEvent);
}
{
lines *= event.GetLinesPerAction();
if (lines > 0)
- newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
+ newEvent.SetEventType(wxEVT_SCROLLWIN_LINEUP);
else
- newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
+ newEvent.SetEventType(wxEVT_SCROLLWIN_LINEDOWN);
int times = abs(lines);
for (; times > 0; times--)
#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()
-bool wxGenericScrolledWindow::Create(wxWindow *parent,
+bool wxScrolledWindow::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
const wxString& name)
{
m_targetWindow = this;
+#ifdef __WXMAC__
+ MacSetClipChildren( true ) ;
+#endif
bool ok = wxPanel::Create(parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name);
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();
-
- if (GetAutoLayout())
- Layout();
-}
-
-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
}
#ifdef __WXMSW__
-WXLRESULT
-wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
+WXLRESULT wxScrolledWindow::MSWWindowProc(WXUINT nMsg,
WXWPARAM wParam,
WXLPARAM lParam)
{
}
#endif // __WXMSW__
-
-#endif // !wxGTK
-
-// vi:sts=4:sw=4:et
projects / wxWidgets.git / blobdiff