X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ad81651f00edc6f489d9b6a0839d316a964fd521..9ce192d417eb9eb614bcf8510e91dac318706249:/src/generic/scrolwin.cpp diff --git a/src/generic/scrolwin.cpp b/src/generic/scrolwin.cpp index a582eb959f..6834384fad 100644 --- a/src/generic/scrolwin.cpp +++ b/src/generic/scrolwin.cpp @@ -1,42 +1,41 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: scrolwin.cpp +// Name: generic/scrolwin.cpp // Purpose: wxScrolledWindow implementation // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + #ifdef __GNUG__ -#pragma implementation -#pragma implementation "scrolwin.h" + #pragma implementation "scrolwin.h" #endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" -#include "wx/utils.h" -#include "wx/dcclient.h" - #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif +#include "wx/utils.h" +#include "wx/dcclient.h" + #include "wx/generic/scrolwin.h" #include "wx/panel.h" -BEGIN_EVENT_TABLE(wxScrolledWindow, wxPanel) - EVT_SCROLLWIN(wxScrolledWindow::OnScroll) - EVT_SIZE(wxScrolledWindow::OnSize) - EVT_PAINT(wxScrolledWindow::OnPaint) -END_EVENT_TABLE() - -IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel) - #ifdef __WXMSW__ -#include "windows.h" + #include "windows.h" #endif #ifdef __WXMOTIF__ @@ -51,6 +50,27 @@ IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel) #endif #endif +// ---------------------------------------------------------------------------- +// event tables +// ---------------------------------------------------------------------------- + +BEGIN_EVENT_TABLE(wxScrolledWindow, wxPanel) + EVT_SCROLLWIN(wxScrolledWindow::OnScroll) + EVT_SIZE(wxScrolledWindow::OnSize) + EVT_PAINT(wxScrolledWindow::OnPaint) + EVT_CHAR(wxScrolledWindow::OnChar) +END_EVENT_TABLE() + +IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel) + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// wxScrolledWindow creation +// ---------------------------------------------------------------------------- + wxScrolledWindow::wxScrolledWindow() { m_xScrollPixelsPerLine = 0; @@ -65,13 +85,15 @@ wxScrolledWindow::wxScrolledWindow() m_yScrollLinesPerPage = 0; m_scaleX = 1.0; m_scaleY = 1.0; + m_targetWindow = (wxWindow*) NULL; } -bool wxScrolledWindow::Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos, - const wxSize& size, - long style, - const wxString& name) +bool wxScrolledWindow::Create(wxWindow *parent, + wxWindowID id, + const wxPoint& pos, + const wxSize& size, + long style, + const wxString& name) { m_xScrollPixelsPerLine = 0; m_yScrollPixelsPerLine = 0; @@ -85,32 +107,45 @@ bool wxScrolledWindow::Create(wxWindow *parent, wxWindowID id, m_yScrollLinesPerPage = 0; m_scaleX = 1.0; m_scaleY = 1.0; - + m_targetWindow = this; - return wxPanel::Create(parent, id, pos, size, style, name); + // we need wxWANTS_CHARS to process arrows ourselves + return wxPanel::Create(parent, id, pos, size, style | wxWANTS_CHARS, name); +} + +wxScrolledWindow::~wxScrolledWindow() +{ } +// ---------------------------------------------------------------------------- +// setting scrolling parameters +// ---------------------------------------------------------------------------- + /* * 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 ) + int noUnitsX, int noUnitsY, + int xPos, int yPos, bool noRefresh ) { + int xpos, ypos; + + CalcUnscrolledPosition(xPos, yPos, &xpos, &ypos); bool do_refresh = ( (noUnitsX != 0 && m_xScrollLines == 0) || - (noUnitsX < m_xScrollLines) || + (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX*noUnitsX) || + (noUnitsY != 0 && m_yScrollLines == 0) || - (noUnitsY < m_yScrollLines) || + (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY*noUnitsY) || (xPos != m_xScrollPosition) || - (yPos != m_yScrollPosition) || - (pixelsPerUnitX != m_xScrollPixelsPerLine) || - (pixelsPerUnitY != m_yScrollPixelsPerLine) + (yPos != m_yScrollPosition) +// (pixelsPerUnitX != m_xScrollPixelsPerLine) || +// (pixelsPerUnitY != m_yScrollPixelsPerLine) ); - + m_xScrollPixelsPerLine = pixelsPerUnitX; m_yScrollPixelsPerLine = pixelsPerUnitY; m_xScrollPosition = xPos; @@ -146,28 +181,34 @@ void wxScrolledWindow::SetScrollbars (int pixelsPerUnitX, int pixelsPerUnitY, m_pixmapHeight = totalPixelHeight; m_backingPixmap = (WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)), m_pixmapWidth, m_pixmapHeight, depth); - } + } } -#endif - +#endif // Motif + AdjustScrollbars(); - - if (do_refresh && !noRefresh) - m_targetWindow->Refresh(); - + + if (do_refresh && !noRefresh) + m_targetWindow->Refresh(); + #ifdef __WXMSW__ - // Necessary? - UpdateWindow ((HWND) m_targetWindow->GetHWND()); + // GRG: if this turns out to be really necessary, we could + // at least move it to the above if { ... } so that it is + // only done if noRefresh = FALSE (the default). OTOH, if + // this doesn't break anything, which seems to be the + // case, we could just leave it out. + + // Necessary? + // UpdateWindow ((HWND) m_targetWindow->GetHWND()); #endif #ifdef __WXMAC__ - m_targetWindow->MacUpdateImmediately() ; + m_targetWindow->MacUpdateImmediately() ; #endif } -wxScrolledWindow::~wxScrolledWindow() -{ -} +// ---------------------------------------------------------------------------- +// target window handling +// ---------------------------------------------------------------------------- void wxScrolledWindow::SetTargetWindow( wxWindow *target ) { @@ -180,6 +221,10 @@ wxWindow *wxScrolledWindow::GetTargetWindow() return m_targetWindow; } +// ---------------------------------------------------------------------------- +// scrolling implementation itself +// ---------------------------------------------------------------------------- + void wxScrolledWindow::OnScroll(wxScrollWinEvent& event) { int orient = event.GetOrientation(); @@ -206,7 +251,7 @@ void wxScrolledWindow::OnScroll(wxScrollWinEvent& event) { m_yScrollPosition += nScrollInc; } - + if (orient == wxHORIZONTAL) { if (m_xScrollingEnabled) @@ -220,9 +265,9 @@ void wxScrolledWindow::OnScroll(wxScrollWinEvent& event) m_targetWindow->ScrollWindow(0, -m_yScrollPixelsPerLine * nScrollInc, (const wxRect *) NULL); else m_targetWindow->Refresh(); - } + } #ifdef __WXMAC__ - m_targetWindow->MacUpdateImmediately() ; + m_targetWindow->MacUpdateImmediately() ; #endif } @@ -277,6 +322,7 @@ int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent& event) break; } case wxEVT_SCROLLWIN_THUMBTRACK: + case wxEVT_SCROLLWIN_THUMBRELEASE: { if (orient == wxHORIZONTAL) nScrollInc = pos - m_xScrollPosition; @@ -292,7 +338,7 @@ int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent& event) if (orient == wxHORIZONTAL) { - if (m_xScrollPixelsPerLine > 0) + if (m_xScrollPixelsPerLine > 0) { int w, h; m_targetWindow->GetClientSize(&w, &h); @@ -300,32 +346,32 @@ int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent& event) int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine; int noPositions = (int) ( ((nMaxWidth - w)/(double)m_xScrollPixelsPerLine) + 0.5 ); if (noPositions < 0) - noPositions = 0; + noPositions = 0; if ( (m_xScrollPosition + nScrollInc) < 0 ) - nScrollInc = -m_xScrollPosition; // As -ve as we can go + 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 + nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go } else m_targetWindow->Refresh(); } else { - if (m_yScrollPixelsPerLine > 0) - { + if (m_yScrollPixelsPerLine > 0) + { int w, h; m_targetWindow->GetClientSize(&w, &h); - + int nMaxHeight = m_yScrollLines*m_yScrollPixelsPerLine; int noPositions = (int) ( ((nMaxHeight - h)/(double)m_yScrollPixelsPerLine) + 0.5 ); if (noPositions < 0) - noPositions = 0; - + noPositions = 0; + if ( (m_yScrollPosition + nScrollInc) < 0 ) - nScrollInc = -m_yScrollPosition; // As -ve as we can go + 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 + nScrollInc = noPositions - m_yScrollPosition; // As +ve as we can go } else m_targetWindow->Refresh(); @@ -339,20 +385,20 @@ void wxScrolledWindow::AdjustScrollbars() { int w, h; m_targetWindow->GetClientSize(&w, &h); - + 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 + // 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); + // the visible portion of it or if below zero + m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition); m_xScrollPosition = wxMax( 0, m_xScrollPosition ); SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines); @@ -360,20 +406,20 @@ void wxScrolledWindow::AdjustScrollbars() SetScrollPageSize(wxHORIZONTAL, noPagePositions); } else - { + { m_xScrollPosition = 0; - SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE); + SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE); } - + if (m_yScrollLines > 0) { - // Calculate page size i.e. number of scroll units you get on the - // current client window + // 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 + // the visible portion of it or if below zero m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition ); m_yScrollPosition = wxMax( 0, m_yScrollPosition ); @@ -384,9 +430,9 @@ void wxScrolledWindow::AdjustScrollbars() else { m_yScrollPosition = 0; - SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE); + SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE); } - + if (oldXScroll != m_xScrollPosition) { if (m_xScrollingEnabled) @@ -394,7 +440,7 @@ void wxScrolledWindow::AdjustScrollbars() else m_targetWindow->Refresh(); } - + if (oldYScroll != m_yScrollPosition) { if (m_yScrollingEnabled) @@ -404,31 +450,11 @@ void wxScrolledWindow::AdjustScrollbars() } } -// Default OnSize resets scrollbars, if any -void wxScrolledWindow::OnSize(wxSizeEvent& WXUNUSED(event)) -{ -#if wxUSE_CONSTRAINTS - if (GetAutoLayout()) Layout(); -#endif - - AdjustScrollbars(); -} - -// This calls OnDraw, having adjusted the origin according to the current -// scroll position -void wxScrolledWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) -{ - wxPaintDC dc(this); - PrepareDC(dc); - - OnDraw(dc); -} - // 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, + dc.SetDeviceOrigin( -m_xScrollPosition * m_xScrollPixelsPerLine, -m_yScrollPosition * m_yScrollPixelsPerLine ); dc.SetUserScale( m_scaleX, m_scaleY ); } @@ -478,9 +504,12 @@ void wxScrolledWindow::SetScrollPageSize(int orient, int pageSize) */ void wxScrolledWindow::Scroll( int x_pos, int y_pos ) { - if (((x_pos == -1) || (x_pos == m_xScrollPosition)) && + if (!m_targetWindow) + return; + + if (((x_pos == -1) || (x_pos == m_xScrollPosition)) && ((y_pos == -1) || (y_pos == m_yScrollPosition))) return; - + int w, h; m_targetWindow->GetClientSize(&w, &h); @@ -488,49 +517,45 @@ void wxScrolledWindow::Scroll( int x_pos, int y_pos ) { 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 + + // 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 + // 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) return; + m_targetWindow->SetScrollPos( wxHORIZONTAL, m_xScrollPosition, TRUE ); - - m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0 ); + m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0 ); } if (y_pos != -1) { 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 + + // 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 + // 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) return; + m_targetWindow->SetScrollPos( wxVERTICAL, m_yScrollPosition, TRUE ); - - m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine ); + m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine ); } - - -#ifdef __WXMSW__ -// ::UpdateWindow ((HWND) GetHWND()); -#else -// Refresh(); -#endif + #ifdef __WXMAC__ - m_targetWindow->MacUpdateImmediately() ; + m_targetWindow->MacUpdateImmediately(); #endif } @@ -549,7 +574,7 @@ void wxScrolledWindow::GetVirtualSize (int *x, int *y) const } // Where the current view starts from -void wxScrolledWindow::ViewStart (int *x, int *y) const +void wxScrolledWindow::GetViewStart (int *x, int *y) const { if ( x ) *x = m_xScrollPosition; @@ -572,3 +597,107 @@ void wxScrolledWindow::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) co if ( yy ) *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine; } + +// ---------------------------------------------------------------------------- +// event handlers +// ---------------------------------------------------------------------------- + +// Default OnSize resets scrollbars, if any +void wxScrolledWindow::OnSize(wxSizeEvent& WXUNUSED(event)) +{ +#if wxUSE_CONSTRAINTS + if (GetAutoLayout()) + Layout(); +#endif + + AdjustScrollbars(); +} + +// This calls OnDraw, having adjusted the origin according to the current +// scroll position +void wxScrolledWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) +{ + wxPaintDC dc(this); + PrepareDC(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 wxScrolledWindow::OnChar(wxKeyEvent& event) +{ + int stx, sty, // view origin + szx, szy, // view size (total) + clix, cliy; // view size (on screen) + + ViewStart(&stx, &sty); + GetClientSize(&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(); + } +}