Implement ScrollableArea::scrollOffset()
[WebKit-https.git] / Source / WebCore / platform / win / PopupMenuWin.h
1 /*
2  * Copyright (C) 2011, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef PopupMenuWin_h
22 #define PopupMenuWin_h
23
24 #include "COMPtr.h"
25 #include "IntRect.h"
26 #include "PopupMenu.h"
27 #include "PopupMenuClient.h"
28 #include "ScrollableArea.h"
29 #include "Scrollbar.h"
30 #include <OleAcc.h>
31 #include <wtf/RefPtr.h>
32 #include <wtf/win/GDIObject.h>
33
34 namespace WebCore {
35
36 class FrameView;
37 class Scrollbar;
38 class AccessiblePopupMenu;
39
40 class PopupMenuWin : public PopupMenu, private ScrollableArea {
41 public:
42     PopupMenuWin(PopupMenuClient*);
43     ~PopupMenuWin();
44
45     void show(const IntRect&, FrameView*, int index) override;
46     void hide() override;
47     void updateFromElement() override;
48     void disconnectClient() override;
49
50     static LPCWSTR popupClassName();
51
52 private:
53     PopupMenuClient* client() const { return m_popupClient; }
54
55     Scrollbar* scrollbar() const { return m_scrollbar.get(); }
56
57     bool up(unsigned lines = 1);
58     bool down(unsigned lines = 1);
59
60     int itemHeight() const { return m_itemHeight; }
61     const IntRect& windowRect() const { return m_windowRect; }
62     IntRect clientRect() const;
63
64     int visibleItems() const;
65
66     int listIndexAtPoint(const IntPoint&) const;
67
68     bool setFocusedIndex(int index, bool hotTracking = false);
69     int focusedIndex() const;
70     void focusFirst();
71     void focusLast();
72
73     void paint(const IntRect& damageRect, HDC = 0);
74
75     HWND popupHandle() const { return m_popup; }
76
77     void setWasClicked(bool b = true) { m_wasClicked = b; }
78     bool wasClicked() const { return m_wasClicked; }
79
80     bool scrollToRevealSelection();
81
82     void incrementWheelDelta(int delta);
83     void reduceWheelDelta(int delta);
84     int wheelDelta() const { return m_wheelDelta; }
85
86     bool scrollbarCapturingMouse() const { return m_scrollbarCapturingMouse; }
87     void setScrollbarCapturingMouse(bool b) { m_scrollbarCapturingMouse = b; }
88
89     // ScrollableArea
90     ScrollPosition scrollPosition() const override;
91     void setScrollOffset(const IntPoint&) override;
92     void invalidateScrollbarRect(Scrollbar&, const IntRect&) override;
93     void invalidateScrollCornerRect(const IntRect&) override { }
94     bool isActive() const override { return true; }
95     ScrollableArea* enclosingScrollableArea() const override { return 0; }
96     bool isScrollableOrRubberbandable() override { return true; }
97     bool hasScrollableOrRubberbandableAncestor() override { return true; }
98     bool isScrollCornerVisible() const override { return false; }
99     IntRect scrollCornerRect() const override { return IntRect(); }
100     Scrollbar* verticalScrollbar() const override { return m_scrollbar.get(); }
101     IntSize visibleSize() const override;
102     IntSize contentsSize() const override;
103     IntRect scrollableAreaBoundingBox(bool* = nullptr) const override;
104     bool forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const override { return false; }
105     bool shouldPlaceBlockDirectionScrollbarOnLeft() const final { return false; }
106
107     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
108     void scrollTo(int offset);
109
110     void calculatePositionAndSize(const IntRect&, FrameView*);
111     void invalidateItem(int index);
112
113     bool onGetObject(WPARAM wParam, LPARAM lParam, LRESULT& lResult);
114
115     static LRESULT CALLBACK PopupMenuWndProc(HWND, UINT, WPARAM, LPARAM);
116     LRESULT wndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
117     static void registerClass();
118
119     RefPtr<Scrollbar> m_scrollbar;
120     COMPtr<IAccessible> m_accessiblePopupMenu;
121     GDIObject<HDC> m_DC;
122     GDIObject<HBITMAP> m_bmp;
123     PopupMenuClient* m_popupClient;
124     HWND m_popup { nullptr };
125     IntRect m_windowRect;
126     int m_itemHeight { 0 };
127     int m_scrollOffset { 0 };
128     int m_wheelDelta { 0 };
129     int m_focusedIndex { 0 };
130     int m_hoveredIndex { 0 };
131     bool m_wasClicked { false };
132     bool m_scrollbarCapturingMouse { false };
133     bool m_showPopup { false };
134     float m_scaleFactor { 1 };
135     FontCascade m_font;
136
137     friend class AccessiblePopupMenu;
138 };
139
140 class AccessiblePopupMenu final : public IAccessible {
141 public:
142     AccessiblePopupMenu(const PopupMenuWin&);
143     ~AccessiblePopupMenu();
144
145     // IUnknown
146     virtual HRESULT STDMETHODCALLTYPE QueryInterface(_In_ REFIID, _COM_Outptr_ void**);
147     virtual ULONG STDMETHODCALLTYPE AddRef();
148     virtual ULONG STDMETHODCALLTYPE Release();
149
150     // IDispatch - Not to be implemented.
151     virtual HRESULT STDMETHODCALLTYPE GetTypeInfoCount(_Out_ UINT* count);
152     virtual HRESULT STDMETHODCALLTYPE GetTypeInfo(UINT, LCID, _COM_Outptr_opt_ ITypeInfo**);
153     virtual HRESULT STDMETHODCALLTYPE GetIDsOfNames(_In_ REFIID, __in_ecount(cNames) LPOLESTR*, UINT cNames, LCID, __out_ecount_full(cNames) DISPID*);
154     virtual HRESULT STDMETHODCALLTYPE Invoke(DISPID, REFIID, LCID, WORD, DISPPARAMS*, VARIANT*, EXCEPINFO*, UINT*);
155
156     // IAccessible
157     virtual HRESULT STDMETHODCALLTYPE get_accParent(_COM_Outptr_opt_ IDispatch**);
158     virtual HRESULT STDMETHODCALLTYPE get_accChildCount(_Out_ long*);
159     virtual HRESULT STDMETHODCALLTYPE get_accChild(VARIANT vChild, _COM_Outptr_opt_ IDispatch** ppChild);
160     virtual HRESULT STDMETHODCALLTYPE get_accName(VARIANT vChild, __deref_out_opt BSTR*);
161     virtual HRESULT STDMETHODCALLTYPE get_accValue(VARIANT vChild, __deref_out_opt BSTR*);
162     virtual HRESULT STDMETHODCALLTYPE get_accDescription(VARIANT, __deref_out_opt BSTR*);
163     virtual HRESULT STDMETHODCALLTYPE get_accRole(VARIANT vChild, _Out_ VARIANT* pvRole);
164     virtual HRESULT STDMETHODCALLTYPE get_accState(VARIANT vChild, _Out_ VARIANT* pvState);
165     virtual HRESULT STDMETHODCALLTYPE get_accHelp(VARIANT vChild, __deref_out_opt BSTR* helpText);
166     virtual HRESULT STDMETHODCALLTYPE get_accKeyboardShortcut(VARIANT vChild, __deref_out_opt BSTR*);
167     virtual HRESULT STDMETHODCALLTYPE get_accFocus(_Out_ VARIANT* pvFocusedChild);
168     virtual HRESULT STDMETHODCALLTYPE get_accSelection(_Out_ VARIANT* pvSelectedChild);
169     virtual HRESULT STDMETHODCALLTYPE get_accDefaultAction(VARIANT vChild, __deref_out_opt BSTR* actionDescription);
170     virtual HRESULT STDMETHODCALLTYPE accSelect(long selectionFlags, VARIANT vChild);
171     virtual HRESULT STDMETHODCALLTYPE accLocation(_Out_ long* left, _Out_ long* top, _Out_ long* width, _Out_ long* height, VARIANT vChild);
172     virtual HRESULT STDMETHODCALLTYPE accNavigate(long direction, VARIANT vFromChild, _Out_ VARIANT* pvNavigatedTo);
173     virtual HRESULT STDMETHODCALLTYPE accHitTest(long x, long y, _Out_ VARIANT* pvChildAtPoint);
174     virtual HRESULT STDMETHODCALLTYPE accDoDefaultAction(VARIANT vChild);
175     virtual HRESULT STDMETHODCALLTYPE put_accName(VARIANT, _In_ BSTR);
176     virtual HRESULT STDMETHODCALLTYPE put_accValue(VARIANT, _In_ BSTR);
177     virtual HRESULT STDMETHODCALLTYPE get_accHelpTopic(BSTR* helpFile, VARIANT, _Out_ long* topicID);
178
179 private:
180     int m_refCount { 0 };
181     const PopupMenuWin& m_popupMenu;
182 };
183
184 } // namespace WebCore
185
186 #endif // PopupMenuWin_h