| // Copyright (c) 2012 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. |
| |
| // The LocationBar class is a virtual interface, defining access to the |
| // window's location bar component. This class exists so that cross-platform |
| // components like the browser command system can talk to the platform |
| // specific implementations of the location bar control. It also allows the |
| // location bar to be mocked for testing. |
| |
| #ifndef CHROME_BROWSER_UI_OMNIBOX_LOCATION_BAR_H_ |
| #define CHROME_BROWSER_UI_OMNIBOX_LOCATION_BAR_H_ |
| |
| #include <string> |
| |
| #include "base/strings/string16.h" |
| #include "content/public/common/page_transition_types.h" |
| #include "ui/base/window_open_disposition.h" |
| |
| class ExtensionAction; |
| class LocationBarTesting; |
| class OmniboxView; |
| |
| namespace content { |
| class WebContents; |
| } |
| |
| class LocationBar { |
| public: |
| // Shows the first run bubble anchored to the location bar. |
| virtual void ShowFirstRunBubble() = 0; |
| |
| // Returns the string of text entered in the location bar. |
| virtual string16 GetInputString() const = 0; |
| |
| // Returns the WindowOpenDisposition that should be used to determine where |
| // to open a URL entered in the location bar. |
| virtual WindowOpenDisposition GetWindowOpenDisposition() const = 0; |
| |
| // Returns the PageTransition that should be recorded in history when the URL |
| // entered in the location bar is loaded. |
| virtual content::PageTransition GetPageTransition() const = 0; |
| |
| // Accepts the current string of text entered in the location bar. |
| virtual void AcceptInput() = 0; |
| |
| // Focuses the location bar. Optionally also selects its contents. |
| virtual void FocusLocation(bool select_all) = 0; |
| |
| // Clears the location bar, inserts an annoying little "?" turd and sets |
| // focus to it. |
| virtual void FocusSearch() = 0; |
| |
| // Updates the state of the images showing the content settings status. |
| virtual void UpdateContentSettingsIcons() = 0; |
| |
| // Updates the state of the page actions. |
| virtual void UpdatePageActions() = 0; |
| |
| // Called when the page-action data needs to be refreshed, e.g. when an |
| // extension is unloaded or crashes. |
| virtual void InvalidatePageActions() = 0; |
| |
| // Updates the state of the button to open a PDF in Adobe Reader. |
| virtual void UpdateOpenPDFInReaderPrompt() = 0; |
| |
| // Updates the generated credit card view. This view serves as an anchor for |
| // the generated credit card bubble, which can show on successful generation |
| // of a new credit card number. |
| virtual void UpdateGeneratedCreditCardView() = 0; |
| |
| // Saves the state of the location bar to the specified WebContents, so that |
| // it can be restored later. (Done when switching tabs). |
| virtual void SaveStateToContents(content::WebContents* contents) = 0; |
| |
| // Reverts the location bar. The bar's permanent text will be shown. |
| virtual void Revert() = 0; |
| |
| // Returns a pointer to the text entry view. |
| virtual const OmniboxView* GetLocationEntry() const = 0; |
| virtual OmniboxView* GetLocationEntry() = 0; |
| |
| // Returns a pointer to the testing interface. |
| virtual LocationBarTesting* GetLocationBarForTesting() = 0; |
| |
| protected: |
| virtual ~LocationBar() {} |
| }; |
| |
| class LocationBarTesting { |
| public: |
| // Returns the total number of page actions in the Omnibox. |
| virtual int PageActionCount() = 0; |
| |
| // Returns the number of visible page actions in the Omnibox. |
| virtual int PageActionVisibleCount() = 0; |
| |
| // Returns the ExtensionAction at |index|. |
| virtual ExtensionAction* GetPageAction(size_t index) = 0; |
| |
| // Returns the visible ExtensionAction at |index|. |
| virtual ExtensionAction* GetVisiblePageAction(size_t index) = 0; |
| |
| // Simulates a left mouse pressed on the visible page action at |index|. |
| virtual void TestPageActionPressed(size_t index) = 0; |
| |
| // Returns whether or not the bookmark star decoration is visible. |
| virtual bool GetBookmarkStarVisibility() = 0; |
| |
| protected: |
| virtual ~LocationBarTesting() {} |
| }; |
| |
| #endif // CHROME_BROWSER_UI_OMNIBOX_LOCATION_BAR_H_ |