libs/canvas/canvas/canvas.h

   1 /*
   2     Copyright (C) 2011-2013 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 /** @file  canvas/canvas.h
  21  *  @brief Declaration of the main canvas classes.
  22  */
  23
  24 #ifndef __CANVAS_CANVAS_H__
  25 #define __CANVAS_CANVAS_H__
  26
  27 #include <gdkmm/window.h>
  28 #include <gtkmm/eventbox.h>
  29 #include <gtkmm/alignment.h>
  30 #include <cairomm/surface.h>
  31 #include <cairomm/context.h>
  32 #include "pbd/signals.h"
  33 #include "canvas/root_group.h"
  34
  35 namespace ArdourCanvas
  36 {
  37
  38 class Rect;
  39 class Group;
  40
  41 /** The base class for our different types of canvas.
  42  *
  43  *  A canvas is an area which holds a collection of canvas items, which in
  44  *  turn represent shapes, text, etc.
  45  *
  46  *  The canvas has an arbitrarily large area, and is addressed in coordinates
  47  *  of screen pixels, with an origin of (0, 0) at the top left.  x increases
  48  *  rightwards and y increases downwards.
  49  */
  50
  51 class Canvas
  52 {
  53 public:
  54         Canvas ();
  55         virtual ~Canvas () {}
  56
  57         /** called to request a redraw of an area of the canvas */
  58         virtual void request_redraw (Rect const &) = 0;
  59         /** called to ask the canvas to request a particular size from its host */
  60         virtual void request_size (Duple) = 0;
  61         /** called to ask the canvas' host to `grab' an item */
  62         virtual void grab (Item *) = 0;
  63         /** called to ask the canvas' host to `ungrab' any grabbed item */
  64         virtual void ungrab () = 0;
  65
  66         void render (Rect const &, Cairo::RefPtr<Cairo::Context> const &) const;
  67
  68         /** @return root group */
  69         Group* root () {
  70                 return &_root;
  71         }
  72
  73         /** Called when an item is being destroyed */
  74         virtual void item_going_away (Item *, boost::optional<Rect>) {}
  75         void item_shown_or_hidden (Item *);
  76         void item_visual_property_changed (Item*);
  77         void item_changed (Item *, boost::optional<Rect>);
  78         void item_moved (Item *, boost::optional<Rect>);
  79
  80         virtual Cairo::RefPtr<Cairo::Context> context () = 0;
  81
  82         std::list<Rect> const & renders () const {
  83                 return _renders;
  84         }
  85
  86         void set_log_renders (bool log) {
  87                 _log_renders = log;
  88         }
  89
  90         Rect canvas_to_window (Rect const&) const;
  91         Rect window_to_canvas (Rect const&) const;
  92         Duple canvas_to_window (Duple const&) const;
  93         Duple window_to_canvas (Duple const&) const;
  94
  95         void canvas_to_window (Coord cx, Coord cy, Coord& wx, Coord& wy) {
  96                 Duple d = canvas_to_window (Duple (cx, cy));
  97                 wx = d.x;
  98                 wy = d.y;
  99         }
 100
 101         void window_to_canvas (Coord wx, Coord wy, Coord& cx, Coord& cy) {
 102                 Duple d = window_to_canvas (Duple (wx, wy));
 103                 cx = d.x;
 104                 cy = d.y;
 105         }
 106
 107         void scroll_to (Coord x, Coord y);
 108         virtual Rect visible_area () const = 0;
 109
 110         std::string indent() const;
 111         std::string render_indent() const;
 112         void dump (std::ostream&) const;
 113
 114 protected:
 115         void queue_draw_item_area (Item *, Rect);
 116
 117         /** our root group */
 118         RootGroup _root;
 119
 120         mutable std::list<Rect> _renders;
 121         bool _log_renders;
 122
 123         Coord _scroll_offset_x;
 124         Coord _scroll_offset_y;
 125 };
 126
 127 /** A canvas which renders onto a GTK EventBox */
 128 class GtkCanvas : public Canvas, public Gtk::EventBox
 129 {
 130 public:
 131         GtkCanvas ();
 132
 133         void request_redraw (Rect const &);
 134         void request_size (Duple);
 135         void grab (Item *);
 136         void ungrab ();
 137
 138         Cairo::RefPtr<Cairo::Context> context ();
 139
 140         Rect visible_area () const;
 141
 142 protected:
 143         bool on_expose_event (GdkEventExpose *);
 144         bool on_button_press_event (GdkEventButton *);
 145         bool on_button_release_event (GdkEventButton* event);
 146         bool on_motion_notify_event (GdkEventMotion *);
 147
 148         bool button_handler (GdkEventButton *);
 149         bool motion_notify_handler (GdkEventMotion *);
 150         bool deliver_event (Duple, GdkEvent *);
 151
 152 private:
 153         void item_going_away (Item *, boost::optional<Rect>);
 154         bool send_leave_event (Item const *, double, double) const;
 155
 156
 157         /** the item that the mouse is currently over, or 0 */
 158         Item const * _current_item;
 159         /** the item that is currently grabbed, or 0 */
 160         Item const * _grabbed_item;
 161 };
 162
 163 /** A GTK::Alignment with a GtkCanvas inside it plus some Gtk::Adjustments for
 164  *   scrolling.
 165  *
 166  * This provides a GtkCanvas that can be scrolled. It does NOT implement the
 167  * Gtk::Scrollable interface.
 168  */
 169 class GtkCanvasViewport : public Gtk::Alignment
 170 {
 171 public:
 172         GtkCanvasViewport (Gtk::Adjustment &, Gtk::Adjustment &);
 173
 174         /** @return our GtkCanvas */
 175         GtkCanvas* canvas () {
 176                 return &_canvas;
 177         }
 178
 179 protected:
 180         void on_size_request (Gtk::Requisition *);
 181
 182 private:
 183         /** our GtkCanvas */
 184         GtkCanvas _canvas;
 185         Gtk::Adjustment& hadjustment;
 186         Gtk::Adjustment& vadjustment;
 187
 188         void scrolled ();
 189 };
 190
 191 }
 192
 193 std::ostream& operator<< (std::ostream&, const ArdourCanvas::Canvas&);
 194
 195 #endif