[dali_2.0.15] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / focus-manager / keyinput-focus-manager-impl.h
1 #ifndef DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/object/base-object.h>
23 #include <dali/public-api/object/object-registry.h>
24 #include <string>
25
26 // INTERNAL INCLUDES
27 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
28 #include <dali-toolkit/public-api/controls/control.h>
29
30 namespace Dali
31 {
32 namespace Integration
33 {
34 class SceneHolder;
35
36 } // namespace Integration
37
38 namespace Toolkit
39 {
40 namespace Internal
41 {
42 class KeyInputFocusManager;
43
44 /**
45  * @copydoc Toolkit::KeyInputFocusManager
46  */
47 class KeyInputFocusManager : public Dali::BaseObject, public Dali::ConnectionTracker
48 {
49 public:
50   /**
51    * Construct a new KeyInputFocusManager.
52    */
53   KeyInputFocusManager();
54
55   /**
56    * @copydoc Toolkit::SetFocus
57    */
58   void SetFocus(Toolkit::Control control);
59
60   /**
61    * @copydoc Toolkit::RemoveFocus
62    */
63   void RemoveFocus(Toolkit::Control control);
64
65   /**
66    * @copydoc Toolkit::GetCurrentFocusControl
67    */
68   Toolkit::Control GetCurrentFocusControl() const;
69
70 public:
71   /**
72    * @copydoc Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignal()
73    */
74   Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType& KeyInputFocusChangedSignal();
75
76   /**
77    * Connects a callback function with the object's signals.
78    * @param[in] object The object providing the signal.
79    * @param[in] tracker Used to disconnect the signal.
80    * @param[in] signalName The signal to connect to.
81    * @param[in] functor A newly allocated FunctorDelegate.
82    * @return True if the signal was connected.
83    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
84    */
85   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
86
87 protected:
88   /**
89    * Destructor
90    */
91   virtual ~KeyInputFocusManager();
92
93 private:
94   /**
95    * This will be called when a new scene holder is created
96    * @param sceneHolder The new scene holder
97    */
98   void OnSceneHolderCreated(Dali::Integration::SceneHolder& sceneHolder);
99
100   /**
101    * Callback for the key event when no actor in the stage has gained the key input focus
102    * @param[in] event The KeyEvent event.
103    */
104   bool OnKeyEvent(const KeyEvent& event);
105
106   /**
107    * Signal handler called when a focused Control is removed from Scene.
108    * @param[in]  control  The control removed from the scene.
109    */
110   void OnFocusControlSceneDisconnection(Dali::Actor control);
111
112   /**
113     *  Recursively deliver events to the control and its parents, until the event is consumed or the stage is reached.
114    * @param[in]  control  The control got KeyEvent.
115    * @param[in]  event    The KeyEvent.
116    * @return True if KeyEvent is consumed.
117     */
118   bool EmitKeyEventSignal(Toolkit::Control control, const KeyEvent& event);
119
120 private:
121   // Undefined
122   KeyInputFocusManager(const KeyInputFocusManager&);
123
124   KeyInputFocusManager& operator=(const KeyInputFocusManager& rhs);
125
126 private:
127   // The key input focus change signal
128   Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType mKeyInputFocusChangedSignal;
129
130   SlotDelegate<KeyInputFocusManager> mSlotDelegate;
131
132   Toolkit::Control mCurrentFocusControl; ///< The current focused control
133 };
134
135 } // namespace Internal
136
137 inline Internal::KeyInputFocusManager& GetImpl(Dali::Toolkit::KeyInputFocusManager& obj)
138 {
139   DALI_ASSERT_ALWAYS(obj);
140
141   Dali::BaseObject& handle = obj.GetBaseObject();
142
143   return static_cast<Internal::KeyInputFocusManager&>(handle);
144 }
145
146 inline const Internal::KeyInputFocusManager& GetImpl(const Dali::Toolkit::KeyInputFocusManager& obj)
147 {
148   DALI_ASSERT_ALWAYS(obj);
149
150   const Dali::BaseObject& handle = obj.GetBaseObject();
151
152   return static_cast<const Internal::KeyInputFocusManager&>(handle);
153 }
154
155 } // namespace Toolkit
156
157 } // namespace Dali
158
159 #endif // DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H