1 /* 2 * Copyright (C) 2022 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 ACCESSIBILITY_ELEMENT_OPERATOR_PROXY_H 17 #define ACCESSIBILITY_ELEMENT_OPERATOR_PROXY_H 18 19 #include "accessibility_ipc_interface_code.h" 20 #include "i_accessibility_element_operator.h" 21 #include "iremote_proxy.h" 22 23 namespace OHOS { 24 namespace Accessibility { 25 /* 26 * The class define the interface for UI to implement. 27 * It triggered by ABMS when AA to request the accessibility information. 28 */ 29 class AccessibilityElementOperatorProxy : public IRemoteProxy<IAccessibilityElementOperator> { 30 public: 31 /** 32 * @brief construct function 33 * @param object The object of IPC 34 */ 35 explicit AccessibilityElementOperatorProxy(const sptr<IRemoteObject> &object); 36 37 /** 38 * @brief destruct function 39 */ 40 virtual ~AccessibilityElementOperatorProxy() = default; 41 42 /** 43 * @brief Make the node information by accessibility ID and set the result by callback. 44 * @param elementId: The unique id of the component ID. 45 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 46 * @param callback To transfer the node info to ASAC and it defined by ASAC. 47 * @param mode PREFETCH_PREDECESSORS: Need to make the parent node info also. 48 * PREFETCH_SIBLINGS: Need to make the sister/brothers node info also. 49 * PREFETCH_CHILDREN: Need to make the child node info also. 50 * otherwise: Make the node information by elementId only. 51 * @sysCap Accessibility 52 */ 53 virtual void SearchElementInfoByAccessibilityId(const int64_t elementId, const int32_t requestId, 54 const sptr<IAccessibilityElementOperatorCallback> &callback, const int32_t mode) override; 55 56 /** 57 * @brief Make the child node information by accessibility ID and filtered by text and set the result by callback. 58 * @param elementId: The unique id of the component ID. 59 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 60 * @param callback To transfer the node info to ASAC and it defined by ASAC. 61 * @param text Filter for the child components to matched with the text 62 */ 63 virtual void SearchElementInfosByText(const int64_t elementId, const std::string &text, 64 const int32_t requestId, const sptr<IAccessibilityElementOperatorCallback> &callback) override; 65 66 /** 67 * @brief Make the node information of the component focused by the focus type specified. 68 * @param elementId: The unique id of the component ID. 69 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 70 * @param callback To transfer the node info to ASAC and it defined by ASAC. 71 * @param focusType FOCUS_TYPE_ACCESSIBILITY: accessibility focus 72 * FOCUS_TYPE_INPUT: text input focus 73 */ 74 virtual void FindFocusedElementInfo(const int64_t elementId, const int32_t focusType, const int32_t requestId, 75 const sptr<IAccessibilityElementOperatorCallback> &callback) override; 76 77 /** 78 * @brief Make the node info by current focus move direction. 79 * @param elementId: The unique id of the component ID. 80 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 81 * @param callback To transfer the node info to ASAC and it defined by ASAC. 82 * @param direction Refer to AccessibilityElementInfo.FocusMoveDirection(UP/DOWN/LEFT/RIGHT/FORWARD/BACKWARD) 83 */ 84 virtual void FocusMoveSearch(const int64_t elementId, const int32_t direction, const int32_t requestId, 85 const sptr<IAccessibilityElementOperatorCallback> &callback) override; 86 87 /** 88 * @brief To return the result of perform action. 89 * @param elementId: The unique id of the component ID. 90 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 91 * @param callback To transfer the node info to ASAC and it defined by ASAC. 92 * @param action Refer to [AccessibilityElementInfo.ActionType] 93 * @param actionArguments The parameter for action type. such as: 94 * action: ACCESSIBILITY_ACTION_NEXT_HTML_ITEM, 95 * actionArguments(ACTION_ARGU_HTML_ELEMENT,HtmlItemType) 96 * action: ACCESSIBILITY_ACTION_PREVIOUS_HTML_ITEM, 97 * actionArguments(ACTION_ARGU_HTML_ELEMENT,HtmlItemType) 98 * action: ACCESSIBILITY_ACTION_NEXT_TEXT, 99 * actionArguments(ACTION_ARGU_MOVE_UNIT,MOVE_UNIT_XXX) 100 * action: ACCESSIBILITY_ACTION_PREVIOUS_TEXT, 101 * actionArguments(ACTION_ARGU_MOVE_UNIT,MOVE_UNIT_XXX) 102 * action: ACCESSIBILITY_ACTION_SET_SELECTION, 103 * actionArguments({ACTION_ARGU_SELECT_TEXT_START,"1"(start location)}, 104 * {ACTION_ARGU_SELECT_TEXT_END,"10"(end location)}) 105 * action: ACCESSIBILITY_ACTION_SET_TEXT, 106 * actionArguments(ACTION_ARGU_SET_TEXT,"the text of setted") 107 */ 108 virtual void ExecuteAction(const int64_t elementId, const int32_t action, 109 const std::map<std::string, std::string> &actionArguments, 110 int32_t requestId, const sptr<IAccessibilityElementOperatorCallback> &callback) override; 111 112 /** 113 * @brief The function is called while accessibility System check the id of window is not equal 114 * to the id of active window when sendAccessibility. 115 */ 116 virtual void ClearFocus() override; 117 118 /** 119 * @brief the low layer is notified by the function called while accessibility system execute 120 * the function of executeAction from AS to check the all low windows cared the outside event. 121 * Example: PopupWindow receive the OUTSIDE_EVENT to close itself. 122 */ 123 virtual void OutsideTouch() override; 124 private: 125 /** 126 * @brief Write the descriptor of IPC. 127 * @param data It is include the descriptor of IPC. 128 * @return true: Write the descriptor successfully; otherwise is not. 129 */ 130 bool WriteInterfaceToken(MessageParcel &data); 131 132 /** 133 * @brief Send the command data from proxy to stub in IPC mechanism. 134 * @param code The code matched the function called. 135 * @param data Serializable data 136 * @param reply The response of IPC 137 * @param option The option parameter of IPC,such as: async,sync 138 * @return true: Write the descriptor successfully; otherwise is not. 139 */ 140 bool SendTransactCmd(AccessibilityInterfaceCode code, MessageParcel &data, 141 MessageParcel &reply, MessageOption &option); 142 static inline BrokerDelegator<AccessibilityElementOperatorProxy> delegator; 143 }; 144 } // namespace Accessibility 145 } // namespace OHOS 146 #endif // ACCESSIBILITY_ELEMENT_OPERATOR_PROXY_H