add an assert indicating that old code overriding OnExecute() must be updated with 2.9

[wxWidgets.git] / include / wx / scrolwin.h

diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h
index 8e12c38018ddc90c2e85fa6a0235da328d904163..1aca7a9a661f26e92768c0d0d0772c10075229ec 100644 (file)
--- a/include/wx/scrolwin.h
+++ b/include/wx/scrolwin.h
@@ -12,30 +12,54 @@
 #ifndef _WX_SCROLWIN_H_BASE_
 #define _WX_SCROLWIN_H_BASE_
 
 #ifndef _WX_SCROLWIN_H_BASE_
 #define _WX_SCROLWIN_H_BASE_
 

-#include "wx/window.h"
+#include "wx/panel.h"

 
 

-class WXDLLEXPORT wxScrollHelperEvtHandler;
-class WXDLLEXPORT wxTimer;
+class WXDLLIMPEXP_FWD_CORE wxScrollHelperEvtHandler;
+class WXDLLIMPEXP_FWD_BASE wxTimer;
+
+// default scrolled window style: scroll in both directions
+#define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxScrollHelper: this class implements the scrolling logic which is used by
-// wxScrolledWindow and wxScrolledControl. It is a mix-in: just derive from it
-// to implement scrolling in your class.
+// The hierarchy of scrolling classes is a bit complicated because we want to
+// put as much functionality as possible in a mix-in class not deriving from
+// wxWindow so that other classes could derive from the same base class on all
+// platforms irrespectively of whether they are native controls (and hence
+// don't use our scrolling) or not.
+//
+// So we have
+//
+//                             wxScrollHelper
+//                                   |
+//                                   |
+//                                  \|/
+//      wxWindow            wxScrollHelperNative
+//       |  \                   /        /
+//       |   \                 /        /
+//       |    _|             |_        /
+//       |     wxScrolledWindow       /
+//       |                           /
+//      \|/                         /
+//   wxControl                     /
+//         \                      /
+//          \                    /
+//           _|                |_
+//            wxScrolledControl
+//

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxScrollHelper
+class WXDLLIMPEXP_CORE wxScrollHelper

 {
 public:
 {
 public:

-    // ctor and dtor
-    wxScrollHelper(wxWindow *winToScroll = (wxWindow *)NULL);
-    void SetWindow(wxWindow *winToScroll);
+    // ctor must be given the associated window
+    wxScrollHelper(wxWindow *winToScroll);

     virtual ~wxScrollHelper();
 
     // configure the scrolling
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                                int noUnitsX, int noUnitsY,
                                int xPos = 0, int yPos = 0,
     virtual ~wxScrollHelper();
 
     // configure the scrolling
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                                int noUnitsX, int noUnitsY,
                                int xPos = 0, int yPos = 0,

-                               bool noRefresh = FALSE );
+                               bool noRefresh = false );

 
     // scroll to the given (in logical coords) position
     virtual void Scroll(int x, int y);
 
     // scroll to the given (in logical coords) position
     virtual void Scroll(int x, int y);


@@ -44,6 +68,10 @@ public:
     int GetScrollPageSize(int orient) const;
     void SetScrollPageSize(int orient, int pageSize);
 
     int GetScrollPageSize(int orient) const;
     void SetScrollPageSize(int orient, int pageSize);
 

+    // get the number of lines the window can scroll, 
+    // returns 0 if no scrollbars are there.
+    int GetScrollLines( int orient ) const;
+

     // Set the x, y scrolling increments.
     void SetScrollRate( int xstep, int ystep );
 
     // Set the x, y scrolling increments.
     void SetScrollRate( int xstep, int ystep );
 


@@ -51,9 +79,9 @@ public:
     virtual void GetScrollPixelsPerUnit(int *pixelsPerUnitX,
                                         int *pixelsPerUnitY) const;
 
     virtual void GetScrollPixelsPerUnit(int *pixelsPerUnitX,
                                         int *pixelsPerUnitY) const;
 

-    // Enable/disable Windows scrolling in either direction. If TRUE, wxWindows
+    // Enable/disable Windows scrolling in either direction. If true, wxWidgets

     // scrolls the canvas and only a bit of the canvas is invalidated; no
     // scrolls the canvas and only a bit of the canvas is invalidated; no

-    // Clear() is necessary. If FALSE, the whole canvas is invalidated and a
+    // Clear() is necessary. If false, the whole canvas is invalidated and a

     // Clear() is necessary. Disable for when the scroll increment is used to
     // actually scroll a non-constant distance
     virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
     // Clear() is necessary. Disable for when the scroll increment is used to
     // actually scroll a non-constant distance
     virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);


@@ -84,7 +112,7 @@ public:
         DoCalcUnscrolledPosition(pt.x, pt.y, &p2.x, &p2.y);
         return p2;
     }
         DoCalcUnscrolledPosition(pt.x, pt.y, &p2.x, &p2.y);
         return p2;
     }

-    
+

     virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
     virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
 
     virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
     virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
 


