Use correct GTK macro in wx_gtk_widget_get_sensitive().

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

diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h
index 006a4d6ca330d205889e49c2a72cfadc5f747074..6360fd721b1d5d45e82c2aac06055ce9c0fb755f 100644 (file)
--- 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:
 // Purpose:     wxScrolledWindow, wxScrolledControl and wxScrollHelper
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -20,6 +20,14 @@ class WXDLLIMPEXP_FWD_BASE wxTimer;
 // default scrolled window style: scroll in both directions
 #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
 
 // default scrolled window style: scroll in both directions
 #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
 

+// values for the second argument of wxScrollHelper::ShowScrollbars()
+enum wxScrollbarVisibility
+{
+    wxSHOW_SB_NEVER = -1,   // never show the scrollbar at all
+    wxSHOW_SB_DEFAULT,      // show scrollbar only if it is needed
+    wxSHOW_SB_ALWAYS        // always show scrollbar, even if not needed
+};
+

 // ----------------------------------------------------------------------------
 // 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
 // ----------------------------------------------------------------------------
 // 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


@@ -29,11 +37,11 @@ class WXDLLIMPEXP_FWD_BASE wxTimer;
 //
 // So we have
 //
 //
 // So we have
 //

-//                             wxScrollHelper
+//                           wxScrollHelperBase

 //                                   |
 //                                   |
 //                                  \|/
 //                                   |
 //                                   |
 //                                  \|/

-//      wxWindow            wxScrollHelperNative
+//      wxWindow               wxScrollHelper

 //       |  \                   /        /
 //       |   \                 /        /
 //       |    _|             |_        /
 //       |  \                   /        /
 //       |   \                 /        /
 //       |    _|             |_        /


@@ -48,12 +56,12 @@ class WXDLLIMPEXP_FWD_BASE wxTimer;
 //
 // ----------------------------------------------------------------------------
 
 //
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxScrollHelper
+class WXDLLIMPEXP_CORE wxScrollHelperBase

 {
 public:
     // ctor must be given the associated window
 {
 public:
     // ctor must be given the associated window

-    wxScrollHelper(wxWindow *winToScroll);
-    virtual ~wxScrollHelper();
+    wxScrollHelperBase(wxWindow *winToScroll);
+    virtual ~wxScrollHelperBase();

 
     // configure the scrolling
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
 
     // configure the scrolling
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,


@@ -62,13 +70,18 @@ public:
                                bool noRefresh = false );
 
     // scroll to the given (in logical coords) position
                                bool noRefresh = false );
 
     // scroll to the given (in logical coords) position

-    virtual void Scroll(int x, int 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;
     void SetScrollPageSize(int orient, int pageSize);
 
 
     // get/set the page size for this orientation (wxVERTICAL/wxHORIZONTAL)
     int GetScrollPageSize(int orient) const;
     void SetScrollPageSize(int orient, int pageSize);
 

-    // get the number of lines the window can scroll, 
+    // get the number of lines the window can scroll,

     // returns 0 if no scrollbars are there.
     int GetScrollLines( int orient ) const;
 
     // returns 0 if no scrollbars are there.
     int GetScrollLines( int orient ) const;
 


@@ -76,8 +89,17 @@ public:
     void SetScrollRate( int xstep, int ystep );
 
     // get the size of one logical unit in physical ones
     void SetScrollRate( int xstep, int ystep );
 
     // get the size of one logical unit in physical ones

-    virtual void GetScrollPixelsPerUnit(int *pixelsPerUnitX,
-                                        int *pixelsPerUnitY) const;
+    void GetScrollPixelsPerUnit(int *pixelsPerUnitX, int *pixelsPerUnitY) const;
+
+    // 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
+    // associated window), always (as wxALWAYS_SHOW_SB style does) or never (in
+    // which case you should provide some other way to scroll the window as the
+    // user wouldn't be able to do it at all)
+    void ShowScrollbars(wxScrollbarVisibility horz, wxScrollbarVisibility vert)
+    {
+        DoShowScrollbars(horz, vert);
+    }

 
     // Enable/disable Windows scrolling in either direction. If true, wxWidgets
     // scrolls the canvas and only a bit of the canvas is invalidated; no
 
     // Enable/disable Windows scrolling in either direction. If true, wxWidgets
     // scrolls the canvas and only a bit of the canvas is invalidated; no


@@ -86,8 +108,26 @@ public:
     // actually scroll a non-constant distance
     virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
 
     // 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
     // Get the view start

-    virtual void GetViewStart(int *x, int *y) const;
+    void GetViewStart(int *x, int *y) const { DoGetViewStart(x, y); }
+
+    wxPoint GetViewStart() const
+    {
+        wxPoint pt;
+        DoGetViewStart(&pt.x, &pt.y);
+        return pt;
+    }

 
     // Set the scale factor, used in PrepareDC
     void SetScale(double xs, double ys) { m_scaleX = xs; m_scaleY = ys; }
 
     // Set the scale factor, used in PrepareDC
     void SetScale(double xs, double ys) { m_scaleX = xs; m_scaleY = ys; }


@@ -113,21 +153,21 @@ public:
         return p2;
     }
 
         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;
