AX: Implement updated CSS3 Speech for 'speak' and 'speak-as' properties
[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 "AccessibilityObject.h"
33 #include <CoreGraphics/CoreGraphics.h>
34
35 namespace WebCore {
36 class AccessibilityObject;
37 struct AccessibilitySearchCriteria;
38 class IntRect;
39 class FloatPoint;
40 class HTMLTextFormControlElement;
41 class Path;
42 class VisiblePosition;
43 }
44
45 @interface WebAccessibilityObjectWrapperBase : NSObject {
46     WebCore::AccessibilityObject* m_object;
47 }
48  
49 - (id)initWithAccessibilityObject:(WebCore::AccessibilityObject*)axObject;
50 - (void)detach;
51 - (WebCore::AccessibilityObject*)accessibilityObject;
52 - (BOOL)updateObjectBackingStore;
53
54 // These are pre-fixed with base so that AppKit does not end up calling into these directly (bypassing safety checks).
55 - (NSString *)baseAccessibilityTitle;
56 - (NSString *)baseAccessibilityDescription;
57 - (NSString *)baseAccessibilityHelpText;
58 - (NSArray<NSString *> *)baseAccessibilitySpeechHint;
59
60 - (NSString *)ariaLandmarkRoleDescription;
61
62 - (id)attachmentView;
63 // Used to inform an element when a notification is posted for it. Used by tests.
64 - (void)accessibilityPostedNotification:(NSString *)notificationName;
65 - (void)accessibilityPostedNotification:(NSString *)notificationName userInfo:(NSDictionary *)userInfo;
66
67 - (CGPathRef)convertPathToScreenSpace:(WebCore::Path &)path;
68 - (CGPoint)convertPointToScreenSpace:(WebCore::FloatPoint &)point;
69
70 // Math related functions
71 - (NSArray *)accessibilityMathPostscriptPairs;
72 - (NSArray *)accessibilityMathPrescriptPairs;
73
74 extern WebCore::AccessibilitySearchCriteria accessibilitySearchCriteriaForSearchPredicateParameterizedAttribute(const NSDictionary *);
75 extern NSArray *convertToNSArray(const WebCore::AccessibilityObject::AccessibilityChildrenVector&);
76
77 @end
78
79 #endif // WebAccessibilityObjectWrapperBase_h