1 #ifndef __DALI_TOOLKIT_KEYBOARD_FOCUS_MANAGER_H__
2 #define __DALI_TOOLKIT_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.
22 #include <dali-toolkit/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
32 class KeyboardFocusManager;
36 * @brief Provides the functionality of handling keyboard navigation
37 * and maintaining the two dimensional keyboard focus chain.
39 * It provides functionality of setting the focus and moving the focus
40 * in four directions (i.e. Left, Right, Up and Down). It also draws a
41 * highlight for the focused actor and emits a signal when the focus
45 * | %Signal Name | Method |
46 * |----------------------------------|------------------------------------|
47 * | keyboard-pre-focus-change | @ref PreFocusChangeSignal() |
48 * | keyboard-focus-changed | @ref FocusChangedSignal() |
49 * | keyboard-focus-group-changed | @ref FocusGroupChangedSignal() |
50 * | keyboard-focused-actor-activated | @ref FocusedActorActivatedSignal() |
52 class DALI_IMPORT_API KeyboardFocusManager : public BaseHandle
57 /// @brief Pre focus change signal
58 typedef Signal< Actor ( Actor, Actor, Control::KeyboardFocusNavigationDirection ) > PreFocusChangeSignalType;
60 /// @brief Focus changed signal
61 typedef Signal< void ( Actor, Actor ) > FocusChangedSignalType;
63 /// @brief Focus group changed signal
64 typedef Signal< void ( Actor, bool ) > FocusGroupChangedSignalType;
66 /// @brief Focused actor activated signal
67 typedef Signal< void ( Actor ) > FocusedActorActivatedSignalType;
70 * @brief Create a KeyboardFocusManager handle; this can be initialised with KeyboardFocusManager::New().
72 * Calling member functions with an uninitialised handle is not allowed.
74 KeyboardFocusManager();
79 * This is non-virtual since derived Handle types must not contain data or virtual methods.
81 ~KeyboardFocusManager();
84 * @brief Get the singleton of KeyboardFocusManager object.
86 * @return A handle to the KeyboardFocusManager control.
88 static KeyboardFocusManager Get();
91 * @brief Move the keyboard focus to the given actor.
93 * Only one actor can be focused at the same time. The actor must
94 * be in the stage already and keyboard focusable.
96 * @pre The KeyboardFocusManager has been initialized.
97 * @pre The Actor has been initialized.
98 * @param actor The actor to be focused
99 * @return Whether the focus is successful or not
101 bool SetCurrentFocusActor(Actor actor);
104 * @brief Get the current focused actor.
106 * @pre The KeyboardFocusManager has been initialized.
107 * @return A handle to the current focused actor or an empty handle if no actor is focused.
109 Actor GetCurrentFocusActor();
112 * @brief Move the focus to the next focusable actor in the focus
113 * chain in the given direction (according to the focus traversal
116 * @pre The KeyboardFocusManager has been initialized.
117 * @param direction The direction of focus movement
118 * @return true if the movement was successful
120 bool MoveFocus(Control::KeyboardFocusNavigationDirection direction);
123 * @brief Clear the focus from the current focused actor if any, so
124 * that no actor is focused in the focus chain.
126 * It will emit focus changed signal without current focused actor
127 * @pre The KeyboardFocusManager has been initialized.
132 * @brief Set whether the focus movement should be looped within the same focus group.
134 * The focus movement is not looped by default.
135 * @pre The KeyboardFocusManager has been initialized.
136 * @param enabled Whether the focus movement should be looped
138 void SetFocusGroupLoop(bool enabled);
141 * @brief Get whether the focus movement should be looped within the same focus group.
143 * @pre The KeyboardFocusManager has been initialized.
144 * @return Whether the focus movement should be looped
146 bool GetFocusGroupLoop() const;
149 * @brief Set whether an actor is a focus group that can limit the
150 * scope of focus movement to its child actors in the focus chain.
152 * Layout controls set themselves as focus groups by default.
154 * @pre The KeyboardFocusManager has been initialized.
155 * @pre The Actor has been initialized.
156 * @param actor The actor to be set as a focus group.
157 * @param isFocusGroup Whether to set the actor as a focus group or not.
159 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
162 * @brief Check whether the actor is set as a focus group or not.
164 * @pre The KeyboardFocusManager has been initialized.
165 * @pre The Actor has been initialized.
166 * @param actor The actor to be checked.
167 * @return Whether the actor is set as a focus group.
169 bool IsFocusGroup(Actor actor) const;
172 * @brief Returns the closest ancestor of the given actor that is a focus group.
174 * @param actor The actor to be checked for its focus group
175 * @return The focus group the given actor belongs to or an empty handle if the given actor
176 * doesn't belong to any focus group
178 Actor GetFocusGroup(Actor actor);
181 * @brief Set the focus indicator actor.
183 * This will replace the default focus indicator actor in
184 * KeyboardFocusManager and will be added to the focused actor as a
187 * @pre The KeyboardFocusManager has been initialized.
188 * @pre The indicator actor has been initialized.
189 * @param indicator The indicator actor to be added
191 void SetFocusIndicatorActor(Actor indicator);
194 * @brief Get the focus indicator actor.
196 * @pre The KeyboardFocusManager has been initialized.
197 * @return A handle to the focus indicator actor
199 Actor GetFocusIndicatorActor();
204 * @brief This signal is emitted before the focus is going to be changed.
206 * KeyboardFocusManager makes the best guess for which actor to
207 * focus towards the given direction, but applications might want to
208 * change that. By connecting with this signal, they can check the
209 * proposed actor to focus and return a different actor if they
210 * wish. This signal is only emitted when the navigation key is
211 * pressed and KeyboardFocusManager tries to move the focus
212 * automatically. It won't be emitted for focus movement by calling
213 * SetCurrentFocusActor directly.
215 * A callback of the following type may be connected:
217 * Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocusNavigationDirection direction);
219 * @pre The Object has been initialized.
220 * @return The signal to connect to.
222 PreFocusChangeSignalType& PreFocusChangeSignal();
225 * @brief This signal is emitted after the current focused actor has been changed.
227 * A callback of the following type may be connected:
229 * void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
231 * @pre The Object has been initialized.
232 * @return The signal to connect to.
234 FocusChangedSignalType& FocusChangedSignal();
237 * @brief This signal is emitted when the focus group has been changed.
239 * If the current focus group has a parent layout control,
240 * KeyboardFocusManager will make the best guess for the next focus
241 * group to move the focus to in the given direction (forward or
242 * backward). If not, the application has to set the new focus.
244 * A callback of the following type may be connected:
246 * void YourCallbackName(Actor currentFocusedActor, bool forward);
248 * @pre The Object has been initialized.
249 * @return The signal to connect to.
251 FocusGroupChangedSignalType& FocusGroupChangedSignal();
254 * @brief This signal is emitted when the current focused actor is activated.
256 * A callback of the following type may be connected:
258 * void YourCallbackName(Actor activatedActor);
260 * @pre The Object has been initialized.
261 * @return The signal to connect to.
263 FocusedActorActivatedSignalType& FocusedActorActivatedSignal();
265 // Not intended for application developers
268 * @brief Creates a new handle from the implementation.
270 * @param[in] impl A pointer to the object.
272 explicit DALI_INTERNAL KeyboardFocusManager(Internal::KeyboardFocusManager *impl);
274 }; // class KeyboardFocusManager
276 } // namespace Toolkit
280 #endif // __DALI_TOOLKIT_KEYBOARD_FOCUS_MANAGER_H__