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"
46 namespace ArdourCanvas
53 /** The base class for our different types of canvas.
55 * A canvas is an area which holds a collection of canvas items, which in
56 * turn represent shapes, text, etc.
58 * The canvas has an arbitrarily large area, and is addressed in coordinates
59 * of screen pixels, with an origin of (0, 0) at the top left. x increases
60 * rightwards and y increases downwards.
63 class LIBCANVAS_API Canvas
69 /** called to request a redraw of an area of the canvas in WINDOW coordinates */
70 virtual void request_redraw (Rect const &) = 0;
71 /** called to ask the canvas to request a particular size from its host */
72 virtual void request_size (Duple) = 0;
73 /** called to ask the canvas' host to `grab' an item */
74 virtual void grab (Item *) = 0;
75 /** called to ask the canvas' host to `ungrab' any grabbed item */
76 virtual void ungrab () = 0;
78 /** called to ask the canvas' host to keyboard focus on an item */
79 virtual void focus (Item *) = 0;
80 /** called to ask the canvas' host to drop keyboard focus on an item */
81 virtual void unfocus (Item*) = 0;
83 void render (Rect const &, Cairo::RefPtr<Cairo::Context> const &) const;
85 /** @return root group */
90 /** Called when an item is being destroyed */
91 virtual void item_going_away (Item *, boost::optional<Rect>) {}
92 void item_shown_or_hidden (Item *);
93 void item_visual_property_changed (Item*);
94 void item_changed (Item *, boost::optional<Rect>);
95 void item_moved (Item *, boost::optional<Rect>);
97 virtual Cairo::RefPtr<Cairo::Context> context () = 0;
99 Duple canvas_to_window (Duple const&, bool rounded = true) const;
100 Duple window_to_canvas (Duple const&) const;
102 void canvas_to_window (Coord cx, Coord cy, Coord& wx, Coord& wy) {
103 Duple d = canvas_to_window (Duple (cx, cy));
108 void window_to_canvas (Coord wx, Coord wy, Coord& cx, Coord& cy) {
109 Duple d = window_to_canvas (Duple (wx, wy));
114 void scroll_to (Coord x, Coord y);
115 void add_scroller (ScrollGroup& i);
117 virtual Rect visible_area () const = 0;
118 virtual Coord width () const = 0;
119 virtual Coord height () const = 0;
121 /** Store the coordinates of the mouse pointer in window coordinates in
122 @param winpos. Return true if the position was within the window,
125 virtual bool get_mouse_position (Duple& winpos) const = 0;
127 /** Signal to be used by items that need to track the mouse position
130 sigc::signal<void,Duple const&> MouseMotion;
132 /** Ensures that the position given by @param winpos (in window
133 coordinates) is within the current window area, possibly reduced by
136 Duple clamp_to_window (Duple const& winpos, Duple border = Duple());
140 std::string indent() const;
141 std::string render_indent() const;
142 void dump (std::ostream&) const;
144 /** Ask the canvas to pick the current item again, and generate
145 an enter event for it.
147 virtual void re_enter () = 0;
149 virtual void start_tooltip_timeout (Item*) {}
150 virtual void stop_tooltip_timeout () {}
152 /** Set the timeout used to display tooltips, in milliseconds
154 static void set_tooltip_timeout (uint32_t msecs);
157 void queue_draw_item_area (Item *, Rect);
162 static uint32_t tooltip_timeout_msecs;
164 virtual void pick_current_item (int state) = 0;
165 virtual void pick_current_item (Duple const &, int state) = 0;
167 std::list<ScrollGroup*> scrollers;
170 /** A canvas which renders onto a GTK EventBox */
171 class LIBCANVAS_API GtkCanvas : public Canvas, public Gtk::EventBox
176 void request_redraw (Rect const &);
177 void request_size (Duple);
181 void unfocus (Item*);
183 Cairo::RefPtr<Cairo::Context> context ();
185 Rect visible_area () const;
187 Coord height() const;
189 bool get_mouse_position (Duple& winpos) const;
193 void start_tooltip_timeout (Item*);
194 void stop_tooltip_timeout ();
197 bool on_scroll_event (GdkEventScroll *);
198 bool on_expose_event (GdkEventExpose *);
199 bool on_button_press_event (GdkEventButton *);
200 bool on_button_release_event (GdkEventButton* event);
201 bool on_motion_notify_event (GdkEventMotion *);
202 bool on_enter_notify_event (GdkEventCrossing*);
203 bool on_leave_notify_event (GdkEventCrossing*);
205 bool button_handler (GdkEventButton *);
206 bool motion_notify_handler (GdkEventMotion *);
207 bool deliver_event (GdkEvent *);
208 void deliver_enter_leave (Duple const & point, int state);
210 void pick_current_item (int state);
211 void pick_current_item (Duple const &, int state);
214 void item_going_away (Item *, boost::optional<Rect>);
215 bool send_leave_event (Item const *, double, double) const;
217 /** Item currently chosen for event delivery based on pointer position */
218 Item * _current_item;
219 /** Item pending as _current_item */
220 Item * _new_current_item;
221 /** the item that is currently grabbed, or 0 */
222 Item * _grabbed_item;
223 /** the item that currently has key focus or 0 */
224 Item * _focused_item;
226 sigc::connection tooltip_timeout_connection;
227 Item* current_tooltip_item;
228 Gtk::Window* tooltip_window;
229 Gtk::Label* tooltip_label;
230 bool show_tooltip ();
231 void hide_tooltip ();
232 bool really_start_tooltip_timeout ();
235 /** A GTK::Alignment with a GtkCanvas inside it plus some Gtk::Adjustments for
238 * This provides a GtkCanvas that can be scrolled. It does NOT implement the
239 * Gtk::Scrollable interface.
241 class LIBCANVAS_API GtkCanvasViewport : public Gtk::Alignment
244 GtkCanvasViewport (Gtk::Adjustment &, Gtk::Adjustment &);
246 /** @return our GtkCanvas */
247 GtkCanvas* canvas () {
252 void on_size_request (Gtk::Requisition *);
257 Gtk::Adjustment& hadjustment;
258 Gtk::Adjustment& vadjustment;
265 std::ostream& operator<< (std::ostream&, const ArdourCanvas::Canvas&);