1 // Copyright 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_UI_TOOLBAR_TOOLBAR_MODEL_H_ 6 #define CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_ 7 8 #include <string> 9 10 #include "base/basictypes.h" 11 #include "base/strings/string16.h" 12 #include "url/gurl.h" 13 14 namespace net { 15 class X509Certificate; 16 } 17 18 // This class is the model used by the toolbar, location bar and autocomplete 19 // edit. It populates its states from the current navigation entry retrieved 20 // from the navigation controller returned by GetNavigationController(). 21 class ToolbarModel { 22 public: 23 // TODO(wtc): unify ToolbarModel::SecurityLevel with SecurityStyle. We 24 // don't need two sets of security UI levels. SECURITY_STYLE_AUTHENTICATED 25 // needs to be refined into three levels: warning, standard, and EV. 26 enum SecurityLevel { 27 #define DEFINE_TOOLBAR_MODEL_SECURITY_LEVEL(name,value) name = value, 28 #include "chrome/browser/ui/toolbar/toolbar_model_security_level_list.h" 29 #undef DEFINE_TOOLBAR_MODEL_SECURITY_LEVEL 30 }; 31 32 virtual ~ToolbarModel(); 33 34 // Returns the text to be displayed in the toolbar for the current page. 35 // The text is formatted in various ways: 36 // - If the current page's URL is a search URL for the user's default search 37 // engine, the query will be extracted and returned for display instead 38 // of the URL. 39 // - If the origin chip is enabled and visible, the text will be empty. 40 // - Otherwise, the text will contain the URL returned by GetFormattedURL(). 41 virtual base::string16 GetText() const = 0; 42 43 // Returns a formatted URL for display in the toolbar. The formatting 44 // includes: 45 // - Some characters may be unescaped. 46 // - The scheme and/or trailing slash may be dropped. 47 // If |prefix_end| is non-NULL, it is set to the length of the pre-hostname 48 // portion of the resulting URL. 49 virtual base::string16 GetFormattedURL(size_t* prefix_end) const = 0; 50 51 // Some search URLs bundle a special "corpus" param that we can extract and 52 // display next to users' search terms in cases where we'd show the search 53 // terms instead of the URL anyway. For example, a Google image search might 54 // show the corpus "Images:" plus a search string. This is only used on 55 // mobile. 56 virtual base::string16 GetCorpusNameForMobile() const = 0; 57 58 // Returns the URL of the current navigation entry. 59 virtual GURL GetURL() const = 0; 60 61 // Returns true if a call to GetText() would successfully replace the URL 62 // with search terms. If |ignore_editing| is true, the result reflects the 63 // underlying state of the page without regard to any user edits that may be 64 // in progress in the omnibox. 65 virtual bool WouldPerformSearchTermReplacement(bool ignore_editing) const = 0; 66 67 // Returns true if a call to GetText() would return something other than the 68 // URL because of either search term replacement or URL omission in favor of 69 // the origin chip. 70 bool WouldReplaceURL() const; 71 72 // Returns the security level that the toolbar should display. If 73 // |ignore_editing| is true, the result reflects the underlying state of the 74 // page without regard to any user edits that may be in progress in the 75 // omnibox. 76 virtual SecurityLevel GetSecurityLevel(bool ignore_editing) const = 0; 77 78 // Returns the resource_id of the icon to show to the left of the address, 79 // based on the current URL. When search term replacement is active, this 80 // returns a search icon. This doesn't cover specialized icons while the 81 // user is editing; see OmniboxView::GetIcon(). 82 virtual int GetIcon() const = 0; 83 84 // As |GetIcon()|, but returns the icon only taking into account the security 85 // |level| given, ignoring search term replacement state. 86 virtual int GetIconForSecurityLevel(SecurityLevel level) const = 0; 87 88 // Returns the name of the EV cert holder. This returns an empty string if 89 // the security level is not EV_SECURE. 90 virtual base::string16 GetEVCertName() const = 0; 91 92 // Returns whether the URL for the current navigation entry should be 93 // in the location bar. 94 virtual bool ShouldDisplayURL() const = 0; 95 96 // Returns true if a call to GetText() would return an empty string instead of 97 // the URL that would have otherwise been displayed because the host/origin is 98 // instead being displayed in the origin chip. This returns false when we 99 // wouldn't have displayed a URL to begin with (e.g. for the NTP). 100 virtual bool WouldOmitURLDueToOriginChip() const = 0; 101 102 // Returns true if the origin should be shown based on the current state of 103 // the ToolbarModel. 104 bool ShouldShowOriginChip() const; 105 106 // Whether the text in the omnibox is currently being edited. 107 void set_input_in_progress(bool input_in_progress) { 108 input_in_progress_ = input_in_progress; 109 } 110 bool input_in_progress() const { return input_in_progress_; } 111 112 // Whether the origin chip should be enabled. 113 void set_origin_chip_enabled(bool enabled) { 114 origin_chip_enabled_ = enabled; 115 } 116 bool origin_chip_enabled() const { 117 return origin_chip_enabled_; 118 } 119 120 // Whether URL replacement should be enabled. 121 void set_url_replacement_enabled(bool enabled) { 122 url_replacement_enabled_ = enabled; 123 } 124 bool url_replacement_enabled() const { 125 return url_replacement_enabled_; 126 } 127 128 protected: 129 ToolbarModel(); 130 131 private: 132 bool input_in_progress_; 133 bool origin_chip_enabled_; 134 bool url_replacement_enabled_; 135 136 DISALLOW_COPY_AND_ASSIGN(ToolbarModel); 137 }; 138 139 #endif // CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_ 140
