*/
+#if !defined USE_CAIRO_IMAGE_SURFACE && !defined NDEBUG
+#define OPTIONAL_CAIRO_IMAGE_SURFACE
+#endif
+
/** @file canvas/canvas.cc
* @brief Implementation of the main canvas classes.
*/
#include "pbd/stacktrace.h"
#include "canvas/canvas.h"
+#include "canvas/colors.h"
#include "canvas/debug.h"
#include "canvas/line.h"
#include "canvas/scroll_group.h"
+#include "canvas/utils.h"
using namespace std;
using namespace ArdourCanvas;
+uint32_t Canvas::tooltip_timeout_msecs = 750;
+
/** Construct a new Canvas */
Canvas::Canvas ()
: _root (this)
+ , _bg_color (rgba_to_color (0, 1.0, 0.0, 1.0))
{
set_epoch ();
}
_root.render (*draw, context);
-#ifdef CANVAS_DEBUG
+#if defined CANVAS_DEBUG && !PLATFORM_WINDOWS
if (getenv ("CANVAS_HARLEQUIN_DEBUGGING")) {
// This transparently colors the rect being rendered, after it has been drawn.
double r = (random() % 65536) /65536.0;
Duple
Canvas::window_to_canvas (Duple const & d) const
{
- /* Find the scroll group that covers d (a window coordinate). Scroll groups are only allowed
- * as children of the root group, so we just scan its first level
- * children and see what we can find.
- */
-
- std::list<Item*> const& root_children (_root.items());
+ ScrollGroup* best_group = 0;
ScrollGroup* sg = 0;
/* if the coordinates are negative, clamp to zero and find the item
in_window.y = 0;
}
- for (std::list<Item*>::const_iterator i = root_children.begin(); i != root_children.end(); ++i) {
- if (((sg = dynamic_cast<ScrollGroup*>(*i)) != 0) && sg->covers_window (in_window)) {
- break;
+ for (list<ScrollGroup*>::const_iterator s = scrollers.begin(); s != scrollers.end(); ++s) {
+
+ if ((*s)->covers_window (in_window)) {
+ sg = *s;
+
+ /* XXX January 22nd 2015: leaving this in place for now
+ * but I think it fixes a bug that really should be
+ * fixed in a different way (and will be) by my next
+ * commit. But it may still be relevant.
+ */
+
+ /* If scroll groups overlap, choose the one with the highest sensitivity,
+ that is, choose an HV scroll group over an H or V
+ only group.
+ */
+ if (!best_group || sg->sensitivity() > best_group->sensitivity()) {
+ best_group = sg;
+ if (sg->sensitivity() == (ScrollGroup::ScrollsVertically | ScrollGroup::ScrollsHorizontally)) {
+ /* Can't do any better than this. */
+ break;
+ }
+ }
}
}
- if (sg) {
- return d.translate (sg->scroll_offset());
+ if (best_group) {
+ return d.translate (best_group->scroll_offset());
}
return d;
break;
}
}
-
if (sg) {
wd = d.translate (-sg->scroll_offset());
request_redraw (item->item_to_window (area));
}
+void
+Canvas::set_tooltip_timeout (uint32_t msecs)
+{
+ tooltip_timeout_msecs = msecs;
+}
+
+void
+Canvas::set_background_color (Color c)
+{
+ _bg_color = c;
+
+ boost::optional<Rect> r = _root.bounding_box();
+
+ if (r) {
+ request_redraw (_root.item_to_window (r.get()));
+ }
+}
+
void
GtkCanvas::re_enter ()
{
, _new_current_item (0)
, _grabbed_item (0)
, _focused_item (0)
+ , _single_exposure (1)
, current_tooltip_item (0)
, tooltip_window (0)
{
/* these are the events we want to know about */
add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK |
- Gdk::SCROLL_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);
+ Gdk::SCROLL_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK |
+ Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);
}
void
leave_event.type = GDK_LEAVE_NOTIFY;
Item* i;
- GdkNotifyType enter_detail;
- GdkNotifyType leave_detail;
+ GdkNotifyType enter_detail = GDK_NOTIFY_UNKNOWN;
+ GdkNotifyType leave_detail = GDK_NOTIFY_UNKNOWN;
vector<Item*> items_to_leave_virtual;
vector<Item*> items_to_enter_virtual;
if (_new_current_item && !_new_current_item->ignore_events()) {
enter_event.detail = enter_detail;
DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("ENTER %1/%2\n", _new_current_item->whatami(), _new_current_item->name));
+ start_tooltip_timeout (_new_current_item);
_new_current_item->Event ((GdkEvent*)&enter_event);
}
- start_tooltip_timeout (_new_current_item);
_current_item = _new_current_item;
-
}
}
+void
+GtkCanvas::on_size_allocate (Gtk::Allocation& a)
+{
+ EventBox::on_size_allocate (a);
+#ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
+ if (getenv("ARDOUR_IMAGE_SURFACE")) {
+#endif
+#if defined USE_CAIRO_IMAGE_SURFACE || defined OPTIONAL_CAIRO_IMAGE_SURFACE
+ /* allocate an image surface as large as the canvas itself */
+
+ canvas_image.clear ();
+ canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, a.get_width(), a.get_height());
+#endif
+#ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
+ }
+#endif
+}
+
/** Handler for GDK expose events.
* @param ev Event.
* @return true if the event was handled.
bool
GtkCanvas::on_expose_event (GdkEventExpose* ev)
{
- Cairo::RefPtr<Cairo::Context> cairo_context = get_window()->create_cairo_context ();
- render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), cairo_context);
- return true;
-}
+#ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
+ Cairo::RefPtr<Cairo::Context> draw_context;
+ Cairo::RefPtr<Cairo::Context> window_context;
+ if (getenv("ARDOUR_IMAGE_SURFACE")) {
+ if (!canvas_image) {
+ canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, get_width(), get_height());
+ }
+ draw_context = Cairo::Context::create (canvas_image);
+ window_context = get_window()->create_cairo_context ();
+ } else {
+ draw_context = get_window()->create_cairo_context ();
+ }
+#elif defined USE_CAIRO_IMAGE_SURFACE
+ if (!canvas_image) {
+ canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, get_width(), get_height());
+ }
+ Cairo::RefPtr<Cairo::Context> draw_context = Cairo::Context::create (canvas_image);
+ Cairo::RefPtr<Cairo::Context> window_context = get_window()->create_cairo_context ();
+#else
+ Cairo::RefPtr<Cairo::Context> draw_context = get_window()->create_cairo_context ();
+#endif
-/** @return Our Cairo context, or 0 if we don't have one */
-Cairo::RefPtr<Cairo::Context>
-GtkCanvas::context ()
-{
- Glib::RefPtr<Gdk::Window> w = get_window ();
- if (!w) {
- return Cairo::RefPtr<Cairo::Context> ();
+ /* draw background color */
+
+ draw_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height);
+ draw_context->clip_preserve ();
+ set_source_rgba (draw_context, _bg_color);
+ draw_context->fill ();
+
+ /* render canvas */
+ if ( _single_exposure ) {
+
+ render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), draw_context);
+
+ } else {
+ GdkRectangle* rects;
+ gint nrects;
+
+ gdk_region_get_rectangles (ev->region, &rects, &nrects);
+ for (gint n = 0; n < nrects; ++n) {
+ draw_context->set_identity_matrix(); //reset the cairo matrix, just in case someone left it transformed after drawing ( cough )
+ render (Rect (rects[n].x, rects[n].y, rects[n].x + rects[n].width, rects[n].y + rects[n].height), draw_context);
+ }
+ g_free (rects);
+ }
+
+#ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
+ if (getenv("ARDOUR_IMAGE_SURFACE")) {
+#endif
+#if defined USE_CAIRO_IMAGE_SURFACE || defined OPTIONAL_CAIRO_IMAGE_SURFACE
+ /* now blit our private surface back to the GDK one */
+
+ window_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height);
+ window_context->clip ();
+ window_context->set_source (canvas_image, 0, 0);
+ window_context->set_operator (Cairo::OPERATOR_SOURCE);
+ window_context->paint ();
+#endif
+#ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
}
+#endif
- return w->create_cairo_context ();
+ return true;
}
/** Handler for GDK scroll events.
return deliver_event (reinterpret_cast<GdkEvent*>(©));
}
+/** Handler for GDK key press events.
+ * @param ev Event.
+ * @return true if the event was handled.
+ */
+bool
+GtkCanvas::on_key_press_event (GdkEventKey* ev)
+{
+ DEBUG_TRACE (PBD::DEBUG::CanvasEvents, "canvas key press\n");
+ return deliver_event (reinterpret_cast<GdkEvent*>(ev));
+}
+
+/** Handler for GDK key release events.
+ * @param ev Event.
+ * @return true if the event was handled.
+ */
+bool
+GtkCanvas::on_key_release_event (GdkEventKey* ev)
+{
+ DEBUG_TRACE (PBD::DEBUG::CanvasEvents, "canvas key release\n");
+ return deliver_event (reinterpret_cast<GdkEvent*>(ev));
+}
+
/** Handler for GDK button press events.
* @param ev Event.
* @return true if the event was handled.
bool
GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev)
{
+ switch (ev->detail) {
+ case GDK_NOTIFY_ANCESTOR:
+ case GDK_NOTIFY_UNKNOWN:
+ case GDK_NOTIFY_VIRTUAL:
+ case GDK_NOTIFY_NONLINEAR:
+ case GDK_NOTIFY_NONLINEAR_VIRTUAL:
+ /* leaving window, cancel any tooltips */
+ stop_tooltip_timeout ();
+ hide_tooltip ();
+ break;
+ default:
+ /* we don't care about any other kind
+ of leave event (notably GDK_NOTIFY_INFERIOR)
+ */
+ break;
+ }
_new_current_item = 0;
deliver_enter_leave (Duple (ev->x, ev->y), ev->state);
return true;
little while.
*/
- std::cerr << "wait for idle now that we're in " << item->name << std::endl;
-
Glib::signal_idle().connect (sigc::mem_fun (*this, &GtkCanvas::really_start_tooltip_timeout));
}
}
* wait 1 second and if the timeout isn't cancelled, show the tooltip.
*/
- std::cerr << "gone idle\n";
-
-
if (current_tooltip_item) {
- std::cerr << "have an item " << current_tooltip_item->name << " now wait 1second\n";
- _current_timeout_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &GtkCanvas::show_tooltip), 1000);
+ tooltip_timeout_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &GtkCanvas::show_tooltip), tooltip_timeout_msecs);
}
return false; /* this is called from an idle callback, don't call it again */
void
GtkCanvas::stop_tooltip_timeout ()
{
- if (current_tooltip_item) {
- std::cerr << "Stop timeout for " << current_tooltip_item->name << "\n";
- }
current_tooltip_item = 0;
- _current_timeout_connection.disconnect ();
+ tooltip_timeout_connection.disconnect ();
}
bool
GtkCanvas::show_tooltip ()
{
- if (current_tooltip_item) {
- std::cerr << "Would show a tooltip for " << current_tooltip_item->name << '\n';
- } else {
- std::cerr << "tooltip timeout expired, but no item\n";
+ Rect tooltip_item_bbox;
+
+ if (!current_tooltip_item || current_tooltip_item->tooltip().empty() || !current_tooltip_item->bounding_box()) {
+ return false;
+ }
+
+ if (!tooltip_window) {
+ tooltip_window = new Gtk::Window (Gtk::WINDOW_POPUP);
+ tooltip_label = manage (new Gtk::Label);
+ tooltip_label->show ();
+ tooltip_window->add (*tooltip_label);
+ tooltip_window->set_border_width (1);
+ tooltip_window->set_name ("tooltip");
}
+ tooltip_label->set_text (current_tooltip_item->tooltip());
+
+ /* figure out where to position the tooltip */
+
+ Gtk::Widget* toplevel = get_toplevel();
+ assert (toplevel);
+ int pointer_x, pointer_y;
+ Gdk::ModifierType mask;
+
+ (void) toplevel->get_window()->get_pointer (pointer_x, pointer_y, mask);
+
+ Duple tooltip_window_origin (pointer_x, pointer_y);
+
+ /* convert to root window coordinates */
+
+ int win_x, win_y;
+ dynamic_cast<Gtk::Window*>(toplevel)->get_position (win_x, win_y);
+
+ tooltip_window_origin = tooltip_window_origin.translate (Duple (win_x, win_y));
+
+ /* we don't want the pointer to be inside the window when it is
+ * displayed, because then we generate a leave/enter event pair when
+ * the window is displayed then hidden - the enter event will
+ * trigger a new tooltip timeout.
+ *
+ * So move the window right of the pointer position by just a enough
+ * to get it away from the pointer.
+ */
+
+ tooltip_window_origin.x += 30;
+ tooltip_window_origin.y += 45;
+
+ /* move the tooltip window into position */
+
+ tooltip_window->move (tooltip_window_origin.x, tooltip_window_origin.y);
+
+ /* ready to show */
+
+ tooltip_window->present ();
+
/* called from a timeout handler, don't call it again */
+
return false;
}
void
GtkCanvas::hide_tooltip ()
{
+ /* hide it if its there */
+
if (tooltip_window) {
tooltip_window->hide ();
+
+ // Delete the tooltip window so it'll get re-created
+ // (i.e. properly re-sized) on the next usage.
+ delete tooltip_window;
+ tooltip_window = NULL;
}
}