typo fixed: __WXUNIV__ => __WXUNIVERSAL__

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

diff --git a/include/wx/generic/scrolwin.h b/include/wx/generic/scrolwin.h
index b80e443e14c3473a294ece60b49e6d8f35f2a2df..acf05c500b1178d52fecaeaa070eea4a52dfd3f3 100644 (file)
--- a/include/wx/generic/scrolwin.h
+++ b/include/wx/generic/scrolwin.h
@@ -1,141 +1,97 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        scrolwin.h
-// Purpose:     wxScrolledWindow class
+// Name:        wx/generic/scrolwin.h
+// Purpose:     wxGenericScrolledWindow class

 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows license
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __SCROLWINH_G__
-#define __SCROLWINH_G__
+#ifndef _WX_GENERIC_SCROLLWIN_H_
+#define _WX_GENERIC_SCROLLWIN_H_

 
 #ifdef __GNUG__
 
 #ifdef __GNUG__

-#pragma interface "scrolwin.h"
+    #pragma interface "genscrolwin.h"

 #endif
 
 #endif
 

-#include "wx/window.h"
+// ----------------------------------------------------------------------------
+// headers and constants
+// ----------------------------------------------------------------------------

 
 

-WXDLLEXPORT_DATA(extern const char*) wxPanelNameStr;
+#include "wx/window.h"
+#include "wx/panel.h"

 
 

-class WXDLLEXPORT wxScrolledWindow: public wxWindow
-{
-  DECLARE_ABSTRACT_CLASS(wxScrolledWindow)
+WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;

 
 

-public:
-  wxScrolledWindow(void);
-  inline wxScrolledWindow(wxWindow *parent, const wxWindowID id = -1,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxHSCROLL|wxVSCROLL,
-           const wxString& name = wxPanelNameStr)
-  {
-      Create(parent, id, pos, size, style, name);
-  }
-
-  inline ~wxScrolledWindow(void) {}
-
-  bool Create(wxWindow *parent, const wxWindowID id,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxHSCROLL|wxVSCROLL,
-           const wxString& name = wxPanelNameStr);
-
-  // Set client size
-  // Should take account of scrollbars
-//  virtual void SetClientSize(const int width, const int size);
-
-  // Is the window retained?
-//  inline bool IsRetained(void) const;
-
-  // 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(const int pixelsPerUnitX, const int pixelsPerUnitY,
-                             const int noUnitsX, const int noUnitsY,
-                             const int xPos = 0, const int yPos = 0, 
-                            const bool noRefresh = FALSE );
-
-  // Physically scroll the window
-  virtual void Scroll(const int x_pos, const int y_pos);
-
-#if WXWIN_COMPATIBILITY
-  virtual void GetScrollUnitsPerPage(int *x_page, int *y_page) const;
+// default scrolled window style
+#ifndef wxScrolledWindowStyle
+#define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)

 #endif
 
 #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(const bool x_scrolling, const bool y_scrolling);
-
-  // Get the view start
-  virtual void ViewStart(int *x, int *y) const;
-
-  // Actual size in pixels when scrolling is taken into account
-  virtual void GetVirtualSize(int *x, int *y) const;
-
-  virtual void CalcScrolledPosition(const int x, const int y, int *xx, int *yy) const ;
-  virtual void CalcUnscrolledPosition(const int x, const int y, float *xx, float *yy) const ;
-
-  // Adjust the scrollbars
-  virtual void AdjustScrollbars(void);
-
-/*
-#if WXWIN_COMPATIBILITY
-  virtual void OldOnScroll(wxCommandEvent& WXUNUSED(event));
-  virtual void OldOnPaint(void);                 // Called when needs painting
-  virtual void OldOnSize(int width, int height);           // Called on resize
-  virtual void OldOnMouseEvent(wxMouseEvent& event);  // Called on mouse event
-  virtual void OldOnChar(wxKeyEvent& event);     // Called on character event
+// avoid triggering this stupid VC++ warning
+#ifdef __VISUALC__
+    #pragma warning(disable:4355) // 'this' used in base member initializer list

 #endif
 #endif

-*/
-
-  void OnScroll(wxScrollEvent& event);
-  void OnSize(wxSizeEvent& event);
-  void OnPaint(wxPaintEvent& event);

 
 

-  // Override this function to draw the graphic.
-  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);
+// ----------------------------------------------------------------------------
+// wxGenericScrolledWindow
+// ----------------------------------------------------------------------------

 
 

+class WXDLLEXPORT wxGenericScrolledWindow : public wxPanel,
+                                            public wxScrollHelper
+{

 public:
 public:

-  ////////////////////////////////////////////////////////////////////////
-  //// IMPLEMENTATION
-  
-  // Calculate scroll increment
-  virtual int CalcScrollInc(wxScrollEvent& event);
-
-  ////////////////////////////////////////////////////////////////////////
-  //// PROTECTED DATA
+    wxGenericScrolledWindow() : wxScrollHelper(this) { }
+    wxGenericScrolledWindow(wxWindow *parent,
+                     wxWindowID id = -1,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxScrolledWindowStyle,
+                     const wxString& name = wxPanelNameStr)
+        : wxScrollHelper(this)
+    {
+        Create(parent, id, pos, size, style, name);
+    }
+
+    virtual ~wxGenericScrolledWindow();
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxScrolledWindowStyle,
+                const wxString& name = wxPanelNameStr);
+
+    virtual void PrepareDC(wxDC& dc) { DoPrepareDC(dc); }
+
+        // lay out the window and its children
+    virtual bool Layout();
+
+    virtual void DoSetVirtualSize( int x, int y );
+

 protected:
 protected:

-  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;
-
-DECLARE_EVENT_TABLE()
+    // this is needed for wxEVT_PAINT processing hack described in
+    // wxScrollHelperEvtHandler::ProcessEvent()
+    void OnPaint(wxPaintEvent& event);
+
+    // we need to return a special WM_GETDLGCODE value to process just the
+    // arrows but let the other navigation characters through
+#ifdef __WXMSW__
+    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+#endif // __WXMSW__
+
+private:
+    DECLARE_ABSTRACT_CLASS(wxGenericScrolledWindow)
+    DECLARE_EVENT_TABLE()

 };
 
 };
 

-////////////////////////////////////////////////////////////////////////
-//// INLINES
+#ifdef __VISUALC__
+    #pragma warning(default:4355)
+#endif

 
 #endif
 
 #endif

-    // __SCROLWINH_G__
+    // _WX_GENERIC_SCROLLWIN_H_
+
+// vi:sts=4:sw=4:et