include/wx/msw/scrolbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        scrollbar.h
   3 // Purpose:     wxScrollBar 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_SCROLBAR_H_
  13 #define _WX_SCROLBAR_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "scrolbar.h"
  17 #endif
  18
  19 // Scrollbar item
  20 class WXDLLEXPORT wxScrollBar: public wxScrollBarBase
  21 {
  22 public:
  23     wxScrollBar() { m_pageSize = 0; m_viewSize = 0; m_objectSize = 0; }
  24     ~wxScrollBar();
  25
  26     wxScrollBar(wxWindow *parent, wxWindowID id,
  27             const wxPoint& pos = wxDefaultPosition,
  28             const wxSize& size = wxDefaultSize,
  29             long style = wxSB_HORIZONTAL,
  30             const wxValidator& validator = wxDefaultValidator,
  31             const wxString& name = wxScrollBarNameStr)
  32     {
  33         Create(parent, id, pos, size, style, validator, name);
  34     }
  35     bool Create(wxWindow *parent, wxWindowID id,
  36             const wxPoint& pos = wxDefaultPosition,
  37             const wxSize& size = wxDefaultSize,
  38             long style = wxSB_HORIZONTAL,
  39             const wxValidator& validator = wxDefaultValidator,
  40             const wxString& name = wxScrollBarNameStr);
  41
  42     int GetThumbPosition() const ;
  43     int GetThumbSize() const { return m_pageSize; }
  44     int GetPageSize() const { return m_viewSize; }
  45     int GetRange() const { return m_objectSize; }
  46
  47     virtual void SetThumbPosition(int viewStart);
  48     virtual void SetScrollbar(int position, int thumbSize, int range, int pageSize,
  49             bool refresh = TRUE);
  50
  51 #if WXWIN_COMPATIBILITY
  52     // Backward compatibility
  53     int GetValue() const { return GetThumbPosition(); }
  54     void SetValue(int viewStart) { SetThumbPosition(viewStart); }
  55     void GetValues(int *viewStart, int *viewLength, int *objectLength,
  56             int *pageLength) const ;
  57     int GetViewLength() const { return m_viewSize; }
  58     int GetObjectLength() const { return m_objectSize; }
  59
  60     void SetPageSize(int pageLength);
  61     void SetObjectLength(int objectLength);
  62     void SetViewLength(int viewLength);
  63 #endif
  64
  65     void Command(wxCommandEvent& event);
  66     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
  67             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
  68     virtual bool MSWOnScroll(int orientation, WXWORD wParam,
  69                              WXWORD pos, WXHWND control);
  70
  71 #if WXWIN_COMPATIBILITY
  72     // Backward compatibility: generate an old-style scroll command
  73     void OnScroll(wxScrollEvent& event);
  74 #endif // WXWIN_COMPATIBILITY
  75
  76 protected:
  77     int m_pageSize;
  78     int m_viewSize;
  79     int m_objectSize;
  80
  81     DECLARE_EVENT_TABLE()
  82     DECLARE_DYNAMIC_CLASS_NO_COPY(wxScrollBar)
  83 };
  84
  85 #endif
  86     // _WX_SCROLBAR_H_