1 #ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
2 #define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
5 * Copyright (c) 2014 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.
25 #include <dali/dali.h>
26 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
38 * @copydoc Toolkit::KeyboardFocusManager
40 class KeyboardFocusManager : public Dali::BaseObject
45 * @copydoc Toolkit::KeyboardFocusManager::Get
47 static Toolkit::KeyboardFocusManager Get();
50 * Construct a new KeyboardFocusManager.
52 KeyboardFocusManager();
55 * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
57 bool SetCurrentFocusActor(Actor actor);
60 * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
62 Actor GetCurrentFocusActor();
65 * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
67 bool MoveFocus(Toolkit::Control::KeyboardFocusNavigationDirection direction);
70 * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
75 * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
77 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
80 * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
82 bool IsFocusGroup(Actor actor) const;
85 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
87 Actor GetFocusGroup(Actor actor);
90 * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
92 void SetFocusGroupLoop(bool enabled);
95 * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
97 bool GetFocusGroupLoop() const;
100 * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
102 void SetFocusIndicatorActor(Actor indicator);
105 * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
107 Actor GetFocusIndicatorActor();
112 * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
114 Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2& PreFocusChangeSignal();
117 * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
119 Toolkit::KeyboardFocusManager::FocusChangedSignalV2& FocusChangedSignal();
122 * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
124 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2& FocusGroupChangedSignal();
127 * @copydoc Toolkit::KeyboardFocusManager::FocusedActorActivatedSignal()
129 Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2& FocusedActorActivatedSignal();
132 * Connects a callback function with the object's signals.
133 * @param[in] object The object providing the signal.
134 * @param[in] tracker Used to disconnect the signal.
135 * @param[in] signalName The signal to connect to.
136 * @param[in] functor A newly allocated FunctorDelegate.
137 * @return True if the signal was connected.
138 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
140 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
147 virtual ~KeyboardFocusManager();
152 * Get the focus group of current focused actor.
153 * @pre The FocusManager has been initialized.
154 * @return A handle to the parent of the current focused actor which is a focus group,
155 * or an empty handle if no actor is focused.
157 Actor GetCurrentFocusGroup();
160 * Move the focus to the specified actor and send notification for the focus change.
161 * @param actorID The ID of the actor to be queried
162 * @return Whether the focus is successful or not
164 bool DoSetCurrentFocusActor(const unsigned int actorID);
167 * Move the focus to the next actor towards the specified direction within the layout control
168 * @param control The layout control to move the focus in
169 * @param actor The current focused actor
170 * @param direction The direction of focus movement
171 * @return Whether the focus is successful or not
173 bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocusNavigationDirection direction);
176 * Move the focus to the first focusable actor in the next focus group in the forward
177 * or backward direction. The "Tab" key changes the focus group in the forward direction
178 * and the "Shift-Tab" key changes it in the backward direction.
179 * @param forward Whether the direction of focus group change is forward or backward
180 * @return Whether the focus group change is successful or not
182 bool DoMoveFocusToNextFocusGroup(bool forward);
185 * Activate the actor. If the actor is control, call OnActivated virtual function.
186 * This function will emit FocusedActorActivatedSignal.
187 * @param actor The actor to activate
189 void DoActivate(Actor actor);
192 * Create the default indicator actor to highlight the focused actor.
194 void CreateDefaultFocusIndicatorActor();
197 * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
198 * The layout control needs to internally set the focus order for the child actor and be able to
199 * tell KeyboardFocusmanager the next focusable actor in the given direction.
200 * @pre The KeyboardFocusManager has been initialized.
201 * @pre The Actor has been initialized.
202 * @param actor The actor to be checked.
203 * @return Whether the actor is a layout control or not.
205 bool IsLayoutControl(Actor actor) const;
208 * Returns the closest ancestor of the given actor that is a layout control.
209 * @param actor The actor to be checked for its parent layout control
210 * @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
212 Toolkit::Control GetParentLayoutControl(Actor actor) const;
215 * Callback for the key event when no actor in the stage has gained the key input focus
216 * @param[in] event The KeyEvent event.
218 void OnKeyEvent(const KeyEvent& event);
221 * Callback for the touch event when the screen is touched and when the touch ends
222 * (i.e. the down & up touch events only).
223 * @param[in] touchEvent The touch event
225 void OnTouched(const TouchEvent& touchEvent);
228 * Change the keyboard focus status when keyboard focus feature turned on or off.
229 * @return Whether the status is changed or not.
231 void OnPhysicalKeyboardStatusChanged(PhysicalKeyboard keyboard);
236 KeyboardFocusManager(const KeyboardFocusManager&);
238 KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
242 Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2 mPreFocusChangeSignalV2; ///< The signal to notify the focus will be changed
243 Toolkit::KeyboardFocusManager::FocusChangedSignalV2 mFocusChangedSignalV2; ///< The signal to notify the focus change
244 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2 mFocusGroupChangedSignalV2; ///< The signal to notify the focus group change
245 Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2 mFocusedActorActivatedSignalV2; ///< The signal to notify the activation of focused actor
247 unsigned int mCurrentFocusActor; ///< The actor ID of current focused actor
249 Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
251 bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
253 bool mIsKeyboardFocusEnabled:1; ///< Whether keyboard focus feature turned on/off
255 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.
257 bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
259 SlotDelegate< KeyboardFocusManager > mSlotDelegate;
262 } // namespace Internal
264 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
266 DALI_ASSERT_ALWAYS(obj);
268 Dali::BaseObject& handle = obj.GetBaseObject();
270 return static_cast<Internal::KeyboardFocusManager&>(handle);
273 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
275 DALI_ASSERT_ALWAYS(obj);
277 const Dali::BaseObject& handle = obj.GetBaseObject();
279 return static_cast<const Internal::KeyboardFocusManager&>(handle);
282 } // namespace Toolkit
286 #endif // __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__