include/wx/gtk/scrolwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/scrolwin.h
   3 // Purpose:     wxScrolledWindow class
   4 // Author:      Robert Roebling
   5 // Modified by: Vadim Zeitlin (2005-10-10): wxScrolledWindow is now common
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GTK_SCROLLWIN_H_
  13 #define _WX_GTK_SCROLLWIN_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // wxScrolledWindow
  17 // ----------------------------------------------------------------------------
  18
  19 class WXDLLIMPEXP_CORE wxScrollHelper : public wxScrollHelperBase
  20 {
  21 public:
  22     // default ctor doesn't do anything
  23     wxScrollHelper(wxWindow *win) : wxScrollHelperBase(win) { }
  24
  25     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
  26                                int noUnitsX, int noUnitsY,
  27                                int xPos = 0, int yPos = 0,
  28                                bool noRefresh = false);
  29     virtual void AdjustScrollbars();
  30
  31 protected:
  32     // this does (each) half of AdjustScrollbars() work
  33     void DoAdjustScrollbar(GtkRange* range,
  34                            int pixelsPerLine,
  35                            int winSize,
  36                            int virtSize,
  37                            int *pos,
  38                            int *lines,
  39                            int *linesPerPage);
  40
  41     void DoAdjustHScrollbar(int winSize, int virtSize)
  42     {
  43         DoAdjustScrollbar
  44         (
  45             m_win->m_scrollBar[wxWindow::ScrollDir_Horz],
  46             m_xScrollPixelsPerLine, winSize, virtSize,
  47             &m_xScrollPosition, &m_xScrollLines, &m_xScrollLinesPerPage
  48         );
  49     }
  50
  51     void DoAdjustVScrollbar(int winSize, int virtSize)
  52     {
  53         DoAdjustScrollbar
  54         (
  55             m_win->m_scrollBar[wxWindow::ScrollDir_Vert],
  56             m_yScrollPixelsPerLine, winSize, virtSize,
  57             &m_yScrollPosition, &m_yScrollLines, &m_yScrollLinesPerPage
  58         );
  59     }
  60
  61     // and this does the same for Scroll()
  62     void DoScrollOneDir(int orient,
  63                         int pos,
  64                         int pixelsPerLine,
  65                         int *posOld);
  66
  67     // implement the base class methods
  68     virtual void DoScroll(int x, int y);
  69     virtual void DoShowScrollbars(wxScrollbarVisibility horz,
  70                                   wxScrollbarVisibility vert);
  71
  72 private:
  73     DECLARE_NO_COPY_CLASS(wxScrollHelper)
  74 };
  75
  76 #endif // _WX_GTK_SCROLLWIN_H_
  77