/////////////////////////////////////////////////////////////////////////////
-// 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
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
-#if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)
+#include "wx/scrolwin.h"
-#include "wx/utils.h"
-#include "wx/dcclient.h"
+#ifndef WX_PRECOMP
+ #include "wx/utils.h"
+ #include "wx/panel.h"
+ #include "wx/dcclient.h"
+ #include "wx/timer.h"
+ #include "wx/sizer.h"
+ #include "wx/settings.h"
+#endif
-#include "wx/scrolwin.h"
-#include "wx/panel.h"
-#if wxUSE_TIMER
-#include "wx/timer.h"
+#ifdef __WXMAC__
+#include "wx/scrolbar.h"
#endif
-#include "wx/sizer.h"
+
#include "wx/recguard.h"
#ifdef __WXMSW__
#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;
}
}
- // reset the skipped flag to false as it might have been set to true in
- // ProcessEvent() above
- event.Skip(false);
-
if ( evType == wxEVT_PAINT )
{
m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
return true;
}
+ if ( evType == wxEVT_CHILD_FOCUS )
+ {
+ m_scrollHelper->HandleOnChildFocus((wxChildFocusEvent &)event);
+ return true;
+ }
+
+ // reset the skipped flag (which might have been set to true in
+ // ProcessEvent() above) to be able to test it below
+ bool wasSkipped = event.GetSkipped();
+ if ( wasSkipped )
+ event.Skip(false);
+
if ( evType == wxEVT_SCROLLWIN_TOP ||
evType == wxEVT_SCROLLWIN_BOTTOM ||
evType == wxEVT_SCROLLWIN_LINEUP ||
evType == wxEVT_SCROLLWIN_THUMBTRACK ||
evType == wxEVT_SCROLLWIN_THUMBRELEASE )
{
- m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
- return !event.GetSkipped();
+ m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
+ if ( !event.GetSkipped() )
+ {
+ // it makes sense to indicate that we processed the message as we
+ // did scroll the window (and also notice that wxAutoScrollTimer
+ // relies on our return value to stop scrolling when we are at top
+ // or bottom already)
+ processed = true;
+ wasSkipped = false;
+ }
}
if ( evType == wxEVT_ENTER_WINDOW )
m_scrollHelper->HandleOnMouseLeave((wxMouseEvent &)event);
}
#if wxUSE_MOUSEWHEEL
+ // Use GTK's own scroll wheel handling in GtkScrolledWindow
+#ifndef __WXGTK20__
else if ( evType == wxEVT_MOUSEWHEEL )
{
m_scrollHelper->HandleOnMouseWheel((wxMouseEvent &)event);
+ return true;
}
+#endif
#endif // wxUSE_MOUSEWHEEL
else if ( evType == wxEVT_CHAR )
{
m_scrollHelper->HandleOnChar((wxKeyEvent &)event);
- return !event.GetSkipped();
+ if ( !event.GetSkipped() )
+ {
+ processed = true;
+ wasSkipped = false;
+ }
}
- return false;
+ if ( processed )
+ event.Skip(wasSkipped);
+
+ return processed;
}
// ----------------------------------------------------------------------------
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()
// 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)
+void wxScrollHelper::ResetDrawnFlag()
{
- 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);
+ wxCHECK_RET( m_handler, "invalid use of ResetDrawnFlag - no handler?" );
+ m_handler->ResetDrawnFlag();
}
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
return;
}
- int orient = event.GetOrientation();
- if (orient == wxHORIZONTAL)
- {
- m_xScrollPosition += nScrollInc;
- m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
- }
- else
- {
- m_yScrollPosition += nScrollInc;
- m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
- }
-
bool needsRefresh = false;
int dx = 0,
dy = 0;
+ int orient = event.GetOrientation();
if (orient == wxHORIZONTAL)
{
if ( m_xScrollingEnabled )
}
}
+ if ( !needsRefresh )
+ {
+ // flush all pending repaints before we change m_{x,y}ScrollPosition, as
+ // otherwise invalidated area could be updated incorrectly later when
+ // ScrollWindow() makes sure they're repainted before scrolling them
+#ifdef __WXMAC__
+ // wxWindowMac is taking care of making sure the update area is correctly
+ // set up, while not forcing an immediate redraw
+#else
+ m_targetWindow->Update();
+#endif
+ }
+
+ if (orient == wxHORIZONTAL)
+ {
+ m_xScrollPosition += nScrollInc;
+ m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
+ }
+ else
+ {
+ m_yScrollPosition += nScrollInc;
+ m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
+ }
+
if ( needsRefresh )
{
m_targetWindow->Refresh(true, GetScrollRect());
if (orient == wxHORIZONTAL)
{
- if (m_xScrollPixelsPerLine > 0)
+ if ( m_xScrollPosition + nScrollInc < 0 )
{
- if ( m_xScrollPosition + nScrollInc < 0 )
- {
- // As -ve as we can go
- nScrollInc = -m_xScrollPosition;
- }
- else // check for the other bound
+ // 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 )
{
- const int posMax = m_xScrollLines - m_xScrollLinesPerPage;
- if ( m_xScrollPosition + nScrollInc > posMax )
- {
- // As +ve as we can go
- nScrollInc = posMax - m_xScrollPosition;
- }
+ // As +ve as we can go
+ nScrollInc = posMax - m_xScrollPosition;
}
}
- else
- m_targetWindow->Refresh(true, GetScrollRect());
}
- else
+ else // wxVERTICAL
{
- if ( m_yScrollPixelsPerLine > 0 )
+ if ( m_yScrollPosition + nScrollInc < 0 )
{
- if ( m_yScrollPosition + nScrollInc < 0 )
- {
- // As -ve as we can go
- nScrollInc = -m_yScrollPosition;
- }
- else // check for the other bound
+ // 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 )
{
- const int posMax = m_yScrollLines - m_yScrollLinesPerPage;
- if ( m_yScrollPosition + nScrollInc > posMax )
- {
- // As +ve as we can go
- nScrollInc = posMax - m_yScrollPosition;
- }
+ // As +ve as we can go
+ nScrollInc = posMax - m_yScrollPosition;
}
}
- else
+ }
+
+ return nScrollInc;
+}
+
+void
+wxScrollHelper::AdjustScrollbar(int orient,
+ int clientSize,
+ int virtSize,
+ int& pixelsPerUnit,
+ int& scrollUnits,
+ int& scrollPosition)
+{
+ // scroll lines per page: if 0, no scrolling is needed
+ int unitsPerPage;
+
+ // check if we need scrollbar in this direction at all
+ if ( pixelsPerUnit == 0 || clientSize >= virtSize )
+ {
+ // scrolling is disabled or unnecessary
+ scrollUnits =
+ scrollPosition = 0;
+ unitsPerPage = 0;
+ }
+ else // might need scrolling
+ {
+ // Round up integer division to catch any "leftover" client space.
+ scrollUnits = (virtSize + pixelsPerUnit - 1) / pixelsPerUnit;
+
+ // Calculate the number of fully scroll units
+ unitsPerPage = clientSize / pixelsPerUnit;
+
+ if (unitsPerPage >= scrollUnits)
{
- // VZ: why do we do this? (FIXME)
- m_targetWindow->Refresh(true, GetScrollRect());
+ // we're big enough to not need scrolling
+ scrollUnits =
+ scrollPosition = 0;
+ unitsPerPage = 0;
+ }
+ else // we do need a scrollbar
+ {
+ if ( unitsPerPage < 1 )
+ unitsPerPage = 1;
+
+ // Correct position if greater than extent of canvas minus
+ // the visible portion of it or if below zero
+ const int posMax = scrollUnits - unitsPerPage;
+ if ( scrollPosition > posMax )
+ scrollPosition = posMax;
+ else if ( scrollPosition < 0 )
+ scrollPosition = 0;
}
}
- return nScrollInc;
+ m_win->SetScrollbar(orient, scrollPosition, unitsPerPage, scrollUnits);
+
+ // The amount by which we scroll when paging
+ SetScrollPageSize(orient, unitsPerPage);
}
-// Adjust the scrollbars - new version.
void wxScrollHelper::AdjustScrollbars()
{
static wxRecursionGuardFlag s_flagReentrancy;
return;
}
- int w = 0, h = 0;
- int oldw, oldh;
-
int oldXScroll = m_xScrollPosition;
int oldYScroll = m_yScrollPosition;
- // 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
+ // we may need to readjust the scrollbars several times as enabling one of
+ // them reduces the area available for the window contents and so can make
+ // the other scrollbar necessary now although it wasn't necessary before
+ //
+ // VZ: normally this loop should be over in at most 2 iterations, I don't
+ // know why do we need 5 of them
+ for ( int iterationCount = 0; iterationCount < 5; iterationCount++ )
{
- GetTargetSize(&w, 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;
- linesPerPage = 0;
- }
- else // might need scrolling
- {
- // 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.
- 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;
- }
- }
-
- m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition,
- linesPerPage, m_xScrollLines);
-
- // The amount by which we scroll when paging
- SetScrollPageSize(wxHORIZONTAL, linesPerPage);
-
- GetTargetSize(0, &h);
-
- if ( m_yScrollPixelsPerLine == 0 )
+ wxSize clientSize = GetTargetSize();
+ const wxSize virtSize = m_targetWindow->GetVirtualSize();
+
+ // this block of code tries to work around the following problem: the
+ // window could have been just resized to have enough space to show its
+ // full contents without the scrollbars, but its client size could be
+ // not big enough because it does have the scrollbars right now and so
+ // the scrollbars would remain even though we don't need them any more
+ //
+ // to prevent this from happening, check if we have enough space for
+ // everything without the scrollbars and explicitly disable them then
+ const wxSize availSize = GetSizeAvailableForScrollTarget(
+ m_win->GetSize() - m_win->GetWindowBorderSize());
+ if ( availSize != clientSize )
{
- // scrolling is disabled
- m_yScrollLines = 0;
- m_yScrollPosition = 0;
- linesPerPage = 0;
- }
- else // might need scrolling
- {
- // 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.
- linesPerPage = h / m_yScrollPixelsPerLine;
-
- // 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)
+ if ( availSize.x >= virtSize.x && availSize.y >= virtSize.y )
{
- // 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;
+ // this will be enough to make the scrollbars disappear below
+ // and then the client size will indeed become equal to the
+ // full available size
+ clientSize = availSize;
}
}
- m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition,
- linesPerPage, m_yScrollLines);
- // The amount by which we scroll when paging
- SetScrollPageSize(wxVERTICAL, linesPerPage);
+ AdjustScrollbar(wxHORIZONTAL,
+ clientSize.x,
+ virtSize.x,
+ m_xScrollPixelsPerLine,
+ m_xScrollLines,
+ m_xScrollPosition);
+ AdjustScrollbar(wxVERTICAL,
+ clientSize.y,
+ virtSize.y,
+ m_yScrollPixelsPerLine,
+ m_yScrollLines,
+ m_yScrollPosition);
- // 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 );
+ // If a scrollbar (dis)appeared as a result of this, we need to adjust
+ // them again but if the client size didn't change, then we're done
+ if ( GetTargetSize() == clientSize )
+ break;
+ }
#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 leave 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);
+ // compute new position:
+ int new_x = m_xScrollPosition;
+ int new_y = m_yScrollPosition;
+
if ((x_pos != -1) && (m_xScrollPixelsPerLine))
{
- int old_x = m_xScrollPosition;
- m_xScrollPosition = x_pos;
+ new_x = 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 );
+ int noPagePositions = w/m_xScrollPixelsPerLine;
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_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
- m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
- GetScrollRect() );
- }
+ new_x = wxMin( m_xScrollLines-noPagePositions, new_x );
+ new_x = wxMax( 0, new_x );
}
if ((y_pos != -1) && (m_yScrollPixelsPerLine))
{
- int old_y = m_yScrollPosition;
- m_yScrollPosition = y_pos;
+ new_y = 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 );
+ int noPagePositions = h/m_yScrollPixelsPerLine;
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 );
+ new_y = wxMin( m_yScrollLines-noPagePositions, new_y );
+ new_y = wxMax( 0, new_y );
+ }
- if (old_y != m_yScrollPosition) {
- m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
- m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
- GetScrollRect() );
- }
+ if ( new_x == m_xScrollPosition && new_y == m_yScrollPosition )
+ return; // nothing to do, the position didn't change
+
+ // flush all pending repaints before we change m_{x,y}ScrollPosition, as
+ // otherwise invalidated area could be updated incorrectly later when
+ // ScrollWindow() makes sure they're repainted before scrolling them
+ m_targetWindow->Update();
+
+ // update the position and scroll the window now:
+ if (m_xScrollPosition != new_x)
+ {
+ int old_x = m_xScrollPosition;
+ m_xScrollPosition = new_x;
+ m_win->SetScrollPos( wxHORIZONTAL, new_x );
+ m_targetWindow->ScrollWindow( (old_x-new_x)*m_xScrollPixelsPerLine, 0,
+ GetScrollRect() );
+ }
+
+ if (m_yScrollPosition != new_y)
+ {
+ int old_y = m_yScrollPosition;
+ m_yScrollPosition = new_y;
+ m_win->SetScrollPos( wxVERTICAL, new_y );
+ m_targetWindow->ScrollWindow( 0, (old_y-new_y)*m_yScrollPixelsPerLine,
+ GetScrollRect() );
}
}
*y = m_yScrollPosition;
}
-#if WXWIN_COMPATIBILITY_2_2
-
-void wxScrollHelper::ViewStart(int *x, int *y) const
-{
- GetViewStart( x, y );
-}
-
-#endif // WXWIN_COMPATIBILITY_2_2
-
void wxScrollHelper::DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const
{
if ( xx )
*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;
+}
+
// ----------------------------------------------------------------------------
// event handlers
// ----------------------------------------------------------------------------
if ( m_targetWindow->GetAutoLayout() )
{
wxSize size = m_targetWindow->GetBestVirtualSize();
-
+
// This will call ::Layout() and ::AdjustScrollbars()
m_win->SetVirtualSize( size );
}
// 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;
if ( m_xScrollPosition != xScrollOld )
{
- wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_xScrollPosition,
+ wxScrollWinEvent evt(wxEVT_SCROLLWIN_THUMBTRACK, m_xScrollPosition,
wxHORIZONTAL);
- event.SetEventObject(m_win);
- m_win->GetEventHandler()->ProcessEvent(event);
+ evt.SetEventObject(m_win);
+ m_win->GetEventHandler()->ProcessEvent(evt);
}
if ( m_yScrollPosition != yScrollOld )
{
- wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_yScrollPosition,
+ wxScrollWinEvent evt(wxEVT_SCROLLWIN_THUMBTRACK, m_yScrollPosition,
wxVERTICAL);
- event.SetEventObject(m_win);
- m_win->GetEventHandler()->ProcessEvent(event);
+ evt.SetEventObject(m_win);
+ m_win->GetEventHandler()->ProcessEvent(evt);
}
}
wxScrollWinEvent newEvent;
newEvent.SetPosition(0);
- newEvent.SetOrientation(wxVERTICAL);
+ newEvent.SetOrientation( event.GetWheelAxis() == 0 ? wxVERTICAL : wxHORIZONTAL);
newEvent.SetEventObject(m_win);
if (event.IsPageScroll())
#endif // wxUSE_MOUSEWHEEL
-// ----------------------------------------------------------------------------
-// wxGenericScrolledWindow implementation
-// ----------------------------------------------------------------------------
-
-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,
- const wxSize& size,
- long style,
- const wxString& name)
+void wxScrollHelper::HandleOnChildFocus(wxChildFocusEvent& event)
{
- m_targetWindow = this;
+ // this event should be processed by all windows in parenthood chain,
+ // e.g. so that nested wxScrolledWindows work correctly
+ event.Skip();
- bool ok = wxPanel::Create(parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name);
+ // find the immediate child under which the window receiving focus is:
+ wxWindow *win = event.GetWindow();
- return ok;
-}
+ if ( win == m_targetWindow )
+ return; // nothing to do
-wxGenericScrolledWindow::~wxGenericScrolledWindow()
-{
-}
+#ifdef __WXMAC__
+ if (wxDynamicCast(win, wxScrollBar))
+ return;
+#endif
-bool wxGenericScrolledWindow::Layout()
-{
- if (GetSizer() && m_targetWindow == this)
+ // Fixing ticket: http://trac.wxwidgets.org/ticket/9563
+ // When a child inside a wxControlContainer receives a focus, the
+ // wxControlContainer generates an artificial wxChildFocusEvent for
+ // itself, telling its parent that 'it' received the focus. The effect is
+ // that this->HandleOnChildFocus is called twice, first with the
+ // artificial wxChildFocusEvent and then with the original event. We need
+ // to ignore the artificial event here or otherwise HandleOnChildFocus
+ // would first scroll the target window to make the entire
+ // wxControlContainer visible and immediately afterwards scroll the target
+ // window again to make the child widget visible. This leads to ugly
+ // flickering when using nested wxPanels/wxScrolledWindows.
+ //
+ // Ignore this event if 'win' is derived from wxControlContainer AND its
+ // parent is the m_targetWindow AND 'win' is not actually reciving the
+ // focus (win != FindFocus). TODO: This affects all wxControlContainer
+ // objects, but wxControlContainer is not part of the wxWidgets RTTI and
+ // so wxDynamicCast(win, wxControlContainer) does not compile. Find a way
+ // to determine if 'win' derives from wxControlContainer. Until then,
+ // testing if 'win' derives from wxPanel will probably get >90% of all
+ // cases.
+
+ wxWindow *actual_focus=wxWindow::FindFocus();
+ if (win != actual_focus &&
+ wxDynamicCast(win, wxPanel) != 0 &&
+ win->GetParent() == m_targetWindow)
+ // if win is a wxPanel and receives the focus, it should not be
+ // scrolled into view
+ return;
+
+ wxSize view(m_targetWindow->GetClientSize());
+
+ // For composite controls such as wxComboCtrl we should try to fit the
+ // entire control inside the visible area of the target window, not just
+ // the focused child of the control. Otherwise we'd make only the textctrl
+ // part of a wxComboCtrl visible and the button would still be outside the
+ // scrolled area. But do so only if the parent fits *entirely* inside the
+ // scrolled window. In other situations, such as nested wxPanel or
+ // wxScrolledWindows, the parent might be way to big to fit inside the
+ // scrolled window. If that is the case, then make only the focused window
+ // visible
+ if ( win->GetParent() != m_targetWindow)
{
- // 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;
+ wxWindow *parent=win->GetParent();
+ wxSize parent_size=parent->GetSize();
+ if (parent_size.GetWidth() <= view.GetWidth() &&
+ parent_size.GetHeight() <= view.GetHeight())
+ // make the immediate parent visible instead of the focused control
+ win=parent;
}
- // fall back to default for LayoutConstraints
- return wxPanel::Layout();
-}
+ // if the child is not fully visible, try to scroll it into view:
+ int stepx, stepy;
+ GetScrollPixelsPerUnit(&stepx, &stepy);
-void wxGenericScrolledWindow::DoSetVirtualSize(int x, int y)
-{
- wxPanel::DoSetVirtualSize( x, y );
- AdjustScrollbars();
+ // 'win' position coordinates are relative to it's parent
+ // convert them so that they are relative to the m_targetWindow viewing area
+ wxRect winrect(m_targetWindow->ScreenToClient(win->GetScreenPosition()),
+ win->GetSize());
- if (GetAutoLayout())
- Layout();
-}
+ int startx, starty;
+ GetViewStart(&startx, &starty);
-// wxWindow's GetBestVirtualSize returns the actual window size,
-// whereas we want to return the virtual size
-wxSize wxGenericScrolledWindow::GetBestVirtualSize() const
-{
- wxSize clientSize( GetClientSize() );
- if (GetSizer())
+ // first in vertical direction:
+ if ( stepy > 0 )
{
- wxSize minSize( GetSizer()->CalcMin() );
+ int diff = 0;
- return wxSize( wxMax( clientSize.x, minSize.x ), wxMax( clientSize.y, minSize.y ) );
+ if ( winrect.GetTop() < 0 )
+ {
+ diff = winrect.GetTop();
+ }
+ else if ( winrect.GetBottom() > view.y )
+ {
+ diff = winrect.GetBottom() - view.y + 1;
+ // round up to next scroll step if we can't get exact position,
+ // so that the window is fully visible:
+ diff += stepy - 1;
+ }
+
+ starty = (starty * stepy + diff) / stepy;
}
- else
- return clientSize;
+
+ // then horizontal:
+ if ( stepx > 0 )
+ {
+ int diff = 0;
+
+ if ( winrect.GetLeft() < 0 )
+ {
+ diff = winrect.GetLeft();
+ }
+ else if ( winrect.GetRight() > view.x )
+ {
+ diff = winrect.GetRight() - view.x + 1;
+ // round up to next scroll step if we can't get exact position,
+ // so that the window is fully visible:
+ diff += stepx - 1;
+ }
+
+ startx = (startx * stepx + diff) / stepx;
+ }
+
+ Scroll(startx, starty);
}
-// return the size best suited for the current window
-// (this isn't a virtual size, this is a sensible size for the window)
-wxSize wxGenericScrolledWindow::DoGetBestSize() const
+// ----------------------------------------------------------------------------
+// wxScrolled<T> and wxScrolledWindow implementation
+// ----------------------------------------------------------------------------
+
+wxSize wxScrolledT_Helper::FilterBestSize(const wxWindow *win,
+ const wxScrollHelperNative *helper,
+ const wxSize& origBest)
{
- wxSize best;
+ // NB: We don't do this in WX_FORWARD_TO_SCROLL_HELPER, because not
+ // all scrollable windows should behave like this, only those that
+ // contain children controls within scrollable area
+ // (i.e., wxScrolledWindow) and other some scrollable windows may
+ // have different DoGetBestSize() implementation (e.g. wxTreeCtrl).
- if ( GetSizer() )
- {
- wxSize b = GetSizer()->GetMinSize();
+ wxSize best = origBest;
+ if ( win->GetAutoLayout() )
+ {
// 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);
+ helper->GetScrollPixelsPerUnit(&ppuX, &ppuY);
- wxSize minSize;
- if ( GetMinSize().IsFullySpecified() )
- minSize = GetMinSize();
- else
- minSize = GetSize();
-
- if (ppuX > 0)
- b.x = minSize.x;
- if (ppuY > 0)
- b.y = minSize.y;
- best = b;
- }
- else
- return wxWindow::DoGetBestSize();
+ // NB: This code used to use *current* size if min size wasn't
+ // specified, presumably to get some reasonable (i.e., larger than
+ // minimal) size. But that's a wrong thing to do in GetBestSize(),
+ // so we use minimal size as specified. If the app needs some
+ // minimal size for its scrolled window, it should set it and put
+ // the window into sizer as expandable so that it can use all space
+ // available to it.
+ //
+ // See also http://svn.wxwidgets.org/viewvc/wx?view=rev&revision=45864
- // Add any difference between size and client size
- wxSize diff = GetSize() - GetClientSize();
- best.x += wxMax(0, diff.x);
- best.y += wxMax(0, diff.y);
+ wxSize minSize = win->GetMinSize();
- return best;
-}
+ if ( ppuX > 0 )
+ best.x = minSize.x + wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
-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();
+ if ( ppuY > 0 )
+ best.y = minSize.y + wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
+ }
- event.Skip();
+ return best;
}
#ifdef __WXMSW__
-WXLRESULT
-wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
- WXWPARAM wParam,
- WXLPARAM lParam)
+WXLRESULT wxScrolledT_Helper::FilterMSWWindowProc(WXUINT nMsg, WXLRESULT rc)
{
- 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__
-#endif // !wxGTK
-
-// vi:sts=4:sw=4:et
+// NB: skipping wxScrolled<T> in wxRTTI information because being a templte,
+// it doesn't and can't implement wxRTTI support
+IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel)
projects / wxWidgets.git / blobdiff