further untangle generic and native GTK implementations of wxScrollHelper: use the standard wxScrollHelperBase/wxScrollHelper naming convention and move the stuff unused by GTK in the generic implementation

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57531 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-12-24 16:43:30 +00:00
parent 69e9752529
commit 29e1398fa0
7 changed files with 738 additions and 703 deletions

View File

@@ -1,11 +1,10 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
// Name: wx/generic/scrolwin.h // Name: wx/generic/scrolwin.h
// Purpose: wxGenericScrolledWindow class // Purpose: generic wxScrollHelper
// Author: Julian Smart // Author: Vadim Zeitlin
// Modified by: // Created: 2008-12-24 (replacing old file with the same name)
// Created: 01/02/97
// RCS-ID: $Id$ // RCS-ID: $Id$
// Copyright: (c) Julian Smart // Copyright: (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence // Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
@@ -13,15 +12,40 @@
#define _WX_GENERIC_SCROLLWIN_H_ #define _WX_GENERIC_SCROLLWIN_H_
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// headers and constants // generic wxScrollHelper implementation
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
#include "wx/window.h" class WXDLLIMPEXP_CORE wxScrollHelper : public wxScrollHelperBase
#include "wx/panel.h" {
public:
wxScrollHelper(wxWindow *winToScroll);
// ---------------------------------------------------------------------------- // implement base class pure virtuals
// wxGenericScrolledWindow virtual void AdjustScrollbars();
// ----------------------------------------------------------------------------
private:
virtual void DoScroll(int x, int y);
virtual void DoShowScrollbars(wxScrollbarVisibility horz,
wxScrollbarVisibility vert);
// helper of AdjustScrollbars(): does the work for the single scrollbar
//
// notice that the parameters passed by non-const references are modified
// by this function
void DoAdjustScrollbar(int orient,
int clientSize,
int virtSize,
int& pixelsPerUnit,
int& scrollUnits,
int& scrollPosition,
wxScrollbarVisibility visibility);
wxScrollbarVisibility m_xVisibility,
m_yVisibility;
DECLARE_NO_COPY_CLASS(wxScrollHelper)
};
#endif // _WX_GENERIC_SCROLLWIN_H_ #endif // _WX_GENERIC_SCROLLWIN_H_

View File

@@ -16,11 +16,11 @@
// wxScrolledWindow // wxScrolledWindow
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class WXDLLIMPEXP_CORE wxScrollHelperNative : public wxScrollHelper class WXDLLIMPEXP_CORE wxScrollHelper : public wxScrollHelperBase
{ {
public: public:
// default ctor doesn't do anything // default ctor doesn't do anything
wxScrollHelperNative(wxWindow *win) : wxScrollHelper(win) { } wxScrollHelper(wxWindow *win) : wxScrollHelperBase(win) { }
virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
int noUnitsX, int noUnitsY, int noUnitsX, int noUnitsY,
@@ -70,7 +70,7 @@ protected:
wxScrollbarVisibility vert); wxScrollbarVisibility vert);
private: private:
DECLARE_NO_COPY_CLASS(wxScrollHelperNative) DECLARE_NO_COPY_CLASS(wxScrollHelper)
}; };
#endif // _WX_GTK_SCROLLWIN_H_ #endif // _WX_GTK_SCROLLWIN_H_

View File

