1 #ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
2 #define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
5 * Copyright (c) 2016 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>
25 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
26 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
38 * @copydoc Toolkit::KeyboardFocusManager
40 class KeyboardFocusManager : public Dali::BaseObject
44 typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
47 * @copydoc Toolkit::KeyboardFocusManager::Get
49 static Toolkit::KeyboardFocusManager Get();
52 * Construct a new KeyboardFocusManager.
54 KeyboardFocusManager();
57 * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
59 bool SetCurrentFocusActor(Actor actor);
62 * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
64 Actor GetCurrentFocusActor();
67 * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
69 bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction);
72 * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
77 * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
79 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
82 * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
84 bool IsFocusGroup(Actor actor) const;
87 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
89 Actor GetFocusGroup(Actor actor);
92 * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
94 void SetFocusGroupLoop(bool enabled);
97 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
99 bool GetFocusGroupLoop() const;
102 * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
104 void SetFocusIndicatorActor(Actor indicator);
107 * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
109 Actor GetFocusIndicatorActor();
112 * Move current focus to backward
114 void MoveFocusBackward();
117 * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
119 void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
124 * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
126 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
129 * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
131 Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
134 * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
136 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
139 * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
141 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
144 * Connects a callback function with the object's signals.
145 * @param[in] object The object providing the signal.
146 * @param[in] tracker Used to disconnect the signal.
147 * @param[in] signalName The signal to connect to.
148 * @param[in] functor A newly allocated FunctorDelegate.
149 * @return True if the signal was connected.
150 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
152 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
159 virtual ~KeyboardFocusManager();
163 typedef Dali::Vector< Dali::BaseObject* > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
164 typedef FocusStack::Iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
167 * Get the focus group of current focused actor.
168 * @pre The FocusManager has been initialized.
169 * @return A handle to the parent of the current focused actor which is a focus group,
170 * or an empty handle if no actor is focused.
172 Actor GetCurrentFocusGroup();
175 * Move the focus to the specified actor and send notification for the focus change.
176 * @param actor The actor to be queried
177 * @return Whether the focus is successful or not
179 bool DoSetCurrentFocusActor(Actor actor);
182 * Move the focus to the next actor towards the specified direction within the layout control
183 * @param control The layout control to move the focus in
184 * @param actor The current focused actor
185 * @param direction The direction of focus movement
186 * @return Whether the focus is successful or not
188 bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
191 * Move the focus to the first focusable actor in the next focus group in the forward
192 * or backward direction. The "Tab" key changes the focus group in the forward direction
193 * and the "Shift-Tab" key changes it in the backward direction.
194 * @param forward Whether the direction of focus group change is forward or backward
195 * @return Whether the focus group change is successful or not
197 bool DoMoveFocusToNextFocusGroup(bool forward);
200 * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
201 * This function will emit FocusedActorEnterKeySignal.
202 * @param actor The actor to notify
204 void DoKeyboardEnter( Actor actor );
207 * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
208 * The layout control needs to internally set the focus order for the child actor and be able to
209 * tell KeyboardFocusmanager the next focusable actor in the given direction.
210 * @pre The KeyboardFocusManager has been initialized.
211 * @pre The Actor has been initialized.
212 * @param actor The actor to be checked.
213 * @return Whether the actor is a layout control or not.
215 bool IsLayoutControl(Actor actor) const;
218 * Returns the closest ancestor of the given actor that is a layout control.
219 * @param actor The actor to be checked for its parent layout control
220 * @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
222 Toolkit::Control GetParentLayoutControl(Actor actor) const;
225 * Callback for the key event when no actor in the stage has gained the key input focus
226 * @param[in] event The KeyEvent event.
228 void OnKeyEvent(const KeyEvent& event);
231 * Callback for the touch event when the screen is touched and when the touch ends
232 * (i.e. the down & up touch events only).
233 * @param[in] touch The touch information
235 void OnTouch( const TouchData& touch );
240 KeyboardFocusManager(const KeyboardFocusManager&);
242 KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
246 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
247 Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
248 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
249 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
251 unsigned int mCurrentFocusActor; ///< The actor ID of current focused actor
253 Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
255 bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
257 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.
259 bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
261 FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
263 SlotDelegate< KeyboardFocusManager > mSlotDelegate;
265 CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
269 } // namespace Internal
271 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
273 DALI_ASSERT_ALWAYS(obj);
275 Dali::BaseObject& handle = obj.GetBaseObject();
277 return static_cast<Internal::KeyboardFocusManager&>(handle);
280 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
282 DALI_ASSERT_ALWAYS(obj);
284 const Dali::BaseObject& handle = obj.GetBaseObject();
286 return static_cast<const Internal::KeyboardFocusManager&>(handle);
289 } // namespace Toolkit
293 #endif // __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__