84810c7af1fcfa4a0042f329b1b0e2c6e5a0e54a
[WebKit.git] / Source / WebCore / platform / chromium / PopupMenuChromium.h
1 /*
2  * Copyright (c) 2008, 2009, Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef PopupMenuChromium_h
32 #define PopupMenuChromium_h
33
34 #include "config.h"
35
36 #include "FramelessScrollView.h"
37 #include "IntRect.h"
38 #include "PlatformString.h"
39 #include "PopupMenu.h"
40 #include "PopupMenuPrivate.h"
41 #include "PopupMenuStyle.h"
42
43 namespace WebCore {
44
45 class ChromeClientChromium;
46 class FrameView;
47 class PopupListBox;
48 class PopupMenuClient;
49
50 // A container for the data for each menu item (e.g. represented by <option>
51 // or <optgroup> in a <select> widget) and is used by PopupListBox.
52 struct PopupItem {
53     enum Type {
54         TypeOption,
55         TypeGroup,
56         TypeSeparator
57     };
58
59     PopupItem(const String& label, Type type)
60         : label(label)
61         , type(type)
62         , yOffset(0)
63     {
64     }
65     String label;
66     Type type;
67     int yOffset; // y offset of this item, relative to the top of the popup.
68     bool enabled;
69 };
70
71 // FIXME: Our FramelessScrollView classes should probably implement HostWindow!
72
73 // The PopupContainer class holds a PopupListBox (see cpp file).  Its sole purpose is to be
74 // able to draw a border around its child.  All its paint/event handling is
75 // just forwarded to the child listBox (with the appropriate transforms).
76 // NOTE: this class is exposed so it can be instantiated direcly for the
77 // autofill popup.  We cannot use the Popup class directly in that case as the
78 // autofill popup should not be focused when shown and we want to forward the
79 // key events to it (through handleKeyEvent).
80
81 struct PopupContainerSettings {
82     // Whether the PopupMenuClient should be told to change its text when a
83     // new item is selected by using the arrow keys.
84     bool setTextOnIndexChange;
85
86     // Whether the selection should be accepted when the popup menu is
87     // closed (through ESC being pressed or the focus going away).
88     // Note that when TAB is pressed, the selection is always accepted
89     // regardless of this setting.
90     bool acceptOnAbandon;
91
92     // Whether we should move the selection to the first/last item when
93     // the user presses down/up arrow keys and the last/first item is
94     // selected.
95     bool loopSelectionNavigation;
96
97     // Whether we should restrict the width of the PopupListBox or not.
98     // Autocomplete popups are restricted, combo-boxes (select tags) aren't.
99     bool restrictWidthOfListBox;
100
101     // A hint on the display directionality of the item text in popup menu.
102     //
103     // We could either display the items in the drop-down using its DOM element's
104     // directionality, or we could display the items in the drop-down using heuristics:
105     // such as in its first strong directionality character's direction.
106     // Please refer to the discussion (especially comment #7 and #10) in
107     // https://bugs.webkit.org/show_bug.cgi?id=27889 for details.
108     enum DirectionalityHint {
109         // Use the DOM element's directionality to display the item text in popup menu.
110         DOMElementDirection,
111         // Use the item text's first strong-directional character's directionality
112         // to display the item text in popup menu.
113         FirstStrongDirectionalCharacterDirection,
114     };
115     DirectionalityHint itemTextDirectionalityHint;
116 };
117
118 class PopupContainer : public FramelessScrollView {
119 public:
120     enum PopupType {
121         Select, // HTML select popup.
122         Suggestion, // Autocomplete/autofill popup.
123     };
124
125     static PassRefPtr<PopupContainer> create(PopupMenuClient*, PopupType,
126                                              const PopupContainerSettings&);
127
128     // Whether a key event should be sent to this popup.
129     virtual bool isInterestedInEventForKey(int keyCode);
130
131     // FramelessScrollView
132     virtual void paint(GraphicsContext*, const IntRect&);
133     virtual void hide();
134     virtual bool handleMouseDownEvent(const PlatformMouseEvent&);
135     virtual bool handleMouseMoveEvent(const PlatformMouseEvent&);
136     virtual bool handleMouseReleaseEvent(const PlatformMouseEvent&);
137     virtual bool handleWheelEvent(const PlatformWheelEvent&);
138     virtual bool handleKeyEvent(const PlatformKeyboardEvent&);
139
140     // PopupContainer methods
141
142     // Show the popup
143     void showPopup(FrameView*);
144
145     // Used on Mac Chromium for HTML select popup menus.
146     void showExternal(const IntRect&, FrameView*, int index);
147
148     // Show the popup in the specified rect for the specified frame.
149     // Note: this code was somehow arbitrarily factored-out of the Popup class
150     // so WebViewImpl can create a PopupContainer. This method is used for
151     // displaying auto complete popup menus on Mac Chromium, and for all
152     // popups on other platforms.
153     void show(const IntRect&, FrameView*, int index);
154
155     // Hides the popup.
156     void hidePopup();
157
158     // The popup was hidden.
159     void notifyPopupHidden();
160
161     // Compute size of widget and children.
162     void layout();
163
164     PopupListBox* listBox() const { return m_listBox.get(); }
165
166     // Gets the index of the item that the user is currently moused-over or
167     // has selected with the keyboard up/down arrows.
168     int selectedIndex() const;
169
170     // Refresh the popup values from the PopupMenuClient.
171     void refresh(const IntRect& targetControlRect);
172
173     // The menu per-item data.
174     const WTF::Vector<PopupItem*>& popupData() const;
175
176     // The height of a row in the menu.
177     int menuItemHeight() const;
178
179     // The size of the font being used.
180     int menuItemFontSize() const;
181
182     // The style of the menu being used.
183     PopupMenuStyle menuStyle() const;
184
185     PopupType popupType() const { return m_popupType; }
186
187 private:
188     friend class WTF::RefCounted<PopupContainer>;
189
190     PopupContainer(PopupMenuClient*, PopupType popupType, const PopupContainerSettings&);
191     ~PopupContainer();
192
193     // Paint the border.
194     void paintBorder(GraphicsContext*, const IntRect&);
195
196     // Layout and calculate popup widget size and location and returns it as IntRect.
197     IntRect layoutAndCalculateWidgetRect(int targetControlHeight, int popupInitialY);
198
199     // Returns the ChromeClient of the page this popup is associated with.
200     ChromeClientChromium* chromeClientChromium();
201
202     RefPtr<PopupListBox> m_listBox;
203     RefPtr<FrameView> m_frameView;
204
205     PopupContainerSettings m_settings;
206     PopupType m_popupType;
207     // Whether the popup is currently open.
208     bool m_popupOpen;
209 };
210
211 class PopupMenuChromium : public PopupMenu {
212 public:
213     PopupMenuChromium(PopupMenuClient*);
214     ~PopupMenuChromium();
215
216     virtual void show(const IntRect&, FrameView*, int index);
217     virtual void hide();
218     virtual void updateFromElement();
219     virtual void disconnectClient();
220
221 private:
222     PopupMenuClient* client() const { return m_popupClient; }
223
224     PopupMenuClient* m_popupClient;
225     PopupMenuPrivate p;
226 };
227
228 } // namespace WebCore
229
230 #endif