1 /*
2  * Copyright (c) 2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_ACCESSIBILITY_ACCESSIBILITY_PROVIDER_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_ACCESSIBILITY_ACCESSIBILITY_PROVIDER_H
18 
19 #include <map>
20 #include <vector>
21 
22 #include "base/memory/ace_type.h"
23 #include "core/accessibility/native_interface_accessibility_impl.h"
24 #include "core/accessibility/third_accessibility_manager.h"
25 
26 namespace OHOS::Accessibility {
27 class AccessibilityElementInfo;
28 class AccessibilityEventInfo;
29 } // namespace OHOS::Accessibility
30 
31 namespace OHOS::Ace {
32 class AccessibilityProvider : public AceType {
33     DECLARE_ACE_TYPE(AccessibilityProvider, AceType);
34 public:
35     virtual int32_t FindAccessibilityNodeInfosById(
36         const int64_t elementId, const int32_t mode, const int32_t requestId,
37         std::vector<ArkUI_AccessibilityElementInfo>& infos) = 0;
38     virtual int32_t FindAccessibilityNodeInfosByText(
39         const int64_t elementId, std::string text, const int32_t requestId,
40         std::vector<ArkUI_AccessibilityElementInfo>& infos) = 0;
41     virtual int32_t FindFocusedAccessibilityNode(
42         const int64_t elementId, int32_t focusType, const int32_t requestId,
43         ArkUI_AccessibilityElementInfo& elementInfo) = 0;
44     virtual int32_t FindNextFocusAccessibilityNode(
45         const int64_t elementId, int32_t direction, const int32_t requestId,
46         ArkUI_AccessibilityElementInfo& elementInfo) = 0;
47     virtual int32_t ExecuteAccessibilityAction(
48         const int64_t elementId, int32_t action, const int32_t requestId,
49         const std::map<std::string, std::string>& actionArguments) = 0;
50     virtual int32_t ClearFocusedAccessibilityNode() = 0;
51     virtual int32_t GetAccessibilityNodeCursorPosition(
52         const int64_t elementId, const int32_t requestId, int32_t &cursorPosition) = 0;
53     virtual int32_t SendAccessibilityAsyncEvent(
54         const ArkUI_AccessibilityEventInfo& accessibilityEvent,
55         void (*callback)(int32_t errorCode)) = 0;
SendThirdAccessibilityProvider(const std::weak_ptr<ThirdAccessibilityManager> & thirdAccessibilityManager)56     virtual void SendThirdAccessibilityProvider(
57         const std::weak_ptr<ThirdAccessibilityManager>& thirdAccessibilityManager) {};
58 };
59 } // namespace OHOS::Ace
60 
61 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_ACCESSIBILITY_ACCESSIBILITY_PROVIDER_H
62