Infobar system refactor.

chrome/browser/infobars/infobar_container.h

 // Copyright (c) 2011 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_INFOBARS_INFOBAR_CONTAINER_H_
 #define CHROME_BROWSER_INFOBARS_INFOBAR_CONTAINER_H_
 
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/time/time.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "third_party/skia/include/core/SkColor.h"
 
 class InfoBar;
-class InfoBarDelegate;
 class InfoBarService;
 
 // InfoBarContainer is a cross-platform base class to handle the visibility-
-// related aspects of InfoBars.  While InfoBars own themselves, the
+// related aspects of InfoBars.  While InfoBarService owns the InfoBars, the
 // InfoBarContainer is responsible for telling particular InfoBars that they
 // should be hidden or visible.
 //
 // Platforms need to subclass this to implement a few platform-specific
 // functions, which are pure virtual here.
 class InfoBarContainer : public content::NotificationObserver {
  public:
   class Delegate {
    public:
     // The separator color may vary depending on where the container is hosted.
     virtual SkColor GetInfoBarSeparatorColor() const = 0;
 
     // The delegate is notified each time the infobar container changes height,
     // as well as when it stops animating.
     virtual void InfoBarContainerStateChanged(bool is_animating) = 0;
 
     // The delegate needs to tell us whether "unspoofable" arrows should be
     // drawn, and if so, at what |x| coordinate.  |x| may be NULL.
     virtual bool DrawInfoBarArrows(int* x) const = 0;
 
    protected:
     virtual ~Delegate();
   };
 
   explicit InfoBarContainer(Delegate* delegate);
   virtual ~InfoBarContainer();
 
   // Changes the InfoBarService for which this container is showing infobars.
-  // This will remove all current infobars from the container, add the infobars
-  // from |infobar_service|, and show them all.  |infobar_service| may be NULL.
+  // This will hide all current infobars, remove them from the container, add
+  // the infobars from |infobar_service|, and show them all.  |infobar_service|
+  // may be NULL.
   void ChangeInfoBarService(InfoBarService* infobar_service);
 
   // Returns the amount by which to overlap the toolbar above, and, when
   // |total_height| is non-NULL, set it to the height of the InfoBarContainer
   // (including overlap).
   int GetVerticalOverlap(int* total_height);
 
   // Called by the delegate when the distance between what the top infobar's
   // "unspoofable" arrow would point to and the top infobar itself changes.
   // This enables the top infobar to show a longer arrow (e.g. because of a
   // visible bookmark bar) or shorter (e.g. due to being in a popup window) if
   // desired.
   //
   // IMPORTANT: This MUST NOT result in a call back to
   // Delegate::InfoBarContainerStateChanged() unless it causes an actual
   // change, lest we infinitely recurse.
   void SetMaxTopArrowHeight(int height);
 
   // Called when a contained infobar has animated or by some other means changed
   // its height, or when it stops animating.  The container is expected to do
   // anything necessary to respond, e.g. re-layout.
   void OnInfoBarStateChanged(bool is_animating);
 
   // Called by |infobar| to request that it be removed from the container.  At
-  // this point, |infobar| should already be hidden.  Once the infobar is
-  // removed, it is guaranteed to delete itself and will not be re-added again.
+  // this point, |infobar| should already be hidden.
   void RemoveInfoBar(InfoBar* infobar);
 
   const Delegate* delegate() const { return delegate_; }
 
  protected:
   // Subclasses must call this during destruction, so that we can remove
   // infobars (which will call the pure virtual functions below) while the
   // subclass portion of |this| has not yet been destroyed.
   void RemoveAllInfoBarsForDestruction();
 
@@ skipping 12 matching lines @@
   virtual void PlatformSpecificInfoBarStateChanged(bool is_animating) {}
 
  private:
   typedef std::vector<InfoBar*> InfoBars;
 
   // content::NotificationObserver:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
-  // Hides an InfoBar for the specified delegate, in response to a notification
-  // from the selected InfoBarService.  The InfoBar's disappearance will be
-  // animated if |use_animation| is true. The InfoBar will call back to
-  // RemoveInfoBar() to remove itself once it's hidden (which may mean
-  // synchronously).  Returns the position within |infobars_| the infobar was
-  // previously at.
-  size_t HideInfoBar(InfoBar* infobar, bool use_animation);
-
-  // Find an existing infobar in the container.
-  InfoBar* FindInfoBar(InfoBarDelegate* delegate);
-
   // Hides all infobars in this container without animation.
   void HideAllInfoBars();
 
   // Adds |infobar| to this container before the existing infobar at position
   // |position| and calls Show() on it.  |animate| is passed along to
   // infobar->Show().  Depending on the value of |callback_status|, this calls
   // infobar->set_container(this) either before or after the call to Show() so
   // that OnInfoBarStateChanged() either will or won't be called as a result.
-  //
-  // This should be called only once for an infobar -- once it's added, it can
-  // be repeatedly shown and hidden, but not removed and then re-added (see
-  // comments on RemoveInfoBar()).
   enum CallbackStatus { NO_CALLBACK, WANT_CALLBACK };
   void AddInfoBar(InfoBar* infobar,
                   size_t position,
                   bool animate,
                   CallbackStatus callback_status);
 
   void UpdateInfoBarArrowTargetHeights();
   int ArrowTargetHeightForInfoBar(size_t infobar_index) const;
 
   content::NotificationRegistrar registrar_;
   Delegate* delegate_;
   InfoBarService* infobar_service_;
   InfoBars infobars_;
 
   // Calculated in SetMaxTopArrowHeight().
   int top_arrow_target_height_;
 
   DISALLOW_COPY_AND_ASSIGN(InfoBarContainer);
 };
 
 #endif  // CHROME_BROWSER_INFOBARS_INFOBAR_CONTAINER_H_