X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/29e1398fa035b277569c4514deb622e9f1ddcf40..c9ccc09c64f4c29d4667796bef7b507d9e8d25ed:/include/wx/scrolwin.h

diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h
index c40548cd69..6360fd721b 100644
--- a/include/wx/scrolwin.h
+++ b/include/wx/scrolwin.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        include/wx/scrolwin.h
+// Name:        wx/scrolwin.h
 // Purpose:     wxScrolledWindow, wxScrolledControl and wxScrollHelper
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -70,8 +70,12 @@ public:
                                bool noRefresh = false );
 
     // scroll to the given (in logical coords) position
-    void Scroll(int x, int y) { DoScroll(x, y); }
-    void Scroll(const wxPoint& pt) { DoScroll(pt.x, pt.y); }
+    //
+    // notice that for backwards compatibility reasons Scroll() is virtual as
+    // the existing code could override it but new code should override
+    // DoScroll() instead
+    virtual void Scroll(int x, int y) { DoScroll(x, y); }
+    virtual void Scroll(const wxPoint& pt) { DoScroll(pt.x, pt.y); }
 
     // get/set the page size for this orientation (wxVERTICAL/wxHORIZONTAL)
     int GetScrollPageSize(int orient) const;
@@ -104,6 +108,17 @@ public:
     // actually scroll a non-constant distance
     virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
 
+    // Disable use of keyboard keys for scrolling. By default cursor movement
+    // keys (including Home, End, Page Up and Down) are used to scroll the
+    // window appropriately. If the derived class uses these keys for something
+    // else, e.g. changing the currently selected item, this function can be
+    // used to disable this behaviour as it's not only not necessary then but
+    // can actually be actively harmful if another object forwards a keyboard
+    // event corresponding to one of the above keys to us using
+    // ProcessWindowEvent() because the event will always be processed which
+    // can be undesirable.
+    void DisableKeyboardScrolling() { m_kbdScrollingEnabled = false; }
+
     // Get the view start
     void GetViewStart(int *x, int *y) const { DoGetViewStart(x, y); }
 
@@ -189,9 +204,11 @@ public:
 #endif // wxUSE_MOUSEWHEEL
     void HandleOnChildFocus(wxChildFocusEvent& event);
 
-    // FIXME: this is needed for now for wxPlot compilation, should be removed
-    //        once it is fixed!
-    void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED(
+        void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
+    )
+#endif // WXWIN_COMPATIBILITY_2_8
 
 protected:
     // get pointer to our scroll rect if we use it or NULL
@@ -278,13 +295,15 @@ protected:
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
 
+    bool                  m_kbdScrollingEnabled;
+
 #if wxUSE_MOUSEWHEEL
     int m_wheelRotation;
 #endif // wxUSE_MOUSEWHEEL
 
     wxScrollHelperEvtHandler *m_handler;
 
-    DECLARE_NO_COPY_CLASS(wxScrollHelperBase)
+    wxDECLARE_NO_COPY_CLASS(wxScrollHelperBase);
 };
 
 // this macro can be used in a wxScrollHelper-derived class to forward wxWindow
@@ -327,9 +346,9 @@ struct WXDLLIMPEXP_CORE wxScrolledT_Helper
 // but wxScrolledWindow includes wxControlContainer functionality and that's
 // not always desirable.
 template<class T>
-class WXDLLIMPEXP_CORE wxScrolled : public T,
-                                    public wxScrollHelper,
-                                    private wxScrolledT_Helper
+class wxScrolled : public T,
+                   public wxScrollHelper,
+                   private wxScrolledT_Helper
 {
 public:
     wxScrolled() : wxScrollHelper(this) { }
@@ -398,16 +417,17 @@ private:
 
     // VC++ 6 gives warning for the declaration of template member function
     // without definition
-#if !defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7)
-    DECLARE_NO_COPY_CLASS(wxScrolled)
+#ifndef __VISUALC6__
+    wxDECLARE_NO_COPY_CLASS(wxScrolled);
 #endif
 };
 
-// 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> )
+#ifdef __VISUALC6__
+    // disable the warning about non dll-interface class used as base for
+    // dll-interface class: it's harmless in this case
+    #pragma warning(push)
+    #pragma warning(disable:4275)
+#endif
 
 // for compatibility with existing code, we provide wxScrolledWindow
 // "typedef" for wxScrolled<wxPanel>. It's not a real typedef because we
@@ -430,4 +450,8 @@ public:
 
 typedef wxScrolled<wxWindow> wxScrolledCanvas;
 
+#ifdef __VISUALC6__
+    #pragma warning(pop)
+#endif
+
 #endif // _WX_SCROLWIN_H_BASE_