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