clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h
index 2986a6c9c4e5f60380e058768c5727884882a3e4..aae769bea40d8d218055344d4180cd9fe12ce0bf 100644 (file)
--- a/include/wx/scrolwin.h
+++ b/include/wx/scrolwin.h
@@ -22,6 +22,7 @@ class WXDLLEXPORT wxTimer;
 // wxScrolledWindow and wxScrolledControl. It is a mix-in: just derive from it
 // to implement scrolling in your class.
 // ----------------------------------------------------------------------------
 // wxScrolledWindow and wxScrolledControl. It is a mix-in: just derive from it
 // to implement scrolling in your class.
 // ----------------------------------------------------------------------------

+#if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)

 
 class WXDLLEXPORT wxScrollHelper
 {
 
 class WXDLLEXPORT wxScrollHelper
 {


@@ -35,7 +36,7 @@ public:
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                                int noUnitsX, int noUnitsY,
                                int xPos = 0, int yPos = 0,
     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,13 +45,16 @@ public:
     int GetScrollPageSize(int orient) const;
     void SetScrollPageSize(int orient, int pageSize);
 
     int GetScrollPageSize(int orient) const;
     void SetScrollPageSize(int orient, int pageSize);
 

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

     // get the size of one logical unit in physical ones
     virtual void GetScrollPixelsPerUnit(int *pixelsPerUnitX,
                                         int *pixelsPerUnitY) const;
 
     // get the size of one logical unit in physical ones
     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);


@@ -58,9 +62,6 @@ public:
     // Get the view start
     virtual void GetViewStart(int *x, int *y) const;
 
     // Get the view start
     virtual void GetViewStart(int *x, int *y) const;
 

-    // Actual size in pixels when scrolling is taken into account
-    virtual void GetVirtualSize(int *x, int *y) const;
-

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


@@ -84,7 +85,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 +122,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


@@ -139,9 +140,14 @@ public:
     //        once it is fixed!
     void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
 
     //        once it is fixed!
     void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
 

+#if WXWIN_COMPATIBILITY_2_2
+    // Compatibility only, don't use
+    void ViewStart(int *x, int *y) const { GetViewStart( x, y ); }
+#endif // WXWIN_COMPATIBILITY_2_2
+

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


@@ -196,8 +202,12 @@ protected:
 #endif // wxUSE_MOUSEWHEEL
 
     wxScrollHelperEvtHandler *m_handler;
 #endif // wxUSE_MOUSEWHEEL
 
     wxScrollHelperEvtHandler *m_handler;

+
+    DECLARE_NO_COPY_CLASS(wxScrollHelper)

 };
 
 };
 

+#endif
+

 // ----------------------------------------------------------------------------
 // wxScrolledWindow: a wxWindow which knows how to scroll
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxScrolledWindow: a wxWindow which knows how to scroll
 // ----------------------------------------------------------------------------


@@ -212,17 +222,17 @@ protected:
     public:
         wxScrolledWindow() { }
         wxScrolledWindow(wxWindow *parent,
     public:
         wxScrolledWindow() { }
         wxScrolledWindow(wxWindow *parent,

-                         wxWindowID id = -1,
+                         wxWindowID winid = wxID_ANY,

                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          long style = wxScrolledWindowStyle,
                          const wxString& name = wxPanelNameStr)
                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          long style = wxScrolledWindowStyle,
                          const wxString& name = wxPanelNameStr)

-            : wxGenericScrolledWindow(parent, id, pos, size, style, name)
+            : wxGenericScrolledWindow(parent, winid, pos, size, style, name)

         {
         }
 
     private:
         {
         }
 
     private:

-        DECLARE_CLASS(wxScrolledWindow)
+        DECLARE_DYNAMIC_CLASS_NO_COPY(wxScrolledWindow)

     };
 
     #define wxSCROLLED_WINDOW_IS_GENERIC 1
     };
 
     #define wxSCROLLED_WINDOW_IS_GENERIC 1


@@ -230,3 +240,4 @@ protected:
 
 #endif
     // _WX_SCROLWIN_H_BASE_
 
 #endif
     // _WX_SCROLWIN_H_BASE_

+