include/wx/os2/scrolbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        scrollbar.h
   3 // Purpose:     wxScrollBar class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/15/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SCROLBAR_H_
  13 #define _WX_SCROLBAR_H_
  14
  15 #include "wx/control.h"
  16
  17 WXDLLEXPORT_DATA(extern const char*) wxScrollBarNameStr;
  18
  19 // Scrollbar item
  20 class WXDLLEXPORT wxScrollBar: public wxControl
  21 {
  22   DECLARE_DYNAMIC_CLASS(wxScrollBar)
  23
  24 public:
  25   inline wxScrollBar() { m_pageSize = 0; m_viewSize = 0; m_objectSize = 0; }
  26   ~wxScrollBar();
  27
  28   inline wxScrollBar(wxWindow *parent, wxWindowID id,
  29            const wxPoint& pos = wxDefaultPosition,
  30            const wxSize& size = wxDefaultSize,
  31            long style = wxSB_HORIZONTAL,
  32 #if wxUSE_VALIDATORS
  33 #  if defined(__VISAGECPP__)
  34            const wxValidator* validator = wxDefaultValidator,
  35 #  else
  36            const wxValidator& validator = wxDefaultValidator,
  37 #  endif
  38 #endif
  39            const wxString& name = wxScrollBarNameStr)
  40   {
  41       Create(parent, id, pos, size, style, validator, name);
  42   }
  43   bool Create(wxWindow *parent, wxWindowID id,
  44            const wxPoint& pos = wxDefaultPosition,
  45            const wxSize& size = wxDefaultSize,
  46            long style = wxSB_HORIZONTAL,
  47 #if wxUSE_VALIDATORS
  48 #  if defined(__VISAGECPP__)
  49            const wxValidator* validator = wxDefaultValidator,
  50 #  else
  51            const wxValidator& validator = wxDefaultValidator,
  52 #  endif
  53 #endif
  54            const wxString& name = wxScrollBarNameStr);
  55
  56   int GetThumbPosition() const ;
  57   inline int GetThumbSize() const { return m_pageSize; }
  58   inline int GetPageSize() const { return m_viewSize; }
  59   inline int GetRange() const { return m_objectSize; }
  60
  61   virtual void SetThumbPosition(int viewStart);
  62   virtual void SetScrollbar(int position, int thumbSize, int range, int pageSize,
  63     bool refresh = TRUE);
  64
  65 #if WXWIN_COMPATIBILITY
  66   // Backward compatibility
  67   int GetValue() const { return GetThumbPosition(); }
  68   void SetValue(int viewStart) { SetThumbPosition(viewStart); }
  69   void GetValues(int *viewStart, int *viewLength, int *objectLength,
  70           int *pageLength) const ;
  71   int GetViewLength() const { return m_viewSize; }
  72   int GetObjectLength() const { return m_objectSize; }
  73
  74   void SetPageSize(int pageLength);
  75   void SetObjectLength(int objectLength);
  76   void SetViewLength(int viewLength);
  77 #endif
  78
  79   void Command(wxCommandEvent& event);
  80
  81   virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
  82           WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
  83   virtual bool OS2OnScroll(int orientation, WXWORD wParam,
  84                            WXWORD pos, WXHWND control);
  85
  86 #if WXWIN_COMPATIBILITY
  87   // Backward compatibility: generate an old-style scroll command
  88   void OnScroll(wxScrollEvent& event);
  89 #endif // WXWIN_COMPATIBILITY
  90
  91 protected:
  92   int m_pageSize;
  93   int m_viewSize;
  94   int m_objectSize;
  95
  96 DECLARE_EVENT_TABLE()
  97 };
  98
  99 #endif
 100     // _WX_SCROLBAR_H_