Mac: Content blocked icons.

chrome/browser/cocoa/location_bar_view_mac.h

 // Copyright (c) 2010 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.
 
 #ifndef CHROME_BROWSER_COCOA_LOCATION_BAR_VIEW_MAC_H_
 #define CHROME_BROWSER_COCOA_LOCATION_BAR_VIEW_MAC_H_
 
 #include <string>
 #include <map>
 #include <vector>
 
 #import <Cocoa/Cocoa.h>
 
 #include "base/scoped_nsobject.h"
 #include "base/scoped_ptr.h"
+#include "base/scoped_vector.h"
 #include "chrome/browser/autocomplete/autocomplete_edit.h"
 #include "chrome/browser/autocomplete/autocomplete_edit_view_mac.h"
 #include "chrome/browser/extensions/image_loading_tracker.h"
 #include "chrome/browser/location_bar.h"
 #include "chrome/browser/toolbar_model.h"
+#include "chrome/common/content_settings_types.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 
 @class AutocompleteTextField;
 class BubblePositioner;
 class CommandUpdater;
 @class ExtensionPopupController;
 class Profile;
 class ToolbarModel;
 
 // A C++ bridge class that represents the location bar UI element to
@@ skipping 112 matching lines @@
     void SetLabel(NSString* text, NSFont* baseFont, NSColor* color);
 
     // Sets the visibility. SetImage() should be called with a valid image
     // before the visibility is set to |true|.
     void SetVisible(bool visible);
 
     const NSImage* GetImage() const { return image_; }
     const NSAttributedString* GetLabel() const { return label_; }
     bool IsVisible() const { return visible_; }
 
+    // Returns the tooltip for this image view or |nil| if there is none.
+    virtual const NSString* GetToolTip() { return nil; }
+
+    // Called on mouse down.
+    virtual void OnMousePressed(NSRect bounds) {}
+
+    // Called to get the icon's context menu. Return |nil| for no menu.
+    virtual NSMenu* GetMenu() { return nil; }
+
    private:
     scoped_nsobject<NSImage> image_;
 
     // The label shown next to the icon, or nil if none.
     scoped_nsobject<NSAttributedString> label_;
 
     bool visible_;
 
     DISALLOW_COPY_AND_ASSIGN(LocationBarImageView);
   };
 
   // SecurityImageView is used to display the lock or warning icon when the
   // current URL's scheme is https.
   class SecurityImageView : public LocationBarImageView {
    public:
     enum Image {
       LOCK = 0,
       WARNING
     };
 
     SecurityImageView(LocationBarViewMac* owner,
                       Profile* profile,
                       ToolbarModel* model);
     virtual ~SecurityImageView();
 
     // Sets the image to the appropriate icon.
     void SetImageShown(Image image);
 
-    // Shows the page info dialog. Virtual so it can be overridden for testing.
-    virtual bool OnMousePressed();
+    // Shows the page info dialog.
+    virtual void OnMousePressed(NSRect bounds);
 
    private:
     // The lock icon shown when using HTTPS. Loaded lazily, the first time it's
     // needed.
     scoped_nsobject<NSImage> lock_icon_;
 
     // The warning icon shown when HTTPS is broken. Loaded lazily, the first
     // time it's needed.
     scoped_nsobject<NSImage> warning_icon_;
 
@@ skipping 23 matching lines @@
 
     void set_preview_enabled(bool enabled) { preview_enabled_ = enabled; }
 
     bool preview_enabled() { return preview_enabled_; }
 
     // Return the size of the image, or a default size if no image available
     // and preview is enabled.
     virtual NSSize GetImageSize();
 
     // Either notify listeners or show a popup depending on the Page Action.
-    // Virtual so it can be overridden for testing.
-    virtual bool OnMousePressed(NSRect bounds);
+    virtual void OnMousePressed(NSRect bounds);
 
     // Overridden from ImageLoadingTracker.
     virtual void OnImageLoaded(SkBitmap* image, size_t index);
 
     // Called to notify the Page Action that it should determine whether to be
     // visible or hidden. |contents| is the TabContents that is active, |url|
     // is the current page URL.
     void UpdateVisibility(TabContents* contents, const GURL& url);
 
     // Sets the tooltip for this Page Action image.
     void SetToolTip(NSString* tooltip);
     void SetToolTip(std::string tooltip);
 
     // Returns the tooltip for this Page Action image or |nil| if there is none.
-    const NSString* GetToolTip();
+    virtual const NSString* GetToolTip();
+
+    // Overridden to return a menu.
+    virtual NSMenu* GetMenu();
 
    protected:
     // For unit testing only.
     PageActionImageView() : owner_(NULL),
                             profile_(NULL),
                             page_action_(NULL),
                             tracker_(NULL),
                             current_tab_id_(-1),
                             preview_enabled_(false) {}
 
@@ skipping 33 matching lines @@
     // This is used for post-install visual feedback. The page_action icon
     // is briefly shown even if it hasn't been enabled by its extension.
     bool preview_enabled_;
 
     // Used to register for notifications received by NotificationObserver.
     NotificationRegistrar registrar_;
 
     DISALLOW_COPY_AND_ASSIGN(PageActionImageView);
   };
 
