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.
5 #ifndef UI_VIEWS_CONTROLS_COMBOBOX_COMBOBOX_H_
6 #define UI_VIEWS_CONTROLS_COMBOBOX_COMBOBOX_H_
10 #include "base/memory/weak_ptr.h"
11 #include "base/time/time.h"
12 #include "ui/base/models/combobox_model_observer.h"
13 #include "ui/gfx/animation/animation_delegate.h"
14 #include "ui/gfx/native_widget_types.h"
15 #include "ui/views/controls/button/button.h"
16 #include "ui/views/controls/menu/menu_delegate.h"
17 #include "ui/views/controls/prefix_delegate.h"
30 class ComboboxListener;
31 class ComboboxMenuRunner;
33 class FocusableBorder;
35 class MenuRunnerHandler;
39 // A non-editable combobox (aka a drop-down list or selector).
40 // Combobox has two distinct parts, the drop down arrow and the text. Combobox
41 // offers two distinct behaviors:
42 // * STYLE_NORMAL: typical combobox, clicking on the text and/or button shows
43 // the drop down, arrow keys change selection, selected index can be changed by
44 // the user to something other than the first item.
45 // * STYLE_ACTION: clicking on the text notifies the listener. The menu can be
46 // shown only by clicking on the arrow. The selected index is always reverted to
47 // 0 after the listener is notified.
48 class VIEWS_EXPORT Combobox : public MenuDelegate,
49 public PrefixDelegate,
50 public ui::ComboboxModelObserver,
51 public ButtonListener {
53 // The style of the combobox.
59 // The combobox's class name.
60 static const char kViewClassName[];
62 // |model| is not owned by the combobox.
63 explicit Combobox(ui::ComboboxModel* model);
66 static const gfx::FontList& GetFontList();
68 // Sets the listener which will be called when a selection has been made.
69 void set_listener(ComboboxListener* listener) { listener_ = listener; }
71 void SetStyle(Style style);
73 // Informs the combobox that its model changed.
76 // Gets/Sets the selected index.
77 int selected_index() const { return selected_index_; }
78 void SetSelectedIndex(int index);
80 // Looks for the first occurrence of |value| in |model()|. If found, selects
81 // the found index and returns true. Otherwise simply noops and returns false.
82 bool SelectValue(const base::string16& value);
84 ui::ComboboxModel* model() const { return model_; }
86 // Set the accessible name of the combobox.
87 void SetAccessibleName(const base::string16& name);
89 // Visually marks the combobox as having an invalid value selected.
90 // When invalid, it paints with white text on a red background.
91 // Callers are responsible for restoring validity with selection changes.
92 void SetInvalid(bool invalid);
93 bool invalid() const { return invalid_; }
95 // Overridden from View:
96 virtual gfx::Size GetPreferredSize() OVERRIDE;
97 virtual const char* GetClassName() const OVERRIDE;
98 virtual bool SkipDefaultKeyEventProcessing(const ui::KeyEvent& e) OVERRIDE;
99 virtual bool OnKeyPressed(const ui::KeyEvent& e) OVERRIDE;
100 virtual bool OnKeyReleased(const ui::KeyEvent& e) OVERRIDE;
101 virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
102 virtual void OnFocus() OVERRIDE;
103 virtual void OnBlur() OVERRIDE;
104 virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
105 virtual ui::TextInputClient* GetTextInputClient() OVERRIDE;
106 virtual void Layout() OVERRIDE;
108 // Overridden from MenuDelegate:
109 virtual bool IsItemChecked(int id) const OVERRIDE;
110 virtual bool IsCommandEnabled(int id) const OVERRIDE;
111 virtual void ExecuteCommand(int id) OVERRIDE;
112 virtual bool GetAccelerator(int id, ui::Accelerator* accelerator) OVERRIDE;
114 // Overridden from PrefixDelegate:
115 virtual int GetRowCount() OVERRIDE;
116 virtual int GetSelectedRow() OVERRIDE;
117 virtual void SetSelectedRow(int row) OVERRIDE;
118 virtual base::string16 GetTextForRow(int row) OVERRIDE;
120 // Overriden from ComboboxModelObserver:
121 virtual void OnComboboxModelChanged(ui::ComboboxModel* model) OVERRIDE;
123 // Overriden from ButtonListener:
124 virtual void ButtonPressed(Button* sender, const ui::Event& event) OVERRIDE;
127 FRIEND_TEST_ALL_PREFIXES(ComboboxTest, Click);
128 FRIEND_TEST_ALL_PREFIXES(ComboboxTest, NotifyOnClickWithMouse);
129 FRIEND_TEST_ALL_PREFIXES(ComboboxTest, ContentWidth);
131 // Updates the combobox's content from its model.
132 void UpdateFromModel();
134 // Updates the border according to the current state.
137 // Given bounds within our View, this helper mirrors the bounds if necessary.
138 void AdjustBoundsForRTLUI(gfx::Rect* rect) const;
140 // Draws the selected value of the drop down list
141 void PaintText(gfx::Canvas* canvas);
143 // Draws the button images.
144 void PaintButtons(gfx::Canvas* canvas);
146 // Show the drop down list
147 void ShowDropDownMenu(ui::MenuSourceType source_type);
149 // Called when the selection is changed by the user.
150 void OnPerformAction();
151 void NotifyPerformAction();
152 void AfterPerformAction();
154 // Converts a menu command ID to a menu item index.
155 int MenuCommandToIndex(int menu_command_id) const;
157 int GetDisclosureArrowLeftPadding() const;
158 int GetDisclosureArrowRightPadding() const;
160 // Handles the clicking event.
161 void HandleClickEvent();
163 // Our model. Not owned.
164 ui::ComboboxModel* model_;
166 // The visual style of this combobox.
169 // Our listener. Not owned. Notified when the selected index change.
170 ComboboxListener* listener_;
172 // The current selected index; -1 and means no selection.
175 // True when the selection is visually denoted as invalid.
178 // The accessible name of this combobox.
179 base::string16 accessible_name_;
181 // A helper used to select entries by keyboard input.
182 scoped_ptr<PrefixSelector> selector_;
184 // The disclosure arrow next to the currently selected item from the list.
185 const gfx::ImageSkia* disclosure_arrow_;
187 // Responsible for showing the context menu.
188 scoped_ptr<MenuRunner> dropdown_list_menu_runner_;
190 // Is the drop down list showing
193 // Like MenuButton, we use a time object in order to keep track of when the
194 // combobox was closed. The time is used for simulating menu behavior; that
195 // is, if the menu is shown and the button is pressed, we need to close the
196 // menu. There is no clean way to get the second click event because the
197 // menu is displayed using a modal loop and, unlike regular menus in Windows,
198 // the button is not part of the displayed menu.
199 base::Time closed_time_;
201 // The maximum dimensions of the content in the dropdown
202 gfx::Size content_size_;
204 // The painters or images that are used when |style_| is STYLE_BUTTONS. The
205 // first index means the state of unfocused or focused.
206 // The images are owned by ResourceBundle.
207 scoped_ptr<Painter> body_button_painters_[2][Button::STATE_COUNT];
208 std::vector<const gfx::ImageSkia*>
209 menu_button_images_[2][Button::STATE_COUNT];
211 // The transparent buttons to handle events and render buttons. These are
212 // placed on top of this combobox as child views, accept event and manage the
213 // button states. These are not rendered but when |style_| is
214 // STYLE_NOTIFY_ON_CLICK, a Combobox renders the button images according to
215 // these button states.
216 // The base View takes the ownerships of these as child views.
217 CustomButton* text_button_;
218 CustomButton* arrow_button_;
220 // Used for making calbacks.
221 base::WeakPtrFactory<Combobox> weak_ptr_factory_;
223 DISALLOW_COPY_AND_ASSIGN(Combobox);
228 #endif // UI_VIEWS_CONTROLS_COMBOBOX_COMBOBOX_H_