[iOS] Replace "node assistance" terminology in WebKit with "focused element"
[WebKit-https.git] / Source / WebKit / UIProcess / WebPopupMenuProxy.h
1 /*
2  * Copyright (C) 2010, 2011 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebPopupMenuProxy_h
27 #define WebPopupMenuProxy_h
28
29 #include <WebCore/WritingMode.h>
30 #include <wtf/Forward.h>
31 #include <wtf/RefCounted.h>
32
33 namespace WebCore {
34     class IntRect;
35 }
36
37 namespace WebKit {
38
39 struct PlatformPopupMenuData;
40 struct WebPopupItem;
41 class NativeWebMouseEvent;
42
43 class WebPopupMenuProxy : public RefCounted<WebPopupMenuProxy> {
44 public:
45     class Client {
46     protected:
47         virtual ~Client()
48         {
49         }
50
51     public:
52         virtual void valueChangedForPopupMenu(WebPopupMenuProxy*, int32_t newSelectedIndex) = 0;
53         virtual void setTextFromItemForPopupMenu(WebPopupMenuProxy*, int32_t index) = 0;
54         virtual NativeWebMouseEvent* currentlyProcessedMouseDownEvent() = 0;
55 #if PLATFORM(GTK)
56         virtual void failedToShowPopupMenu() = 0;
57 #endif
58     };
59
60     virtual ~WebPopupMenuProxy()
61     {
62     }
63
64     virtual void showPopupMenu(const WebCore::IntRect& rect, WebCore::TextDirection, double pageScaleFactor, const Vector<WebPopupItem>& items, const PlatformPopupMenuData&, int32_t selectedIndex) = 0;
65     virtual void hidePopupMenu() = 0;
66     virtual void cancelTracking() { }
67
68     void invalidate() { m_client = 0; }
69
70 protected:
71     explicit WebPopupMenuProxy(Client& client)
72         : m_client(&client)
73     {
74     }
75
76     Client* m_client;
77 };
78
79 } // namespace WebKit
80
81 #endif // WebPopupMenuProxy_h