wx(Choice/List/Note)book controls send CHANG(ED/ING) events in SetSelection.

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

diff --git a/include/wx/gtk/scrolwin.h b/include/wx/gtk/scrolwin.h
index e92401642043e195fd1eb0ed794cdd5d468c3585..3023df7fc41871615c19e26884167e897f30a8b8 100644 (file)
--- a/include/wx/gtk/scrolwin.h
+++ b/include/wx/gtk/scrolwin.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        wx/generic/scrolwin.h
+// Name:        wx/gtk/scrolwin.h
 // Purpose:     wxScrolledWindow class
 // Author:      Robert Roebling
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_GTK_SCROLLWIN_H_
 #define _WX_GTK_SCROLLWIN_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "scrolwin.h"
 #endif
 
@@ -62,12 +62,20 @@ public:
     // 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();
+    virtual void SetTargetWindow( wxWindow *target, bool pushEventHandler = FALSE );
+    virtual wxWindow *GetTargetWindow() const;
+
+    // Set the scrolled area of the window.
+    virtual void DoSetVirtualSize( int x, int y );
+
+    // Set the x, y scrolling increments.
+    void SetScrollRate( int xstep, int ystep );
 
     // Number of pixels per user unit (0 or -1 for no scrollbar)
     // Length of virtual canvas in user units
     // Length of page in user units
+    // Default action is to set the virtual size and alter scrollbars
+    // accordingly.
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                              int noUnitsX, int noUnitsY,
                              int xPos = 0, int yPos = 0,
@@ -82,7 +90,7 @@ public:
     virtual void GetScrollPixelsPerUnit(int *x_unit, int *y_unit) const;
 
     // Enable/disable Windows scrolling in either direction.
-    // If TRUE, wxWindows scrolls the canvas and only a bit of
+    // If TRUE, wxWidgets 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. Disable for when the scroll increment is used
@@ -91,22 +99,38 @@ public:
 
     // Get the view start
     virtual void GetViewStart(int *x, int *y) const;
-    // Compatibility
-    void ViewStart(int *x, int *y) const
-       { GetViewStart( x, y ); }
 
-    // Actual size in pixels when scrolling is taken into account
-    virtual void GetVirtualSize(int *x, int *y) const;
-
-    virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
-    virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
+    // translate between scrolled and unscrolled coordinates
+    void CalcScrolledPosition(int x, int y, int *xx, int *yy) const
+        {  DoCalcScrolledPosition(x, y, xx, yy); }
+    wxPoint CalcScrolledPosition(const wxPoint& pt) const
+    {
+        wxPoint p2;
+        DoCalcScrolledPosition(pt.x, pt.y, &p2.x, &p2.y);
+        return p2;
+    }
+
+    void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
+        {  DoCalcUnscrolledPosition(x, y, xx, yy); }
+    wxPoint CalcUnscrolledPosition(const wxPoint& pt) const
+    {
+        wxPoint 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;
 
     // Override this function to draw the graphic (or just process EVT_PAINT)
     virtual void OnDraw(wxDC& WXUNUSED(dc)) {}
 
     // Override this function if you don't want to have wxScrolledWindow
     // automatically change the origin according to the scroll position.
-    virtual void PrepareDC(wxDC& dc);
+    void PrepareDC(wxDC& dc) { DoPrepareDC(dc); }
+
+    // lay out the window and its children
+    virtual bool Layout();
 
     // Adjust the scrollbars
     virtual void AdjustScrollbars();
@@ -122,8 +146,8 @@ public:
     void OnPaint(wxPaintEvent& event);
     void OnChar(wxKeyEvent& event);
 
-    void GtkVScroll( float value );
-    void GtkHScroll( float value );
+    void GtkVScroll( float value, unsigned int scroll_type );
+    void GtkHScroll( float value, unsigned int scroll_type );
     void GtkVConnectEvent();
     void GtkHConnectEvent();
     void GtkVDisconnectEvent();
@@ -132,19 +156,28 @@ public:
     // Calculate scroll increment
     virtual int CalcScrollInc(wxScrollWinEvent& event);
 
-    // Overridden from wxWindows due callback being static
+    // Overridden from wxWidgets due callback being static
     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 
+#if WXWIN_COMPATIBILITY_2_2
+    // Compatibility
+    void ViewStart(int *x, int *y) const { GetViewStart( x, y ); }
+#endif // WXWIN_COMPATIBILITY_2_2
+
+    virtual void DoPrepareDC(wxDC& dc);
+
 protected:
     wxWindow             *m_targetWindow;
     int                   m_xScrollPixelsPerLine;
     int                   m_yScrollPixelsPerLine;
     bool                  m_xScrollingEnabled;
     bool                  m_yScrollingEnabled;
+
+    // FIXME: these next four members are duplicated in the GtkAdjustment
+    //        members of wxWindow.  Can they be safely removed from here?
+
     int                   m_xScrollPosition;
     int                   m_yScrollPosition;
-    int                   m_xScrollLines;
-    int                   m_yScrollLines;
     int                   m_xScrollLinesPerPage;
     int                   m_yScrollLinesPerPage;
 
@@ -157,3 +190,5 @@ private:
 
 #endif
     // _WX_GTK_SCROLLWIN_H_
+
+// vi:sts=4:sw=4:et