Update Xcode projects with "Apply Configuration to XCFileLists" build target
[WebKit-https.git] / Tools / DumpRenderTree / AccessibilityController.h
1 /*
2  * Copyright (C) 2008, 2009, 2010 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef AccessibilityController_h
27 #define AccessibilityController_h
28
29 #include "AccessibilityUIElement.h"
30 #include <JavaScriptCore/JSObjectRef.h>
31 #include <JavaScriptCore/JSRetainPtr.h>
32 #include <string>
33 #include <wtf/HashMap.h>
34 #include <wtf/Platform.h>
35 #if PLATFORM(WIN)
36 #include <windows.h>
37 #endif
38 #if HAVE(ACCESSIBILITY) && PLATFORM(GTK)
39 #include "AccessibilityNotificationHandlerAtk.h"
40 #include <atk/atk.h>
41 #endif
42
43 class AccessibilityController {
44 public:
45     AccessibilityController();
46     ~AccessibilityController();
47
48     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
49
50     // Controller Methods - platform-independent implementations
51     AccessibilityUIElement rootElement();
52     AccessibilityUIElement focusedElement();
53     AccessibilityUIElement elementAtPoint(int x, int y);
54     AccessibilityUIElement accessibleElementById(JSStringRef id);
55
56     void setLogFocusEvents(bool);
57     void setLogValueChangeEvents(bool);
58     void setLogScrollingStartEvents(bool);
59     void setLogAccessibilityEvents(bool);
60
61     void resetToConsistentState();
62
63     // Global notification listener, captures notifications on any object.
64     bool addNotificationListener(JSObjectRef functionCallback);
65     void removeNotificationListener();
66
67     // Enhanced accessibility.
68     void enableEnhancedAccessibility(bool);
69     bool enhancedAccessibilityEnabled();
70
71     JSRetainPtr<JSStringRef> platformName() const;
72
73 #if PLATFORM(WIN)
74     // Helper methods so this class can add the listeners on behalf of AccessibilityUIElement.
75     void winAddNotificationListener(PlatformUIElement, JSObjectRef functionCallback);
76     void winNotificationReceived(PlatformUIElement, const std::string& eventName);
77 #endif
78
79 #if HAVE(ACCESSIBILITY) && PLATFORM(GTK)
80     AtkObject* childElementById(AtkObject* parent, const char* id);
81 #endif
82
83 private:
84     static JSClassRef getJSClass();
85
86 #if PLATFORM(WIN)
87     HWINEVENTHOOK m_focusEventHook { nullptr };
88     HWINEVENTHOOK m_valueChangeEventHook { nullptr };
89     HWINEVENTHOOK m_scrollingStartEventHook { nullptr };
90
91     HWINEVENTHOOK m_allEventsHook { nullptr };
92     HWINEVENTHOOK m_notificationsEventHook { nullptr };
93     HashMap<PlatformUIElement, JSObjectRef> m_notificationListeners;
94 #endif
95
96 #if PLATFORM(COCOA) || PLATFORM(IOS_FAMILY)
97     RetainPtr<NotificationHandler> m_globalNotificationHandler;
98 #endif
99
100 #if HAVE(ACCESSIBILITY) && PLATFORM(GTK)
101     RefPtr<AccessibilityNotificationHandler> m_globalNotificationHandler;
102 #endif
103     
104     void platformResetToConsistentState();
105 };
106
107 #endif // AccessibilityController_h