• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_VIEW_H_
6 #define CHROME_BROWSER_UI_VIEWS_FIND_BAR_VIEW_H_
7 
8 #include "base/compiler_specific.h"
9 #include "base/strings/string16.h"
10 #include "chrome/browser/ui/views/dropdown_bar_view.h"
11 #include "ui/views/controls/button/button.h"
12 #include "ui/views/controls/textfield/textfield.h"
13 #include "ui/views/controls/textfield/textfield_controller.h"
14 
15 class FindBarHost;
16 class FindNotificationDetails;
17 
18 namespace views {
19 class ImageButton;
20 class Label;
21 class MouseEvent;
22 class View;
23 }
24 
25 ////////////////////////////////////////////////////////////////////////////////
26 //
27 // The FindBarView is responsible for drawing the UI controls of the
28 // FindBar, the find text box, the 'Find' button and the 'Close'
29 // button. It communicates the user search words to the FindBarHost.
30 //
31 ////////////////////////////////////////////////////////////////////////////////
32 class FindBarView : public DropdownBarView,
33                     public views::ButtonListener,
34                     public views::TextfieldController {
35  public:
36   // A tag denoting which button the user pressed.
37   enum ButtonTag {
38     FIND_PREVIOUS_TAG = 0,  // The Find Previous button.
39     FIND_NEXT_TAG,          // The Find Next button.
40     CLOSE_TAG,              // The Close button (the 'X').
41   };
42 
43   explicit FindBarView(FindBarHost* host);
44   virtual ~FindBarView();
45 
46   // Accessors for the text and selection displayed in the text box.
47   void SetFindTextAndSelectedRange(const base::string16& find_text,
48                                    const gfx::Range& selected_range);
49   base::string16 GetFindText() const;
50   gfx::Range GetSelectedRange() const;
51 
52   // Gets the selected text in the text box.
53   base::string16 GetFindSelectedText() const;
54 
55   // Gets the match count text displayed in the text box.
56   base::string16 GetMatchCountText() const;
57 
58   // Updates the label inside the Find text box that shows the ordinal of the
59   // active item and how many matches were found.
60   void UpdateForResult(const FindNotificationDetails& result,
61                        const base::string16& find_text);
62 
63   // Clears the current Match Count value in the Find text box.
64   void ClearMatchCount();
65 
66   // Claims focus for the text field and selects its contents.
67   virtual void SetFocusAndSelection(bool select_all) OVERRIDE;
68 
69   // views::View:
70   virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
71   virtual void Layout() OVERRIDE;
72   virtual gfx::Size GetPreferredSize() OVERRIDE;
73   virtual void ViewHierarchyChanged(
74       const ViewHierarchyChangedDetails& details) OVERRIDE;
75 
76   // views::ButtonListener:
77   virtual void ButtonPressed(views::Button* sender,
78                              const ui::Event& event) OVERRIDE;
79 
80   // views::TextfieldController:
81   virtual bool HandleKeyEvent(views::Textfield* sender,
82                               const ui::KeyEvent& key_event) OVERRIDE;
83   virtual void OnAfterUserAction(views::Textfield* sender) OVERRIDE;
84   virtual void OnAfterPaste() OVERRIDE;
85 
86  private:
87   // Starts finding |search_text|.  If the text is empty, stops finding.
88   void Find(const base::string16& search_text);
89 
90   // Updates the appearance for the match count label.
91   void UpdateMatchCountAppearance(bool no_match);
92 
93   // views::View:
94   virtual void OnThemeChanged() OVERRIDE;
95 
96   // We use a hidden view to grab mouse clicks and bring focus to the find
97   // text box. This is because although the find text box may look like it
98   // extends all the way to the find button, it only goes as far as to the
99   // match_count label. The user, however, expects being able to click anywhere
100   // inside what looks like the find text box (including on or around the
101   // match_count label) and have focus brought to the find box.
102   class FocusForwarderView : public views::View {
103    public:
FocusForwarderView(views::Textfield * view_to_focus_on_mousedown)104     explicit FocusForwarderView(
105         views::Textfield* view_to_focus_on_mousedown)
106       : view_to_focus_on_mousedown_(view_to_focus_on_mousedown) {}
107 
108    private:
109     virtual bool OnMousePressed(const ui::MouseEvent& event) OVERRIDE;
110 
111     views::Textfield* view_to_focus_on_mousedown_;
112 
113     DISALLOW_COPY_AND_ASSIGN(FocusForwarderView);
114   };
115 
116   // Returns the OS-specific view for the find bar that acts as an intermediary
117   // between us and the WebContentsView.
118   FindBarHost* find_bar_host() const;
119 
120   // Used to detect if the input text, not including the IME composition text,
121   // has changed or not.
122   base::string16 last_searched_text_;
123 
124   // The controls in the window.
125   views::Textfield* find_text_;
126   views::Label* match_count_text_;
127   FocusForwarderView* focus_forwarder_view_;
128   views::ImageButton* find_previous_button_;
129   views::ImageButton* find_next_button_;
130   views::ImageButton* close_button_;
131 
132   // The preferred height of the find bar.
133   int preferred_height_;
134 
135   // The background image for the Find text box, which we draw behind the Find
136   // box to provide the Chrome look to the edge of the text box.
137   const gfx::ImageSkia* text_box_background_;
138 
139   // The rounded edge on the left side of the Find text box.
140   const gfx::ImageSkia* text_box_background_left_;
141 
142   DISALLOW_COPY_AND_ASSIGN(FindBarView);
143 };
144 
145 #endif  // CHROME_BROWSER_UI_VIEWS_FIND_BAR_VIEW_H_
146