Implement the Instant extended API startMargin, endMargin, and rtl properties and the onmarginchang…

chrome/browser/instant/instant_controller.h

 // 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 CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_
 #define CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 73 matching lines @@
   // has typed. |full_text| is what the omnibox is showing. These may differ if
   // the user typed only some text, and the rest was inline autocompleted. If
   // |verbatim| is true, search results are shown for the exact omnibox text,
   // rather than the best guess as to what the user means. Returns true if the
   // update is accepted (i.e., if |match| is a search rather than a URL).
   bool Update(const AutocompleteMatch& match,
               const string16& user_text,
               const string16& full_text,
               bool verbatim);
 
-  // Sets the bounds of the omnibox dropdown, in screen coordinates.
-  void SetOmniboxBounds(const gfx::Rect& bounds);
+  // Sets the bounds of the omnibox popup, in screen coordinates.
+  void SetPopupBounds(const gfx::Rect& bounds);
+
+  // Sets the offset to the start and end point of the Instant page. Note that
+  // both offsets are calculated from the start edge of the page.
+  void SetMarginSize(int start, int end);
 
   // Send autocomplete results from |providers| to the preview page.
   void HandleAutocompleteResults(
       const std::vector<AutocompleteProvider*>& providers);
 
   // Called when the user presses up or down. |count| is a repeat count,
   // negative for moving up, positive for moving down. Returns true if Instant
   // handled the key press.
   bool OnUpOrDownKeyPressed(int count);
 
@@ skipping 95 matching lines @@
   // Calls OnStaleLoader if |stale_loader_timer_| is not running.
   void MaybeOnStaleLoader();
 
   // Destroys the |loader_| and its preview contents.
   void DeleteLoader();
 
   // Counterpart to Hide(). Asks the |browser_| to display the preview with
   // the given |height|.
   void Show(InstantShownReason reason, int height, InstantSizeUnits units);
 
-  // Send the omnibox dropdown bounds to the page.
+  // Send the omnibox popup bounds to the page.
   void SendBoundsToPage();
 
   // If |template_url| is a valid TemplateURL for use with Instant, fills in
   // |instant_url| and returns true; returns false otherwise.
   // Note: If the command-line switch kInstantURL is set, this method uses its
   // value for |instant_url| and returns true without examining |template_url|.
   bool GetInstantURL(const TemplateURL* template_url,
                      const GURL& tab_url,
                      std::string* instant_url) const;
 
@@ skipping 24 matching lines @@
 
   // True if the last match passed to Update() was a search (versus a URL).
   bool last_match_was_search_;
 
   // True if the omnibox is focused, false otherwise.
   bool is_omnibox_focused_;
 
   // True if the active tab in the current window is the NTP, false otherwise.
   bool active_tab_is_ntp_;
 
-  // Current omnibox bounds.
-  gfx::Rect omnibox_bounds_;
+  // Current omnibox popup bounds.
+  gfx::Rect popup_bounds_;
 
-  // Last bounds passed to the page.
-  gfx::Rect last_omnibox_bounds_;
+  // Last popup bounds passed to the page.
+  gfx::Rect last_popup_bounds_;
+
+  // Offset from the start edge of the page to the start of the page text area.

[samarth, 2012/11/16 22:08:26]

Page text area is a little confusing in this context. Do you mean "omnibox text
area"?

[melevin, 2012/11/16 22:34:43]

Yeah I suppose. I wasn't sure what we were calling it since this is not only the
dropdown margin but also the results margin.

+  int start_margin_;
+
+  // Offset from the start edge of the page to the end of the page text area.
+  int end_margin_;
 
   // Timer used to update the bounds of the omnibox.
   base::OneShotTimer<InstantController> update_bounds_timer_;
 
   // Timer used to ensure that the Instant page does not get too stale.
   base::OneShotTimer<InstantController> stale_loader_timer_;
 
   // For each key K => value N, the map says that we found that the search
   // engine identified by Instant URL K didn't support the Instant API in each
   // of the last N times that we loaded it. If an Instant URL isn't present in
   // the map at all or has a value 0, it means that search engine supports the
   // Instant API (or we assume it does, since we haven't determined it doesn't).
   std::map<std::string, int> blacklisted_urls_;
 
   // Search terms extraction (for autocomplete history matches) doesn't work
   // on Instant URLs. So, whenever the user commits an Instant search, we add
   // an equivalent non-Instant search URL to history, so that the search shows
   // up in autocomplete history matches.
   GURL url_for_history_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantController);
 };
 
 #endif  // CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_