• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef CHROME_BROWSER_UI_COCOA_WRENCH_MENU_MENU_TRACKED_BUTTON_H_
6 #define CHROME_BROWSER_UI_COCOA_WRENCH_MENU_MENU_TRACKED_BUTTON_H_
7 #pragma once
8 
9 #import <Cocoa/Cocoa.h>
10 
11 // A MenuTrackedButton is meant to be used whenever a button is placed inside
12 // the custom view of an NSMenuItem. If the user opens the menu in a non-sticky
13 // fashion (i.e. clicks, holds, and drags) and then releases the mouse over
14 // a MenuTrackedButton, it will |-performClick:| itself.
15 //
16 // To create the hover state effects, there are two code paths.  When the menu
17 // is opened sticky, a tracking rect produces mouse entered/exit events that
18 // allow for setting the cell's highlight property.  When in a drag cycle,
19 // however, the only event received is |-mouseDragged:|.  Therefore, a
20 // delayed selector is scheduled to poll the mouse location after each drag
21 // event.  This checks if the user is still over the button after the drag
22 // events stop being sent, indicating either the user is hovering without
23 // movement or that the mouse is no longer over the receiver.
24 @interface MenuTrackedButton : NSButton {
25  @private
26   // If the button received a |-mouseEntered:| event. This short-circuits the
27   // custom drag tracking logic.
28   BOOL didEnter_;
29 
30   // Whether or not the user is in a click-drag-release event sequence. If so
31   // and this receives a |-mouseUp:|, then this will click itself.
32   BOOL tracking_;
33 
34   // In order to get hover effects when the menu is sticky-opened, a tracking
35   // rect needs to be installed on the button.
36   NSTrackingRectTag trackingTag_;
37 }
38 
39 @property(nonatomic, readonly, getter=isTracking) BOOL tracking;
40 
41 @end
42 
43 #endif  // CHROME_BROWSER_UI_COCOA_WRENCH_MENU_MENU_TRACKED_BUTTON_H_
44