Source/JavaScriptCore:
[WebKit-https.git] / Source / WebCore / accessibility / mac / WebAccessibilityObjectWrapperBase.h
1 /*
2  * Copyright (C) 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef WebAccessibilityObjectWrapperBase_h
30 #define WebAccessibilityObjectWrapperBase_h
31
32 #include "AXIsolatedTree.h"
33 #include "AccessibilityObject.h"
34 #include <CoreGraphics/CoreGraphics.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/Variant.h>
37 #include <wtf/WeakPtr.h>
38
39 namespace WebCore {
40 class AccessibilityObject;
41 #if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
42 class AXIsolatedTreeNode;
43 #endif
44 struct AccessibilitySearchCriteria;
45 class IntRect;
46 class FloatPoint;
47 class HTMLTextFormControlElement;
48 class Path;
49 class VisiblePosition;
50 }
51
52 @interface WebAccessibilityObjectWrapperBase : NSObject {
53     WebCore::AccessibilityObject* m_object;
54     WebCore::AXID _identifier;
55 }
56  
57 - (id)initWithAccessibilityObject:(WebCore::AccessibilityObject*)axObject;
58
59 #if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
60 @property (nonatomic, readonly) RefPtr<WebCore::AXIsolatedTreeNode> isolatedTreeNode;
61 @property (nonatomic, assign) WebCore::AXIsolatedTreeID isolatedTreeIdentifier;
62 #endif
63
64 - (void)detach;
65
66 @property (nonatomic, assign) WebCore::AXID identifier;
67
68 - (WebCore::AccessibilityObject*)accessibilityObject;
69 - (BOOL)updateObjectBackingStore;
70
71 // This can be either an AccessibilityObject or an AXIsolatedTreeNode
72 - (WebCore::AccessibilityObjectInterface*)axBackingObject;
73
74 // These are pre-fixed with base so that AppKit does not end up calling into these directly (bypassing safety checks).
75 - (NSString *)baseAccessibilityTitle;
76 - (NSString *)baseAccessibilityDescription;
77 - (NSString *)baseAccessibilityHelpText;
78 - (NSArray<NSString *> *)baseAccessibilitySpeechHint;
79
80 - (NSString *)ariaLandmarkRoleDescription;
81
82 - (id)attachmentView;
83 // Used to inform an element when a notification is posted for it. Used by tests.
84 - (void)accessibilityPostedNotification:(NSString *)notificationName;
85 - (void)accessibilityPostedNotification:(NSString *)notificationName userInfo:(NSDictionary *)userInfo;
86
87 - (CGPathRef)convertPathToScreenSpace:(WebCore::Path &)path;
88
89 enum ConversionSpace { ScreenSpace, PageSpace };
90 - (CGRect)convertRectToSpace:(WebCore::FloatRect &)rect space:(ConversionSpace)space;
91
92 // Math related functions
93 - (NSArray *)accessibilityMathPostscriptPairs;
94 - (NSArray *)accessibilityMathPrescriptPairs;
95
96 extern WebCore::AccessibilitySearchCriteria accessibilitySearchCriteriaForSearchPredicateParameterizedAttribute(const NSDictionary *);
97 extern NSArray *convertToNSArray(const WebCore::AccessibilityObject::AccessibilityChildrenVector&);
98
99 #if PLATFORM(IOS_FAMILY)
100 - (id)_accessibilityWebDocumentView;
101 #endif
102
103 @end
104
105 #endif // WebAccessibilityObjectWrapperBase_h