123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305 |
- // Copyright 2014 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 COMPONENTS_INFOBARS_CORE_INFOBAR_DELEGATE_H_
- #define COMPONENTS_INFOBARS_CORE_INFOBAR_DELEGATE_H_
- #include <string>
- #include "base/memory/raw_ptr.h"
- #include "build/build_config.h"
- #include "ui/base/models/image_model.h"
- #include "ui/base/window_open_disposition.h"
- #include "url/gurl.h"
- class ConfirmInfoBarDelegate;
- class HungRendererInfoBarDelegate;
- class ThemeInstalledInfoBarDelegate;
- namespace blocked_content {
- class PopupBlockedInfoBarDelegate;
- }
- #if BUILDFLAG(IS_ANDROID)
- namespace offline_pages {
- class OfflinePageInfoBarDelegate;
- }
- #endif
- namespace translate {
- class TranslateInfoBarDelegate;
- }
- namespace gfx {
- class Image;
- struct VectorIcon;
- }
- namespace infobars {
- class InfoBar;
- // 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
- // 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,
- };
- enum InfoBarAutomationType {
- CONFIRM_INFOBAR,
- PASSWORD_INFOBAR,
- RPH_INFOBAR,
- UNKNOWN_INFOBAR,
- };
- // Unique identifier for every InfoBarDelegate subclass. Use suffixes to mark
- // infobars specific to particular OSes/platforms.
- // KEEP IN SYNC WITH THE InfoBarIdentifier ENUM IN enums.xml.
- // NEW VALUES MUST BE APPENDED AND AVOID CHANGING ANY PRE-EXISTING VALUES.
- // A Java counterpart will be generated for this enum.
- // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.infobar
- enum InfoBarIdentifier {
- INVALID = -1,
- TEST_INFOBAR = 0,
- // Removed: APP_BANNER_INFOBAR_DELEGATE = 1,
- // Removed: APP_BANNER_INFOBAR_DELEGATE_DESKTOP = 2,
- // Removed: ANDROID_DOWNLOAD_MANAGER_DUPLICATE_INFOBAR_DELEGATE = 3,
- DUPLICATE_DOWNLOAD_INFOBAR_DELEGATE_ANDROID = 4,
- // Removed: DOWNLOAD_REQUEST_INFOBAR_DELEGATE_ANDROID = 5,
- // Removed: FULLSCREEN_INFOBAR_DELEGATE = 6,
- HUNG_PLUGIN_INFOBAR_DELEGATE = 7,
- HUNG_RENDERER_INFOBAR_DELEGATE_ANDROID = 8,
- // Removed: MEDIA_STREAM_INFOBAR_DELEGATE_ANDROID = 9,
- // Removed: MEDIA_THROTTLE_INFOBAR_DELEGATE = 10,
- // Removed: REQUEST_QUOTA_INFOBAR_DELEGATE = 11,
- DEV_TOOLS_INFOBAR_DELEGATE = 12,
- EXTENSION_DEV_TOOLS_INFOBAR_DELEGATE = 13,
- INCOGNITO_CONNECTABILITY_INFOBAR_DELEGATE = 14,
- THEME_INSTALLED_INFOBAR_DELEGATE = 15,
- // Removed: GEOLOCATION_INFOBAR_DELEGATE_ANDROID = 16,
- THREE_D_API_INFOBAR_DELEGATE = 17,
- // Removed: INSECURE_CONTENT_INFOBAR_DELEGATE = 18,
- // Removed: MIDI_PERMISSION_INFOBAR_DELEGATE_ANDROID = 19,
- // Removed: PROTECTED_MEDIA_IDENTIFIER_INFOBAR_DELEGATE_ANDROID = 20,
- NACL_INFOBAR_DELEGATE = 21,
- // Removed: DATA_REDUCTION_PROXY_INFOBAR_DELEGATE_ANDROID = 22,
- // Removed: NOTIFICATION_PERMISSION_INFOBAR_DELEGATE = 23,
- // Removed: AUTO_SIGNIN_FIRST_RUN_INFOBAR_DELEGATE = 24,
- GENERATED_PASSWORD_SAVED_INFOBAR_DELEGATE_ANDROID = 25,
- SAVE_PASSWORD_INFOBAR_DELEGATE_MOBILE = 26,
- // Removed: PEPPER_BROKER_INFOBAR_DELEGATE = 27,
- PERMISSION_UPDATE_INFOBAR_DELEGATE_ANDROID = 28,
- // Removed: DURABLE_STORAGE_PERMISSION_INFOBAR_DELEGATE_ANDROID = 29,
- // Removed: NPAPI_REMOVAL_INFOBAR_DELEGATE = 30,
- OUTDATED_PLUGIN_INFOBAR_DELEGATE = 31,
- // Removed: PLUGIN_METRO_MODE_INFOBAR_DELEGATE = 32,
- RELOAD_PLUGIN_INFOBAR_DELEGATE = 33,
- PLUGIN_OBSERVER_INFOBAR_DELEGATE = 34,
- // Removed: SSL_ADD_CERTIFICATE = 35,
- // Removed: SSL_ADD_CERTIFICATE_INFOBAR_DELEGATE = 36,
- POPUP_BLOCKED_INFOBAR_DELEGATE_MOBILE = 37,
- FILE_ACCESS_DISABLED_INFOBAR_DELEGATE = 38,
- KEYSTONE_PROMOTION_INFOBAR_DELEGATE_MAC = 39,
- COLLECTED_COOKIES_INFOBAR_DELEGATE = 40,
- INSTALLATION_ERROR_INFOBAR_DELEGATE = 41,
- ALTERNATE_NAV_INFOBAR_DELEGATE = 42,
- BAD_FLAGS_INFOBAR_DELEGATE = 43,
- DEFAULT_BROWSER_INFOBAR_DELEGATE = 44,
- GOOGLE_API_KEYS_INFOBAR_DELEGATE = 45,
- OBSOLETE_SYSTEM_INFOBAR_DELEGATE = 46,
- SESSION_CRASHED_INFOBAR_DELEGATE_IOS = 47,
- PAGE_INFO_INFOBAR_DELEGATE = 48,
- AUTOFILL_CC_INFOBAR_DELEGATE_MOBILE = 49,
- TRANSLATE_INFOBAR_DELEGATE_NON_AURA = 50,
- // Removed: IOS_CHROME_SAVE_PASSWORD_INFOBAR_DELEGATE = 51,
- // Removed: NATIVE_APP_INSTALLER_INFOBAR_DELEGATE = 52,
- // Removed: NATIVE_APP_LAUNCHER_INFOBAR_DELEGATE = 53,
- // Removed: NATIVE_APP_OPEN_POLICY_INFOBAR_DELEGATE = 54,
- RE_SIGN_IN_INFOBAR_DELEGATE_IOS = 55,
- SHOW_PASSKIT_ERROR_INFOBAR_DELEGATE_IOS = 56,
- // Removed: READER_MODE_INFOBAR_DELEGATE_IOS = 57,
- SYNC_ERROR_INFOBAR_DELEGATE_IOS = 58,
- UPGRADE_INFOBAR_DELEGATE_IOS = 59,
- // Removed: WINDOW_ERROR_INFOBAR_DELEGATE_ANDROID = 60,
- DANGEROUS_DOWNLOAD_INFOBAR_DELEGATE_ANDROID = 61,
- // Removed: DESKTOP_SEARCH_REDIRECTION_INFOBAR_DELEGATE = 62,
- UPDATE_PASSWORD_INFOBAR_DELEGATE_MOBILE = 63,
- // Removed: DATA_REDUCTION_PROMO_INFOBAR_DELEGATE_ANDROID = 64,
- AUTOFILL_CREDIT_CARD_FILLING_INFOBAR_DELEGATE_ANDROID = 65,
- ADS_BLOCKED_INFOBAR_DELEGATE_ANDROID = 66,
- INSTANT_APPS_INFOBAR_DELEGATE_ANDROID = 67,
- // Removed: DATA_REDUCTION_PROXY_PREVIEW_INFOBAR_DELEGATE = 68,
- // Removed: SCREEN_CAPTURE_INFOBAR_DELEGATE_ANDROID = 69,
- GROUPED_PERMISSION_INFOBAR_DELEGATE_ANDROID = 70,
- OFFLINE_PAGE_INFOBAR_DELEGATE_ANDROID = 71,
- SEARCH_GEOLOCATION_DISCLOSURE_INFOBAR_DELEGATE_ANDROID = 72,
- AUTOMATION_INFOBAR_DELEGATE = 73,
- // Removed: VR_SERVICES_UPGRADE_ANDROID = 74,
- READER_MODE_INFOBAR_ANDROID = 75,
- VR_FEEDBACK_INFOBAR_ANDROID = 76,
- // Removed: FRAMEBUST_BLOCK_INFOBAR_ANDROID = 77,
- SURVEY_INFOBAR_ANDROID = 78,
- NEAR_OOM_INFOBAR_ANDROID = 79,
- INSTALLABLE_AMBIENT_BADGE_INFOBAR_DELEGATE = 80,
- // Removed: PAGE_LOAD_CAPPING_INFOBAR_DELEGATE = 81,
- DOWNLOAD_PROGRESS_INFOBAR_ANDROID = 82,
- // Removed: AR_CORE_UPGRADE_ANDROID = 83,
- BLOATED_RENDERER_INFOBAR_DELEGATE = 84,
- // Removed: SUPERVISED_USERS_DEPRECATED_INFOBAR_DELEGATE = 85,
- NEAR_OOM_REDUCTION_INFOBAR_ANDROID = 86,
- // Removed: LITE_PAGE_PREVIEWS_INFOBAR = 87,
- // Removed: MODULE_INSTALL_FAILURE_INFOBAR_ANDROID = 88,
- // Removed: INLINE_UPDATE_READY_INFOBAR_ANDROID = 89,
- // Removed: INLINE_UPDATE_FAILED_INFOBAR_ANDROID = 90,
- // Removed: FLASH_DEPRECATION_INFOBAR_DELEGATE = 91,
- SEND_TAB_TO_SELF_INFOBAR_DELEGATE = 92,
- TAB_SHARING_INFOBAR_DELEGATE = 93,
- SAFETY_TIP_INFOBAR_DELEGATE = 94,
- WEBOTP_SERVICE_INFOBAR_DELEGATE = 95,
- KNOWN_INTERCEPTION_DISCLOSURE_INFOBAR_DELEGATE = 96,
- SYNC_ERROR_INFOBAR_DELEGATE_ANDROID = 97,
- MIXED_CONTENT_DOWNLOAD_INFOBAR_DELEGATE_ANDROID = 98,
- // Removed: CONDITIONAL_TAB_STRIP_INFOBAR_ANDROID = 99,
- // Removed: LITE_MODE_HTTPS_IMAGE_COMPRESSION_INFOBAR_ANDROID = 100,
- // Removed: SYSTEM_INFOBAR_DELEGATE_MAC = 101,
- EXPERIMENTAL_INFOBAR_DELEGATE_LACROS = 102,
- // Removed: ROSETTA_REQUIRED_INFOBAR_DELEGATE = 103,
- // Removed: WEBID_PERMISSION_INFOBAR_DELEGATE = 104,
- AUTOFILL_OFFER_NOTIFICATION_INFOBAR_DELEGATE = 105,
- AUTOFILL_ADDRESS_PROFILE_INFOBAR_DELEGATE_IOS = 106,
- ADD_TO_READING_LIST_IOS = 107,
- IOS_PERMISSIONS_INFOBAR_DELEGATE = 108,
- SUPPORTED_LINKS_INFOBAR_DELEGATE_CHROMEOS = 109,
- AUTOFILL_VIRTUAL_CARD_ENROLLMENT_INFOBAR_DELEGATE_MOBILE = 110,
- };
- // Describes navigation events, used to decide whether infobars should be
- // dismissed.
- struct NavigationDetails {
- // Unique identifier for the entry.
- int entry_id;
- // True if it is a navigation to a different page (as opposed to in-page).
- bool is_navigation_to_different_page;
- // True if the entry replaced the existing one.
- bool did_replace_entry;
- bool is_reload;
- bool is_redirect;
- // True if the navigation was caused by a form submission.
- bool is_form_submission = false;
- };
- // Value to use when the InfoBar has no icon to show.
- static const int kNoIconID;
- InfoBarDelegate(const InfoBarDelegate&) = delete;
- InfoBarDelegate& operator=(const InfoBarDelegate&) = delete;
- // Called when the InfoBar that owns this delegate is being destroyed. At
- // this point nothing is visible onscreen.
- virtual ~InfoBarDelegate();
- // Returns a unique value identifying the infobar.
- // New implementers must append a new value to the InfoBarIdentifier enum here
- // and in histograms/enums.xml.
- virtual InfoBarIdentifier GetIdentifier() const = 0;
- virtual InfoBarAutomationType GetInfoBarAutomationType() const;
- // Returns the resource ID of the icon to be shown for this InfoBar. If the
- // value is equal to |kNoIconID|, GetIcon() will not show an icon by default.
- virtual int GetIconId() const;
- // Returns the vector icon identifier to be shown for this InfoBar. This will
- // take precedence over GetIconId() (although typically only one of the two
- // should be defined for any given infobar).
- virtual const gfx::VectorIcon& GetVectorIcon() const;
- // Returns the icon to be shown for this InfoBar. If the returned Image is
- // empty, no icon is shown.
- //
- // Most subclasses should not override this; override GetIconId() instead
- // unless the infobar needs to show an image from somewhere other than the
- // resource bundle as its icon.
- virtual ui::ImageModel GetIcon() const;
- // Returns the text of the link to be displayed, if any. Otherwise returns
- // an empty string.
- virtual std::u16string GetLinkText() const;
- // Returns the URL the link should navigate to.
- virtual GURL GetLinkURL() const;
- // 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
- // InfoBarManager when determining whether or not a delegate should be
- // added because a matching one already exists. If this function returns true,
- // the InfoBarManager 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. By default this returns true if the navigation is to a new
- // page (not including reloads). Subclasses wishing to change this behavior
- // can override this function.
- virtual bool ShouldExpire(const NavigationDetails& details) const;
- // Called when the link (if any) is clicked; if this function returns true,
- // the infobar is then immediately closed. The default implementation opens
- // the URL returned by GetLinkURL(), above, and returns false. Subclasses MUST
- // NOT return true if in handling this call something triggers the infobar to
- // begin closing.
- //
- // The |disposition| specifies how the resulting document should be loaded
- // (based on the event flags present when the link was clicked).
- virtual bool LinkClicked(WindowOpenDisposition disposition);
- // Called when the user clicks on the close button to dismiss the infobar.
- virtual void InfoBarDismissed();
- // Returns true if the InfoBar has a close button; true by default.
- virtual bool IsCloseable() const;
- // Returns true if the InfoBar should animate when showing or hiding; true by
- // default.
- virtual bool ShouldAnimate() const;
- // Type-checking downcast routines:
- virtual ConfirmInfoBarDelegate* AsConfirmInfoBarDelegate();
- virtual HungRendererInfoBarDelegate* AsHungRendererInfoBarDelegate();
- virtual blocked_content::PopupBlockedInfoBarDelegate*
- AsPopupBlockedInfoBarDelegate();
- virtual ThemeInstalledInfoBarDelegate* AsThemePreviewInfobarDelegate();
- virtual translate::TranslateInfoBarDelegate* AsTranslateInfoBarDelegate();
- #if BUILDFLAG(IS_ANDROID)
- virtual offline_pages::OfflinePageInfoBarDelegate*
- AsOfflinePageInfoBarDelegate();
- #endif
- void set_infobar(InfoBar* infobar) { infobar_ = infobar; }
- void set_nav_entry_id(int nav_entry_id) { nav_entry_id_ = nav_entry_id; }
- protected:
- InfoBarDelegate();
- InfoBar* infobar() { return infobar_; }
- private:
- // The InfoBar associated with us.
- raw_ptr<InfoBar> infobar_ = nullptr;
- // The ID of the active navigation entry at the time we became owned.
- int nav_entry_id_ = 0;
- };
- } // namespace infobars
- #endif // COMPONENTS_INFOBARS_CORE_INFOBAR_DELEGATE_H_
|