+    void DoCalcScrolledPosition(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
     // 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
     // scrollbars (spreadsheet: only cell area will move).
 
     // Normally the wxScrolledWindow will scroll itself, but in some rare
     // 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
     // scrollbars (spreadsheet: only cell area will move).

-    virtual void SetTargetWindow(wxWindow *target);
-    virtual wxWindow *GetTargetWindow() const;
+    void SetTargetWindow(wxWindow *target);
+    wxWindow *GetTargetWindow() const;

 
     void SetTargetRect(const wxRect& rect) { m_rectToScroll = rect; }
     wxRect GetTargetRect() const { return m_rectToScroll; }
 
     void SetTargetRect(const wxRect& rect) { m_rectToScroll = rect; }
     wxRect GetTargetRect() const { return m_rectToScroll; }


@@ -164,9 +204,11 @@ public:
 #endif // wxUSE_MOUSEWHEEL
     void HandleOnChildFocus(wxChildFocusEvent& event);
 
 #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
 
 protected:
     // get pointer to our scroll rect if we use it or NULL


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

+    // implementation of public methods with the same name
+    virtual void DoGetViewStart(int *x, int *y) const;
+    virtual void DoScroll(int x, int y) = 0;
+    virtual void DoShowScrollbars(wxScrollbarVisibility horz,
+                                  wxScrollbarVisibility vert) = 0;
+

     // implementations of various wxWindow virtual methods which should be
     // forwarded to us (this can be done by WX_FORWARD_TO_SCROLL_HELPER())
     bool ScrollLayout();
     // implementations of various wxWindow virtual methods which should be
     // forwarded to us (this can be done by WX_FORWARD_TO_SCROLL_HELPER())
     bool ScrollLayout();


@@ -208,17 +256,6 @@ protected:
     // in wxScrollHelperEvtHandler::ProcessEvent()
     void ResetDrawnFlag();
 
     // in wxScrollHelperEvtHandler::ProcessEvent()
     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);
-

     // this function should be overridden to return the size available for
     // m_targetWindow inside m_win of the given size
     //
     // this function should be overridden to return the size available for
     // m_targetWindow inside m_win of the given size
     //


@@ -226,7 +263,11 @@ protected:
     // case, if we're scrolling a subwindow you must override this method
     virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size)
     {
     // case, if we're scrolling a subwindow you must override this method
     virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size)
     {

-        wxASSERT_MSG( m_targetWindow == m_win, "must be overridden" );
+        // returning just size from here is wrong but it was decided that it is
+        // not wrong enough to break the existing code (which doesn't override
+        // this recently added function at all) by adding this assert
+        //
+        // wxASSERT_MSG( m_targetWindow == m_win, "must be overridden" );

 
         return size;
     }
 
         return size;
     }


