src/chrome/browser/extensions/extension_action_icon_factory.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_EXTENSIONS_EXTENSION_ACTION_ICON_FACTORY_H_
   6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_ACTION_ICON_FACTORY_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "extensions/browser/extension_icon_image.h"
  10
  11 class ExtensionAction;
  12 class ExtensionIconSet;
  13 class Profile;
  14
  15 namespace extensions {
  16 class Extension;
  17 }
  18
  19 // Used to get an icon to be used in the UI for an extension action.
  20 // If the extension action icon is the default icon defined in the extension's
  21 // manifest, it is loaded using extensions::IconImage. This icon can be loaded
  22 // asynchronously. The factory observes underlying IconImage and notifies its
  23 // own observer when the icon image changes.
  24 class ExtensionActionIconFactory : public extensions::IconImage::Observer {
  25  public:
  26   class Observer {
  27    public:
  28     virtual ~Observer() {}
  29     // Called when the underlying icon image changes.
  30     virtual void OnIconUpdated() = 0;
  31   };
  32
  33   // Observer should outlive this.
  34   ExtensionActionIconFactory(Profile* profile,
  35                              const extensions::Extension* extension,
  36                              const ExtensionAction* action,
  37                              Observer* observer);
  38   ~ExtensionActionIconFactory() override;
  39
  40   // extensions::IconImage override.
  41   void OnExtensionIconImageChanged(extensions::IconImage* image) override;
  42
  43   // Gets the extension action icon for the tab.
  44   // If there is an icon set using |SetIcon|, that icon is returned.
  45   // Else, if there is a default icon set for the extension action, the icon is
  46   // created using IconImage. Observer is triggered wheniever the icon gets
  47   // updated.
  48   // Else, extension favicon is returned.
  49   // In all cases, action's attention and animation icon transformations are
  50   // applied on the icon.
  51   gfx::Image GetIcon(int tab_id);
  52
  53  private:
  54   // Gets the icon that should be returned by |GetIcon| (without the attention
  55   // and animation transformations).
  56   gfx::ImageSkia GetBaseIconFromAction(int tab_id);
  57
  58   const extensions::Extension* extension_;
  59   const ExtensionAction* action_;
  60   Observer* observer_;
  61   // Underlying icon image for the default icon.
  62   scoped_ptr<extensions::IconImage> default_icon_;
  63
  64   DISALLOW_COPY_AND_ASSIGN(ExtensionActionIconFactory);
  65 };
  66
  67 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_ACTION_ICON_FACTORY_H_