@@ -121,7 +149,7 @@ public:
     // stop the timer, so it will be called repeatedly and will typically
     // return different values depending on the current mouse position
     //
     // stop the timer, so it will be called repeatedly and will typically
     // return different values depending on the current mouse position
     //

-    // the base class version just returns TRUE
+    // the base class version just returns true

     virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
 
     // the methods to be called from the window event handlers
     virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
 
     // the methods to be called from the window event handlers


@@ -134,6 +162,7 @@ public:
 #if wxUSE_MOUSEWHEEL
     void HandleOnMouseWheel(wxMouseEvent& event);
 #endif // wxUSE_MOUSEWHEEL
 #if wxUSE_MOUSEWHEEL
     void HandleOnMouseWheel(wxMouseEvent& event);
 #endif // wxUSE_MOUSEWHEEL

+    void HandleOnChildFocus(wxChildFocusEvent& event);

 
     // FIXME: this is needed for now for wxPlot compilation, should be removed
     //        once it is fixed!
 
     // FIXME: this is needed for now for wxPlot compilation, should be removed
     //        once it is fixed!


@@ -141,7 +170,7 @@ public:
 
 protected:
     // get pointer to our scroll rect if we use it or NULL
 
 protected:
     // get pointer to our scroll rect if we use it or NULL

-    const wxRect *GetRect() const
+    const wxRect *GetScrollRect() const

     {
         return m_rectToScroll.width != 0 ? &m_rectToScroll : NULL;
     }
     {
         return m_rectToScroll.width != 0 ? &m_rectToScroll : NULL;
     }


@@ -153,7 +182,7 @@ protected:
                                          : m_targetWindow->GetClientSize();
     }
 
                                          : m_targetWindow->GetClientSize();
     }
 

-    void GetTargetSize(int *w, int *h)
+    void GetTargetSize(int *w, int *h) const

     {
         wxSize size = GetTargetSize();
         if ( w )
     {
         wxSize size = GetTargetSize();
         if ( w )


@@ -162,6 +191,12 @@ protected:
             *h = size.y;
     }
 
             *h = size.y;
     }
 

+    // implementations of various wxWindow virtual methods which should be
+    // forwarded to us (this can be done by WX_FORWARD_TO_SCROLL_HELPER())
+    bool ScrollLayout();
+    void ScrollDoSetVirtualSize(int x, int y);
+    wxSize ScrollGetBestVirtualSize() const;
+

     // change just the target window (unlike SetWindow which changes m_win as
     // well)
     void DoSetTargetWindow(wxWindow *target);
     // change just the target window (unlike SetWindow which changes m_win as
     // well)
     void DoSetTargetWindow(wxWindow *target);


@@ -169,6 +204,14 @@ protected:
     // delete the event handler we installed
     void DeleteEvtHandler();
 
     // delete the event handler we installed
     void DeleteEvtHandler();
 

+    // calls wxScrollHelperEvtHandler::ResetDrawnFlag(), see explanation
+    // in wxScrollHelperEvtHandler::ProcessEvent()
+    void ResetDrawnFlag();
+
+
+    double                m_scaleX;
+    double                m_scaleY;
+

     wxWindow             *m_win,
                          *m_targetWindow;
 
     wxWindow             *m_win,
                          *m_targetWindow;
 


@@ -188,47 +231,151 @@ protected:
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
 
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
 

-    double                m_scaleX;
-    double                m_scaleY;
-

 #if wxUSE_MOUSEWHEEL
     int m_wheelRotation;
 #endif // wxUSE_MOUSEWHEEL
 
     wxScrollHelperEvtHandler *m_handler;
 #if wxUSE_MOUSEWHEEL
     int m_wheelRotation;
 #endif // wxUSE_MOUSEWHEEL
 
     wxScrollHelperEvtHandler *m_handler;

+
+    DECLARE_NO_COPY_CLASS(wxScrollHelper)

 };
 
 };
 

+// this macro can be used in a wxScrollHelper-derived class to forward wxWindow
+// methods to corresponding wxScrollHelper methods
+#define WX_FORWARD_TO_SCROLL_HELPER()                                         \
+public:                                                                       \
+    virtual void PrepareDC(wxDC& dc) { DoPrepareDC(dc); }                     \
+    virtual bool Layout() { return ScrollLayout(); }                          \
+    virtual void DoSetVirtualSize(int x, int y)                               \
+        { ScrollDoSetVirtualSize(x, y); }                                     \
+    virtual wxSize GetBestVirtualSize() const                                 \
+        { return ScrollGetBestVirtualSize(); }
+
+// include the declaration of wxScrollHelperNative if needed
+#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
+    #include "wx/gtk/scrolwin.h"
+#elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
+    #include "wx/gtk1/scrolwin.h"
+#else
+    typedef wxScrollHelper wxScrollHelperNative;
+#endif
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxScrolledWindow: a wxWindow which knows how to scroll
+// wxScrolled<T>: a wxWindow which knows how to scroll

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-#if defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
-    #include "wx/gtk/scrolwin.h"
-#else // !wxGTK
-    #include "wx/generic/scrolwin.h"
+// helper class for wxScrolled<T> below
+struct WXDLLIMPEXP_CORE wxScrolledT_Helper
+{
+    static wxSize FilterBestSize(const wxWindow *win,
+                                 const wxScrollHelperNative *helper,
+                                 const wxSize& origBest);
+#ifdef __WXMSW__
+    static WXLRESULT FilterMSWWindowProc(WXUINT nMsg, WXLRESULT origResult);
+#endif
+};

 
 

