1 /*
2  * Copyright (c) 2021 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_COMMON_IME_TEXT_INPUT_PROXY_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMMON_IME_TEXT_INPUT_PROXY_H
18 
19 #include <memory>
20 
21 #include "base/utils/singleton.h"
22 #include "core/common/ime/text_input.h"
23 
24 namespace OHOS::Ace {
25 
26 class TextInputProxy : public Singleton<TextInputProxy>, public TextInput {
27     DECLARE_SINGLETON(TextInputProxy);
28 
29 public:
30     void SetDelegate(std::unique_ptr<TextInput>&& delegate);
31 
32     /**
33      * @brief When component needs to interact with IME, it is the first step.
34      *
35      * Internally an auto-increment `clientId` will be generated to identify each connection.
36      *
37      * @param[in] client The event receiver to handle IME event. Make it weak.
38      * @param[in] config Indicate how to show the keyboard.
39      * @param[in] taskExecutor The task executor to be posted to run JNI task.
40      *
41      * @return A connection which can interact with IME.
42      */
43     RefPtr<TextInputConnection> Attach(const WeakPtr<TextInputClient>& client, const TextInputConfiguration& config,
44         const RefPtr<TaskExecutor>& taskExecutor, int32_t instanceId) override;
45 
46 private:
47     std::unique_ptr<TextInput> delegate_;
48 };
49 
50 } // namespace OHOS::Ace
51 
52 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMMON_IME_TEXT_INPUT_PROXY_H
53