+  // ContentBlockedImageView is used to display the content settings images
+  // when types of contents are blocked on the current page.
+  class ContentBlockedImageView : public LocationBarImageView {
+   public:
+    ContentBlockedImageView(ContentSettingsType settings_type,
+                            LocationBarViewMac* owner,
+                            Profile* profile);
+    virtual ~ContentBlockedImageView();
+
+    // Shows a content settings bubble.
+    void OnMousePressed(NSRect bounds);
+
+    // Returns the settings type this shows up for.
+    ContentSettingsType settings_type() { return settings_type_; }
+
+    // Returns the tooltip for this Page Action image or |nil| if there is none.
+    virtual const NSString* GetToolTip();
+
+   private:
+    void SetToolTip(NSString* tooltip);
+
+    // The type of content handled by this view.
+    ContentSettingsType settings_type_;
+
+    LocationBarViewMac* owner_;
+    Profile* profile_;
+    scoped_nsobject<NSString> tooltip_;
+
+    DISALLOW_COPY_AND_ASSIGN(ContentBlockedImageView);
+  };
+  typedef ScopedVector<ContentBlockedImageView> ContentBlockedViews;
+
   class PageActionViewList {
    public:
     PageActionViewList(LocationBarViewMac* location_bar,
                        Profile* profile,
                        ToolbarModel* toolbar_model)
         : owner_(location_bar),
           profile_(profile),
           toolbar_model_(toolbar_model) {}
     ~PageActionViewList() {
       DeleteAll();
@@ skipping 28 matching lines @@
  private:
   // Sets the SSL icon we should be showing.
   void SetSecurityIcon(ToolbarModel::Icon icon);
 
   // Sets the label for the SSL icon.
   void SetSecurityIconLabel();
 
   // Posts |notification| to the default notification center.
   void PostNotification(const NSString* notification);
 
+  // Updates visibility of the content blocked icons based on the current
+  // tab contents state.
+  void RefreshContentBlockedViews();
+
   scoped_ptr<AutocompleteEditViewMac> edit_view_;
 
   CommandUpdater* command_updater_;  // Weak, owned by Browser.
 
   AutocompleteTextField* field_;  // owned by tab controller
 
   // When we get an OnAutocompleteAccept notification from the autocomplete
   // edit, we save the input string so we can give it back to the browser on
   // the LocationBar interface via GetInputString().
   std::wstring location_input_;
 
   // The user's desired disposition for how their input should be opened.
   WindowOpenDisposition disposition_;
 
   // The view that shows the lock/warning when in HTTPS mode.
   SecurityImageView security_image_view_;
 
   // Any installed Page Actions.
   PageActionViewList page_action_views_;
 
+  // The content blocked views.
+  ContentBlockedViews content_blocked_views_;
+
   Profile* profile_;
 
   Browser* browser_;
 
   ToolbarModel* toolbar_model_;  // Weak, owned by Browser.
 
   // Image used in drawing keyword hint.
   scoped_nsobject<NSImage> tab_button_image_;
 
   // The transition type to use for the navigation.
   PageTransition::Type transition_;
 
   // Used to register for notifications received by NotificationObserver.
   NotificationRegistrar registrar_;
 
   DISALLOW_COPY_AND_ASSIGN(LocationBarViewMac);
 };
 
 #endif  // CHROME_BROWSER_COCOA_LOCATION_BAR_VIEW_MAC_H_