1 #ifndef DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
5 * Copyright (c) 2021 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.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/weak-handle.h>
27 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
28 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
29 #include <dali/devel-api/adaptor-framework/window-devel.h>
37 } // namespace Integration
44 * @copydoc Toolkit::KeyboardFocusManager
46 class KeyboardFocusManager : public Dali::BaseObject, public ConnectionTracker
49 typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
51 enum FocusIndicatorState
53 UNKNOWN = -1, ///< Unknown state
54 HIDE = 0, ///< FocusIndicator is hidden
55 SHOW = 1, ///< FocusIndicator is shown
58 enum EnableFocusedIndicatorState
60 DISABLE = 0, ///< FocusIndicator is disable
61 ENABLE = 1, ///< FocusIndicator is enable
64 enum FocusedIndicatorModeState
66 NONE = 0, ///< Set nothing
67 ALWAYS_SHOW = 1, ///< FocusIndicator is always shown
71 * @copydoc Toolkit::KeyboardFocusManager::Get
73 static Toolkit::KeyboardFocusManager Get();
76 * Construct a new KeyboardFocusManager.
78 KeyboardFocusManager();
81 * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
83 bool SetCurrentFocusActor(Actor actor);
86 * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
88 Actor GetCurrentFocusActor();
91 * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
93 bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction, const std::string& deviceName = "");
96 * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
101 * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
103 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
106 * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
108 bool IsFocusGroup(Actor actor) const;
111 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
113 Actor GetFocusGroup(Actor actor);
116 * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
118 void SetFocusGroupLoop(bool enabled);
121 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
123 bool GetFocusGroupLoop() const;
126 * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
128 void SetFocusIndicatorActor(Actor indicator);
131 * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
133 Actor GetFocusIndicatorActor();
136 * Move current focus to backward
138 void MoveFocusBackward();
141 * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
143 void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
146 * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
148 void EnableFocusIndicator(bool enable);
151 * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
153 bool IsFocusIndicatorEnabled() const;
156 * @copydoc Toolkit::DevelKeyboardFocusManager::EnableDefaultAlgorithm
158 void EnableDefaultAlgorithm(bool enable);
161 * @copydoc Toolkit::DevelKeyboardFocusManager::IsDefaultAlgorithmEnabled
163 bool IsDefaultAlgorithmEnabled() const;
166 * @copydoc Toolkit::DevelKeyboardFocusManager::SetFocusFinderRootActor
168 void SetFocusFinderRootActor(Actor actor);
171 * @copydoc Toolkit::DevelKeyboardFocusManager::ResetFocusFinderRootActor
173 void ResetFocusFinderRootActor();
177 * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
179 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
182 * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
184 Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
187 * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
189 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
192 * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
194 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
197 * Connects a callback function with the object's signals.
198 * @param[in] object The object providing the signal.
199 * @param[in] tracker Used to disconnect the signal.
200 * @param[in] signalName The signal to connect to.
201 * @param[in] functor A newly allocated FunctorDelegate.
202 * @return True if the signal was connected.
203 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
205 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
211 virtual ~KeyboardFocusManager();
214 typedef std::vector<WeakHandle<Actor> > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
215 typedef FocusStack::iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
218 * This will be called when the adaptor is initialized
220 void OnAdaptorInit();
223 * This will be called when a new scene holder is created
224 * @param sceneHolder The new scene holder
226 void OnSceneHolderCreated(Dali::Integration::SceneHolder& sceneHolder);
229 * Get configuration from StyleManager.
231 void GetConfigurationFromStyleManger();
234 * Get the focus group of current focused actor.
235 * @pre The FocusManager has been initialized.
236 * @return A handle to the parent of the current focused actor which is a focus group,
237 * or an empty handle if no actor is focused.
239 Actor GetCurrentFocusGroup();
242 * Move the focus to the specified actor and send notification for the focus change.
243 * @param actor The actor to be queried
244 * @return Whether the focus is successful or not
246 bool DoSetCurrentFocusActor(Actor actor);
249 * Move the focus to the next actor towards the specified direction within the layout control
250 * @param control The layout control to move the focus in
251 * @param actor The current focused actor
252 * @param direction The direction of focus movement
253 * @return Whether the focus is successful or not
255 bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
258 * Move the focus to the first focusable actor in the next focus group in the forward
259 * or backward direction. The "Tab" key changes the focus group in the forward direction
260 * and the "Shift-Tab" key changes it in the backward direction.
261 * @param forward Whether the direction of focus group change is forward or backward
262 * @return Whether the focus group change is successful or not
264 bool DoMoveFocusToNextFocusGroup(bool forward);
267 * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
268 * This function will emit FocusedActorEnterKeySignal.
269 * @param actor The actor to notify
271 void DoKeyboardEnter(Actor actor);
274 * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
275 * The layout control needs to internally set the focus order for the child actor and be able to
276 * tell KeyboardFocusmanager the next focusable actor in the given direction.
277 * @pre The KeyboardFocusManager has been initialized.
278 * @pre The Actor has been initialized.
279 * @param actor The actor to be checked.
280 * @return Whether the actor is a layout control or not.
282 bool IsLayoutControl(Actor actor) const;
285 * Returns the closest ancestor of the given actor that is a layout control.
286 * @param actor The actor to be checked for its parent layout control
287 * @return The parent layout control the given actor belongs to or an empty handle if the given actor doesn't belong to a layout control
289 Toolkit::Control GetParentLayoutControl(Actor actor) const;
292 * Callback for the key event when no actor in the stage has gained the key input focus
293 * @param[in] event The KeyEvent event.
295 void OnKeyEvent(const KeyEvent& event);
298 * Callback for the touch event when the screen is touched and when the touch ends
299 * (i.e. the down & up touch events only).
300 * @param[in] touch The touch information
302 void OnTouch(const TouchEvent& touch);
305 * Callback for the wheel event when the custom wheel event occurs.
306 * @param[in] wheel The WheelEvent information
308 bool OnCustomWheelEvent(const WheelEvent& wheel);
311 * Callback for the wheel event when the wheel event occurs.
312 * @param[in] wheel The WheelEvent information
314 void OnWheelEvent(const WheelEvent& wheel);
317 * Called when the window focus is changed.
318 * @param[in] window The window whose focus is changed
319 * @param[in] focusIn Whether the focus is in/out
321 void OnWindowFocusChanged(Window window, bool focusIn);
324 * Get the focus Actor from current window
326 Actor GetFocusActorFromCurrentWindow();
329 * Recursively deliver events to the control and its parents, until the event is consumed or the stage is reached.
330 * @param[in] actor The actor got WheelEvent.
331 * @param[in] event The WheelEvent.
332 * @return True if WheelEvent is consumed.
334 bool EmitCustomWheelSignals(Actor actor, const WheelEvent& event);
337 * Clear the focus indicator actor.
339 void ClearFocusIndicator();
343 KeyboardFocusManager(const KeyboardFocusManager&);
345 KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
348 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
349 Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
350 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
351 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
353 WeakHandle<Actor> mCurrentFocusActor; ///< A weak handle to the current focused actor
355 Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
357 WeakHandle<Actor> mFocusFinderRootActor; ///<The root actor from which the focus finder is started.
359 FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
361 SlotDelegate<KeyboardFocusManager> mSlotDelegate;
363 CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
365 typedef std::vector<std::pair<WeakHandle<Layer>, WeakHandle<Actor> > > FocusActorContainer;
367 FocusActorContainer mCurrentFocusActors; ///< A container of focused actors
369 WeakHandle<Layer> mCurrentFocusedWindow; ///< A weak handle to the current focused window's root layer
371 FocusIndicatorState mIsFocusIndicatorShown; ///< Whether indicator should be shown / hidden when getting focus. It could be enabled when keyboard focus feature is enabled and navigation keys or 'Tab' key are pressed.
373 EnableFocusedIndicatorState mEnableFocusIndicator; ///< Whether use focus indicator
375 FocusedIndicatorModeState mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused
377 bool mFocusGroupLoopEnabled : 1; ///< Whether the focus movement is looped within the same focus group
379 bool mIsWaitingKeyboardFocusChangeCommit : 1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
381 bool mClearFocusOnTouch : 1; ///< Whether clear focus on touch.
383 bool mEnableDefaultAlgorithm : 1; ///< Whether use default algorithm focus
387 } // namespace Internal
389 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
391 DALI_ASSERT_ALWAYS(obj);
393 Dali::BaseObject& handle = obj.GetBaseObject();
395 return static_cast<Internal::KeyboardFocusManager&>(handle);
398 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
400 DALI_ASSERT_ALWAYS(obj);
402 const Dali::BaseObject& handle = obj.GetBaseObject();
404 return static_cast<const Internal::KeyboardFocusManager&>(handle);
407 } // namespace Toolkit
411 #endif // DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H