find_bar_host.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_UI_VIEWS_FIND_BAR_HOST_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_UI_VIEWS_FIND_BAR_HOST_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/ui/find_bar/find_bar.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/ui/views/dropdown_bar_host.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/ui/views/find_bar_view.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/native_widget_types.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/rect.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/textfield/textfield.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BrowserView; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FindBarController; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FindNotificationDetails; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The FindBarHost implements the container widget for the 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// find-in-page functionality. It uses the implementation from 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// find_bar_host_aura.cc to draw its content and is responsible for showing, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// hiding, closing, and moving the widget if needed, for example if the widget 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// is obscuring the selection results. It also receives notifications about the 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// search results and communicates that to the view. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// There is one FindBarHost per BrowserView, and its state is updated 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// whenever the selected Tab is changed. The FindBarHost is created when 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the BrowserView is attached to the frame's Widget for the first time. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FindBarHost : public DropdownBarHost, 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public FindBar, 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public FindBarTesting { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit FindBarHost(BrowserView* browser_view); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~FindBarHost(); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Forwards selected key events to the renderer. This is useful to make sure 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that arrow keys and PageUp and PageDown result in scrolling, instead of 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // being eaten because the FindBar has focus. Returns true if the keystroke 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // was forwarded, false if not. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool MaybeForwardKeyEventToWebpage(const ui::KeyEvent& key_event); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FindBar implementation: 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual FindBarController* GetFindBarController() const OVERRIDE; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetFindBarController( 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FindBarController* find_bar_controller) OVERRIDE; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Show(bool animate) OVERRIDE; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Hide(bool animate) OVERRIDE; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetFocusAndSelection() OVERRIDE; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ClearResults(const FindNotificationDetails& results) OVERRIDE; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void StopAnimation() OVERRIDE; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void MoveWindowIfNecessary(const gfx::Rect& selection_rect, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool no_redraw) OVERRIDE; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetFindTextAndSelectedRange( 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::string16& find_text, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Range& selected_range) OVERRIDE; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::string16 GetFindText() OVERRIDE; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual gfx::Range GetSelectedRange() OVERRIDE; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void UpdateUIForFindResult(const FindNotificationDetails& result, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::string16& find_text) OVERRIDE; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AudibleAlert() OVERRIDE; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsFindBarVisible() OVERRIDE; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RestoreSavedFocus() OVERRIDE; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool HasGlobalFindPasteboard() OVERRIDE; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void UpdateFindBarForChangedWebContents() OVERRIDE; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual FindBarTesting* GetFindBarTesting() OVERRIDE; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from ui::AcceleratorTarget in DropdownBarHost class: 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool CanHandleAccelerators() const OVERRIDE; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FindBarTesting implementation: 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool GetFindBarWindowInfo(gfx::Point* position, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool* fully_visible) OVERRIDE; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::string16 GetFindSelectedText() OVERRIDE; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::string16 GetMatchCountText() OVERRIDE; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetWidth() OVERRIDE; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from DropdownBarHost: 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the rectangle representing where to position the find bar. It uses 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GetDialogBounds and positions itself within that, either to the left (if an 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // InfoBar is present) or to the right (no InfoBar). If 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |avoid_overlapping_rect| is specified, the return value will be a rectangle 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // located immediately to the left of |avoid_overlapping_rect|, as long as 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // there is enough room for the dialog to draw within the bounds. If not, the 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // dialog position returned will overlap |avoid_overlapping_rect|. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: |avoid_overlapping_rect| is expected to use coordinates relative to 92 // the top of the page area, (it will be converted to coordinates relative to 93 // the top of the browser window, when comparing against the dialog 94 // coordinates). The returned value is relative to the browser window. 95 virtual gfx::Rect GetDialogPosition( 96 gfx::Rect avoid_overlapping_rect) OVERRIDE; 97 // Moves the dialog window to the provided location, moves it to top in the 98 // z-order (HWND_TOP, not HWND_TOPMOST) and shows the window (if hidden). 99 // It then calls UpdateWindowEdges to make sure we don't overwrite the Chrome 100 // window border. If |no_redraw| is set, the window is getting moved but not 101 // sized, and should not be redrawn to reduce update flicker. 102 virtual void SetDialogPosition(const gfx::Rect& new_pos, 103 bool no_redraw) OVERRIDE; 104 105 // Retrieves the boundaries that the find bar widget has to work with 106 // within the Chrome frame window. The resulting rectangle will be a 107 // rectangle that overlaps the bottom of the Chrome toolbar by one 108 // pixel (so we can create the illusion that the dropdown widget is 109 // part of the toolbar) and covers the page area, except that we 110 // deflate the rect width by subtracting (from both sides) the width 111 // of the toolbar and some extra pixels to account for the width of 112 // the Chrome window borders. |bounds| is relative to the browser 113 // window. If the function fails to determine the browser 114 // window/client area rectangle or the rectangle for the page area 115 // then |bounds| will be an empty rectangle. 116 virtual void GetWidgetBounds(gfx::Rect* bounds) OVERRIDE; 117 118 // Additional accelerator handling (on top of what DropDownBarHost does). 119 virtual void RegisterAccelerators() OVERRIDE; 120 virtual void UnregisterAccelerators() OVERRIDE; 121 122 protected: 123 // Overridden from DropdownBarHost: 124 virtual void OnVisibilityChanged() OVERRIDE; 125 126 private: 127 // Allows implementation to tweak widget position. 128 void GetWidgetPositionNative(gfx::Rect* avoid_overlapping_rect); 129 130 // Allows native implementation to prevent key events from being forwarded. 131 bool ShouldForwardKeyEventToWebpageNative(const ui::KeyEvent& key_event); 132 133 // Returns the FindBarView. 134 FindBarView* find_bar_view() { return static_cast<FindBarView*>(view()); } 135 136 // A pointer back to the owning controller. 137 FindBarController* find_bar_controller_; 138 139 DISALLOW_COPY_AND_ASSIGN(FindBarHost); 140}; 141 142#endif // CHROME_BROWSER_UI_VIEWS_FIND_BAR_HOST_H_ 143