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