1 #ifndef DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/object-registry.h>
27 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
28 #include <dali-toolkit/public-api/controls/control.h>
41 class KeyInputFocusManager;
44 * @copydoc Toolkit::KeyInputFocusManager
46 class KeyInputFocusManager : public Dali::BaseObject, public Dali::ConnectionTracker
50 * Construct a new KeyInputFocusManager.
52 KeyInputFocusManager();
55 * @copydoc Toolkit::SetFocus
57 void SetFocus(Toolkit::Control control);
60 * @copydoc Toolkit::RemoveFocus
62 void RemoveFocus(Toolkit::Control control);
65 * @copydoc Toolkit::GetCurrentFocusControl
67 Toolkit::Control GetCurrentFocusControl() const;
72 * @copydoc Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignal()
74 Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType& KeyInputFocusChangedSignal();
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.
85 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
92 virtual ~KeyInputFocusManager();
96 * This will be called when a new window is created
97 * @param window The new window
99 void OnWindowCreated( Dali::Window& window );
102 * Callback for the key event when no actor in the stage has gained the key input focus
103 * @param[in] event The KeyEvent event.
105 bool OnKeyEvent(const KeyEvent& event);
108 * Signal handler called when a focused Control is removed from Stage.
109 * @param[in] control The control removed from stage.
111 void OnFocusControlStageDisconnection( Dali::Actor control );
114 * Recursively deliver events to the control and its parents, until the event is consumed or the stage is reached.
115 * @param[in] control The control got KeyEvent.
116 * @param[in] event The KeyEvent.
117 * @return True if KeyEvent is consumed.
119 bool EmitKeyEventSignal( Toolkit::Control control, const KeyEvent& event );
124 KeyInputFocusManager(const KeyInputFocusManager&);
126 KeyInputFocusManager& operator=(const KeyInputFocusManager& rhs);
130 // The key input focus change signal
131 Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType mKeyInputFocusChangedSignal;
133 SlotDelegate< KeyInputFocusManager > mSlotDelegate;
135 Toolkit::Control mCurrentFocusControl; ///< The current focused control
138 } // namespace Internal
140 inline Internal::KeyInputFocusManager& GetImpl(Dali::Toolkit::KeyInputFocusManager& obj)
142 DALI_ASSERT_ALWAYS(obj);
144 Dali::BaseObject& handle = obj.GetBaseObject();
146 return static_cast<Internal::KeyInputFocusManager&>(handle);
149 inline const Internal::KeyInputFocusManager& GetImpl(const Dali::Toolkit::KeyInputFocusManager& obj)
151 DALI_ASSERT_ALWAYS(obj);
153 const Dali::BaseObject& handle = obj.GetBaseObject();
155 return static_cast<const Internal::KeyInputFocusManager&>(handle);
158 } // namespace Toolkit
162 #endif // DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H