accessibility/common/interface/include/iaccessibility_element_operator_callback.h

/*
 * Copyright (C) 2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef INTERFACE_ACCESSIBILITY_ELEMENT_OPERATOR_CALLBACK_H
#define INTERFACE_ACCESSIBILITY_ELEMENT_OPERATOR_CALLBACK_H

#include <cstdint>
#include <list>
#include <string>
#include <vector>
#include "accessibility_element_info.h"
#include "iremote_broker.h"

namespace OHOS {
namespace Accessibility {
/*
* The class supply the callback to feedback the result from UI to AA.
*/
class IAccessibilityElementOperatorCallback : public IRemoteBroker {
public:
    DECLARE_INTERFACE_DESCRIPTOR(u"ohos.accessibility.IAccessibilityElementOperatorCallback");

    /**
     * @brief Set the element information by accessibility id to AA.
     * @param infos The element info searched by accessibility id.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetSearchElementInfoByAccessibilityIdResult(const std::vector<AccessibilityElementInfo> &infos,
        const int32_t requestId) = 0;

    /**
     * @brief Set the element information by window id to AA.
     * @param infos The element info searched by window id.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetSearchDefaultFocusByWindowIdResult(const std::vector<AccessibilityElementInfo> &infos,
        const int32_t requestId) = 0;

    /**
     * @brief Set the element information matched with text to AA.
     * @param infos The element information searched matched with text.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetSearchElementInfoByTextResult(const std::vector<AccessibilityElementInfo> &infos,
        const int32_t requestId) = 0;

    /**
     * @brief Set the element information matched with focus type to AA.
     * @param info The element information searched matched with focus type.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetFindFocusedElementInfoResult(const AccessibilityElementInfo &info, const int32_t requestId) = 0;

    /**
     * @brief Set the element information by focus direction to AA.
     * @param info The element information searched by focus direction.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetFocusMoveSearchResult(const AccessibilityElementInfo &info, const int32_t requestId) = 0;

    /**
     * @brief Set the result of action executed to AA.
     * @param succeeded True: The action is executed successfully; otherwise is false.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetExecuteActionResult(const bool succeeded, const int32_t requestId) = 0;

    /**
     * @brief Set the result of cursor position to AA.
     * @param cursorPosition The cursorPosition to be returned.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetCursorPositionResult(const int32_t cursorPosition, const int32_t requestId) = 0;

    /**
     * @brief Set the search element info by specific property result.
     * @param infos The element infos searched by specific property.
     * @param treeInfos The element infos searched by specific property.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetSearchElementInfoBySpecificPropertyResult(const std::list<AccessibilityElementInfo> &infos,
         const std::list<AccessibilityElementInfo> &treeInfos, const int32_t requestId) = 0;

    virtual void SetFocusMoveSearchWithConditionResult(
        const std::list<AccessibilityElementInfo> &infos, const FocusMoveResult &result, const int32_t requestId) = 0;

    /**
     * @brief Set result of update accessibility element info to AA.
     * @param result The result code of update operation, refer to OperateVirtualNodeResult.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetUpdateCustomAccessibilityPropertyResult(const OperateVirtualNodeResult result,
        const int32_t requestId) = 0;
 
    /**
     * @brief Set result of add accessibility virtual node to AA.
     * @param result The result of add operation, refer to OperateVirtualNodeResult.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetAddAccessibilityVirtualNodeResult(const OperateVirtualNodeResult result,
        const int32_t requestId) = 0;
 
    /**
     * @brief Set result of remove accessibility virtual node to AA.
     * @param result The result of remove operation, refer to OperateVirtualNodeResult.
     * @param requestId The request id from AA, it is used to match with request and response.
     */
    virtual void SetRemoveAccessibilityVirtualNodeResult(const OperateVirtualNodeResult result,
        const int32_t requestId) = 0;

    /**
     * @brief Set isFilter.
     * @param enableFilter True : Perform filtering ;otherwise is false.
     */
    void SetIsFilter(bool enableFilter)
    {
        isFilter = enableFilter;
    }

    /**
     * @brief Get isFilter.
     */
    bool GetFilter()
    {
        return isFilter;
    }
private:
   bool isFilter = false;
};
} // namespace Accessibility
} // namespace OHOS
#endif // INTERFACE_ACCESSIBILITY_ELEMENT_OPERATOR_CALLBACK_H