| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ | 5 #ifndef CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ |
| 6 #define CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ | 6 #define CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ |
| 7 | 7 |
| 8 #include <vector> | 8 #include <vector> |
| 9 | 9 |
| 10 #include "base/memory/scoped_ptr.h" | 10 #include "base/memory/scoped_ptr.h" |
| 11 #include "content/public/browser/web_contents_observer.h" | 11 #include "content/public/browser/web_contents_observer.h" |
| 12 #include "content/public/browser/web_contents_user_data.h" | 12 #include "content/public/browser/web_contents_user_data.h" |
| 13 | 13 |
| 14 class InfoBar; | 14 class InfoBarDelegate; |
| 15 | 15 |
| 16 // Provides access to creating, removing and enumerating info bars | 16 // Provides access to creating, removing and enumerating info bars |
| 17 // attached to a tab. | 17 // attached to a tab. |
| 18 class InfoBarService : public content::WebContentsObserver, | 18 class InfoBarService : public content::WebContentsObserver, |
| 19 public content::WebContentsUserData<InfoBarService> { | 19 public content::WebContentsUserData<InfoBarService> { |
| 20 public: | 20 public: |
| 21 // Changes whether infobars are enabled. The default is true. | 21 // Changes whether infobars are enabled. The default is true. |
| 22 void set_infobars_enabled(bool enabled) { infobars_enabled_ = enabled; } | 22 void set_infobars_enabled(bool enabled) { infobars_enabled_ = enabled; } |
| 23 | 23 |
| 24 // Adds the specified |infobar|, which already owns a delegate. | 24 // Adds an InfoBar for the specified |delegate|. |
| 25 // | 25 // |
| 26 // If infobars are disabled for this tab or the tab already has an infobar | 26 // If infobars are disabled for this tab or the tab already has a delegate |
| 27 // whose delegate returns true for | 27 // which returns true for InfoBarDelegate::EqualsDelegate(delegate), |
| 28 // InfoBarDelegate::EqualsDelegate(infobar->delegate()), |infobar| is deleted | 28 // |delegate| is closed immediately without being added. |
| 29 // immediately without being added. | |
| 30 // | 29 // |
| 31 // Returns the infobar if it was successfully added. | 30 // Returns the delegate if it was successfully added. |
| 32 virtual InfoBar* AddInfoBar(scoped_ptr<InfoBar> infobar); | 31 InfoBarDelegate* AddInfoBar(scoped_ptr<InfoBarDelegate> infobar); |
| 33 | 32 |
| 34 // Removes the specified |infobar|. This in turn may close immediately or | 33 // Removes the InfoBar for the specified |delegate|. |
| 35 // animate closed; at the end the infobar will delete itself. | |
| 36 // | 34 // |
| 37 // If infobars are disabled for this tab, this will do nothing, on the | 35 // If infobars are disabled for this tab, this will do nothing, on the |
| 38 // assumption that the matching AddInfoBar() call will have already deleted | 36 // assumption that the matching AddInfoBar() call will have already closed the |
| 39 // the infobar (see above). | 37 // delegate (see above). |
| 40 void RemoveInfoBar(InfoBar* infobar); | 38 void RemoveInfoBar(InfoBarDelegate* infobar); |
| 41 | 39 |
| 42 // Replaces one infobar with another, without any animation in between. This | 40 // Replaces one infobar with another, without any animation in between. |
| 43 // will result in |old_infobar| being synchronously deleted. | |
| 44 // | 41 // |
| 45 // If infobars are disabled for this tab, |new_infobar| is deleted immediately | 42 // If infobars are disabled for this tab, |new_delegate| is closed immediately |
| 46 // without being added, and nothing else happens. | 43 // without being added, and nothing else happens. |
| 47 // | 44 // |
| 48 // Returns the new infobar if it was successfully added. | 45 // Returns the new delegate if it was successfully added. |
| 49 // | 46 // |
| 50 // NOTE: This does not perform any EqualsDelegate() checks like AddInfoBar(). | 47 // NOTE: This does not perform any EqualsDelegate() checks like AddInfoBar(). |
| 51 InfoBar* ReplaceInfoBar(InfoBar* old_infobar, | 48 InfoBarDelegate* ReplaceInfoBar(InfoBarDelegate* old_infobar, |
| 52 scoped_ptr<InfoBar> new_infobar); | 49 scoped_ptr<InfoBarDelegate> new_infobar); |
| 53 | 50 |
| 54 // Returns the number of infobars for this tab. | 51 // Returns the number of infobars for this tab. |
| 55 size_t infobar_count() const { return infobars_.size(); } | 52 size_t infobar_count() const { return infobars_.size(); } |
| 56 | 53 |
| 57 // Returns the infobar at the given |index|. The InfoBarService retains | 54 // Returns the infobar at the given |index|. The InfoBarService retains |
| 58 // ownership. | 55 // ownership. |
| 59 // | 56 // |
| 60 // Warning: Does not sanity check |index|. | 57 // Warning: Does not sanity check |index|. |
| 61 InfoBar* infobar_at(size_t index) { return infobars_[index]; } | 58 InfoBarDelegate* infobar_at(size_t index) { return infobars_[index]; } |
| 62 | 59 |
| 63 // Retrieve the WebContents for the tab this service is associated with. | 60 // Retrieve the WebContents for the tab this service is associated with. |
| 64 content::WebContents* web_contents() { | 61 content::WebContents* web_contents() { |
| 65 return content::WebContentsObserver::web_contents(); | 62 return content::WebContentsObserver::web_contents(); |
| 66 } | 63 } |
| 67 | 64 |
| 68 private: | 65 private: |
| 69 friend class content::WebContentsUserData<InfoBarService>; | 66 friend class content::WebContentsUserData<InfoBarService>; |
| 70 | 67 |
| 71 // InfoBars associated with this InfoBarService. We own these pointers. | 68 typedef std::vector<InfoBarDelegate*> InfoBars; |
| 72 // However, this is not a ScopedVector, because we don't delete the infobars | |
| 73 // directly once they've been added to this; instead, when we're done with an | |
| 74 // infobar, we instruct it to delete itself and then orphan it. See | |
| 75 // RemoveInfoBarInternal(). | |
| 76 typedef std::vector<InfoBar*> InfoBars; | |
| 77 | 69 |
| 70 // Delegates for InfoBars associated with this InfoBarService. We do not own |
| 71 // these pointers; they own themselves and are deleted in response to being |
| 72 // closed. |
| 73 // TODO(pkasting): These leak if closed while not visible. |
| 78 explicit InfoBarService(content::WebContents* web_contents); | 74 explicit InfoBarService(content::WebContents* web_contents); |
| 79 virtual ~InfoBarService(); | 75 virtual ~InfoBarService(); |
| 80 | 76 |
| 81 // content::WebContentsObserver: | 77 // content::WebContentsObserver: |
| 82 virtual void RenderProcessGone(base::TerminationStatus status) OVERRIDE; | 78 virtual void RenderProcessGone(base::TerminationStatus status) OVERRIDE; |
| 83 virtual void NavigationEntryCommitted( | 79 virtual void NavigationEntryCommitted( |
| 84 const content::LoadCommittedDetails& load_details) OVERRIDE; | 80 const content::LoadCommittedDetails& load_details) OVERRIDE; |
| 85 virtual void WebContentsDestroyed( | 81 virtual void WebContentsDestroyed( |
| 86 content::WebContents* web_contents) OVERRIDE; | 82 content::WebContents* web_contents) OVERRIDE; |
| 87 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; | 83 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; |
| 88 | 84 |
| 89 void RemoveInfoBarInternal(InfoBar* infobar, bool animate); | 85 void RemoveInfoBarInternal(InfoBarDelegate* infobar, bool animate); |
| 90 void RemoveAllInfoBars(bool animate); | 86 void RemoveAllInfoBars(bool animate); |
| 91 | 87 |
| 92 // Message handlers. | 88 // Message handlers. |
| 93 void OnDidBlockDisplayingInsecureContent(); | 89 void OnDidBlockDisplayingInsecureContent(); |
| 94 void OnDidBlockRunningInsecureContent(); | 90 void OnDidBlockRunningInsecureContent(); |
| 95 | 91 |
| 96 InfoBars infobars_; | 92 InfoBars infobars_; |
| 97 bool infobars_enabled_; | 93 bool infobars_enabled_; |
| 98 | 94 |
| 99 DISALLOW_COPY_AND_ASSIGN(InfoBarService); | 95 DISALLOW_COPY_AND_ASSIGN(InfoBarService); |
| 100 }; | 96 }; |
| 101 | 97 |
| 102 #endif // CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ | 98 #endif // CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_ |
| OLD | NEW |