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
44 class DALI_IMPORT_API KeyboardFocusManager : public BaseHandle
48 static const char* const SIGNAL_PRE_FOCUS_CHANGE; ///< name "keyboard-pre-focus-change"
49 static const char* const SIGNAL_FOCUS_CHANGED; ///< name "keyboard-focus-changed"
50 static const char* const SIGNAL_FOCUS_GROUP_CHANGED; ///< name "keyboard-focus-group-changed"
51 static const char* const SIGNAL_FOCUSED_ACTOR_ACTIVATED; ///< name "keyboard-focused-actor-activated"
55 /// @brief Pre focus change signal
56 typedef SignalV2< Actor ( Actor, Actor, Control::KeyboardFocusNavigationDirection ) > PreFocusChangeSignalV2;
58 /// @brief Focus changed signal
59 typedef SignalV2< void ( Actor, Actor ) > FocusChangedSignalV2;
61 /// @brief Focus group changed signal
62 typedef SignalV2< void ( Actor, bool ) > FocusGroupChangedSignalV2;
64 /// @brief Focused actor activated signal
65 typedef SignalV2< void ( Actor ) > FocusedActorActivatedSignalV2;
68 * @brief Create a KeyboardFocusManager handle; this can be initialised with KeyboardFocusManager::New().
70 * Calling member functions with an uninitialised handle is not allowed.
72 KeyboardFocusManager();
77 * This is non-virtual since derived Handle types must not contain data or virtual methods.
79 ~KeyboardFocusManager();
82 * @brief Get the singleton of KeyboardFocusManager object.
84 * @return A handle to the KeyboardFocusManager control.
86 static KeyboardFocusManager Get();
89 * @brief Move the keyboard focus to the given actor.
91 * Only one actor can be focused at the same time. The actor must
92 * be in the stage already and keyboard focusable.
94 * @pre The KeyboardFocusManager has been initialized.
95 * @pre The Actor has been initialized.
96 * @param actor The actor to be focused
97 * @return Whether the focus is successful or not
99 bool SetCurrentFocusActor(Actor actor);
102 * @brief Get the current focused actor.
104 * @pre The KeyboardFocusManager has been initialized.
105 * @return A handle to the current focused actor or an empty handle if no actor is focused.
107 Actor GetCurrentFocusActor();
110 * @brief Move the focus to the next focusable actor in the focus
111 * chain in the given direction (according to the focus traversal
114 * @pre The KeyboardFocusManager has been initialized.
115 * @param direction The direction of focus movement
116 * @return true if the movement was successful
118 bool MoveFocus(Control::KeyboardFocusNavigationDirection direction);
121 * @brief Clear the focus from the current focused actor if any, so
122 * that no actor is focused in the focus chain.
124 * It will emit focus changed signal without current focused actor
125 * @pre The KeyboardFocusManager has been initialized.
130 * @brief Set whether the focus movement should be looped within the same focus group.
132 * The focus movement is not looped by default.
133 * @pre The KeyboardFocusManager has been initialized.
134 * @param enabled Whether the focus movement should be looped
136 void SetFocusGroupLoop(bool enabled);
139 * @brief Get whether the focus movement should be looped within the same focus group.
141 * @pre The KeyboardFocusManager has been initialized.
142 * @return Whether the focus movement should be looped
144 bool GetFocusGroupLoop() const;
147 * @brief Set whether an actor is a focus group that can limit the
148 * scope of focus movement to its child actors in the focus chain.
150 * Layout controls set themselves as focus groups by default.
152 * @pre The KeyboardFocusManager has been initialized.
153 * @pre The Actor has been initialized.
154 * @param actor The actor to be set as a focus group.
155 * @param isFocusGroup Whether to set the actor as a focus group or not.
157 void SetAsFocusGroup(Actor actor, bool isFocusGroup);
160 * @brief Check whether the actor is set as a focus group or not.
162 * @pre The KeyboardFocusManager has been initialized.
163 * @pre The Actor has been initialized.
164 * @param actor The actor to be checked.
165 * @return Whether the actor is set as a focus group.
167 bool IsFocusGroup(Actor actor) const;
170 * @brief Returns the closest ancestor of the given actor that is a focus group.
172 * @param actor The actor to be checked for its focus group
173 * @return The focus group the given actor belongs to or an empty handle if the given actor
174 * doesn't belong to any focus group
176 Actor GetFocusGroup(Actor actor);
179 * @brief Set the focus indicator actor.
181 * This will replace the default focus indicator actor in
182 * KeyboardFocusManager and will be added to the focused actor as a
185 * @pre The KeyboardFocusManager has been initialized.
186 * @pre The indicator actor has been initialized.
187 * @param indicator The indicator actor to be added
189 void SetFocusIndicatorActor(Actor indicator);
192 * @brief Get the focus indicator actor.
194 * @pre The KeyboardFocusManager has been initialized.
195 * @return A handle to the focus indicator actor
197 Actor GetFocusIndicatorActor();
202 * @brief This signal is emitted before the focus is going to be changed.
204 * KeyboardFocusManager makes the best guess for which actor to
205 * focus towards the given direction, but applications might want to
206 * change that. By connecting with this signal, they can check the
207 * proposed actor to focus and return a different actor if they
208 * wish. This signal is only emitted when the navigation key is
209 * pressed and KeyboardFocusManager tries to move the focus
210 * automatically. It won't be emitted for focus movement by calling
211 * SetCurrentFocusActor directly.
213 * A callback of the following type may be connected:
215 * Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocusNavigationDirection direction);
217 * @pre The Object has been initialized.
218 * @return The signal to connect to.
220 PreFocusChangeSignalV2& PreFocusChangeSignal();
223 * @brief This signal is emitted after the current focused actor has been changed.
225 * A callback of the following type may be connected:
227 * void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
229 * @pre The Object has been initialized.
230 * @return The signal to connect to.
232 FocusChangedSignalV2& FocusChangedSignal();
235 * @brief This signal is emitted when the focus group has been changed.
237 * If the current focus group has a parent layout control,
238 * KeyboardFocusManager will make the best guess for the next focus
239 * group to move the focus to in the given direction (forward or
240 * backward). If not, the application has to set the new focus.
242 * A callback of the following type may be connected:
244 * void YourCallbackName(Actor currentFocusedActor, bool forward);
246 * @pre The Object has been initialized.
247 * @return The signal to connect to.
249 FocusGroupChangedSignalV2& FocusGroupChangedSignal();
252 * @brief This signal is emitted when the current focused actor is activated.
254 * A callback of the following type may be connected:
256 * void YourCallbackName(Actor activatedActor);
258 * @pre The Object has been initialized.
259 * @return The signal to connect to.
261 FocusedActorActivatedSignalV2& FocusedActorActivatedSignal();
263 // Not intended for application developers
266 * @brief Creates a new handle from the implementation.
268 * @param[in] impl A pointer to the object.
270 explicit DALI_INTERNAL KeyboardFocusManager(Internal::KeyboardFocusManager *impl);
272 }; // class KeyboardFocusManager
274 } // namespace Toolkit
278 #endif // __DALI_TOOLKIT_KEYBOARD_FOCUS_MANAGER_H__