Source/WebCore: AccessibilityController should support listening to notifications...
[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 <string>
32 #include <wtf/HashMap.h>
33 #include <wtf/Platform.h>
34 #if PLATFORM(WIN)
35 #include <windows.h>
36 #endif
37
38 class AccessibilityController {
39 public:
40     AccessibilityController();
41     ~AccessibilityController();
42
43     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
44
45     // Controller Methods - platform-independent implementations
46     AccessibilityUIElement rootElement();
47     AccessibilityUIElement focusedElement();
48     AccessibilityUIElement elementAtPoint(int x, int y);
49
50     void setLogFocusEvents(bool);
51     void setLogValueChangeEvents(bool);
52     void setLogScrollingStartEvents(bool);
53     void setLogAccessibilityEvents(bool);
54
55     void resetToConsistentState();
56
57     // Global notification listener, captures notifications on any object.
58     bool addNotificationListener(JSObjectRef functionCallback);
59     void removeNotificationListener();
60
61 #if PLATFORM(WIN)
62     // Helper methods so this class can add the listeners on behalf of AccessibilityUIElement.
63     void winAddNotificationListener(PlatformUIElement, JSObjectRef functionCallback);
64     void winNotificationReceived(PlatformUIElement, const std::string& eventName);
65 #endif
66
67 private:
68     static JSClassRef getJSClass();
69
70 #if PLATFORM(WIN)
71     HWINEVENTHOOK m_focusEventHook;
72     HWINEVENTHOOK m_valueChangeEventHook;
73     HWINEVENTHOOK m_scrollingStartEventHook;
74
75     HWINEVENTHOOK m_allEventsHook;
76     HWINEVENTHOOK m_notificationsEventHook;
77     HashMap<PlatformUIElement, JSObjectRef> m_notificationListeners;
78 #endif
79
80 #if PLATFORM(MAC)
81     RetainPtr<NotificationHandler> m_globalNotificationHandler;
82 #endif
83 };
84
85 #endif // AccessibilityController_h