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, 55 bool isFilter = false) override; 56 57 /** 58 * @brief Make the child node information by accessibility ID and filtered by text and set the result by callback. 59 * @param elementId: The unique id of the component ID. 60 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 61 * @param callback To transfer the node info to ASAC and it defined by ASAC. 62 * @param text Filter for the child components to matched with the text 63 */ 64 virtual void SearchElementInfosByText(const int64_t elementId, const std::string &text, 65 const int32_t requestId, const sptr<IAccessibilityElementOperatorCallback> &callback) override; 66 67 /** 68 * @brief Make the node information of the component focused by the focus type specified. 69 * @param elementId: The unique id of the component ID. 70 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 71 * @param callback To transfer the node info to ASAC and it defined by ASAC. 72 * @param focusType FOCUS_TYPE_ACCESSIBILITY: accessibility focus 73 * FOCUS_TYPE_INPUT: text input focus 74 */ 75 virtual void FindFocusedElementInfo(const int64_t elementId, const int32_t focusType, const int32_t requestId, 76 const sptr<IAccessibilityElementOperatorCallback> &callback) override; 77 78 /** 79 * @brief Make the node info by current focus move direction. 80 * @param elementId: The unique id of the component ID. 81 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 82 * @param callback To transfer the node info to ASAC and it defined by ASAC. 83 * @param direction Refer to AccessibilityElementInfo.FocusMoveDirection(UP/DOWN/LEFT/RIGHT/FORWARD/BACKWARD) 84 */ 85 virtual void FocusMoveSearch(const int64_t elementId, const int32_t direction, const int32_t requestId, 86 const sptr<IAccessibilityElementOperatorCallback> &callback) override; 87 88 /** 89 * @brief To return the result of perform action. 90 * @param elementId: The unique id of the component ID. 91 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 92 * @param callback To transfer the node info to ASAC and it defined by ASAC. 93 * @param action Refer to [AccessibilityElementInfo.ActionType] 94 * @param actionArguments The parameter for action type. such as: 95 * action: ACCESSIBILITY_ACTION_NEXT_HTML_ITEM, 96 * actionArguments(ACTION_ARGU_HTML_ELEMENT,HtmlItemType) 97 * action: ACCESSIBILITY_ACTION_PREVIOUS_HTML_ITEM, 98 * actionArguments(ACTION_ARGU_HTML_ELEMENT,HtmlItemType) 99 * action: ACCESSIBILITY_ACTION_NEXT_TEXT, 100 * actionArguments(ACTION_ARGU_MOVE_UNIT,MOVE_UNIT_XXX) 101 * action: ACCESSIBILITY_ACTION_PREVIOUS_TEXT, 102 * actionArguments(ACTION_ARGU_MOVE_UNIT,MOVE_UNIT_XXX) 103 * action: ACCESSIBILITY_ACTION_SET_SELECTION, 104 * actionArguments({ACTION_ARGU_SELECT_TEXT_START,"1"(start location)}, 105 * {ACTION_ARGU_SELECT_TEXT_END,"10"(end location)}) 106 * action: ACCESSIBILITY_ACTION_SET_TEXT, 107 * actionArguments(ACTION_ARGU_SET_TEXT,"the text of setted") 108 */ 109 virtual void ExecuteAction(const int64_t elementId, const int32_t action, 110 const std::map<std::string, std::string> &actionArguments, 111 int32_t requestId, const sptr<IAccessibilityElementOperatorCallback> &callback) override; 112 113 /** 114 * @brief To return the result of cursor position. 115 * @param elementId: The unique id of the component ID. 116 * @param requestId Matched the request and response. It needn't cared by ACE, transfer it by callback only. 117 * @param callback To transfer the node info to ASAC and it defined by ASAC. 118 */ 119 virtual void GetCursorPosition(const int64_t elementId, 120 int32_t requestId, const sptr<IAccessibilityElementOperatorCallback> &callback) override; 121 122 /** 123 * @brief The function is called while accessibility System check the id of window is not equal 124 * to the id of active window when sendAccessibility. 125 */ 126 virtual void ClearFocus() override; 127 128 /** 129 * @brief the low layer is notified by the function called while accessibility system execute 130 * the function of executeAction from AS to check the all low windows cared the outside event. 131 * Example: PopupWindow receive the OUTSIDE_EVENT to close itself. 132 */ 133 virtual void OutsideTouch() override; 134 135 /** 136 * @brief Set isFilter. 137 * @param enableFilter True : Perform filtering ;otherwise is false. 138 */ 139 void SetIsFilter(bool enableFilter); 140 141 /** 142 * @brief Get isFilter. 143 */ 144 bool GetFilter(); 145 146 /** 147 * @brief To return the result of elementId, treeId, childWindowId. 148 * @param elementId: The element Id. 149 * @param treeId: The tree Id. 150 * @param childWindowId The childwindow Id. 151 */ 152 virtual void SetChildTreeIdAndWinId(const int64_t elementId, const int32_t treeId, 153 const int32_t childWindowId) override; 154 155 /** 156 * @brief To return the result of treeId 157 * @param treeId: The tree Id. 158 */ 159 virtual void SetBelongTreeId(const int32_t treeId) override; 160 161 /** 162 * @brief Set the parent window Id to the element info. 163 * @param iParentWindowId The parent window Id 164 * @sysCap Accessibility 165 */ 166 void SetParentWindowId(const int32_t iParentWindowId) override; 167 private: 168 bool isFilter = false; 169 170 /** 171 * @brief Write the descriptor of IPC. 172 * @param data It is include the descriptor of IPC. 173 * @return true: Write the descriptor successfully; otherwise is not. 174 */ 175 bool WriteInterfaceToken(MessageParcel &data); 176 177 /** 178 * @brief Send the command data from proxy to stub in IPC mechanism. 179 * @param code The code matched the function called. 180 * @param data Serializable data 181 * @param reply The response of IPC 182 * @param option The option parameter of IPC,such as: async,sync 183 * @return true: Write the descriptor successfully; otherwise is not. 184 */ 185 bool SendTransactCmd(AccessibilityInterfaceCode code, MessageParcel &data, 186 MessageParcel &reply, MessageOption &option); 187 static inline BrokerDelegator<AccessibilityElementOperatorProxy> delegator; 188 }; 189 } // namespace Accessibility 190 } // namespace OHOS 191 #endif // ACCESSIBILITY_ELEMENT_OPERATOR_PROXY_H