-    class WXDLLEXPORT wxScrolledWindow : public wxGenericScrolledWindow
+// Scrollable window base on window type T. This used to be wxScrolledWindow,
+// but wxScrolledWindow includes wxControlContainer functionality and that's
+// not always desirable.
+template<class T>
+class WXDLLIMPEXP_CORE wxScrolled : public T,
+                                    public wxScrollHelperNative,
+                                    private wxScrolledT_Helper
+{
+public:
+    wxScrolled() : wxScrollHelperNative(this) { }
+    wxScrolled(wxWindow *parent,
+               wxWindowID winid = wxID_ANY,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxScrolledWindowStyle,
+               const wxString& name = wxPanelNameStr)
+        : wxScrollHelperNative(this)

     {
     {

-    public:
-        wxScrolledWindow() { }
-        wxScrolledWindow(wxWindow *parent,
-                         wxWindowID id = -1,
-                         const wxPoint& pos = wxDefaultPosition,
-                         const wxSize& size = wxDefaultSize,
-                         long style = wxScrolledWindowStyle,
-                         const wxString& name = wxPanelNameStr)
-            : wxGenericScrolledWindow(parent, id, pos, size, style, name)
-        {
-        }
-
-    private:
-        DECLARE_CLASS(wxScrolledWindow)
-    };
-
-    #define wxSCROLLED_WINDOW_IS_GENERIC 1
-#endif
+        Create(parent, winid, pos, size, style, name);
+    }

 
 

+    bool Create(wxWindow *parent,
+                wxWindowID winid,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxScrolledWindowStyle,
+                const wxString& name = wxPanelNameStr)
+    {
+        m_targetWindow = this;
+
+#ifdef __WXMAC__
+        this->MacSetClipChildren(true);

 #endif
 #endif

-    // _WX_SCROLWIN_H_BASE_

 
 

-// vi:sts=4:sw=4:et
+        this->Connect(wxEVT_PAINT, wxPaintEventHandler(wxScrolled::OnPaint));
+
+        // by default, we're scrollable in both directions (but if one of the
+        // styles is specified explicitly, we shouldn't add the other one
+        // automatically)
+        if ( !(style & (wxHSCROLL | wxVSCROLL)) )
+            style |= wxHSCROLL | wxVSCROLL;
+
+        return T::Create(parent, winid, pos, size, style, name);
+    }
+
+    // we need to return a special WM_GETDLGCODE value to process just the
+    // arrows but let the other navigation characters through
+#ifdef __WXMSW__
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+    {
+        return FilterMSWWindowProc(nMsg, T::MSWWindowProc(nMsg, wParam, lParam));
+    }
+#endif // __WXMSW__
+
+    WX_FORWARD_TO_SCROLL_HELPER()
+
+protected:
+    virtual wxSize DoGetBestSize() const
+    {
+        return FilterBestSize(this, this, T::DoGetBestSize());
+    }
+
+private:
+    // this is needed for wxEVT_PAINT processing hack described in
+    // wxScrollHelperEvtHandler::ProcessEvent()
+    void 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
+        ResetDrawnFlag();
+        event.Skip();
+    }
+
+    DECLARE_NO_COPY_CLASS(wxScrolled)
+};
+
+// VC++ <= 6 requires this; it's unlikely any other specializations would
+// be needed by user code _and_ they were using VC6, so we list only wxWindow
+// (typical use) and wxPanel (wxScrolledWindow use) specializations here
+WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE( wxScrolled<wxPanel> )
+WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE( wxScrolled<wxWindow> )
+
+// for compatibility with existing code, we provide wxScrolledWindow
+// "typedef" for wxScrolled<wxPanel>. It's not a real typedef because we
+// want wxScrolledWindow to show in wxRTTI information (the class is widely
+// used and likelihood of its wxRTTI information being used too is high):
+class WXDLLIMPEXP_CORE wxScrolledWindow : public wxScrolled<wxPanel>
+{
+public:
+    wxScrolledWindow() : wxScrolled<wxPanel>() {}
+    wxScrolledWindow(wxWindow *parent,
+                     wxWindowID winid = wxID_ANY,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxScrolledWindowStyle,
+                     const wxString& name = wxPanelNameStr)
+        : wxScrolled<wxPanel>(parent, winid, pos, size, style, name) {}
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxScrolledWindow)
+};
+
+typedef wxScrolled<wxWindow> wxScrolledCanvas;
+
+#endif // _WX_SCROLWIN_H_BASE_