MacViews: Implement Tooltips

ui/views/cocoa/bridged_content_view.mm

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ui/views/cocoa/bridged_content_view.h"
 
 #include "base/logging.h"
 #import "base/mac/scoped_nsobject.h"
 #include "base/strings/sys_string_conversions.h"
 #include "ui/base/ime/text_input_client.h"
@@ skipping 40 matching lines @@
         ui::POST_DISPATCH_NONE)
       return true;
   }
   return false;
 }
 
 }  // namespace
 
 @interface BridgedContentView ()
 
-// Translates the location of |theEvent| to toolkit-views coordinates and passes
-// the event to NativeWidgetMac for handling.
-- (void)handleMouseEvent:(NSEvent*)theEvent;
-
 // Translates keycodes and modifiers on |theEvent| to ui::KeyEvents and passes
 // the event to the InputMethod for dispatch.
 - (void)handleKeyEvent:(NSEvent*)theEvent;
 
 // Handles an NSResponder Action Message by mapping it to a corresponding text
 // editing command from ui_strings.grd and, when not being sent to a
 // TextInputClient, the keyCode that toolkit-views expects internally.
 // For example, moveToLeftEndOfLine: would pass ui::VKEY_HOME in non-RTL locales
 // even though the Home key on Mac defaults to moveToBeginningOfDocument:.
 // This approach also allows action messages a user
