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_NATIVE_INTERFACE_ACCESSIBILITY_HANDLE_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_ACCESSIBILITY_NATIVE_INTERFACE_ACCESSIBILITY_HANDLE_H 18 19 #include <functional> 20 #include <memory> 21 22 #include "core/accessibility/accessibility_provider.h" 23 24 enum AccessibilityProviderOperatorErrorCode : int32_t { 25 OPERATOR_SUCCESS = 0, 26 NOT_REGISTERED = -10001, 27 COPY_FAILED = -10002, 28 }; 29 30 struct ArkUI_AccessibilityProvider { 31 public: 32 ArkUI_AccessibilityProvider() = default; ~ArkUI_AccessibilityProviderArkUI_AccessibilityProvider33 virtual ~ArkUI_AccessibilityProvider() {} 34 using RegisterCallback = std::function<void(bool)>; 35 36 int32_t FindAccessibilityNodeInfosById( 37 const int64_t elementId, const int32_t mode, const int32_t requestId, 38 std::vector<ArkUI_AccessibilityElementInfo>& infos); 39 int32_t FindAccessibilityNodeInfosByText( 40 const int64_t elementId, std::string text, const int32_t requestId, 41 std::vector<ArkUI_AccessibilityElementInfo>& infos); 42 int32_t FindFocusedAccessibilityNode( 43 const int64_t elementId, int32_t focusType, const int32_t requestId, 44 ArkUI_AccessibilityElementInfo& elementInfo); 45 int32_t FindNextFocusAccessibilityNode( 46 const int64_t elementId, int32_t direction, const int32_t requestId, 47 ArkUI_AccessibilityElementInfo& elementInfo); 48 int32_t ExecuteAccessibilityAction( 49 const int64_t elementId, int32_t action, const int32_t requestId, 50 const std::map<std::string, std::string>& actionArguments); 51 int32_t ClearFocusedAccessibilityNode(); 52 int32_t GetAccessibilityNodeCursorPosition( 53 const int64_t elementId, const int32_t requestId, int32_t &cursorPosition); 54 int32_t SendAccessibilityAsyncEvent( 55 ArkUI_AccessibilityEventInfo* accessibilityEvent, 56 void (*callback)(int32_t errorCode)); 57 int32_t AccessibilityProviderRegisterCallback( 58 ArkUI_AccessibilityProviderCallbacks* callbacks); 59 int32_t AccessibilityProviderRegisterCallbackWithInstance(const char* instanceId, 60 ArkUI_AccessibilityProviderCallbacksWithInstance* callbacks); 61 void SetInnerAccessibilityProvider( 62 const OHOS::Ace::WeakPtr<OHOS::Ace::AccessibilityProvider>& accessibilityProvider); 63 bool IsRegister(); 64 void SetRegisterCallback(RegisterCallback callback); 65 66 private: 67 ArkUI_AccessibilityProviderCallbacks accessibilityProviderCallbacks_ {}; 68 ArkUI_AccessibilityProviderCallbacksWithInstance accessibilityProviderCallbacksWithInstance_ {}; 69 OHOS::Ace::WeakPtr<OHOS::Ace::AccessibilityProvider> accessibilityProvider_; 70 RegisterCallback registerCallback_; 71 std::string instanceId_; 72 }; 73 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_ACCESSIBILITY_NATIVE_INTERFACE_ACCESSIBILITY_HANDLE_H