@@ -16,20 +16,23 @@
// wxScrolledWindow // wxScrolledWindow
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class WXDLLIMPEXP_CORE wxScrollHelperNative : public wxScrollHelper class WXDLLIMPEXP_CORE wxScrollHelper : public wxScrollHelperBase
{ {
public: public:
// default ctor doesn't do anything wxScrollHelper(wxWindow *win) : wxScrollHelperBase(win) { }
wxScrollHelperNative(wxWindow *win) : wxScrollHelper(win) { }
// implement base class pure virtuals
virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
int noUnitsX, int noUnitsY, int noUnitsX, int noUnitsY,
int xPos = 0, int yPos = 0, int xPos = 0, int yPos = 0,
bool noRefresh = false); bool noRefresh = false);
virtual void AdjustScrollbars(); virtual void AdjustScrollbars();
virtual void Scroll(int x, int y);
protected: protected:
virtual void DoScroll(int x, int y);
virtual void DoShowScrollbars(wxScrollbarVisibility horz,
wxScrollbarVisibility vert);
// this does (each) half of AdjustScrollbars() work // this does (each) half of AdjustScrollbars() work
void DoAdjustScrollbar(GtkAdjustment *adj, void DoAdjustScrollbar(GtkAdjustment *adj,
int pixelsPerLine, int pixelsPerLine,
@@ -40,14 +43,14 @@ protected:
int *linesPerPage); int *linesPerPage);
// and this does the same for Scroll() // and this does the same for Scroll()
void DoScroll(int orient, void DoScrollOneDir(int orient,
GtkAdjustment *adj, GtkAdjustment *adj,
int pos, int pos,
int pixelsPerLine, int pixelsPerLine,
int *posOld); int *posOld);
private: private:
DECLARE_NO_COPY_CLASS(wxScrollHelperNative) DECLARE_NO_COPY_CLASS(wxScrollHelper)
}; };
#endif // _WX_GTK_SCROLLWIN_H_ #endif // _WX_GTK_SCROLLWIN_H_

View File