@@ skipping 28 matching lines @@
   gfx::Rect bounds = viewToHost->bounds();
   // To keep things simple, assume the origin is (0, 0) until there exists a use
   // case for something other than that.
   DCHECK(bounds.origin().IsOrigin());
   NSRect initialFrame = NSMakeRect(0, 0, bounds.width(), bounds.height());
   if ((self = [super initWithFrame:initialFrame])) {
     hostedView_ = viewToHost;
 
     // Apple's documentation says that NSTrackingActiveAlways is incompatible
     // with NSTrackingCursorUpdate, so use NSTrackingActiveInActiveApp.
-    trackingArea_.reset([[CrTrackingArea alloc]
+    cursorTrackingArea_.reset([[CrTrackingArea alloc]
         initWithRect:NSZeroRect
              options:NSTrackingMouseMoved | NSTrackingCursorUpdate |
                      NSTrackingActiveInActiveApp | NSTrackingInVisibleRect
                owner:self
             userInfo:nil]);
-    [self addTrackingArea:trackingArea_.get()];
+    [self addTrackingArea:cursorTrackingArea_.get()];
   }
   return self;
 }
 
 - (void)clearView {
   hostedView_ = NULL;
-  [trackingArea_.get() clearOwner];
-  [self removeTrackingArea:trackingArea_.get()];
+  [cursorTrackingArea_.get() clearOwner];
+  [self removeTrackingArea:cursorTrackingArea_.get()];
 }
 
 - (void)processCapturedMouseEvent:(NSEvent*)theEvent {
   if (!hostedView_)
     return;
 
   NSWindow* source = [theEvent window];
   NSWindow* target = [self window];
   DCHECK(target);
 
   // If it's the view's window, process normally.
   if ([target isEqual:source]) {
-    [self handleMouseEvent:theEvent];
+    [self mouseEvent:theEvent];
     return;
   }
 
   ui::MouseEvent event(theEvent);
   event.set_location(
       MovePointToWindow([theEvent locationInWindow], source, target));
   hostedView_->GetWidget()->OnMouseEvent(&event);
 }
 
+- (void)updateTooltipIfRequiredAt:(const gfx::Point&)locationInWindow {
+  DCHECK(hostedView_);
+  base::string16 newTooltipText;
+
+  views::View* view = hostedView_->GetTooltipHandlerForPoint(locationInWindow);
+  if (view) {
+    gfx::Point viewPoint = locationInWindow;
+    views::View::ConvertPointToTarget(hostedView_, view, &viewPoint);
+    if (!view->GetTooltipText(viewPoint, &newTooltipText))
+      DCHECK(newTooltipText.empty());
+  }
+  if (newTooltipText != lastTooltipText_) {
+    std::swap(newTooltipText, lastTooltipText_);
+    [self setToolTipAtMousePoint:base::SysUTF16ToNSString(lastTooltipText_)];
+  }
+}
+
 // BridgedContentView private implementation.
 
-- (void)handleMouseEvent:(NSEvent*)theEvent {
-  if (!hostedView_)
-    return;
-
-  ui::MouseEvent event(theEvent);
-  hostedView_->GetWidget()->OnMouseEvent(&event);
-}
-
 - (void)handleKeyEvent:(NSEvent*)theEvent {
   if (!hostedView_)
     return;
 
   DCHECK(theEvent);
   ui::KeyEvent event(theEvent);
   if (DispatchEventToMenu(hostedView_->GetWidget(), event.key_code()))
     return;
 
   hostedView_->GetWidget()->GetInputMethod()->DispatchKeyEvent(event);
@@ skipping 66 matching lines @@
 }
 
 - (void)selectAll:(id)sender {
   DCHECK(textInputClient_->IsEditCommandEnabled(IDS_APP_SELECT_ALL));
   [self handleAction:IDS_APP_SELECT_ALL
              keyCode:ui::VKEY_A
              domCode:ui::DomCode::KEY_A
           eventFlags:ui::EF_CONTROL_DOWN];
 }
 
+// BaseView implementation.
+
+// Don't use tracking areas from BaseView. BridgedContentView's tracks
+// NSTrackingCursorUpdate and Apple's documentation suggests it's incompatible.
+- (void)enableTracking {
+}
+
+// Translates the location of |theEvent| to toolkit-views coordinates and passes
+// the event to NativeWidgetMac for handling.
+- (void)mouseEvent:(NSEvent*)theEvent {
+  if (!hostedView_)
+    return;
+
+  ui::MouseEvent event(theEvent);
+
+  // Aura updates tooltips with the help of aura::Window::AddPreTargetHandler().
+  // Mac hooks in here.
+  [self updateTooltipIfRequiredAt:event.location()];
+
+  hostedView_->GetWidget()->OnMouseEvent(&event);
+}
+
 // NSView implementation.
 
 - (BOOL)acceptsFirstResponder {
   return YES;
 }
 
 - (void)viewDidMoveToWindow {
   // When this view is added to a window, AppKit calls setFrameSize before it is
   // added to the window, so the behavior in setFrameSize is not triggered.
   NSWindow* window = [self window];
@@ skipping 48 matching lines @@
 
 // NSResponder implementation.
 
 - (void)keyDown:(NSEvent*)theEvent {
   // Convert the event into an action message, according to OSX key mappings.
   inKeyDown_ = YES;
   [self interpretKeyEvents:@[ theEvent ]];
   inKeyDown_ = NO;
 }
 
-- (void)mouseDown:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)rightMouseDown:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)otherMouseDown:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)mouseUp:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)rightMouseUp:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)otherMouseUp:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)mouseDragged:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)rightMouseDragged:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)otherMouseDragged:(NSEvent*)theEvent {
-  [self handleMouseEvent:theEvent];
-}
-
-- (void)mouseMoved:(NSEvent*)theEvent {
-  // Note: mouseEntered: and mouseExited: are not handled separately.
-  // |hostedView_| is responsible for converting the move events into entered
-  // and exited events for the view heirarchy.
-  [self handleMouseEvent:theEvent];
-}
-
 - (void)scrollWheel:(NSEvent*)theEvent {
   if (!hostedView_)
     return;
 
   ui::MouseWheelEvent event(theEvent);
   hostedView_->GetWidget()->OnMouseEvent(&event);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // NSResponder Action Messages. Keep sorted according NSResponder.h (from the
@@ skipping 354 matching lines @@
   }
 
   return [super accessibilityAttributeValue:attribute];
 }
 
 - (id)accessibilityHitTest:(NSPoint)point {
   return [hostedView_->GetNativeViewAccessible() accessibilityHitTest:point];
 }
 
 @end