ui/base/cocoa/hover_button.h

   1 // Copyright (c) 2011 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 UI_BASE_COCOA_HOVER_BUTTON_
   6 #define UI_BASE_COCOA_HOVER_BUTTON_
   7
   8 #import <Cocoa/Cocoa.h>
   9
  10 #import "ui/base/cocoa/tracking_area.h"
  11 #import "ui/base/ui_base_export.h"
  12
  13 // A button that changes when you hover over it and click it.
  14 UI_BASE_EXPORT
  15 @interface HoverButton : NSButton {
  16  @protected
  17   // Enumeration of the hover states that the close button can be in at any one
  18   // time. The button cannot be in more than one hover state at a time.
  19   enum HoverState {
  20     kHoverStateNone = 0,
  21     kHoverStateMouseOver = 1,
  22     kHoverStateMouseDown = 2
  23   };
  24
  25   HoverState hoverState_;
  26
  27  @private
  28   // Tracking area for button mouseover states. Nil if not enabled.
  29   ui::ScopedCrTrackingArea trackingArea_;
  30 }
  31
  32 @property(nonatomic) HoverState hoverState;
  33
  34 // Text that would be announced by screen readers.
  35 - (void)setAccessibilityTitle:(NSString*)accessibilityTitle;
  36
  37 // Enables or disables the tracking for the button.
  38 - (void)setTrackingEnabled:(BOOL)enabled;
  39
  40 // Checks to see whether the mouse is in the button's bounds and update
  41 // the image in case it gets out of sync.  This occurs to the close button
  42 // when you close a tab so the tab to the left of it takes its place, and
  43 // drag the button without moving the mouse before you press the button down.
  44 - (void)checkImageState;
  45
  46 @end
  47
  48 #endif  // UI_BASE_COCOA_HOVER_BUTTON_