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