dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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
  10 //
  11 //     http://floralicense.org/license/
  12 //
  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.
  18 //
  19
  20 // EXTERNAL INCLUDES
  21 #include <string>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali/dali.h>
  25 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 /**
  37  * @copydoc Toolkit::KeyboardFocusManager
  38  */
  39 class KeyboardFocusManager : public Dali::BaseObject
  40 {
  41 public:
  42
  43   /**
  44    * @copydoc Toolkit::KeyboardFocusManager::Get
  45    */
  46   static Toolkit::KeyboardFocusManager Get();
  47
  48   /**
  49    * Construct a new KeyboardFocusManager.
  50    */
  51   KeyboardFocusManager();
  52
  53   /**
  54    * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
  55    */
  56   bool SetCurrentFocusActor(Actor actor);
  57
  58   /**
  59    * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
  60    */
  61   Actor GetCurrentFocusActor();
  62
  63   /**
  64    * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
  65    */
  66   bool MoveFocus(Toolkit::Control::KeyboardFocusNavigationDirection direction);
  67
  68   /**
  69    * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
  70    */
  71   void ClearFocus();
  72
  73   /**
  74    * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
  75    */
  76   void SetAsFocusGroup(Actor actor, bool isFocusGroup);
  77
  78   /**
  79    * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
  80    */
  81   bool IsFocusGroup(Actor actor) const;
  82
  83   /**
  84    * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
  85    */
  86   Actor GetFocusGroup(Actor actor);
  87
  88   /**
  89    * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
  90    */
  91   void SetFocusGroupLoop(bool enabled);
  92
  93   /**
  94    * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
  95    */
  96   bool GetFocusGroupLoop() const;
  97
  98   /**
  99    * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
 100    */
 101   void SetFocusIndicatorActor(Actor indicator);
 102
 103   /**
 104    * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
 105    */
 106   Actor GetFocusIndicatorActor();
 107
 108 public:
 109
 110   /**
 111    * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
 112    */
 113   Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2& PreFocusChangeSignal();
 114
 115   /**
 116    * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
 117    */
 118   Toolkit::KeyboardFocusManager::FocusChangedSignalV2& FocusChangedSignal();
 119
 120   /**
 121    * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
 122    */
 123   Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2& FocusGroupChangedSignal();
 124
 125   /**
 126    * @copydoc Toolkit::KeyboardFocusManager::FocusedActorActivatedSignal()
 127    */
 128   Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2& FocusedActorActivatedSignal();
 129
 130   /**
 131    * Connects a callback function with the object's signals.
 132    * @param[in] object The object providing the signal.
 133    * @param[in] tracker Used to disconnect the signal.
 134    * @param[in] signalName The signal to connect to.
 135    * @param[in] functor A newly allocated FunctorDelegate.
 136    * @return True if the signal was connected.
 137    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 138    */
 139   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 140
 141 protected:
 142
 143   /**
 144    * Destructor
 145    */
 146   virtual ~KeyboardFocusManager();
 147
 148 private:
 149
 150   /**
 151    * Get the focus group of current focused actor.
 152    * @pre The FocusManager has been initialized.
 153    * @return A handle to the parent of the current focused actor which is a focus group,
 154    * or an empty handle if no actor is focused.
 155    */
 156   Actor GetCurrentFocusGroup();
 157
 158   /**
 159    * Move the focus to the specified actor and send notification for the focus change.
 160    * @param actorID The ID of the actor to be queried
 161    * @return Whether the focus is successful or not
 162    */
 163   bool DoSetCurrentFocusActor(const unsigned int actorID);
 164
 165   /**
 166    * Move the focus to the next actor towards the specified direction within the layout control
 167    * @param control The layout control to move the focus in
 168    * @param actor The current focused actor
 169    * @param direction The direction of focus movement
 170    * @return Whether the focus is successful or not
 171    */
 172   bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocusNavigationDirection direction);
 173
 174   /**
 175    * Move the focus to the first focusable actor in the next focus group in the forward
 176    * or backward direction. The "Tab" key changes the focus group in the forward direction
 177    * and the "Shift-Tab" key changes it in the backward direction.
 178    * @param forward Whether the direction of focus group change is forward or backward
 179    * @return Whether the focus group change is successful or not
 180    */
 181   bool DoMoveFocusToNextFocusGroup(bool forward);
 182
 183   /**
 184    * Activate the actor. If the actor is control, call OnActivated virtual function.
 185    * This function will emit FocusedActorActivatedSignal.
 186    * @param actor The actor to activate
 187    */
 188   void DoActivate(Actor actor);
 189
 190   /**
 191    * Create the default indicator actor to highlight the focused actor.
 192    */
 193   void CreateDefaultFocusIndicatorActor();
 194
 195   /**
 196    * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
 197    * The layout control needs to internally set the focus order for the child actor and be able to
 198    * tell KeyboardFocusmanager the next focusable actor in the given direction.
 199    * @pre The KeyboardFocusManager has been initialized.
 200    * @pre The Actor has been initialized.
 201    * @param actor The actor to be checked.
 202    * @return Whether the actor is a layout control or not.
 203    */
 204   bool IsLayoutControl(Actor actor) const;
 205
 206   /**
 207    * Returns the closest ancestor of the given actor that is a layout control.
 208    * @param actor The actor to be checked for its parent layout control
 209    * @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
 210    */
 211  Toolkit::Control GetParentLayoutControl(Actor actor) const;
 212
 213   /**
 214    * Callback for the key event when no actor in the stage has gained the key input focus
 215    * @param[in] event The KeyEvent event.
 216    */
 217   void OnKeyEvent(const KeyEvent& event);
 218
 219   /**
 220    * Callback for the touch event when the screen is touched and when the touch ends
 221    * (i.e. the down & up touch events only).
 222    * @param[in] touchEvent The touch event
 223    */
 224   void OnTouched(const TouchEvent& touchEvent);
 225
 226   /**
 227    * Change the keyboard focus status when keyboard focus feature turned on or off.
 228    * @return Whether the status is changed or not.
 229    */
 230   void OnPhysicalKeyboardStatusChanged(PhysicalKeyboard keyboard);
 231
 232 private:
 233
 234   // Undefined
 235   KeyboardFocusManager(const KeyboardFocusManager&);
 236
 237   KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
 238
 239 private:
 240
 241   Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2 mPreFocusChangeSignalV2; ///< The signal to notify the focus will be changed
 242   Toolkit::KeyboardFocusManager::FocusChangedSignalV2 mFocusChangedSignalV2; ///< The signal to notify the focus change
 243   Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2 mFocusGroupChangedSignalV2; ///< The signal to notify the focus group change
 244   Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2 mFocusedActorActivatedSignalV2; ///< The signal to notify the activation of focused actor
 245
 246   unsigned int mCurrentFocusActor; ///< The actor ID of current focused actor
 247
 248   Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
 249
 250   bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
 251
 252   bool mIsKeyboardFocusEnabled:1; ///< Whether keyboard focus feature turned on/off
 253
 254   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.
 255
 256   bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
 257
 258   SlotDelegate< KeyboardFocusManager > mSlotDelegate;
 259 };
 260
 261 } // namespace Internal
 262
 263 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
 264 {
 265   DALI_ASSERT_ALWAYS(obj);
 266
 267   Dali::BaseObject& handle = obj.GetBaseObject();
 268
 269   return static_cast<Internal::KeyboardFocusManager&>(handle);
 270 }
 271
 272 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
 273 {
 274   DALI_ASSERT_ALWAYS(obj);
 275
 276   const Dali::BaseObject& handle = obj.GetBaseObject();
 277
 278   return static_cast<const Internal::KeyboardFocusManager&>(handle);
 279 }
 280
 281 } // namespace Toolkit
 282
 283 } // namespace Dali
 284
 285 #endif // __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__