| // 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. |
| |
| #ifndef IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_IOS_H_ |
| #define IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_IOS_H_ |
| |
| #import <UIKit/UIKit.h> |
| |
| #include <memory> |
| |
| #include "components/omnibox/browser/location_bar_model.h" |
| #include "components/omnibox/browser/omnibox_view.h" |
| #import "ios/chrome/browser/ui/omnibox/omnibox_left_image_consumer.h" |
| #include "ios/chrome/browser/ui/omnibox/omnibox_text_change_delegate.h" |
| #import "ios/chrome/browser/ui/omnibox/omnibox_text_field_ios.h" |
| #include "ios/chrome/browser/ui/omnibox/popup/omnibox_popup_provider.h" |
| #import "ios/chrome/browser/ui/omnibox/popup/omnibox_popup_view_suggestions_delegate.h" |
| |
| class AutocompleteResult; |
| class ChromeBrowserState; |
| class GURL; |
| class WebOmniboxEditController; |
| struct AutocompleteMatch; |
| @class OmniboxTextFieldIOS; |
| @class OmniboxTextFieldPasteDelegate; |
| @protocol OmniboxCommands; |
| |
| // iOS implementation of OmniBoxView. Wraps a UITextField and |
| // interfaces with the rest of the autocomplete system. |
| class OmniboxViewIOS : public OmniboxView, |
| public OmniboxPopupViewSuggestionsDelegate, |
| public OmniboxTextChangeDelegate { |
| public: |
| // Retains |field|. |
| OmniboxViewIOS(OmniboxTextFieldIOS* field, |
| WebOmniboxEditController* controller, |
| id<OmniboxLeftImageConsumer> left_image_consumer, |
| ChromeBrowserState* browser_state, |
| id<OmniboxCommands> omnibox_focuser); |
| |
| ~OmniboxViewIOS() override; |
| |
| void SetPopupProvider(OmniboxPopupProvider* provider) { |
| popup_provider_ = provider; |
| } |
| |
| // Returns a color representing |security_level|, adjusted based on whether |
| // the browser is in Incognito mode. |
| static UIColor* GetSecureTextColor( |
| security_state::SecurityLevel security_level, |
| bool in_dark_mode); |
| |
| void OnReceiveClipboardURLForOpenMatch( |
| const AutocompleteMatch& match, |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t selected_line, |
| base::TimeTicks match_selection_timestamp, |
| base::Optional<GURL> optional_gurl); |
| |
| void OnReceiveClipboardTextForOpenMatch( |
| const AutocompleteMatch& match, |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t selected_line, |
| base::TimeTicks match_selection_timestamp, |
| base::Optional<std::u16string> optional_text); |
| |
| void OnReceiveClipboardImageForOpenMatch( |
| const AutocompleteMatch& match, |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t selected_line, |
| base::TimeTicks match_selection_timestamp, |
| base::Optional<gfx::Image> optional_image); |
| |
| void OnReceiveImageMatchForOpenMatch( |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t selected_line, |
| base::TimeTicks match_selection_timestamp, |
| base::Optional<AutocompleteMatch> optional_match); |
| |
| // OmniboxView implementation. |
| void OpenMatch(const AutocompleteMatch& match, |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t selected_line, |
| base::TimeTicks match_selection_timestamp) override; |
| std::u16string GetText() const override; |
| void SetWindowTextAndCaretPos(const std::u16string& text, |
| size_t caret_pos, |
| bool update_popup, |
| bool notify_text_changed) override; |
| void SetCaretPos(size_t caret_pos) override; |
| void RevertAll() override; |
| void UpdatePopup() override; |
| void OnTemporaryTextMaybeChanged(const std::u16string& display_text, |
| const AutocompleteMatch& match, |
| bool save_original_selection, |
| bool notify_text_changed) override; |
| void OnInlineAutocompleteTextMaybeChanged(const std::u16string& display_text, |
| std::vector<gfx::Range> selections, |
| size_t user_text_length) override; |
| void OnBeforePossibleChange() override; |
| bool OnAfterPossibleChange(bool allow_keyword_ui_change) override; |
| bool IsImeComposing() const override; |
| bool IsIndicatingQueryRefinement() const override; |
| |
| // OmniboxView stubs. |
| void Update() override {} |
| void SetAdditionalText(const std::u16string& text) override {} |
| void EnterKeywordModeForDefaultSearchProvider() override {} |
| bool IsSelectAll() const override; |
| void GetSelectionBounds(std::u16string::size_type* start, |
| std::u16string::size_type* end) const override; |
| size_t GetAllSelectionsLength() const override; |
| void SelectAll(bool reversed) override {} |
| void SetFocus(bool is_user_initiated) override {} |
| void ApplyCaretVisibility() override {} |
| void OnInlineAutocompleteTextCleared() override {} |
| void OnRevertTemporaryText(const std::u16string& display_text, |
| const AutocompleteMatch& match) override {} |
| gfx::NativeView GetNativeView() const override; |
| gfx::NativeView GetRelativeWindowForPopup() const override; |
| |
| // OmniboxTextChangeDelegate methods |
| |
| void OnDidBeginEditing() override; |
| bool OnWillChange(NSRange range, NSString* new_text) override; |
| void OnDidChange(bool processing_user_input) override; |
| void OnWillEndEditing() override; |
| void EndEditing() override; |
| void OnAccept() override; |
| void OnCopy() override; |
| void ClearText() override; |
| void WillPaste() override; |
| void OnDeleteBackward() override; |
| |
| // OmniboxPopupViewSuggestionsDelegate methods |
| |
| void OnSelectedMatchImageChanged( |
| bool has_match, |
| AutocompleteMatchType::Type match_type, |
| base::Optional<SuggestionAnswer::AnswerType> answer_type, |
| GURL favicon_url) override; |
| void OnResultsChanged(const AutocompleteResult& result) override; |
| void OnPopupDidScroll() override; |
| void OnSelectedMatchForAppending(const std::u16string& str) override; |
| void OnSelectedMatchForOpening(AutocompleteMatch match, |
| WindowOpenDisposition disposition, |
| const GURL& alternate_nav_url, |
| const std::u16string& pasted_text, |
| size_t index) override; |
| |
| ChromeBrowserState* browser_state() { return browser_state_; } |
| |
| // Updates this edit view to show the proper text, highlight and images. |
| void UpdateAppearance(); |
| |
| // Updates the appearance of popup to have proper text alignment. |
| void UpdatePopupAppearance(); |
| |
| void OnClear(); |
| |
| // Hide keyboard only. Used when omnibox popups grab focus but editing isn't |
| // complete. |
| void HideKeyboard(); |
| |
| // Focus the omnibox field. This is used when the omnibox popup copies a |
| // search query to the omnibox so the user can modify it further. |
| // This does not affect the popup state and is a NOOP if the omnibox is |
| // already focused. |
| void FocusOmnibox(); |
| |
| // Returns |true| if AutocompletePopupView is currently open. |
| BOOL IsPopupOpen(); |
| |
| protected: |
| int GetOmniboxTextLength() const override; |
| void EmphasizeURLComponents() override {} |
| |
| private: |
| void SetEmphasis(bool emphasize, const gfx::Range& range) override {} |
| void UpdateSchemeStyle(const gfx::Range& scheme_range) override {} |
| |
| // Calculates text attributes according to |display_text| and |
| // returns them in an autoreleased object. |
| NSAttributedString* ApplyTextAttributes(const std::u16string& text); |
| |
| // Removes the query refinement chip from the omnibox. |
| void RemoveQueryRefinementChip(); |
| |
| // Returns true if user input should currently be ignored. On iOS7, |
| // modifying the contents of a text field while Siri is pending leads to a |
| // UIKit crash. In order to sidestep that crash, OmniboxViewIOS checks that |
| // voice search is not pending before attempting to process user actions that |
| // may modify text field contents. |
| // TODO(crbug.com/303212): Remove this workaround once the crash is fixed. |
| bool ShouldIgnoreUserInputDueToPendingVoiceSearch(); |
| |
| ChromeBrowserState* browser_state_; |
| |
| OmniboxTextFieldIOS* field_; |
| |
| OmniboxTextFieldPasteDelegate* paste_delegate_; |
| WebOmniboxEditController* controller_; // weak, owns us |
| __weak id<OmniboxLeftImageConsumer> left_image_consumer_; |
| // Focuser, used to transition the location bar to focused/defocused state as |
| // necessary. |
| __weak id<OmniboxCommands> omnibox_focuser_; |
| |
| State state_before_change_; |
| NSString* marked_text_before_change_; |
| NSRange current_selection_; |
| NSRange old_selection_; |
| |
| // TODO(rohitrao): This is a monster hack, needed because closing the popup |
| // ends up inadvertently triggering a new round of autocomplete. Fix the |
| // underlying problem, which is that textDidChange: is called when closing the |
| // popup, and then remove this hack. b/5877366. |
| BOOL ignore_popup_updates_; |
| |
| // iOS 10.3 fails to apply the strikethrough style unless an extra style is |
| // also applied. See https://crbug.com/699702 for discussion. |
| BOOL use_strikethrough_workaround_; |
| |
| // Temporary pointer to the attributed display string, stored as color and |
| // other emphasis attributes are applied by the superclass. |
| NSMutableAttributedString* attributing_display_string_; |
| |
| OmniboxPopupProvider* popup_provider_; // weak |
| |
| // Used to cancel clipboard callbacks if this is deallocated; |
| base::WeakPtrFactory<OmniboxViewIOS> weak_ptr_factory_{this}; |
| }; |
| |
| #endif // IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_IOS_H_ |