Clarify documentation for wxPropertyGridEvent::GetProperty()

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

diff --git a/include/wx/gtk1/scrolwin.h b/include/wx/gtk1/scrolwin.h
index 96688d1ab913ce39942be6f38d1834effad43f5c..1447788a724e5acab8610ea850c8fcb456e7afda 100644 (file)
--- a/include/wx/gtk1/scrolwin.h
+++ b/include/wx/gtk1/scrolwin.h
@@ -1,162 +1,57 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        wx/generic/scrolwin.h
+// Name:        wx/gtk1/scrolwin.h

 // Purpose:     wxScrolledWindow class
 // Author:      Robert Roebling
 // Purpose:     wxScrolledWindow class
 // Author:      Robert Roebling

-// Modified by:
+// Modified by: Vadim Zeitlin (2005-10-10): wxScrolledWindow is now common

 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling
 // 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_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_GTK_SCROLLWIN_H_
 #define _WX_GTK_SCROLLWIN_H_
 

-#ifdef __GNUG__
-    #pragma interface "scrolwin.h"
-#endif
-
-// ----------------------------------------------------------------------------
-// headers and constants
-// ----------------------------------------------------------------------------
-
-#include "wx/window.h"
-#include "wx/panel.h"
-
-WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
-
-// default scrolled window style
-#ifndef wxScrolledWindowStyle
-#define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
-#endif
-

 // ----------------------------------------------------------------------------
 // wxScrolledWindow
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxScrolledWindow
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxScrolledWindow : public wxPanel
+class WXDLLIMPEXP_CORE wxScrollHelper : public wxScrollHelperBase

 {
 public:
 {
 public:

-    wxScrolledWindow()
-        { Init(); }
-
-    wxScrolledWindow(wxWindow *parent,
-                     wxWindowID id = -1,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxScrolledWindowStyle,
-                     const wxString& name = wxPanelNameStr)
-        { Create(parent, id, pos, size, style, name); }
+    wxScrollHelper(wxWindow *win) : wxScrollHelperBase(win) { }

 
 

-    void Init();
-
-    bool Create(wxWindow *parent,
-                wxWindowID id,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxScrolledWindowStyle,
-                const wxString& name = wxPanelNameStr);
-
-    // Normally the wxScrolledWindow will scroll itself, but in
-    // some rare occasions you might want it to scroll 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, bool pushEventHandler = FALSE );
-    virtual wxWindow *GetTargetWindow();
-
-    // 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
+    // implement base class pure virtuals

     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,

-                             int noUnitsX, int noUnitsY,
-                             int xPos = 0, int yPos = 0,
-                             bool noRefresh = FALSE );
-
-    // Physically scroll the window
-    virtual void Scroll(int x_pos, int y_pos);
-
-    int GetScrollPageSize(int orient) const;
-    void SetScrollPageSize(int orient, int pageSize);
-
-    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
-    // 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
-    // to actually scroll a non-constant distance
-    virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
-
-    // 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;
-
-    // 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);
-
-    // lay out the window and its children
-    virtual bool Layout();
-
-    // Adjust the scrollbars
+                               int noUnitsX, int noUnitsY,
+                               int xPos = 0, int yPos = 0,
+                               bool noRefresh = false);

     virtual void AdjustScrollbars();
 
     virtual void AdjustScrollbars();
 

-    // 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; }
-    double GetScaleY() const { return m_scaleY; }
-
-    // implementation from now on
-    void OnScroll(wxScrollWinEvent& event);
-    void OnSize(wxSizeEvent& event);
-    void OnPaint(wxPaintEvent& event);
-    void OnChar(wxKeyEvent& event);
-
-    void GtkVScroll( float value, unsigned int scroll_type );
-    void GtkHScroll( float value, unsigned int scroll_type );
-    void GtkVConnectEvent();
-    void GtkHConnectEvent();
-    void GtkVDisconnectEvent();
-    void GtkHDisconnectEvent();
-
-    // Calculate scroll increment
-    virtual int CalcScrollInc(wxScrollWinEvent& event);
-
-    // Overridden from wxWindows due callback being static
-    virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
-

 protected:
 protected:

-    wxWindow             *m_targetWindow;
-    int                   m_xScrollPixelsPerLine;
-    int                   m_yScrollPixelsPerLine;
-    bool                  m_xScrollingEnabled;
-    bool                  m_yScrollingEnabled;
-    int                   m_xScrollPosition;
-    int                   m_yScrollPosition;
-    int                   m_xScrollLines;
-    int                   m_yScrollLines;
-    int                   m_xScrollLinesPerPage;
-    int                   m_yScrollLinesPerPage;
-
-    double                m_scaleY,m_scaleX;
+    virtual void DoScroll(int x, int y);
+    virtual void DoShowScrollbars(wxScrollbarVisibility horz,
+                                  wxScrollbarVisibility vert);
+
+    // this does (each) half of AdjustScrollbars() work
+    void DoAdjustScrollbar(GtkAdjustment *adj,
+                           int pixelsPerLine,
+                           int winSize,
+                           int virtSize,
+                           int *pos,
+                           int *lines,
+                           int *linesPerPage);
+
+    // and this does the same for Scroll()
+    void DoScrollOneDir(int orient,
+                        GtkAdjustment *adj,
+                        int pos,
+                        int pixelsPerLine,
+                        int *posOld);

 
 private:
 
 private:

-    DECLARE_EVENT_TABLE()
-    DECLARE_ABSTRACT_CLASS(wxScrolledWindow)
+    wxDECLARE_NO_COPY_CLASS(wxScrollHelper);

 };
 
 };
 

-#endif
-    // _WX_GTK_SCROLLWIN_H_
+#endif // _WX_GTK_SCROLLWIN_H_
+