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 OHOS_ABILITY_RUNTIME_PAGE_ABILITY_IMPL_H
17 #define OHOS_ABILITY_RUNTIME_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      * @param sessionInfo  Indicates the sessionInfo.
47      *
48      */
49     void HandleAbilityTransaction(const Want &want, const AAFwk::LifeCycleStateInfo &targetState,
50         sptr<AAFwk::SessionInfo> sessionInfo = nullptr) override;
51 
52     /**
53       * @brief Handling the life cycle switching of PageAbility in switch.
54       *
55       * @param want Indicates the structure containing information about the ability.
56       * @param targetState The life cycle state to switch to.
57       *
58       * @return return true if the lifecycle transaction successfully, otherwise return false.
59       *
60       */
61     bool AbilityTransaction(const Want &want, const AAFwk::LifeCycleStateInfo &targetState);
62 
63     void AbilityTransactionForeground(const Want &want, const AAFwk::LifeCycleStateInfo &targetState);
64 
65     /**
66      * @brief Execution the KeyDown callback of the ability
67      * @param keyEvent Indicates the key-down event.
68      *
69      * @return Returns true if this event is handled and will not be passed further; returns false if this event is
70      * not handled and should be passed to other handlers.
71      *
72      */
73     void DoKeyDown(const std::shared_ptr<MMI::KeyEvent>& keyEvent) override;
74 
75     /**
76      * @brief Execution the KeyUp callback of the ability
77      * @param keyEvent Indicates the key-up event.
78      *
79      * @return Returns true if this event is handled and will not be passed further; returns false if this event is
80      * not handled and should be passed to other handlers.
81      *
82      */
83     void DoKeyUp(const std::shared_ptr<MMI::KeyEvent>& keyEvent) override;
84 
85     /**
86      * @brief Called when a touch event is dispatched to this ability. The default implementation of this callback
87      * does nothing and returns false.
88      * @param touchEvent Indicates information about the touch event.
89      *
90      * @return Returns true if the event is handled; returns false otherwise.
91      *
92      */
93     void DoPointerEvent(std::shared_ptr<MMI::PointerEvent>& pointerEvent) override;
94 };
95 }  // namespace AppExecFwk
96 }  // namespace OHOS
97 #endif  // OHOS_ABILITY_RUNTIME_PAGE_ABILITY_IMPL_H
98