]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/scrolwin.h
Add import/export macros
[wxWidgets.git] / include / wx / generic / scrolwin.h
index 1c9d92168ba88aee88fa1955ed4c6d1f3deabbfb..8ce2e1499622d0efed89e86bf00536eb24996a8a 100644 (file)
@@ -1,19 +1,19 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/generic/scrolwin.h
-// Purpose:     wxScrolledWindow class
+// Purpose:     wxGenericScrolledWindow class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_GENERIC_SCROLLWIN_H_
 #define _WX_GENERIC_SCROLLWIN_H_
 
-#ifdef __GNUG__
-    #pragma interface "scrolwin.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "genscrolwin.h"
 #endif
 
 // ----------------------------------------------------------------------------
 #include "wx/window.h"
 #include "wx/panel.h"
 
-WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxPanelNameStr;
 
 // default scrolled window style
 #ifndef wxScrolledWindowStyle
-#define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
+    #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
+#endif
+
+// avoid triggering this stupid VC++ warning
+#ifdef __VISUALC__
+    #if _MSC_VER > 1100
+        #pragma warning(push)
+    #endif
+    #pragma warning(disable:4355) // 'this' used in base member initializer list
 #endif
 
 // ----------------------------------------------------------------------------
 // wxGenericScrolledWindow
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxGenericScrolledWindow : public wxPanel
+class WXDLLEXPORT wxGenericScrolledWindow : public wxPanel,
+                                            public wxScrollHelper
 {
 public:
-    wxGenericScrolledWindow();
+    wxGenericScrolledWindow() : wxScrollHelper(this) { }
     wxGenericScrolledWindow(wxWindow *parent,
-                     wxWindowID id = -1,
+                     wxWindowID winid = wxID_ANY,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxScrolledWindowStyle,
                      const wxString& name = wxPanelNameStr)
+        : wxScrollHelper(this)
     {
-        Create(parent, id, pos, size, style, name);
+        Create(parent, winid, pos, size, style, name);
     }
 
-    ~wxGenericScrolledWindow();
+    virtual ~wxGenericScrolledWindow();
 
     bool Create(wxWindow *parent,
-                wxWindowID id,
+                wxWindowID winid,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxScrolledWindowStyle,
                 const wxString& name = wxPanelNameStr);
 
-    // Normally the wxGenericScrolledWindow 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 );
-    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
-    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);
-
-#if WXWIN_COMPATIBILITY
-    virtual void GetScrollUnitsPerPage(int *x_page, int *y_page) const;
-    virtual void CalcUnscrolledPosition(int x, int y, float *xx, float *yy) const;
-#endif
-
-    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 PrepareDC(wxDC& dc) { DoPrepareDC(dc); }
 
-    // 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; }
+    // lay out the window and its children
+    virtual bool Layout();
 
-    virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
-    virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
+    virtual void DoSetVirtualSize(int x, int y);
 
-    // Adjust the scrollbars
-    virtual void AdjustScrollbars(void);
+    // wxWindow's GetBestVirtualSize returns the actual window size,
+    // whereas we want to return the virtual size
+    virtual wxSize GetBestVirtualSize() const;
 
-    // Override this function to draw the graphic (or just process EVT_PAINT)
-    virtual void OnDraw(wxDC& WXUNUSED(dc)) {};
+    // Return the size best suited for the current window
+    // (this isn't a virtual size, this is a sensible size for the window)
+    virtual wxSize DoGetBestSize() const;
 
-    // Override this function if you don't want to have wxGenericScrolledWindow
-    // automatically change the origin according to the scroll position.
-    virtual void PrepareDC(wxDC& dc);
-
-    // implementation from now on
-    void OnScroll(wxScrollWinEvent& event);
-    void OnSize(wxSizeEvent& event);
+protected:
+    // this is needed for wxEVT_PAINT processing hack described in
+    // wxScrollHelperEvtHandler::ProcessEvent()
     void OnPaint(wxPaintEvent& event);
-    void OnChar(wxKeyEvent& event);
 
-    // Calculate scroll increment
-    virtual int CalcScrollInc(wxScrollWinEvent& event);
-
-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_scaleX;
-    double                m_scaleY;
+    // we need to return a special WM_GETDLGCODE value to process just the
+    // arrows but let the other navigation characters through
+#ifdef __WXMSW__
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+#endif // __WXMSW__
 
 private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxGenericScrolledWindow)
     DECLARE_EVENT_TABLE()
-    DECLARE_ABSTRACT_CLASS(wxGenericScrolledWindow)
 };
 
+#if defined(__VISUALC__) && (_MSC_VER > 1100)
+    #pragma warning(pop)
+#endif
+
 #endif
     // _WX_GENERIC_SCROLLWIN_H_
+