@@ -254,14 +295,15 @@ protected:
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
 
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
 

+    bool                  m_kbdScrollingEnabled;
+

 #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)
+    wxDECLARE_NO_COPY_CLASS(wxScrollHelperBase);

 };
 
 // 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


@@ -275,13 +317,14 @@ public:                                                                       \
     virtual wxSize GetBestVirtualSize() const                                 \
         { return ScrollGetBestVirtualSize(); }
 
     virtual wxSize GetBestVirtualSize() const                                 \
         { return ScrollGetBestVirtualSize(); }
 

-// include the declaration of wxScrollHelperNative if needed
+// include the declaration of the real wxScrollHelper

 #if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
     #include "wx/gtk/scrolwin.h"
 #elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
     #include "wx/gtk1/scrolwin.h"
 #else
 #if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
     #include "wx/gtk/scrolwin.h"
 #elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
     #include "wx/gtk1/scrolwin.h"
 #else

-    typedef wxScrollHelper wxScrollHelperNative;
+    #define wxHAS_GENERIC_SCROLLWIN
+    #include "wx/generic/scrolwin.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -292,7 +335,7 @@ public:                                                                       \
 struct WXDLLIMPEXP_CORE wxScrolledT_Helper
 {
     static wxSize FilterBestSize(const wxWindow *win,
 struct WXDLLIMPEXP_CORE wxScrolledT_Helper
 {
     static wxSize FilterBestSize(const wxWindow *win,

-                                 const wxScrollHelperNative *helper,
+                                 const wxScrollHelper *helper,

                                  const wxSize& origBest);
 #ifdef __WXMSW__
     static WXLRESULT FilterMSWWindowProc(WXUINT nMsg, WXLRESULT origResult);
                                  const wxSize& origBest);
 #ifdef __WXMSW__
     static WXLRESULT FilterMSWWindowProc(WXUINT nMsg, WXLRESULT origResult);


@@ -303,19 +346,19 @@ struct WXDLLIMPEXP_CORE wxScrolledT_Helper
 // but wxScrolledWindow includes wxControlContainer functionality and that's
 // not always desirable.
 template<class T>
 // 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
+class wxScrolled : public T,
+                   public wxScrollHelper,
+                   private wxScrolledT_Helper

 {
 public:
 {
 public:

-    wxScrolled() : wxScrollHelperNative(this) { }
+    wxScrolled() : wxScrollHelper(this) { }

     wxScrolled(wxWindow *parent,
                wxWindowID winid = wxID_ANY,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxScrolledWindowStyle,
                const wxString& name = wxPanelNameStr)
     wxScrolled(wxWindow *parent,
                wxWindowID winid = wxID_ANY,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxScrolledWindowStyle,
                const wxString& name = wxPanelNameStr)

-        : wxScrollHelperNative(this)
+        : wxScrollHelper(this)

     {
         Create(parent, winid, pos, size, style, name);
     }
     {
         Create(parent, winid, pos, size, style, name);
     }


@@ -374,16 +417,17 @@ private:
 
     // VC++ 6 gives warning for the declaration of template member function
     // without definition
 
     // 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
 };
 
 #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
 
 // for compatibility with existing code, we provide wxScrolledWindow
 // "typedef" for wxScrolled<wxPanel>. It's not a real typedef because we


@@ -406,4 +450,8 @@ public:
 
 typedef wxScrolled<wxWindow> wxScrolledCanvas;
 
 
 typedef wxScrolled<wxWindow> wxScrolledCanvas;
 

+#ifdef __VISUALC6__
+    #pragma warning(pop)
+#endif
+

 #endif // _WX_SCROLWIN_H_BASE_
 #endif // _WX_SCROLWIN_H_BASE_