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 ARK_WEB_FIND_CALLBACK_H_
17 #define ARK_WEB_FIND_CALLBACK_H_
18 #pragma once
19 
20 #include "base/include/ark_web_base_ref_counted.h"
21 
22 namespace OHOS::ArkWeb {
23 
24 /*--ark web(source=webview)--*/
25 class ArkWebFindCallback : public virtual ArkWebBaseRefCounted {
26 public:
27     /**
28      * @brief Notify the host application that OnFindResultReceived
29      *
30      * @param active_match_ordinal int: the zero-based ordinal of the currently
31      *        selected match
32      * @param number_of_matches int: how many matches have been found
33      * @param is_done_counting bool: whether the find operation has actually
34      *        completed. The listener may be notified multiple times while the
35      *        operation is underway, and the number_of_matches value should not be
36      *        considered final unless is_done_counting is true.
37      */
38     /*--ark web()--*/
39     virtual void OnFindResultReceived(
40         const int active_match_ordinal, const int number_of_matches, const bool is_done_counting) = 0;
41 };
42 
43 } // namespace OHOS::ArkWeb
44 
45 #endif // ARK_WEB_FIND_CALLBACK_H_
46