include/wx/generic/scrolwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/scrolwin.h
   3 // Purpose:     wxGenericScrolledWindow class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GENERIC_SCROLLWIN_H_
  13 #define _WX_GENERIC_SCROLLWIN_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "genscrolwin.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers and constants
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/window.h"
  24 #include "wx/panel.h"
  25
  26 extern WXDLLEXPORT_DATA(const wxChar*) wxPanelNameStr;
  27
  28 // default scrolled window style
  29 #ifndef wxScrolledWindowStyle
  30     #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
  31 #endif
  32
  33 // avoid triggering this stupid VC++ warning
  34 #ifdef __VISUALC__
  35     #pragma warning(disable:4355) // 'this' used in base member initializer list
  36 #endif
  37
  38 // ----------------------------------------------------------------------------
  39 // wxGenericScrolledWindow
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLEXPORT wxGenericScrolledWindow : public wxPanel,
  43                                             public wxScrollHelper
  44 {
  45 public:
  46     wxGenericScrolledWindow() : wxScrollHelper(this) { }
  47     wxGenericScrolledWindow(wxWindow *parent,
  48                      wxWindowID winid = wxID_ANY,
  49                      const wxPoint& pos = wxDefaultPosition,
  50                      const wxSize& size = wxDefaultSize,
  51                      long style = wxScrolledWindowStyle,
  52                      const wxString& name = wxPanelNameStr)
  53         : wxScrollHelper(this)
  54     {
  55         Create(parent, winid, pos, size, style, name);
  56     }
  57
  58     virtual ~wxGenericScrolledWindow();
  59
  60     bool Create(wxWindow *parent,
  61                 wxWindowID winid,
  62                 const wxPoint& pos = wxDefaultPosition,
  63                 const wxSize& size = wxDefaultSize,
  64                 long style = wxScrolledWindowStyle,
  65                 const wxString& name = wxPanelNameStr);
  66
  67     virtual void PrepareDC(wxDC& dc) { DoPrepareDC(dc); }
  68
  69     // lay out the window and its children
  70     virtual bool Layout();
  71
  72     virtual void DoSetVirtualSize(int x, int y);
  73
  74     // wxWindow's GetBestVirtualSize returns the actual window size,
  75     // whereas we want to return the virtual size
  76     virtual wxSize GetBestVirtualSize() const;
  77
  78     // Return the size best suited for the current window
  79     // (this isn't a virtual size, this is a sensible size for the window)
  80     virtual wxSize DoGetBestSize() const;
  81
  82 #ifdef __WXMAC__
  83     virtual bool MacClipChildren() const { return true ; }
  84 #endif
  85 protected:
  86     // this is needed for wxEVT_PAINT processing hack described in
  87     // wxScrollHelperEvtHandler::ProcessEvent()
  88     void OnPaint(wxPaintEvent& event);
  89
  90     // we need to return a special WM_GETDLGCODE value to process just the
  91     // arrows but let the other navigation characters through
  92 #ifdef __WXMSW__
  93     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  94 #endif // __WXMSW__
  95
  96 private:
  97     DECLARE_DYNAMIC_CLASS_NO_COPY(wxGenericScrolledWindow)
  98     DECLARE_EVENT_TABLE()
  99 };
 100
 101 #ifdef __VISUALC__
 102     #pragma warning(default:4355)
 103 #endif
 104
 105 #endif
 106     // _WX_GENERIC_SCROLLWIN_H_
 107