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 FRAMEWORKS_INPUTMETHOD_ABILITY_INCLUDE_I_INPUT_METHOD_AGENT_H 17 #define FRAMEWORKS_INPUTMETHOD_ABILITY_INCLUDE_I_INPUT_METHOD_AGENT_H 18 19 #include "global.h" 20 #include "i_keyevent_consumer.h" 21 #include "input_method_utils.h" 22 #include "iremote_broker.h" 23 #include "key_event.h" 24 25 /** 26 * brief Definition of interface IInputMethodAgent 27 * It defines the remote calls from input client to input method service 28 */ 29 namespace OHOS { 30 namespace MiscServices { 31 class IInputMethodAgent : public IRemoteBroker { 32 public: 33 enum { 34 AGENT_CODE_BEGIN, 35 DISPATCH_KEY_EVENT = AGENT_CODE_BEGIN, 36 ON_CURSOR_UPDATE, 37 ON_SELECTION_CHANGE, 38 SET_CALLING_WINDOW_ID, 39 SEND_PRIVATE_COMMAND, 40 ON_ATTRIBUTE_CHANGE, 41 SEND_MESSAGE, 42 AGENT_CODE_END, 43 }; 44 45 DECLARE_INTERFACE_DESCRIPTOR(u"ohos.miscservices.inputmethod.IInputMethodAgent"); 46 47 virtual int32_t DispatchKeyEvent( 48 const std::shared_ptr<MMI::KeyEvent> &keyEvent, sptr<IKeyEventConsumer> &consumer) = 0; 49 virtual void OnCursorUpdate(int32_t positionX, int32_t positionY, int height) = 0; 50 virtual void OnSelectionChange( 51 std::u16string text, int32_t oldBegin, int32_t oldEnd, int32_t newBegin, int32_t newEnd) = 0; 52 virtual void SetCallingWindow(uint32_t windowId) = 0; 53 virtual void OnAttributeChange(const InputAttribute &attribute) = 0; 54 virtual int32_t SendPrivateCommand(const std::unordered_map<std::string, PrivateDataValue> &privateCommand) = 0; 55 virtual int32_t SendMessage(const ArrayBuffer &arraybuffer) = 0; 56 }; 57 } // namespace MiscServices 58 } // namespace OHOS 59 #endif // FRAMEWORKS_INPUTMETHOD_ABILITY_INCLUDE_I_INPUT_METHOD_AGENT_H 60