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_APPEXECFWK_OHOS_PAGE_ABILITY_IMPL_H 17 #define FOUNDATION_APPEXECFWK_OHOS_PAGE_ABILITY_IMPL_H 18 19 #include "ability_impl.h" 20 21 namespace OHOS { 22 namespace AppExecFwk { 23 class Ability; 24 class AbilityHandler; 25 class AbilityLocalRecord; 26 class AbilityImpl; 27 class PageAbilityImpl final : public AbilityImpl { 28 public: 29 /** 30 * @brief Constructor. 31 * 32 */ 33 PageAbilityImpl() = default; 34 35 /** 36 * @brief Destructor. 37 * 38 */ 39 ~PageAbilityImpl() = default; 40 41 /** 42 * @brief Handling the life cycle switching of PageAbility. 43 * 44 * @param want Indicates the structure containing information about the ability. 45 * @param targetState The life cycle state to switch to. 46 * 47 */ 48 void HandleAbilityTransaction(const Want &want, const AAFwk::LifeCycleStateInfo &targetState); 49 50 /** 51 * @brief Handling the life cycle switching of PageAbility in switch. 52 * 53 * @param want Indicates the structure containing information about the ability. 54 * @param targetState The life cycle state to switch to. 55 * 56 * @return return true if the lifecycle transaction successfully, otherwise return false. 57 * 58 */ 59 bool AbilityTransaction(const Want &want, const AAFwk::LifeCycleStateInfo &targetState); 60 61 /** 62 * @brief Execution the KeyDown callback of the ability 63 * @param keyCode Indicates the code of the key pressed. 64 * @param keyEvent Indicates the key-down event. 65 * 66 * @return Returns true if this event is handled and will not be passed further; returns false if this event is 67 * not handled and should be passed to other handlers. 68 * 69 */ 70 bool DoKeyDown(int keyCode, const KeyEvent &keyEvent); 71 72 /** 73 * @brief Execution the KeyUp callback of the ability 74 * @param keyCode Indicates the code of the key released. 75 * @param keyEvent Indicates the key-up event. 76 * 77 * @return Returns true if this event is handled and will not be passed further; returns false if this event is 78 * not handled and should be passed to other handlers. 79 * 80 */ 81 bool DoKeyUp(int keyCode, const KeyEvent &keyEvent); 82 83 /** 84 * @brief Called when a touch event is dispatched to this ability. The default implementation of this callback 85 * does nothing and returns false. 86 * @param touchEvent Indicates information about the touch event. 87 * 88 * @return Returns true if the event is handled; returns false otherwise. 89 * 90 */ 91 bool DoTouchEvent(const TouchEvent &touchEvent); 92 }; 93 } // namespace AppExecFwk 94 } // namespace OHOS 95 #endif // FOUNDATION_APPEXECFWK_OHOS_PAGE_ABILITY_IMPL_H