2 Copyright (C) 2011-2013 Paul Davis
3 Author: Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file canvas/canvas.h
21 * @brief Declaration of the main canvas classes.
24 #ifndef __CANVAS_CANVAS_H__
25 #define __CANVAS_CANVAS_H__
29 #include <gdkmm/window.h>
30 #include <gtkmm/eventbox.h>
31 #include <gtkmm/alignment.h>
32 #include <cairomm/surface.h>
33 #include <cairomm/context.h>
35 #include "pbd/signals.h"
37 #include "canvas/visibility.h"
39 #include "canvas/root_group.h"
41 namespace ArdourCanvas
48 /** The base class for our different types of canvas.
50 * A canvas is an area which holds a collection of canvas items, which in
51 * turn represent shapes, text, etc.
53 * The canvas has an arbitrarily large area, and is addressed in coordinates
54 * of screen pixels, with an origin of (0, 0) at the top left. x increases
55 * rightwards and y increases downwards.
58 class LIBCANVAS_API Canvas
64 /** called to request a redraw of an area of the canvas in WINDOW coordinates */
65 virtual void request_redraw (Rect const &) = 0;
66 /** called to ask the canvas to request a particular size from its host */
67 virtual void request_size (Duple) = 0;
68 /** called to ask the canvas' host to `grab' an item */
69 virtual void grab (Item *) = 0;
70 /** called to ask the canvas' host to `ungrab' any grabbed item */
71 virtual void ungrab () = 0;
73 /** called to ask the canvas' host to keyboard focus on an item */
74 virtual void focus (Item *) = 0;
75 /** called to ask the canvas' host to drop keyboard focus on an item */
76 virtual void unfocus (Item*) = 0;
78 void render (Rect const &, Cairo::RefPtr<Cairo::Context> const &) const;
80 /** @return root group */
85 /** Called when an item is being destroyed */
86 virtual void item_going_away (Item *, boost::optional<Rect>) {}
87 void item_shown_or_hidden (Item *);
88 void item_visual_property_changed (Item*);
89 void item_changed (Item *, boost::optional<Rect>);
90 void item_moved (Item *, boost::optional<Rect>);
92 virtual Cairo::RefPtr<Cairo::Context> context () = 0;
94 Duple canvas_to_window (Duple const&, bool rounded = true) const;
95 Duple window_to_canvas (Duple const&) const;
97 void canvas_to_window (Coord cx, Coord cy, Coord& wx, Coord& wy) {
98 Duple d = canvas_to_window (Duple (cx, cy));
103 void window_to_canvas (Coord wx, Coord wy, Coord& cx, Coord& cy) {
104 Duple d = window_to_canvas (Duple (wx, wy));
109 void scroll_to (Coord x, Coord y);
110 void add_scroller (ScrollGroup& i);
112 virtual Rect visible_area () const = 0;
113 virtual Coord width () const = 0;
114 virtual Coord height () const = 0;
118 std::string indent() const;
119 std::string render_indent() const;
120 void dump (std::ostream&) const;
123 void queue_draw_item_area (Item *, Rect);
125 /** our root group */
128 virtual void pick_current_item (int state) = 0;
129 virtual void pick_current_item (Duple const &, int state) = 0;
131 std::list<ScrollGroup*> scrollers;
134 /** A canvas which renders onto a GTK EventBox */
135 class LIBCANVAS_API GtkCanvas : public Canvas, public Gtk::EventBox
140 void request_redraw (Rect const &);
141 void request_size (Duple);
145 void unfocus (Item*);
147 Cairo::RefPtr<Cairo::Context> context ();
149 Rect visible_area () const;
151 Coord height() const;
154 bool on_expose_event (GdkEventExpose *);
155 bool on_button_press_event (GdkEventButton *);
156 bool on_button_release_event (GdkEventButton* event);
157 bool on_motion_notify_event (GdkEventMotion *);
158 bool on_enter_notify_event (GdkEventCrossing*);
159 bool on_leave_notify_event (GdkEventCrossing*);
161 bool button_handler (GdkEventButton *);
162 bool motion_notify_handler (GdkEventMotion *);
163 bool deliver_event (GdkEvent *);
164 void deliver_enter_leave (Duple const & point, int state);
166 void pick_current_item (int state);
167 void pick_current_item (Duple const &, int state);
170 void item_going_away (Item *, boost::optional<Rect>);
171 bool send_leave_event (Item const *, double, double) const;
173 /** Item currently chosen for event delivery based on pointer position */
174 Item * _current_item;
175 /** Item pending as _current_item */
176 Item * _new_current_item;
177 /** the item that is currently grabbed, or 0 */
178 Item * _grabbed_item;
179 /** the item that currently has key focus or 0 */
180 Item * _focused_item;
183 /** A GTK::Alignment with a GtkCanvas inside it plus some Gtk::Adjustments for
186 * This provides a GtkCanvas that can be scrolled. It does NOT implement the
187 * Gtk::Scrollable interface.
189 class LIBCANVAS_API GtkCanvasViewport : public Gtk::Alignment
192 GtkCanvasViewport (Gtk::Adjustment &, Gtk::Adjustment &);
194 /** @return our GtkCanvas */
195 GtkCanvas* canvas () {
200 void on_size_request (Gtk::Requisition *);
205 Gtk::Adjustment& hadjustment;
206 Gtk::Adjustment& vadjustment;
213 std::ostream& operator<< (std::ostream&, const ArdourCanvas::Canvas&);