chrome/browser/ui/content_settings/content_setting_image_model.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 CHROME_BROWSER_UI_CONTENT_SETTINGS_CONTENT_SETTING_IMAGE_MODEL_H_
   6 #define CHROME_BROWSER_UI_CONTENT_SETTINGS_CONTENT_SETTING_IMAGE_MODEL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "components/content_settings/core/common/content_settings_types.h"
  12 #include "ui/gfx/image/image.h"
  13
  14 namespace content {
  15 class WebContents;
  16 }
  17
  18 namespace gfx {
  19 enum class VectorIconId;
  20 }
  21
  22 // This model provides data (icon ids and tooltip) for the content setting icons
  23 // that are displayed in the location bar.
  24 class ContentSettingImageModel {
  25  public:
  26   virtual ~ContentSettingImageModel() {}
  27
  28   // Factory function.
  29   static ContentSettingImageModel* CreateContentSettingImageModel(
  30      ContentSettingsType content_settings_type);
  31
  32   // Notifies this model that its setting might have changed and it may need to
  33   // update its visibility, icon and tooltip.
  34   virtual void UpdateFromWebContents(content::WebContents* web_contents) = 0;
  35
  36   ContentSettingsType get_content_settings_type() const {
  37     return content_settings_type_;
  38   }
  39   bool is_visible() const { return is_visible_; }
  40   const gfx::Image& icon() const { return icon_; }
  41 #if defined(OS_MACOSX)
  42   int icon_id() const { return icon_id_; }
  43 #endif
  44   // Returns the resource ID of a string to show when the icon appears, or 0 if
  45   // we don't wish to show anything.
  46   int explanatory_string_id() const { return explanatory_string_id_; }
  47   std::string get_tooltip() const { return tooltip_; }
  48
  49  protected:
  50   explicit ContentSettingImageModel(ContentSettingsType content_settings_type);
  51   void SetIconByResourceId(int id);
  52 #if !defined(OS_MACOSX)
  53   void SetIconByVectorId(gfx::VectorIconId id, bool blocked);
  54 #endif
  55   void set_visible(bool visible) { is_visible_ = visible; }
  56   void set_explanatory_string_id(int text_id) {
  57     explanatory_string_id_ = text_id;
  58   }
  59   void set_tooltip(const std::string& tooltip) { tooltip_ = tooltip; }
  60
  61  private:
  62   const ContentSettingsType content_settings_type_;
  63   bool is_visible_;
  64   int icon_id_;
  65   gfx::Image icon_;
  66   int explanatory_string_id_;
  67   std::string tooltip_;
  68
  69   DISALLOW_COPY_AND_ASSIGN(ContentSettingImageModel);
  70 };
  71
  72 #endif  // CHROME_BROWSER_UI_CONTENT_SETTINGS_CONTENT_SETTING_IMAGE_MODEL_H_