chrome/browser/infobars/infobar_service.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_INFOBARS_INFOBAR_SERVICE_H_
   6 #define CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9
  10 namespace content {
  11 class WebContents;
  12 }
  13
  14 class InfoBarDelegate;
  15
  16 // Provides access to creating, removing and enumerating info bars
  17 // attached to a tab.
  18 class InfoBarService {
  19  public:
  20   // Passthrough functions to the implementing subclass.  The subclass .cc file
  21   // should define these.
  22   static void CreateForWebContents(content::WebContents* web_contents);
  23   static InfoBarService* FromWebContents(content::WebContents* web_contents);
  24   static const InfoBarService*
  25       FromWebContents(const content::WebContents* web_contents);
  26
  27   virtual ~InfoBarService();
  28
  29   // Changes whether infobars are enabled.  The default is true.
  30   virtual void SetInfoBarsEnabled(bool enabled) = 0;
  31
  32   // Adds an InfoBar for the specified |delegate|.
  33   //
  34   // If infobars are disabled for this tab or the tab already has a delegate
  35   // which returns true for InfoBarDelegate::EqualsDelegate(delegate),
  36   // |delegate| is closed immediately without being added.
  37   //
  38   // Returns the delegate if it was successfully added.
  39   virtual InfoBarDelegate* AddInfoBar(scoped_ptr<InfoBarDelegate> delegate) = 0;
  40
  41   // Removes the InfoBar for the specified |delegate|.
  42   //
  43   // If infobars are disabled for this tab, this will do nothing, on the
  44   // assumption that the matching AddInfoBar() call will have already closed the
  45   // delegate (see above).
  46   virtual void RemoveInfoBar(InfoBarDelegate* delegate) = 0;
  47
  48   // Replaces one infobar with another, without any animation in between.
  49   //
  50   // If infobars are disabled for this tab, |new_delegate| is closed immediately
  51   // without being added, and nothing else happens.
  52   //
  53   // Returns the new delegate if it was successfully added.
  54   //
  55   // NOTE: This does not perform any EqualsDelegate() checks like AddInfoBar().
  56   virtual InfoBarDelegate* ReplaceInfoBar(
  57       InfoBarDelegate* old_delegate,
  58       scoped_ptr<InfoBarDelegate> new_delegate) = 0;
  59
  60   // Returns the number of infobars for this tab.
  61   virtual size_t GetInfoBarCount() const = 0;
  62
  63   // Returns the infobar delegate at the given |index|.  The InfoBarService
  64   // retains ownership.
  65   //
  66   // Warning: Does not sanity check |index|.
  67   virtual InfoBarDelegate* GetInfoBarDelegateAt(size_t index) = 0;
  68
  69   // Retrieve the WebContents for the tab this service is associated with.
  70   virtual content::WebContents* GetWebContents() = 0;
  71 };
  72
  73 #endif  // CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_