X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fcanvas%2Fcanvas.cc;h=9d1d9f3ad9df7c5965b85c827ae4f6fdbe25b79d;hb=b04414d170bff6d3d7cbfdcedd2dcab917fa3e18;hp=7c0fa28bf07e0bb2d955e2af58b9daab0d18330b;hpb=1676789907b95aa8d5bf6cc2ce62aa66a80b9aae;p=ardour.git diff --git a/libs/canvas/canvas.cc b/libs/canvas/canvas.cc index 7c0fa28bf0..9d1d9f3ad9 100644 --- a/libs/canvas/canvas.cc +++ b/libs/canvas/canvas.cc @@ -26,21 +26,24 @@ #include #include #include +#include #include "pbd/compose.h" #include "pbd/stacktrace.h" #include "canvas/canvas.h" #include "canvas/debug.h" +#include "canvas/line.h" +#include "canvas/scroll_group.h" using namespace std; using namespace ArdourCanvas; +uint32_t Canvas::tooltip_timeout_msecs = 750; + /** Construct a new Canvas */ Canvas::Canvas () : _root (this) - , _scroll_offset_x (0) - , _scroll_offset_y (0) { set_epoch (); } @@ -48,20 +51,37 @@ Canvas::Canvas () void Canvas::scroll_to (Coord x, Coord y) { - _scroll_offset_x = x; - _scroll_offset_y = y; + /* We do things this way because we do not want to recurse through + the canvas for every scroll. In the presence of large MIDI + tracks this means traversing item lists that include + thousands of items (notes). + + This design limits us to moving only those items (groups, typically) + that should move in certain ways as we scroll. In other terms, it + becomes O(1) rather than O(N). + */ + + for (list::iterator i = scrollers.begin(); i != scrollers.end(); ++i) { + (*i)->scroll_to (Duple (x, y)); + } - enter_leave_items (0); // no current mouse position + pick_current_item (0); // no current mouse position +} + +void +Canvas::add_scroller (ScrollGroup& i) +{ + scrollers.push_back (&i); } void Canvas::zoomed () { - enter_leave_items (0); // no current mouse position + pick_current_item (0); // no current mouse position } /** Render an area of the canvas. - * @param area Area in canvas coordinates. + * @param area Area in window coordinates. * @param context Cairo context to render to. */ void @@ -69,7 +89,7 @@ Canvas::render (Rect const & area, Cairo::RefPtr const & context { #ifdef CANVAS_DEBUG if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) { - cerr << "RENDER: " << area << endl; + cerr << this << " RENDER: " << area << endl; //cerr << "CANVAS @ " << this << endl; //dump (cerr); //cerr << "-------------------------\n"; @@ -86,16 +106,24 @@ Canvas::render (Rect const & area, Cairo::RefPtr const & context boost::optional draw = root_bbox->intersection (area); if (draw) { - - // context->rectangle (area.x0, area.y0, area.x1 - area.x0, area.y1 - area.y0); - // context->set_source_rgba (1.0, 0, 0, 1.0); - // context->fill (); - + /* there's a common area between the root and the requested area, so render it. */ _root.render (*draw, context); + +#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; + double g = (random() % 65536) /65536.0; + double b = (random() % 65536) /65536.0; + context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0); + context->set_source_rgba (r, g, b, 0.25); + context->fill (); + } +#endif } } @@ -146,7 +174,9 @@ Canvas::item_shown_or_hidden (Item* item) { boost::optional bbox = item->bounding_box (); if (bbox) { - queue_draw_item_area (item, bbox.get ()); + if (item->item_to_window (*bbox).intersection (visible_area ())) { + queue_draw_item_area (item, bbox.get ()); + } } } @@ -159,7 +189,9 @@ Canvas::item_visual_property_changed (Item* item) { boost::optional bbox = item->bounding_box (); if (bbox) { - queue_draw_item_area (item, bbox.get ()); + if (item->item_to_window (*bbox).intersection (visible_area ())) { + queue_draw_item_area (item, bbox.get ()); + } } } @@ -171,49 +203,98 @@ Canvas::item_visual_property_changed (Item* item) void Canvas::item_changed (Item* item, boost::optional pre_change_bounding_box) { + + Rect window_bbox = visible_area (); + if (pre_change_bounding_box) { - /* request a redraw of the item's old bounding box */ - queue_draw_item_area (item, pre_change_bounding_box.get ()); + + if (item->item_to_window (*pre_change_bounding_box).intersection (window_bbox)) { + /* request a redraw of the item's old bounding box */ + queue_draw_item_area (item, pre_change_bounding_box.get ()); + } } boost::optional post_change_bounding_box = item->bounding_box (); if (post_change_bounding_box) { - /* request a redraw of the item's new bounding box */ - queue_draw_item_area (item, post_change_bounding_box.get ()); + + if (item->item_to_window (*post_change_bounding_box).intersection (window_bbox)) { + /* request a redraw of the item's new bounding box */ + queue_draw_item_area (item, post_change_bounding_box.get ()); + } } } Duple Canvas::window_to_canvas (Duple const & d) const { - return d.translate (Duple (_scroll_offset_x, _scroll_offset_y)); + /* 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 const& root_children (_root.items()); + ScrollGroup* sg = 0; + + /* if the coordinates are negative, clamp to zero and find the item + * that covers that "edge" position. + */ + + Duple in_window (d); + + if (in_window.x < 0) { + in_window.x = 0; + } + if (in_window.y < 0) { + in_window.y = 0; + } + + for (std::list::const_iterator i = root_children.begin(); i != root_children.end(); ++i) { + if (((sg = dynamic_cast(*i)) != 0) && sg->covers_window (in_window)) { + break; + } + } + + if (sg) { + return d.translate (sg->scroll_offset()); + } + + return d; } Duple -Canvas::canvas_to_window (Duple const & d) const +Canvas::canvas_to_window (Duple const & d, bool rounded) const { - Duple wd = d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y)); - wd.x = round (wd.x); - wd.y = round (wd.y); - return wd; -} + /* Find the scroll group that covers d (a canvas 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. + */ -Rect -Canvas::window_to_canvas (Rect const & r) const -{ - return r.translate (Duple (_scroll_offset_x, _scroll_offset_y)); -} + std::list const& root_children (_root.items()); + ScrollGroup* sg = 0; + Duple wd; -Rect -Canvas::canvas_to_window (Rect const & r) const -{ - Rect wr = r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y)); - wr.x0 = floor (wr.x0); - wr.x1 = ceil (wr.x1); - wr.y0 = floor (wr.y0); - wr.y1 = ceil (wr.y1); - return wr; -} + for (std::list::const_iterator i = root_children.begin(); i != root_children.end(); ++i) { + if (((sg = dynamic_cast(*i)) != 0) && sg->covers_canvas (d)) { + break; + } + } + + + if (sg) { + wd = d.translate (-sg->scroll_offset()); + } else { + wd = d; + } + + /* Note that this intentionally almost always returns integer coordinates */ + + if (rounded) { + wd.x = round (wd.x); + wd.y = round (wd.y); + } + + return wd; +} /** Called when an item has moved. * @param item Item that has moved. @@ -250,9 +331,21 @@ Canvas::item_moved (Item* item, boost::optional pre_change_parent_bounding void Canvas::queue_draw_item_area (Item* item, Rect area) { - ArdourCanvas::Rect canvas_area = item->item_to_canvas (area); - // cerr << "CANVAS " << this << " for " << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << endl; - request_redraw (canvas_area); + request_redraw (item->item_to_window (area)); +} + +void +Canvas::set_tooltip_timeout (uint32_t msecs) +{ + tooltip_timeout_msecs = msecs; +} + +void +GtkCanvas::re_enter () +{ + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, "re-enter canvas by request\n"); + _current_item = 0; + pick_current_item (0); } /** Construct a GtkCanvas */ @@ -261,19 +354,21 @@ GtkCanvas::GtkCanvas () , _new_current_item (0) , _grabbed_item (0) , _focused_item (0) + , 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::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK); + Gdk::SCROLL_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK); } void -GtkCanvas::enter_leave_items (int state) +GtkCanvas::pick_current_item (int state) { int x; int y; - /* this version of ::enter_leave_items() is called after an item is + /* this version of ::pick_current_item() is called after an item is * added or removed, so we have no coordinates to work from as is the * case with a motion event. Find out where the mouse is and use that. */ @@ -284,11 +379,15 @@ GtkCanvas::enter_leave_items (int state) return; } - enter_leave_items (window_to_canvas (Duple (x, y)), state); + pick_current_item (Duple (x, y), state); } - + +/** Given @param point (a position in window coordinates) + * and mouse state @param state, check to see if _current_item + * (which will be used to deliver events) should change. + */ void -GtkCanvas::enter_leave_items (Duple const & point, int state) +GtkCanvas::pick_current_item (Duple const & point, int state) { /* we do not enter/leave items during a drag/grab */ @@ -296,25 +395,25 @@ GtkCanvas::enter_leave_items (Duple const & point, int state) return; } - GdkEventCrossing enter_event; - enter_event.type = GDK_ENTER_NOTIFY; - enter_event.window = get_window()->gobj(); - enter_event.send_event = 0; - enter_event.subwindow = 0; - enter_event.mode = GDK_CROSSING_NORMAL; - enter_event.focus = FALSE; - enter_event.state = state; - enter_event.x = point.x; - enter_event.y = point.y; - - GdkEventCrossing leave_event = enter_event; - leave_event.type = GDK_LEAVE_NOTIFY; - - /* find the items at the given position */ + /* find the items at the given window position */ vector items; _root.add_items_at_point (point, items); + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("%1 covers %2 items\n", point, items.size())); + +#ifndef NDEBUG + if (DEBUG_ENABLED(PBD::DEBUG::CanvasEnterLeave)) { + for (vector::const_iterator it = items.begin(); it != items.end(); ++it) { +#ifdef CANVAS_DEBUG + std::cerr << "\tItem " << (*it)->whatami() << '/' << (*it)->name << " ignore events ? " << (*it)->ignore_events() << " vis ? " << (*it)->visible() << std::endl; +#else + std::cerr << "\tItem " << (*it)->whatami() << '/' << " ignore events ? " << (*it)->ignore_events() << " vis ? " << (*it)->visible() << std::endl; +#endif + } + } +#endif + /* put all items at point that are event-sensitive and visible and NOT groups into within_items. Note that items is sorted from bottom to top, but we're going to reverse that for within_items so that its @@ -326,77 +425,204 @@ GtkCanvas::enter_leave_items (Duple const & point, int state) for (i = items.begin(); i != items.end(); ++i) { - Item const * new_item = *i; + Item const * possible_item = *i; + + /* We ignore invisible items, containers and items that ignore events */ - if (new_item->ignore_events() || dynamic_cast(new_item) != 0) { + if (!possible_item->visible() || possible_item->ignore_events() || dynamic_cast(possible_item) != 0) { continue; } - - within_items.push_front (new_item); + within_items.push_front (possible_item); } + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("after filtering insensitive + containers, we have %1 items\n", within_items.size())); + if (within_items.empty()) { - /* no items at point */ - if (_current_item) { - leave_event.detail = GDK_NOTIFY_UNKNOWN; - DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("Leave %1 %2\n", _current_item->whatami(), _current_item->name)); - deliver_event (reinterpret_cast (&leave_event)); - _current_item = 0; + + /* no items at point, just send leave event below */ + _new_current_item = 0; + + } else { + + if (within_items.front() == _current_item) { + /* uppermost item at point is already _current_item */ + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("CURRENT ITEM %1/%2\n", _new_current_item->whatami(), _current_item->name)); + return; } - return; - } - if (within_items.front() == _current_item) { - /* uppermost item at point is already _current_item */ + _new_current_item = const_cast (within_items.front()); + } + + if (_new_current_item != _current_item) { + deliver_enter_leave (point, state); + } + + if (_current_item) { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("CURRENT ITEM %1/%2\n", _new_current_item->whatami(), _current_item->name)); + } else { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, "--- no current item\n"); + } + +} + +/** Deliver a series of enter & leave events based on the pointer position being at window + * coordinate @param point, and pointer @param state (modifier keys, etc) + */ +void +GtkCanvas::deliver_enter_leave (Duple const & point, int state) +{ + /* setup enter & leave event structures */ + + Glib::RefPtr win = get_window(); + + if (!win) { return; } - _new_current_item = within_items.front(); + GdkEventCrossing enter_event; + enter_event.type = GDK_ENTER_NOTIFY; + enter_event.window = win->gobj(); + enter_event.send_event = 0; + enter_event.subwindow = 0; + enter_event.mode = GDK_CROSSING_NORMAL; + enter_event.focus = FALSE; + enter_event.state = state; + + /* Events delivered to canvas items are expected to be in canvas + * coordinates but @param point is in window coordinates. + */ - if (_current_item) { + Duple c = window_to_canvas (point); + enter_event.x = c.x; + enter_event.y = c.y; + + GdkEventCrossing leave_event = enter_event; + leave_event.type = GDK_LEAVE_NOTIFY; + + Item* i; + GdkNotifyType enter_detail; + GdkNotifyType leave_detail; + vector items_to_leave_virtual; + vector items_to_enter_virtual; - if (_new_current_item->is_descendant_of (*_current_item)) { - leave_event.detail = GDK_NOTIFY_INFERIOR; - enter_event.detail = GDK_NOTIFY_ANCESTOR; - } else if (_current_item->is_descendant_of (*_new_current_item)) { - leave_event.detail = GDK_NOTIFY_ANCESTOR; - enter_event.detail = GDK_NOTIFY_INFERIOR; - } else { - leave_event.detail = GDK_NOTIFY_UNKNOWN; - enter_event.detail = GDK_NOTIFY_UNKNOWN; + if (_new_current_item == 0) { + + leave_detail = GDK_NOTIFY_UNKNOWN; + + if (_current_item) { + + /* no current item, so also send virtual leave events to the + * entire heirarchy for the current item + */ + + for (i = _current_item->parent(); i ; i = i->parent()) { + items_to_leave_virtual.push_back (i); + } } - std::cerr << "CROSS from " - << _current_item->whatami() << '/' << _current_item->name - << " to " - << _new_current_item->whatami() << '/' << _new_current_item->name - << " detail = " << leave_event.detail - << '\n'; - - DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("Leave %1 %2\n", _current_item->whatami(), _current_item->name)); - deliver_event (reinterpret_cast (&leave_event)); - _current_item = 0; + } else if (_current_item == 0) { + + enter_detail = GDK_NOTIFY_UNKNOWN; + + /* no current item, so also send virtual enter events to the + * entire heirarchy for the new item + */ + + for (i = _new_current_item->parent(); i ; i = i->parent()) { + items_to_enter_virtual.push_back (i); + } + + } else if (_current_item->is_descendant_of (*_new_current_item)) { + + /* move from descendant to ancestor (X: "_current_item is an + * inferior ("child") of _new_current_item") + * + * Deliver "virtual" leave notifications to all items in the + * heirarchy between current and new_current. + */ + + for (i = _current_item->parent(); i && i != _new_current_item; i = i->parent()) { + items_to_leave_virtual.push_back (i); + } + + enter_detail = GDK_NOTIFY_INFERIOR; + leave_detail = GDK_NOTIFY_ANCESTOR; + + } else if (_new_current_item->is_descendant_of (*_current_item)) { + /* move from ancestor to descendant (X: "_new_current_item is + * an inferior ("child") of _current_item") + * + * Deliver "virtual" enter notifications to all items in the + * heirarchy between current and new_current. + */ + + for (i = _new_current_item->parent(); i && i != _current_item; i = i->parent()) { + items_to_enter_virtual.push_back (i); + } + + enter_detail = GDK_NOTIFY_ANCESTOR; + leave_detail = GDK_NOTIFY_INFERIOR; } else { - enter_event.detail = GDK_NOTIFY_UNKNOWN; + Item const * common_ancestor = _current_item->closest_ancestor_with (*_new_current_item); + + /* deliver virtual leave events to everything between _current + * and common_ancestor. + */ + + for (i = _current_item->parent(); i && i != common_ancestor; i = i->parent()) { + items_to_leave_virtual.push_back (i); + } + + /* deliver virtual enter events to everything between + * _new_current and common_ancestor. + */ + + for (i = _new_current_item->parent(); i && i != common_ancestor; i = i->parent()) { + items_to_enter_virtual.push_back (i); + } + enter_detail = GDK_NOTIFY_NONLINEAR; + leave_detail = GDK_NOTIFY_NONLINEAR; } - /* _new_current_item could potentially have been reset when handling - * the leave event. if it has, there is nothing to do here. - */ - - if (!_new_current_item) { - return; + + if (_current_item && !_current_item->ignore_events ()) { + leave_event.detail = leave_detail; + _current_item->Event ((GdkEvent*)&leave_event); + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("LEAVE %1/%2\n", _current_item->whatami(), _current_item->name)); } - _current_item = _new_current_item; - deliver_event (reinterpret_cast (&enter_event)); + leave_event.detail = GDK_NOTIFY_VIRTUAL; + enter_event.detail = GDK_NOTIFY_VIRTUAL; - DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("Enter %1 %2\n", _current_item->whatami(), _current_item->name)); + for (vector::iterator it = items_to_leave_virtual.begin(); it != items_to_leave_virtual.end(); ++it) { + if (!(*it)->ignore_events()) { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("leave %1/%2\n", (*it)->whatami(), (*it)->name)); + (*it)->Event ((GdkEvent*)&leave_event); + } + } + + for (vector::iterator it = items_to_enter_virtual.begin(); it != items_to_enter_virtual.end(); ++it) { + if (!(*it)->ignore_events()) { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("enter %1/%2\n", (*it)->whatami(), (*it)->name)); + (*it)->Event ((GdkEvent*)&enter_event); + // std::cerr << "enter " << (*it)->whatami() << '/' << (*it)->name << std::endl; + } + } + + 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); + } + + _current_item = _new_current_item; } + /** Deliver an event to the appropriate item; either the grabbed item, or * one of the items underneath the event. * @param point Position that the event has occurred at, in canvas coordinates. @@ -407,30 +633,31 @@ GtkCanvas::deliver_event (GdkEvent* event) { /* Point in in canvas coordinate space */ + const Item* event_item; + if (_grabbed_item) { /* we have a grabbed item, so everything gets sent there */ DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n", _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name)); - return _grabbed_item->Event (event); + event_item = _grabbed_item; + } else { + event_item = _current_item; } - if (!_current_item) { + if (!event_item) { return false; } /* run through the items from child to parent, until one claims the event */ - for (Item* item = const_cast (_current_item); item; item = item->parent()) { + Item* item = const_cast (event_item); + + while (item) { - if (item->ignore_events ()) { - // DEBUG_TRACE ( - // PBD::DEBUG::CanvasEvents, - // string_compose ("canvas event ignored by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name) - // ); - continue; - } - - if (item->Event (event)) { + Item* parent = item->parent (); + + if (!item->ignore_events () && + item->Event (event)) { /* this item has just handled the event */ DEBUG_TRACE ( PBD::DEBUG::CanvasEvents, @@ -440,7 +667,12 @@ GtkCanvas::deliver_event (GdkEvent* event) return true; } - DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event left unhandled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name)); + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event %3 left unhandled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name, event_type_string (event->type))); + + if ((item = parent) == 0) { + break; + } + } return false; @@ -457,17 +689,10 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) queue_draw_item_area (item, bounding_box.get ()); } - /* no need to send a leave event to this item, since it is going away - */ - if (_new_current_item == item) { _new_current_item = 0; } - if (_current_item == item) { - _current_item = 0; - } - if (_grabbed_item == item) { _grabbed_item = 0; } @@ -476,10 +701,37 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) _focused_item = 0; } - enter_leave_items (0); // no mouse state + if (current_tooltip_item) { + current_tooltip_item = 0; + stop_tooltip_timeout (); + } + + ScrollGroup* sg = dynamic_cast(item); + if (sg) { + scrollers.remove (sg); + } + + if (_current_item == item) { + /* no need to send a leave event to this item, since it is going away + */ + _current_item = 0; + pick_current_item (0); // no mouse state + } } +void +GtkCanvas::on_size_allocate (Gtk::Allocation& a) +{ + EventBox::on_size_allocate (a); +#ifdef USE_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 +} + /** Handler for GDK expose events. * @param ev Event. * @return true if the event was handled. @@ -487,23 +739,75 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) bool GtkCanvas::on_expose_event (GdkEventExpose* ev) { - Cairo::RefPtr c = get_window()->create_cairo_context (); +#ifdef USE_CAIRO_IMAGE_SURFACE + if (!canvas_image) { + canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, get_width(), get_height()); + } + + { + /* scope for image_context */ + Cairo::RefPtr image_context = Cairo::Context::create (canvas_image); + + /* clear expose area to transparent */ - render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), c); + image_context->save (); + image_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height); + image_context->clip (); + image_context->set_operator (Cairo::OPERATOR_CLEAR); + image_context->paint (); + image_context->restore (); + + /* render into image surface */ + + render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), image_context); + + /* image surface is flushed when image_context goes out of scope */ + } + + /* now blit our private surface back to the GDK one */ + + Cairo::RefPtr cairo_context = get_window()->create_cairo_context (); + + cairo_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height); + cairo_context->clip (); + cairo_context->set_source (canvas_image, 0, 0); + cairo_context->set_operator (Cairo::OPERATOR_SOURCE); + cairo_context->paint (); + +#else + + Cairo::RefPtr 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); + +#endif return true; } -/** @return Our Cairo context, or 0 if we don't have one */ -Cairo::RefPtr -GtkCanvas::context () +/** Handler for GDK scroll events. + * @param ev Event. + * @return true if the event was handled. + */ +bool +GtkCanvas::on_scroll_event (GdkEventScroll* ev) { - Glib::RefPtr w = get_window (); - if (!w) { - return Cairo::RefPtr (); - } + /* translate event coordinates from window to canvas */ - return w->create_cairo_context (); + GdkEvent copy = *((GdkEvent*)ev); + Duple winpos = Duple (ev->x, ev->y); + Duple where = window_to_canvas (winpos); + + pick_current_item (winpos, ev->state); + + copy.button.x = where.x; + copy.button.y = where.y; + + /* Coordinates in the event will be canvas coordinates, correctly adjusted + for scroll if this GtkCanvas is in a GtkCanvasViewport. + */ + + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas scroll @ %1, %2 => %3\n", ev->x, ev->y, where)); + return deliver_event (reinterpret_cast(©)); } /** Handler for GDK button press events. @@ -516,7 +820,10 @@ GtkCanvas::on_button_press_event (GdkEventButton* ev) /* translate event coordinates from window to canvas */ GdkEvent copy = *((GdkEvent*)ev); - Duple where = window_to_canvas (Duple (ev->x, ev->y)); + Duple winpos = Duple (ev->x, ev->y); + Duple where = window_to_canvas (winpos); + + pick_current_item (winpos, ev->state); copy.button.x = where.x; copy.button.y = where.y; @@ -525,7 +832,6 @@ GtkCanvas::on_button_press_event (GdkEventButton* ev) for scroll if this GtkCanvas is in a GtkCanvasViewport. */ - enter_leave_items (where, ev->state); DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button press @ %1, %2 => %3\n", ev->x, ev->y, where)); return deliver_event (reinterpret_cast(©)); } @@ -540,9 +846,10 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev) /* translate event coordinates from window to canvas */ GdkEvent copy = *((GdkEvent*)ev); - Duple where = window_to_canvas (Duple (ev->x, ev->y)); + Duple winpos = Duple (ev->x, ev->y); + Duple where = window_to_canvas (winpos); - enter_leave_items (where, ev->state); + pick_current_item (winpos, ev->state); copy.button.x = where.x; copy.button.y = where.y; @@ -551,11 +858,32 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev) for scroll if this GtkCanvas is in a GtkCanvasViewport. */ - enter_leave_items (where, ev->state); DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button release @ %1, %2 => %3\n", ev->x, ev->y, where)); return deliver_event (reinterpret_cast(©)); } +bool +GtkCanvas::get_mouse_position (Duple& winpos) const +{ + int x; + int y; + Gdk::ModifierType mask; + Glib::RefPtr self = Glib::RefPtr::cast_const (get_window ()); + + if (!self) { + std::cerr << " no self window\n"; + winpos = Duple (0, 0); + return false; + } + + Glib::RefPtr win = self->get_pointer (x, y, mask); + + winpos.x = x; + winpos.y = y; + + return true; +} + /** Handler for GDK motion events. * @param ev Event. * @return true if the event was handled. @@ -563,6 +891,8 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev) bool GtkCanvas::on_motion_notify_event (GdkEventMotion* ev) { + hide_tooltip (); + /* translate event coordinates from window to canvas */ GdkEvent copy = *((GdkEvent*)ev); @@ -575,18 +905,11 @@ GtkCanvas::on_motion_notify_event (GdkEventMotion* ev) /* Coordinates in "copy" will be canvas coordinates, */ - // DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2\n", ev->x, ev->y)); + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2 canvas @ %3, %4\n", ev->x, ev->y, copy.motion.x, copy.motion.y)); - if (_grabbed_item) { - /* if we have a grabbed item, it gets just the motion event, - since no enter/leave events can have happened. - */ - DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send MOTION event there\n", - _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name)); - return _grabbed_item->Event (reinterpret_cast (©)); - } + MouseMotion (point); /* EMIT SIGNAL */ - enter_leave_items (where, ev->state); + pick_current_item (point, ev->state); /* Now deliver the motion event. It may seem a little inefficient to recompute the items under the event, but the enter notify/leave @@ -600,39 +923,53 @@ GtkCanvas::on_motion_notify_event (GdkEventMotion* ev) bool GtkCanvas::on_enter_notify_event (GdkEventCrossing* ev) { - Duple where = window_to_canvas (Duple (ev->x, ev->y)); - enter_leave_items (where, ev->state); + pick_current_item (Duple (ev->x, ev->y), ev->state); return true; } bool -GtkCanvas::on_leave_notify_event (GdkEventCrossing* /*ev*/) +GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev) { - _current_item = 0; + 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; } -bool -GtkCanvas::on_key_press_event (GdkEventKey* ev) -{ - return false; -} - -bool -GtkCanvas::on_key_release_event (GdkEventKey* ev) -{ - return false; -} - /** Called to request a redraw of our canvas. - * @param area Area to redraw, in canvas coordinates. + * @param area Area to redraw, in window coordinates. */ void GtkCanvas::request_redraw (Rect const & request) { - Rect area = canvas_to_window (request); - queue_draw_area (floor (area.x0), floor (area.y0), ceil (area.width()), ceil (area.height())); + Rect real_area; + + Coord const w = width (); + Coord const h = height (); + + /* clamp area requested to actual visible window */ + + real_area.x0 = max (0.0, min (w, request.x0)); + real_area.x1 = max (0.0, min (w, request.x1)); + real_area.y0 = max (0.0, min (h, request.y0)); + real_area.y1 = max (0.0, min (h, request.y1)); + + queue_draw_area (real_area.x0, real_area.y0, real_area.width(), real_area.height()); } /** Called to request that we try to get a particular size for ourselves. @@ -693,13 +1030,134 @@ GtkCanvas::unfocus (Item* item) } } -/** @return The visible area of the canvas, in canvas coordinates */ +/** @return The visible area of the canvas, in window coordinates */ Rect GtkCanvas::visible_area () const { - Distance const xo = _scroll_offset_x; - Distance const yo = _scroll_offset_y; - return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ()); + return Rect (0, 0, get_allocation().get_width (), get_allocation().get_height ()); +} + +Coord +GtkCanvas::width() const +{ + return get_allocation().get_width(); +} + +Coord +GtkCanvas::height() const +{ + return get_allocation().get_height(); +} + +void +GtkCanvas::start_tooltip_timeout (Item* item) +{ + stop_tooltip_timeout (); + + if (item) { + current_tooltip_item = item; + + /* wait for the first idle that happens after this is + called. this means that we've stopped processing events, which + in turn implies that the user has stopped doing stuff for a + little while. + */ + + Glib::signal_idle().connect (sigc::mem_fun (*this, &GtkCanvas::really_start_tooltip_timeout)); + } +} + +bool +GtkCanvas::really_start_tooltip_timeout () +{ + /* an idle has occured since we entered a tooltip-bearing widget. Now + * wait 1 second and if the timeout isn't cancelled, show the tooltip. + */ + + if (current_tooltip_item) { + 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 () +{ + current_tooltip_item = 0; + tooltip_timeout_connection.disconnect (); +} + +bool +GtkCanvas::show_tooltip () +{ + 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 (6); + 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(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 += 20; + + /* 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 (); + } } /** Create a GtkCanvaSViewport.