libs/canvas/canvas/scroll_group.h

   1 /*
   2     Copyright (C) 2014 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __CANVAS_SCROLL_GROUP_H__
  20 #define __CANVAS_SCROLL_GROUP_H__
  21
  22 #include "canvas/container.h"
  23
  24 namespace ArdourCanvas {
  25
  26 /** A ScrollGroup has no contents of its own, but renders
  27  *  its children in a way that reflects the most recent
  28  *  call to its scroll_to() method.
  29  */
  30 class LIBCANVAS_API ScrollGroup : public Container
  31 {
  32   public:
  33         enum ScrollSensitivity {
  34                 ScrollsVertically = 0x1,
  35                 ScrollsHorizontally = 0x2
  36         };
  37
  38         ScrollGroup (Canvas*, ScrollSensitivity);
  39         ScrollGroup (Item*, ScrollSensitivity);
  40
  41         void scroll_to (Duple const& d);
  42         Duple scroll_offset() const { return _scroll_offset; }
  43
  44         bool covers_canvas (Duple const& d) const;
  45         bool covers_window (Duple const& d) const;
  46
  47         void render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const;
  48
  49         ScrollSensitivity sensitivity() const { return _scroll_sensitivity; }
  50
  51   private:
  52         ScrollSensitivity _scroll_sensitivity;
  53         Duple             _scroll_offset;
  54 };
  55
  56 }
  57
  58 #endif