components/infobars/core/infobar.h

   1 // Copyright 2014 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 COMPONENTS_INFOBARS_CORE_INFOBAR_H_
   6 #define COMPONENTS_INFOBARS_CORE_INFOBAR_H_
   7
   8 #include <utility>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "components/infobars/core/infobar_delegate.h"
  12 #include "third_party/skia/include/core/SkColor.h"
  13 #include "ui/gfx/animation/animation_delegate.h"
  14 #include "ui/gfx/animation/slide_animation.h"
  15 #include "ui/gfx/geometry/size.h"
  16
  17 namespace infobars {
  18
  19 class InfoBarContainer;
  20 class InfoBarManager;
  21
  22 // InfoBar is a cross-platform base class for an infobar "view" (in the MVC
  23 // sense), which owns a corresponding InfoBarDelegate "model".  Typically,
  24 // a caller will call XYZInfoBarDelegate::Create() and pass in the
  25 // InfoBarManager for the relevant tab.  This will create an XYZInfoBarDelegate,
  26 // create a platform-specific subclass of InfoBar to own it, and then call
  27 // InfoBarManager::AddInfoBar() to give it ownership of the infobar.
  28 // During its life, the InfoBar may be shown and hidden as the owning tab is
  29 // switched between the foreground and background.  Eventually, InfoBarManager
  30 // will instruct the InfoBar to close itself.  At this point, the InfoBar will
  31 // optionally animate closed; once it's no longer visible, it deletes itself,
  32 // destroying the InfoBarDelegate in the process.
  33 //
  34 // Thus, InfoBarDelegate and InfoBar implementations can assume they share
  35 // lifetimes, and not NULL-check each other; but if one needs to reach back into
  36 // the owning InfoBarManager, it must check whether that's still possible.
  37 class InfoBar : public gfx::AnimationDelegate {
  38  public:
  39   // These are the types passed as Details for infobar-related notifications.
  40   typedef InfoBar AddedDetails;
  41   typedef std::pair<InfoBar*, bool> RemovedDetails;
  42
  43   explicit InfoBar(scoped_ptr<InfoBarDelegate> delegate);
  44   ~InfoBar() override;
  45
  46   static SkColor GetTopColor(InfoBarDelegate::Type infobar_type);
  47   static SkColor GetBottomColor(InfoBarDelegate::Type infobar_type);
  48
  49   InfoBarManager* owner() { return owner_; }
  50   InfoBarDelegate* delegate() const { return delegate_.get(); }
  51   void set_container(InfoBarContainer* container) { container_ = container; }
  52
  53   // Sets |owner_|.  This also calls StoreActiveEntryUniqueID() on |delegate_|.
  54   // This must only be called once as there's no way to extract an infobar from
  55   // its owner without deleting it, for reparenting in another tab.
  56   void SetOwner(InfoBarManager* owner);
  57
  58   // Makes the infobar visible.  If |animate| is true, the infobar is then
  59   // animated to full size.
  60   void Show(bool animate);
  61
  62   // Makes the infobar hidden.  If |animate| is false, the infobar is
  63   // immediately removed from the container, and, if now unowned, deleted.  If
  64   // |animate| is true, the infobar is animated to zero size, ultimately
  65   // triggering a call to AnimationEnded().
  66   void Hide(bool animate);
  67
  68   // Changes the target height of the arrow portion of the infobar.  This has no
  69   // effect once the infobar is animating closed.
  70   void SetArrowTargetHeight(int height);
  71
  72   // Notifies the infobar that it is no longer owned and should delete itself
  73   // once it is invisible.
  74   void CloseSoon();
  75
  76   // Forwards a close request to our owner.  This is a no-op if we're already
  77   // unowned.
  78   void RemoveSelf();
  79
  80   // Changes the target height of the main ("bar") portion of the infobar.
  81   void SetBarTargetHeight(int height);
  82
  83   const gfx::SlideAnimation& animation() const { return animation_; }
  84   int arrow_height() const { return arrow_height_; }
  85   int arrow_target_height() const { return arrow_target_height_; }
  86   int arrow_half_width() const { return arrow_half_width_; }
  87   int total_height() const { return arrow_height_ + bar_height_; }
  88
  89  protected:
  90   // gfx::AnimationDelegate:
  91   void AnimationProgressed(const gfx::Animation* animation) override;
  92
  93   const InfoBarContainer* container() const { return container_; }
  94   InfoBarContainer* container() { return container_; }
  95   gfx::SlideAnimation* animation() { return &animation_; }
  96   int bar_height() const { return bar_height_; }
  97   int bar_target_height() const { return bar_target_height_; }
  98
  99   // Platforms may optionally override these if they need to do work during
 100   // processing of the given calls.
 101   virtual void PlatformSpecificSetOwner() {}
 102   virtual void PlatformSpecificShow(bool animate) {}
 103   virtual void PlatformSpecificHide(bool animate) {}
 104   virtual void PlatformSpecificOnCloseSoon() {}
 105   virtual void PlatformSpecificOnHeightsRecalculated() {}
 106
 107  private:
 108   // gfx::AnimationDelegate:
 109   void AnimationEnded(const gfx::Animation* animation) override;
 110
 111   // Finds the new desired arrow and bar heights, and if they differ from the
 112   // current ones, calls PlatformSpecificOnHeightRecalculated().  Informs our
 113   // container our state has changed if either the heights have changed or
 114   // |force_notify| is set.
 115   void RecalculateHeights(bool force_notify);
 116
 117   // Checks whether the infobar is unowned and done with all animations.  If so,
 118   // notifies the container that it should remove this infobar, and deletes
 119   // itself.
 120   void MaybeDelete();
 121
 122   InfoBarManager* owner_;
 123   scoped_ptr<InfoBarDelegate> delegate_;
 124   InfoBarContainer* container_;
 125   gfx::SlideAnimation animation_;
 126
 127   // The current and target heights of the arrow and bar portions, and half the
 128   // current arrow width.  (It's easier to work in half-widths as we draw the
 129   // arrow as two halves on either side of a center point.)  All these values
 130   // scale in unison to the container delegate's default and maximum values.
 131   int arrow_height_;         // Includes both fill and top stroke.
 132   int arrow_target_height_;  // Should always be set by the time we read it.
 133   int arrow_half_width_;     // Includes only fill.
 134   int bar_height_;           // Includes both fill and bottom separator.
 135   int bar_target_height_;    // May be left as -1, meaning "use default".
 136
 137   DISALLOW_COPY_AND_ASSIGN(InfoBar);
 138 };
 139
 140 }  // namespace infobars
 141
 142 #endif  // COMPONENTS_INFOBARS_CORE_INFOBAR_H_