@@ -37,11 +37,11 @@ enum wxScrollbarVisibility
// //
// So we have // So we have
// //
// wxScrollHelper // wxScrollHelperBase
// | // |
// | // |
// \|/ // \|/
// wxWindow wxScrollHelperNative // wxWindow wxScrollHelper
// | \ / / // | \ / /
// | \ / / // | \ / /
// | _| |_ / // | _| |_ /
@@ -56,12 +56,12 @@ enum wxScrollbarVisibility
// //
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class WXDLLIMPEXP_CORE wxScrollHelper class WXDLLIMPEXP_CORE wxScrollHelperBase
{ {
public: public:
// ctor must be given the associated window // ctor must be given the associated window
wxScrollHelper(wxWindow *winToScroll); wxScrollHelperBase(wxWindow *winToScroll);
virtual ~wxScrollHelper(); virtual ~wxScrollHelperBase();
// configure the scrolling // configure the scrolling
virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
@@ -85,8 +85,7 @@ public:
void SetScrollRate( int xstep, int ystep ); void SetScrollRate( int xstep, int ystep );
// get the size of one logical unit in physical ones // get the size of one logical unit in physical ones
virtual void GetScrollPixelsPerUnit(int *pixelsPerUnitX, void GetScrollPixelsPerUnit(int *pixelsPerUnitX, int *pixelsPerUnitY) const;
int *pixelsPerUnitY) const;
// Set scrollbar visibility: it is possible to show scrollbar only if it is // Set scrollbar visibility: it is possible to show scrollbar only if it is
// needed (i.e. if our virtual size is greater than the current size of the // needed (i.e. if our virtual size is greater than the current size of the
@@ -139,21 +138,21 @@ public:
return p2; return p2;
} }
virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const; void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const; void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
// Adjust the scrollbars // Adjust the scrollbars
virtual void AdjustScrollbars(void); virtual void AdjustScrollbars() = 0;
// Calculate scroll increment // Calculate scroll increment
virtual int CalcScrollInc(wxScrollWinEvent& event); int CalcScrollInc(wxScrollWinEvent& event);
// Normally the wxScrolledWindow will scroll itself, but in some rare // Normally the wxScrolledWindow will scroll itself, but in some rare
// occasions you might want it to scroll [part of] another window (e.g. a // occasions you might want it to scroll [part of] another window (e.g. a
// child of it in order to scroll only a portion the area between the // child of it in order to scroll only a portion the area between the
// scrollbars (spreadsheet: only cell area will move). // scrollbars (spreadsheet: only cell area will move).
virtual void SetTargetWindow(wxWindow *target); void SetTargetWindow(wxWindow *target);
virtual wxWindow *GetTargetWindow() const; wxWindow *GetTargetWindow() const;
void SetTargetRect(const wxRect& rect) { m_rectToScroll = rect; } void SetTargetRect(const wxRect& rect) { m_rectToScroll = rect; }
wxRect GetTargetRect() const { return m_rectToScroll; } wxRect GetTargetRect() const { return m_rectToScroll; }
@@ -219,9 +218,9 @@ protected:
// implementation of public methods with the same name // implementation of public methods with the same name
virtual void DoGetViewStart(int *x, int *y) const; virtual void DoGetViewStart(int *x, int *y) const;
virtual void DoScroll(int x, int y); virtual void DoScroll(int x, int y) = 0;
virtual void DoShowScrollbars(wxScrollbarVisibility horz, virtual void DoShowScrollbars(wxScrollbarVisibility horz,
wxScrollbarVisibility vert); wxScrollbarVisibility vert) = 0;
// implementations of various wxWindow virtual methods which should be // implementations of various wxWindow virtual methods which should be
// forwarded to us (this can be done by WX_FORWARD_TO_SCROLL_HELPER()) // forwarded to us (this can be done by WX_FORWARD_TO_SCROLL_HELPER())
@@ -240,18 +239,6 @@ protected:
// in wxScrollHelperEvtHandler::ProcessEvent() // in wxScrollHelperEvtHandler::ProcessEvent()
void ResetDrawnFlag(); void ResetDrawnFlag();
// helper of AdjustScrollbars(): does the work for the single scrollbar
//
// notice that the parameters passed by non-const references are modified
// by this function
void AdjustScrollbar(int orient,
int clientSize,
int virtSize,
int& pixelsPerUnit,
int& scrollUnits,
int& scrollPosition,
wxScrollbarVisibility visibility);
// this function should be overridden to return the size available for // this function should be overridden to return the size available for
// m_targetWindow inside m_win of the given size // m_targetWindow inside m_win of the given size
// //
@@ -297,10 +284,7 @@ protected:
wxScrollHelperEvtHandler *m_handler; wxScrollHelperEvtHandler *m_handler;
wxScrollbarVisibility m_xVisibility, DECLARE_NO_COPY_CLASS(wxScrollHelperBase)
m_yVisibility;
DECLARE_NO_COPY_CLASS(wxScrollHelper)
}; };
// this macro can be used in a wxScrollHelper-derived class to forward wxWindow // this macro can be used in a wxScrollHelper-derived class to forward wxWindow
@@ -314,13 +298,14 @@ public: \
virtual wxSize GetBestVirtualSize() const \ virtual wxSize GetBestVirtualSize() const \
{ return ScrollGetBestVirtualSize(); } { return ScrollGetBestVirtualSize(); }
// include the declaration of wxScrollHelperNative if needed // include the declaration of the real wxScrollHelper
#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__) #if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
#include "wx/gtk/scrolwin.h" #include "wx/gtk/scrolwin.h"
#elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__) #elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
#include "wx/gtk1/scrolwin.h" #include "wx/gtk1/scrolwin.h"
#else #else
typedef wxScrollHelper wxScrollHelperNative; #define wxHAS_GENERIC_SCROLLWIN
#include "wx/generic/scrolwin.h"
#endif #endif
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
@@ -331,7 +316,7 @@ public: \
struct WXDLLIMPEXP_CORE wxScrolledT_Helper struct WXDLLIMPEXP_CORE wxScrolledT_Helper
{ {
static wxSize FilterBestSize(const wxWindow *win, static wxSize FilterBestSize(const wxWindow *win,
const wxScrollHelperNative *helper, const wxScrollHelper *helper,
const wxSize& origBest); const wxSize& origBest);
#ifdef __WXMSW__ #ifdef __WXMSW__
static WXLRESULT FilterMSWWindowProc(WXUINT nMsg, WXLRESULT origResult); static WXLRESULT FilterMSWWindowProc(WXUINT nMsg, WXLRESULT origResult);
@@ -343,18 +328,18 @@ struct WXDLLIMPEXP_CORE wxScrolledT_Helper
// not always desirable. // not always desirable.
template<class T> template<class T>
class WXDLLIMPEXP_CORE wxScrolled : public T, class WXDLLIMPEXP_CORE wxScrolled : public T,
public wxScrollHelperNative, public wxScrollHelper,
private wxScrolledT_Helper private wxScrolledT_Helper
{ {
public: public:
wxScrolled() : wxScrollHelperNative(this) { } wxScrolled() : wxScrollHelper(this) { }
wxScrolled(wxWindow *parent, wxScrolled(wxWindow *parent,
wxWindowID winid = wxID_ANY, wxWindowID winid = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxScrolledWindowStyle, long style = wxScrolledWindowStyle,
const wxString& name = wxPanelNameStr) const wxString& name = wxPanelNameStr)
: wxScrollHelperNative(this) : wxScrollHelper(this)
{ {
Create(parent, winid, pos, size, style, name); Create(parent, winid, pos, size, style, name);
} }

File diff suppressed because it is too large Load Diff

View File

@@ -36,10 +36,10 @@
// wxScrollHelper implementation // wxScrollHelper implementation
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
void wxScrollHelperNative::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, void wxScrollHelper::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
int noUnitsX, int noUnitsY, int noUnitsX, int noUnitsY,
int xPos, int yPos, int xPos, int yPos,
bool noRefresh) bool noRefresh)
{ {
int xs, ys; int xs, ys;
GetViewStart(& xs, & ys); GetViewStart(& xs, & ys);
@@ -81,13 +81,13 @@ void wxScrollHelperNative::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
} }
} }
void wxScrollHelperNative::DoAdjustScrollbar(GtkRange* range, void wxScrollHelper::DoAdjustScrollbar(GtkRange* range,
int pixelsPerLine, int pixelsPerLine,
int winSize, int winSize,
int virtSize, int virtSize,
int *pos, int *pos,
int *lines, int *lines,
int *linesPerPage) int *linesPerPage)
{ {
int upper; int upper;
int page_size; int page_size;
@@ -119,7 +119,7 @@ void wxScrollHelperNative::DoAdjustScrollbar(GtkRange* range,
*pos = *lines; *pos = *lines;
} }
void wxScrollHelperNative::AdjustScrollbars() void wxScrollHelper::AdjustScrollbars()
{ {
int vw, vh; int vw, vh;
m_targetWindow->GetVirtualSize(&vw, &vh); m_targetWindow->GetVirtualSize(&vw, &vh);
@@ -163,10 +163,10 @@ void wxScrollHelperNative::AdjustScrollbars()
} }
} }
void wxScrollHelperNative::DoScrollOneDir(int orient, void wxScrollHelper::DoScrollOneDir(int orient,
int pos, int pos,
int pixelsPerLine, int pixelsPerLine,
int *posOld) int *posOld)
{ {
if ( pos != -1 && pos != *posOld && pixelsPerLine ) if ( pos != -1 && pos != *posOld && pixelsPerLine )
{ {
@@ -181,7 +181,7 @@ void wxScrollHelperNative::DoScrollOneDir(int orient,
} }
} }
void wxScrollHelperNative::DoScroll( int x_pos, int y_pos ) void wxScrollHelper::DoScroll( int x_pos, int y_pos )
{ {
wxCHECK_RET( m_targetWindow != 0, _T("No target window") ); wxCHECK_RET( m_targetWindow != 0, _T("No target window") );
@@ -219,8 +219,8 @@ GtkPolicyType GtkPolicyFromWX(wxScrollbarVisibility visibility)
} // anonymous namespace } // anonymous namespace
void wxScrollHelperNative::DoShowScrollbars(wxScrollbarVisibility horz, void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz,
wxScrollbarVisibility vert) wxScrollbarVisibility vert)
{ {
GtkScrolledWindow * const scrolled = GTK_SCROLLED_WINDOW(m_win->m_widget); GtkScrolledWindow * const scrolled = GTK_SCROLLED_WINDOW(m_win->m_widget);
wxCHECK_RET( scrolled, "window must be created" ); wxCHECK_RET( scrolled, "window must be created" );

View File

@@ -36,7 +36,7 @@
// wxScrollHelper implementation // wxScrollHelper implementation
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
void wxScrollHelperNative::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, void wxScrollHelper::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
int noUnitsX, int noUnitsY, int noUnitsX, int noUnitsY,
int xPos, int yPos, int xPos, int yPos,
bool noRefresh) bool noRefresh)
@@ -73,7 +73,7 @@ void wxScrollHelperNative::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
m_targetWindow->m_hasScrolling = pixelsPerUnitX || pixelsPerUnitY; m_targetWindow->m_hasScrolling = pixelsPerUnitX || pixelsPerUnitY;
} }
void wxScrollHelperNative::DoAdjustScrollbar(GtkAdjustment *adj, void wxScrollHelper::DoAdjustScrollbar(GtkAdjustment *adj,
int pixelsPerLine, int pixelsPerLine,
int winSize, int winSize,
int virtSize, int virtSize,
@@ -127,7 +127,7 @@ void wxScrollHelperNative::DoAdjustScrollbar(GtkAdjustment *adj,
gtk_signal_emit_by_name( GTK_OBJECT(adj), "changed" ); gtk_signal_emit_by_name( GTK_OBJECT(adj), "changed" );
} }
void wxScrollHelperNative::AdjustScrollbars() void wxScrollHelper::AdjustScrollbars()
{ {
int w, h; int w, h;
int vw, vh; int vw, vh;
@@ -141,7 +141,7 @@ void wxScrollHelperNative::AdjustScrollbars()
&m_yScrollPosition, &m_yScrollLines, &m_yScrollLinesPerPage); &m_yScrollPosition, &m_yScrollLines, &m_yScrollLinesPerPage);
} }
void wxScrollHelperNative::DoScroll(int orient, void wxScrollHelper::DoScrollOneDir(int orient,
GtkAdjustment *adj, GtkAdjustment *adj,
int pos, int pos,
int pixelsPerLine, int pixelsPerLine,
@@ -169,13 +169,19 @@ void wxScrollHelperNative::DoScroll(int orient,
} }
} }
void wxScrollHelperNative::Scroll( int x_pos, int y_pos ) void wxScrollHelper::DoScroll( int x_pos, int y_pos )
{ {
wxCHECK_RET( m_targetWindow != 0, _T("No target window") ); wxCHECK_RET( m_targetWindow != 0, _T("No target window") );
DoScroll(wxHORIZONTAL, m_win->m_hAdjust, x_pos, m_xScrollPixelsPerLine, DoScrollOneDir(wxHORIZONTAL, m_win->m_hAdjust, x_pos, m_xScrollPixelsPerLine,
&m_xScrollPosition); &m_xScrollPosition);
DoScroll(wxVERTICAL, m_win->m_vAdjust, y_pos, m_yScrollPixelsPerLine, DoScrollOneDir(wxVERTICAL, m_win->m_vAdjust, y_pos, m_yScrollPixelsPerLine,
&m_yScrollPosition); &m_yScrollPosition);
} }
void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility WXUNUSED(horz),
wxScrollbarVisibility WXUNUSED(vert))
{
// TODO: not supported/implemented
}