1 #ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
2 #define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
5 * Copyright (c) 2017 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/devel-api/object/weak-handle.h>
26 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
27 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
39 * @copydoc Toolkit::KeyboardFocusManager
41 class KeyboardFocusManager : public Dali::BaseObject
45 typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
48 * @copydoc Toolkit::KeyboardFocusManager::Get
50 static Toolkit::KeyboardFocusManager Get();
53 * Construct a new KeyboardFocusManager.
55 KeyboardFocusManager();
58 * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
60 bool SetCurrentFocusActor(Actor actor);
63 * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
65 Actor GetCurrentFocusActor();
68 * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
70 bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction);
73 * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
78 * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
80 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
83 * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
85 bool IsFocusGroup(Actor actor) const;
88 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
90 Actor GetFocusGroup(Actor actor);
93 * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
95 void SetFocusGroupLoop(bool enabled);
98 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
100 bool GetFocusGroupLoop() const;
103 * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
105 void SetFocusIndicatorActor(Actor indicator);
108 * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
110 Actor GetFocusIndicatorActor();
113 * Move current focus to backward
115 void MoveFocusBackward();
118 * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
120 void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
125 * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
127 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
130 * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
132 Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
135 * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
137 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
140 * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
142 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
145 * Connects a callback function with the object's signals.
146 * @param[in] object The object providing the signal.
147 * @param[in] tracker Used to disconnect the signal.
148 * @param[in] signalName The signal to connect to.
149 * @param[in] functor A newly allocated FunctorDelegate.
150 * @return True if the signal was connected.
151 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
153 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
160 virtual ~KeyboardFocusManager();
164 typedef Dali::Vector< Dali::BaseObject* > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
165 typedef FocusStack::Iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
168 * Get the focus group of current focused actor.
169 * @pre The FocusManager has been initialized.
170 * @return A handle to the parent of the current focused actor which is a focus group,
171 * or an empty handle if no actor is focused.
173 Actor GetCurrentFocusGroup();
176 * Move the focus to the specified actor and send notification for the focus change.
177 * @param actor The actor to be queried
178 * @return Whether the focus is successful or not
180 bool DoSetCurrentFocusActor(Actor actor);
183 * Move the focus to the next actor towards the specified direction within the layout control
184 * @param control The layout control to move the focus in
185 * @param actor The current focused actor
186 * @param direction The direction of focus movement
187 * @return Whether the focus is successful or not
189 bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
192 * Move the focus to the first focusable actor in the next focus group in the forward
193 * or backward direction. The "Tab" key changes the focus group in the forward direction
194 * and the "Shift-Tab" key changes it in the backward direction.
195 * @param forward Whether the direction of focus group change is forward or backward
196 * @return Whether the focus group change is successful or not
198 bool DoMoveFocusToNextFocusGroup(bool forward);
201 * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
202 * This function will emit FocusedActorEnterKeySignal.
203 * @param actor The actor to notify
205 void DoKeyboardEnter( Actor actor );
208 * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
209 * The layout control needs to internally set the focus order for the child actor and be able to
210 * tell KeyboardFocusmanager the next focusable actor in the given direction.
211 * @pre The KeyboardFocusManager has been initialized.
212 * @pre The Actor has been initialized.
213 * @param actor The actor to be checked.
214 * @return Whether the actor is a layout control or not.
216 bool IsLayoutControl(Actor actor) const;
219 * Returns the closest ancestor of the given actor that is a layout control.
220 * @param actor The actor to be checked for its parent layout control
221 * @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
223 Toolkit::Control GetParentLayoutControl(Actor actor) const;
226 * Callback for the key event when no actor in the stage has gained the key input focus
227 * @param[in] event The KeyEvent event.
229 void OnKeyEvent(const KeyEvent& event);
232 * Callback for the touch event when the screen is touched and when the touch ends
233 * (i.e. the down & up touch events only).
234 * @param[in] touch The touch information
236 void OnTouch( const TouchData& touch );
241 KeyboardFocusManager(const KeyboardFocusManager&);
243 KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
247 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
248 Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
249 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
250 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
252 WeakHandle< Actor > mCurrentFocusActor; ///< A weak handle to the current focused actor
254 Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
256 bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
258 bool mIsFocusIndicatorEnabled:1; ///< Whether indicator should be shown / hidden. It could be enabled when keyboard focus feature enabled and navigation keys or 'Tab' key pressed.
260 bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
262 FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
264 SlotDelegate< KeyboardFocusManager > mSlotDelegate;
266 CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
270 } // namespace Internal
272 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
274 DALI_ASSERT_ALWAYS(obj);
276 Dali::BaseObject& handle = obj.GetBaseObject();
278 return static_cast<Internal::KeyboardFocusManager&>(handle);
281 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
283 DALI_ASSERT_ALWAYS(obj);
285 const Dali::BaseObject& handle = obj.GetBaseObject();
287 return static_cast<const Internal::KeyboardFocusManager&>(handle);
290 } // namespace Toolkit
294 #endif // __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__