1 #ifndef DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_KEYBOARD_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.
22 #include <dali/public-api/object/base-object.h>
23 #include <dali/public-api/object/weak-handle.h>
24 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
28 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
38 } // namespace Integration
47 * @copydoc Toolkit::KeyboardFocusManager
49 class KeyboardFocusManager : public Dali::BaseObject, public ConnectionTracker
53 typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
56 * @copydoc Toolkit::KeyboardFocusManager::Get
58 static Toolkit::KeyboardFocusManager Get();
61 * Construct a new KeyboardFocusManager.
63 KeyboardFocusManager();
66 * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
68 bool SetCurrentFocusActor(Actor actor);
71 * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
73 Actor GetCurrentFocusActor();
76 * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
78 bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction);
81 * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
86 * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
88 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
91 * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
93 bool IsFocusGroup(Actor actor) const;
96 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
98 Actor GetFocusGroup(Actor actor);
101 * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
103 void SetFocusGroupLoop(bool enabled);
106 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
108 bool GetFocusGroupLoop() const;
111 * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
113 void SetFocusIndicatorActor(Actor indicator);
116 * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
118 Actor GetFocusIndicatorActor();
121 * Move current focus to backward
123 void MoveFocusBackward();
126 * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
128 void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
131 * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
133 void EnableFocusIndicator(bool enable);
136 * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
138 bool IsFocusIndicatorEnabled() const;
143 * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
145 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
148 * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
150 Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
153 * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
155 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
158 * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
160 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
163 * Connects a callback function with the object's signals.
164 * @param[in] object The object providing the signal.
165 * @param[in] tracker Used to disconnect the signal.
166 * @param[in] signalName The signal to connect to.
167 * @param[in] functor A newly allocated FunctorDelegate.
168 * @return True if the signal was connected.
169 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
171 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
178 virtual ~KeyboardFocusManager();
182 typedef std::vector< WeakHandle< Actor > > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
183 typedef FocusStack::iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
186 * This will be called when the adaptor is initialized
188 void OnAdaptorInit();
191 * This will be called when a new scene holder is created
192 * @param sceneHolder The new scene holder
194 void OnSceneHolderCreated( Dali::Integration::SceneHolder& sceneHolder );
197 * Get configuration from StyleManager.
199 void GetConfigurationFromStyleManger();
202 * Get the focus group of current focused actor.
203 * @pre The FocusManager has been initialized.
204 * @return A handle to the parent of the current focused actor which is a focus group,
205 * or an empty handle if no actor is focused.
207 Actor GetCurrentFocusGroup();
210 * Move the focus to the specified actor and send notification for the focus change.
211 * @param actor The actor to be queried
212 * @return Whether the focus is successful or not
214 bool DoSetCurrentFocusActor(Actor actor);
217 * Move the focus to the next actor towards the specified direction within the layout control
218 * @param control The layout control to move the focus in
219 * @param actor The current focused actor
220 * @param direction The direction of focus movement
221 * @return Whether the focus is successful or not
223 bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
226 * Move the focus to the first focusable actor in the next focus group in the forward
227 * or backward direction. The "Tab" key changes the focus group in the forward direction
228 * and the "Shift-Tab" key changes it in the backward direction.
229 * @param forward Whether the direction of focus group change is forward or backward
230 * @return Whether the focus group change is successful or not
232 bool DoMoveFocusToNextFocusGroup(bool forward);
235 * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
236 * This function will emit FocusedActorEnterKeySignal.
237 * @param actor The actor to notify
239 void DoKeyboardEnter( Actor actor );
242 * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
243 * The layout control needs to internally set the focus order for the child actor and be able to
244 * tell KeyboardFocusmanager the next focusable actor in the given direction.
245 * @pre The KeyboardFocusManager has been initialized.
246 * @pre The Actor has been initialized.
247 * @param actor The actor to be checked.
248 * @return Whether the actor is a layout control or not.
250 bool IsLayoutControl(Actor actor) const;
253 * Returns the closest ancestor of the given actor that is a layout control.
254 * @param actor The actor to be checked for its parent layout control
255 * @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
257 Toolkit::Control GetParentLayoutControl(Actor actor) const;
260 * Callback for the key event when no actor in the stage has gained the key input focus
261 * @param[in] event The KeyEvent event.
263 void OnKeyEvent(const KeyEvent& event);
266 * Callback for the touch event when the screen is touched and when the touch ends
267 * (i.e. the down & up touch events only).
268 * @param[in] touch The touch information
270 void OnTouch( const TouchData& touch );
275 KeyboardFocusManager(const KeyboardFocusManager&);
277 KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
281 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
282 Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
283 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
284 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
286 WeakHandle< Actor > mCurrentFocusActor; ///< A weak handle to the current focused actor
288 Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
290 int 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.
292 bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
294 bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
296 bool mClearFocusOnTouch:1; ///< Whether clear focus on touch.
298 bool mEnableFocusIndicator; ///< Whether use focus indicator
300 bool mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused.
302 FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
304 SlotDelegate< KeyboardFocusManager > mSlotDelegate;
306 CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
310 } // namespace Internal
312 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
314 DALI_ASSERT_ALWAYS(obj);
316 Dali::BaseObject& handle = obj.GetBaseObject();
318 return static_cast<Internal::KeyboardFocusManager&>(handle);
321 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
323 DALI_ASSERT_ALWAYS(obj);
325 const Dali::BaseObject& handle = obj.GetBaseObject();
327 return static_cast<const Internal::KeyboardFocusManager&>(handle);
330 } // namespace Toolkit
334 #endif // DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H