Implement {Start,Stop}CapturingKeyStrokes for Instant.

chrome/browser/ui/omnibox/omnibox_edit_model.h

 // Copyright 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 CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 19 matching lines @@
 class Image;
 class Rect;
 }
 
 class OmniboxEditModel : public AutocompleteControllerDelegate {
  public:
   struct State {
     State(bool user_input_in_progress,
           const string16& user_text,
           const string16& keyword,
-          bool is_keyword_hint);
+          bool is_keyword_hint,
+          bool is_caret_visible);
     ~State();
 
     bool user_input_in_progress;
     const string16 user_text;
     const string16 keyword;
     const bool is_keyword_hint;
+    const bool is_caret_visible;
   };
 
   OmniboxEditModel(OmniboxView* view,
                    OmniboxEditController* controller,
                    Profile* profile);
   virtual ~OmniboxEditModel();
 
   AutocompleteController* autocomplete_controller() const {
     return autocomplete_controller_.get();
   }
@@ skipping 126 matching lines @@
   void AcceptInput(WindowOpenDisposition disposition,
                    bool for_drop);
 
   // Asks the browser to load the item at |index|, with the given properties.
   void OpenMatch(const AutocompleteMatch& match,
                  WindowOpenDisposition disposition,
                  const GURL& alternate_nav_url,
                  size_t index);
 
   bool has_focus() const { return has_focus_; }
+  bool is_caret_visible() const { return is_caret_visible_; }
 
   // Accessors for keyword-related state (see comments on keyword_ and
   // is_keyword_hint_).
   const string16& keyword() const { return keyword_; }
   bool is_keyword_hint() const { return is_keyword_hint_; }
 
   // Accepts the current keyword hint as a keyword. It always returns true for
   // caller convenience.
   bool AcceptKeyword();
 
   // Clears the current keyword.  |visible_text| is the (non-keyword) text
   // currently visible in the edit.
   void ClearKeyword(const string16& visible_text);
 
   // Returns the current autocomplete result.  This logic should in the future
   // live in AutocompleteController but resides here for now.  This method is
   // used by AutomationProvider::AutocompleteEditGetMatches.
   const AutocompleteResult& result() const;
 
   // Called when the view is gaining focus.  |control_down| is whether the
   // control key is down (at the time we're gaining focus).
   void OnSetFocus(bool control_down);
 
+  // Sets the visibility of the caret in the omnibox, if it has focus. The
+  // visibility of the caret is reset to visible if any of the following
+  // happens:
+  // - User starts typing in the omnibox
+  // - User clicks in the omnibox
+  // - Omnibox loses and then regains focus
+  // - SetFocus() is explicitly called again
+  // Caret visibility is tracked per-tab and updates automatically upon
+  // switching tabs.
+  void SetCaretVisibility(bool visible);
+
   // Sent before |OnKillFocus| and before the popup is closed.
   void OnWillKillFocus(gfx::NativeView view_gaining_focus);
 
   // Called when the view is losing focus.  Resets some state.
   void OnKillFocus();
 
   // Called when the user presses the escape key.  Decides what, if anything, to
   // revert about any current edits.  Returns whether the key was handled.
   bool OnEscapeKeyPressed();
 
@@ skipping 171 matching lines @@
 
   OmniboxView* view_;
 
   OmniboxPopupModel* popup_;
 
   OmniboxEditController* controller_;
 
   // Whether the edit has focus.
   bool has_focus_;
 
+  // Is the caret visible? Only meaningful if has_focus_ is true.
+  bool is_caret_visible_;
+
   // The URL of the currently displayed page.
   string16 permanent_text_;
 
   // This flag is true when the user has modified the contents of the edit, but
   // not yet accepted them.  We use this to determine when we need to save
   // state (on switching tabs) and whether changes to the page URL should be
   // immediately displayed.
   // This flag will be true in a superset of the cases where the popup is open.
   bool user_input_in_progress_;
 
@@ skipping 87 matching lines @@
   // an exact keyword match.  If this is true then keyword mode will be
   // triggered automatically if the input is "<keyword> <search string>".  We
   // allow this when CreatedKeywordSearchByInsertingSpaceInMiddle() is true.
   // This has no effect if we're already in keyword mode.
   bool allow_exact_keyword_match_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxEditModel);
 };
 
 #endif  // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_