Source/WebCore: Popups on Chromium now check the minimum row height set through the...
[WebKit-https.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     TextDirection textDirection;
69     bool hasTextDirectionOverride;
70     bool enabled;
71 };
72
73 // FIXME: Our FramelessScrollView classes should probably implement HostWindow!
74
75 // The PopupContainer class holds a PopupListBox (see cpp file).  Its sole purpose is to be
76 // able to draw a border around its child.  All its paint/event handling is
77 // just forwarded to the child listBox (with the appropriate transforms).
78 // NOTE: this class is exposed so it can be instantiated direcly for the
79 // autofill popup.  We cannot use the Popup class directly in that case as the
80 // autofill popup should not be focused when shown and we want to forward the
81 // key events to it (through handleKeyEvent).
82
83 struct PopupContainerSettings {
84     // Whether the PopupMenuClient should be told to change its text when a
85     // new item is selected by using the arrow keys.
86     bool setTextOnIndexChange;
87
88     // Whether the selection should be accepted when the popup menu is
89     // closed (through ESC being pressed or the focus going away).
90     // Note that when TAB is pressed, the selection is always accepted
91     // regardless of this setting.
92     bool acceptOnAbandon;
93
94     // Whether we should move the selection to the first/last item when
95     // the user presses down/up arrow keys and the last/first item is
96     // selected.
97     bool loopSelectionNavigation;
98
99     // Whether we should restrict the width of the PopupListBox or not.
100     // Autocomplete popups are restricted, combo-boxes (select tags) aren't.
101     bool restrictWidthOfListBox;
102 };
103
104 class PopupContainer : public FramelessScrollView {
105 public:
106     enum PopupType {
107         Select, // HTML select popup.
108         Suggestion, // Autocomplete/autofill popup.
109     };
110
111     static PassRefPtr<PopupContainer> create(PopupMenuClient*, PopupType,
112                                              const PopupContainerSettings&);
113
114     // Whether a key event should be sent to this popup.
115     virtual bool isInterestedInEventForKey(int keyCode);
116
117     // FramelessScrollView
118     virtual void paint(GraphicsContext*, const IntRect&);
119     virtual void hide();
120     virtual bool handleMouseDownEvent(const PlatformMouseEvent&);
121     virtual bool handleMouseMoveEvent(const PlatformMouseEvent&);
122     virtual bool handleMouseReleaseEvent(const PlatformMouseEvent&);
123     virtual bool handleWheelEvent(const PlatformWheelEvent&);
124     virtual bool handleKeyEvent(const PlatformKeyboardEvent&);
125
126     // PopupContainer methods
127
128     // Show the popup
129     void showPopup(FrameView*);
130
131     // Show the popup in the specified rect for the specified frame.
132     // Note: this code was somehow arbitrarily factored-out of the Popup class
133     // so WebViewImpl can create a PopupContainer. This method is used for
134     // displaying auto complete popup menus on Mac Chromium, and for all
135     // popups on other platforms.
136     void showInRect(const IntRect&, FrameView*, int index);
137
138     // Hides the popup.
139     void hidePopup();
140
141     // The popup was hidden.
142     void notifyPopupHidden();
143
144     // Compute size of widget and children. Return right offset for the popup right alignment.
145     int layoutAndGetRTLOffset();
146
147     PopupListBox* listBox() const { return m_listBox.get(); }
148
149     bool isRTL() const;
150
151     // Gets the index of the item that the user is currently moused-over or
152     // has selected with the keyboard up/down arrows.
153     int selectedIndex() const;
154
155     // Refresh the popup values from the PopupMenuClient.
156     void refresh(const IntRect& targetControlRect);
157
158     // The menu per-item data.
159     const WTF::Vector<PopupItem*>& popupData() const;
160
161     // The height of a row in the menu.
162     int menuItemHeight() const;
163
164     // The size of the font being used.
165     int menuItemFontSize() const;
166
167     // The style of the menu being used.
168     PopupMenuStyle menuStyle() const;
169
170     PopupType popupType() const { return m_popupType; }
171
172     // While hovering popup menu window, we want to show tool tip message.
173     String getSelectedItemToolTip();
174
175 private:
176     friend class WTF::RefCounted<PopupContainer>;
177
178     PopupContainer(PopupMenuClient*, PopupType, const PopupContainerSettings&);
179     ~PopupContainer();
180
181     // Paint the border.
182     void paintBorder(GraphicsContext*, const IntRect&);
183
184     // Layout and calculate popup widget size and location and returns it as IntRect.
185     IntRect layoutAndCalculateWidgetRect(int targetControlHeight, const IntPoint& popupInitialCoordinate);
186
187     // Returns the ChromeClient of the page this popup is associated with.
188     ChromeClientChromium* chromeClientChromium();
189
190     RefPtr<PopupListBox> m_listBox;
191     RefPtr<FrameView> m_frameView;
192
193     PopupContainerSettings m_settings;
194     PopupType m_popupType;
195     IntRect m_originalFrameRect;
196     // Whether the popup is currently open.
197     bool m_popupOpen;
198 };
199
200 class PopupMenuChromium : public PopupMenu {
201 public:
202     PopupMenuChromium(PopupMenuClient*);
203     ~PopupMenuChromium();
204
205     virtual void show(const IntRect&, FrameView*, int index);
206     virtual void hide();
207     virtual void updateFromElement();
208     virtual void disconnectClient();
209
210     static int minimumRowHeight() { return s_minimumRowHeight; }
211     static void setMinimumRowHeight(int minimumRowHeight) { s_minimumRowHeight = minimumRowHeight; }
212
213 private:
214     PopupMenuClient* client() const { return m_popupClient; }
215
216     PopupMenuClient* m_popupClient;
217     PopupMenuPrivate p;
218
219     static int s_minimumRowHeight;
220 };
221
222 } // namespace WebCore
223
224 #endif