src/chrome/browser/ui/cocoa/location_bar/zoom_decoration.h

   1 // Copyright (c) 2012 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_LOCATION_BAR_ZOOM_DECORATION_H_
   6 #define CHROME_BROWSER_UI_COCOA_LOCATION_BAR_ZOOM_DECORATION_H_
   7
   8 #import <Cocoa/Cocoa.h>
   9
  10 #include "base/basictypes.h"
  11 #import "chrome/browser/ui/cocoa/browser/zoom_bubble_controller.h"
  12 #include "chrome/browser/ui/cocoa/location_bar/image_decoration.h"
  13
  14 class LocationBarViewMac;
  15 @class ZoomBubbleController;
  16 class ZoomController;
  17 class ZoomDecorationTest;
  18
  19 // Zoom icon at the end of the omnibox (close to page actions) when at a
  20 // non-standard zoom level.
  21 class ZoomDecoration : public ImageDecoration,
  22                        public ZoomBubbleControllerDelegate {
  23  public:
  24   explicit ZoomDecoration(LocationBarViewMac* owner);
  25   ~ZoomDecoration() override;
  26
  27   // Called when this decoration should show or hide itself in its most current
  28   // state. Returns whether any updates were made.
  29   bool UpdateIfNecessary(ZoomController* zoom_controller);
  30
  31   // Shows the zoom bubble for this decoration. If |auto_close| is YES, then
  32   // the bubble will automatically close after a fixed period of time.
  33   void ShowBubble(BOOL auto_close);
  34
  35   // Closes the zoom bubble.
  36   void CloseBubble();
  37
  38  protected:
  39   // Hides all UI associated with the zoom decoration.
  40   // Virtual and protected for testing.
  41   virtual void HideUI();
  42
  43   // Show and update UI associated with the zoom decoration.
  44   // Virtual and protected for testing.
  45   virtual void ShowAndUpdateUI(ZoomController* zoom_controller,
  46                                NSString* tooltip_string);
  47
  48  private:
  49   friend ZoomDecorationTest;
  50
  51   bool IsAtDefaultZoom() const;
  52
  53   // Virtual for testing.
  54   virtual bool ShouldShowDecoration() const;
  55
  56   // LocationBarDecoration implementation.
  57   bool AcceptsMousePress() override;
  58   bool OnMousePressed(NSRect frame, NSPoint location) override;
  59   NSString* GetToolTip() override;
  60   NSPoint GetBubblePointInFrame(NSRect frame) override;
  61
  62   // ZoomBubbleControllerDelegate implementation.
  63   content::WebContents* GetWebContents() override;
  64   void OnClose() override;
  65
  66   // The control that owns this. Weak.
  67   LocationBarViewMac* owner_;
  68
  69   // The bubble that this decoration shows. Weak, owns self.
  70   ZoomBubbleController* bubble_;
  71
  72   // The string to show for a tooltip.
  73   base::scoped_nsobject<NSString> tooltip_;
  74
  75   DISALLOW_COPY_AND_ASSIGN(ZoomDecoration);
  76 };
  77
  78 #endif  // CHROME_BROWSER_UI_COCOA_LOCATION_BAR_ZOOM_DECORATION_H_