1 #ifndef __DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H__
2 #define __DALI_TOOLKIT_INTERNAL_KEYINPUT_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.
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/object-registry.h>
27 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
28 #include <dali-toolkit/public-api/controls/control.h>
39 class KeyInputFocusManager;
42 * @copydoc Toolkit::KeyInputFocusManager
44 class KeyInputFocusManager : public Dali::BaseObject, public Dali::ConnectionTracker
47 typedef Dali::Vector< Dali::BaseObject* > FocusStack;
48 typedef FocusStack::Iterator FocusStackIterator;
51 * Construct a new KeyInputFocusManager.
53 KeyInputFocusManager();
56 * @copydoc Toolkit::SetFocus
58 void SetFocus(Toolkit::Control control);
61 * @copydoc Toolkit::RemoveFocus
63 void RemoveFocus(Toolkit::Control control);
66 * @copydoc Toolkit::GetCurrentFocusControl
68 Toolkit::Control GetCurrentFocusControl() const;
71 * @copydoc Toolkit::IsKeyboardListener
73 bool IsKeyboardListener(Toolkit::Control control) const;
78 * @copydoc Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignal()
80 Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType& KeyInputFocusChangedSignal();
83 * @copydoc Toolkit::KeyInputFocusManager::UnhandledKeyEventSignal()
85 Toolkit::KeyInputFocusManager::UnhandledKeyEventSignalType& UnhandledKeyEventSignal();
88 * Connects a callback function with the object's signals.
89 * @param[in] object The object providing the signal.
90 * @param[in] tracker Used to disconnect the signal.
91 * @param[in] signalName The signal to connect to.
92 * @param[in] functor A newly allocated FunctorDelegate.
93 * @return True if the signal was connected.
94 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
96 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
103 virtual ~KeyInputFocusManager();
108 * Search for a control in the focus stack.
109 * @param[in] control The control for which to search
110 * @return An iterator to the control. If not found, this will equate to the
111 * mFocusStack.End() iterator.
113 FocusStackIterator FindFocusControlInStack( Toolkit::Control control ) const;
116 * Callback for the key event when no actor in the stage has gained the key input focus
117 * @param[in] event The KeyEvent event.
119 void OnKeyEvent(const KeyEvent& event);
122 * Signal handler called when a focused Control is removed from Stage.
123 * @param[in] control The control removed from stage.
125 void OnFocusControlStageDisconnection( Dali::Actor control );
128 * Signal handler called when an actor is destroyed.
130 void OnObjectDestroyed(const Dali::RefObject* object);
135 KeyInputFocusManager(const KeyInputFocusManager&);
137 KeyInputFocusManager& operator=(const KeyInputFocusManager& rhs);
141 // The key input focus change signal
142 Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType mKeyInputFocusChangedSignal;
144 // The un-handled key event signal
145 Toolkit::KeyInputFocusManager::UnhandledKeyEventSignalType mUnhandledKeyEventSignal;
147 // Keyboard events are sent to the current focus actor, which will be the actor on the top of the focus actors stack.
148 FocusStack mFocusStack;
149 SlotDelegate< KeyInputFocusManager > mSlotDelegate;
150 ObjectRegistry mObjectRegistry;
153 } // namespace Internal
155 inline Internal::KeyInputFocusManager& GetImpl(Dali::Toolkit::KeyInputFocusManager& obj)
157 DALI_ASSERT_ALWAYS(obj);
159 Dali::BaseObject& handle = obj.GetBaseObject();
161 return static_cast<Internal::KeyInputFocusManager&>(handle);
164 inline const Internal::KeyInputFocusManager& GetImpl(const Dali::Toolkit::KeyInputFocusManager& obj)
166 DALI_ASSERT_ALWAYS(obj);
168 const Dali::BaseObject& handle = obj.GetBaseObject();
170 return static_cast<const Internal::KeyInputFocusManager&>(handle);
173 } // namespace Toolkit
177 #endif // __DALI_TOOLKIT_INTERNAL_KEYINPUT_FOCUS_MANAGER_H__