blob: dd1247263ecb96ee28694ca0cb4924a4157ce633 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
// 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_TAB_CONTENTS_INFOBAR_DELEGATE_H_
#define CHROME_BROWSER_TAB_CONTENTS_INFOBAR_DELEGATE_H_
#pragma once
#include "base/basictypes.h"
#include "base/string16.h"
#include "content/browser/tab_contents/navigation_controller.h"
#include "webkit/glue/window_open_disposition.h"
class ConfirmInfoBarDelegate;
class ExtensionInfoBarDelegate;
class InfoBar;
class LinkInfoBarDelegate;
class PluginInstallerInfoBarDelegate;
class ThemeInstalledInfoBarDelegate;
class TranslateInfoBarDelegate;
namespace gfx {
class Image;
}
// An interface implemented by objects wishing to control an InfoBar.
// Implementing this interface is not sufficient to use an InfoBar, since it
// does not map to a specific InfoBar type. Instead, you must implement either
// LinkInfoBarDelegate or ConfirmInfoBarDelegate, or override with your own
// delegate for your own InfoBar variety.
class InfoBarDelegate {
public:
// The type of the infobar. It controls its appearance, such as its background
// color.
enum Type {
WARNING_TYPE,
PAGE_ACTION_TYPE,
};
virtual ~InfoBarDelegate();
// Called to create the InfoBar. Implementation of this method is
// platform-specific.
virtual InfoBar* CreateInfoBar() = 0;
// Returns true if the supplied |delegate| is equal to this one. Equality is
// left to the implementation to define. This function is called by the
// TabContents when determining whether or not a delegate should be added
// because a matching one already exists. If this function returns true, the
// TabContents will not add the new delegate because it considers one to
// already be present.
virtual bool EqualsDelegate(InfoBarDelegate* delegate) const;
// Returns true if the InfoBar should be closed automatically after the page
// is navigated. The default behavior is to return true if the user initiated
// navigation somewhere else or reloaded.
virtual bool ShouldExpire(
const NavigationController::LoadCommittedDetails& details) const;
// Called when the user clicks on the close button to dismiss the infobar.
virtual void InfoBarDismissed();
// Called after the InfoBar is closed. Deletes |this|.
// TODO(pkasting): Get rid of this and delete delegates directly.
void InfoBarClosed();
// Return the icon to be shown for this InfoBar. If the returned Image is
// NULL, no icon is shown.
virtual gfx::Image* GetIcon() const;
// Returns the type of the infobar. The type determines the appearance (such
// as background color) of the infobar.
virtual Type GetInfoBarType() const;
// Type-checking downcast routines:
virtual ConfirmInfoBarDelegate* AsConfirmInfoBarDelegate();
virtual ExtensionInfoBarDelegate* AsExtensionInfoBarDelegate();
virtual LinkInfoBarDelegate* AsLinkInfoBarDelegate();
virtual PluginInstallerInfoBarDelegate* AsPluginInstallerInfoBarDelegate();
virtual ThemeInstalledInfoBarDelegate* AsThemePreviewInfobarDelegate();
virtual TranslateInfoBarDelegate* AsTranslateInfoBarDelegate();
protected:
// Provided to subclasses as a convenience to initialize the state of this
// object. If |contents| is non-NULL, its active entry's unique ID will be
// stored using StoreActiveEntryUniqueID automatically.
explicit InfoBarDelegate(TabContents* contents);
// Store the unique id for the active entry in the specified TabContents, to
// be used later upon navigation to determine if this InfoBarDelegate should
// be expired from |contents_|.
void StoreActiveEntryUniqueID(TabContents* contents);
// Returns true if the navigation is to a new URL or a reload occured.
bool ShouldExpireInternal(
const NavigationController::LoadCommittedDetails& details) const;
private:
// The unique id of the active NavigationEntry of the TabContents that we were
// opened for. Used to help expire on navigations.
int contents_unique_id_;
DISALLOW_COPY_AND_ASSIGN(InfoBarDelegate);
};
#endif // CHROME_BROWSER_TAB_CONTENTS_INFOBAR_DELEGATE_H_
|
