1// Copyright (c) 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_VIEWS_FIND_BAR_HOST_H_
6#define CHROME_BROWSER_UI_VIEWS_FIND_BAR_HOST_H_
7
8#include "base/compiler_specific.h"
9#include "chrome/browser/ui/find_bar/find_bar.h"
10#include "chrome/browser/ui/views/dropdown_bar_host.h"
11#include "chrome/browser/ui/views/find_bar_view.h"
12#include "ui/gfx/native_widget_types.h"
13#include "ui/gfx/rect.h"
14#include "ui/views/controls/textfield/textfield.h"
15
16class BrowserView;
17class FindBarController;
18class FindNotificationDetails;
19
20////////////////////////////////////////////////////////////////////////////////
21//
22// The FindBarHost implements the container widget for the
23// find-in-page functionality. It uses the implementation from
24// find_bar_host_aura.cc to draw its content and is responsible for showing,
25// hiding, closing, and moving the widget if needed, for example if the widget
26// is obscuring the selection results. It also receives notifications about the
27// search results and communicates that to the view.
28//
29// There is one FindBarHost per BrowserView, and its state is updated
30// whenever the selected Tab is changed. The FindBarHost is created when
31// the BrowserView is attached to the frame's Widget for the first time.
32//
33////////////////////////////////////////////////////////////////////////////////
34class FindBarHost : public DropdownBarHost,
35                    public FindBar,
36                    public FindBarTesting {
37 public:
38  explicit FindBarHost(BrowserView* browser_view);
39  virtual ~FindBarHost();
40
41  // Forwards selected key events to the renderer. This is useful to make sure
42  // that arrow keys and PageUp and PageDown result in scrolling, instead of
43  // being eaten because the FindBar has focus. Returns true if the keystroke
44  // was forwarded, false if not.
45  bool MaybeForwardKeyEventToWebpage(const ui::KeyEvent& key_event);
46
47  // FindBar implementation:
48  virtual FindBarController* GetFindBarController() const OVERRIDE;
49  virtual void SetFindBarController(
50      FindBarController* find_bar_controller) OVERRIDE;
51  virtual void Show(bool animate) OVERRIDE;
52  virtual void Hide(bool animate) OVERRIDE;
53  virtual void SetFocusAndSelection() OVERRIDE;
54  virtual void ClearResults(const FindNotificationDetails& results) OVERRIDE;
55  virtual void StopAnimation() OVERRIDE;
56  virtual void MoveWindowIfNecessary(const gfx::Rect& selection_rect,
57                                     bool no_redraw) OVERRIDE;
58  virtual void SetFindTextAndSelectedRange(
59      const base::string16& find_text,
60      const gfx::Range& selected_range) OVERRIDE;
61  virtual base::string16 GetFindText() OVERRIDE;
62  virtual gfx::Range GetSelectedRange() OVERRIDE;
63  virtual void UpdateUIForFindResult(const FindNotificationDetails& result,
64                                     const base::string16& find_text) OVERRIDE;
65  virtual void AudibleAlert() OVERRIDE;
66  virtual bool IsFindBarVisible() OVERRIDE;
67  virtual void RestoreSavedFocus() OVERRIDE;
68  virtual bool HasGlobalFindPasteboard() OVERRIDE;
69  virtual void UpdateFindBarForChangedWebContents() OVERRIDE;
70  virtual FindBarTesting* GetFindBarTesting() OVERRIDE;
71
72  // Overridden from ui::AcceleratorTarget in DropdownBarHost class:
73  virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
74  virtual bool CanHandleAccelerators() const OVERRIDE;
75
76  // FindBarTesting implementation:
77  virtual bool GetFindBarWindowInfo(gfx::Point* position,
78                                    bool* fully_visible) OVERRIDE;
79  virtual base::string16 GetFindSelectedText() OVERRIDE;
80  virtual base::string16 GetMatchCountText() OVERRIDE;
81  virtual int GetWidth() OVERRIDE;
82
83  // Overridden from DropdownBarHost:
84  // Returns the rectangle representing where to position the find bar. It uses
85  // GetDialogBounds and positions itself within that, either to the left (if an
86  // InfoBar is present) or to the right (no InfoBar). If
87  // |avoid_overlapping_rect| is specified, the return value will be a rectangle
88  // located immediately to the left of |avoid_overlapping_rect|, as long as
89  // there is enough room for the dialog to draw within the bounds. If not, the
90  // dialog position returned will overlap |avoid_overlapping_rect|.
91  // 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