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) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  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
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-object.h>
  23 #include <dali/public-api/object/weak-handle.h>
  24 #include <dali/public-api/common/vector-wrapper.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
  28 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
  29 #include <dali/devel-api/adaptor-framework/window-devel.h>
  30
  31 namespace Dali
  32 {
  33
  34 class Window;
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 /**
  43  * @copydoc Toolkit::KeyboardFocusManager
  44  */
  45 class KeyboardFocusManager : public Dali::BaseObject, public ConnectionTracker
  46 {
  47 public:
  48
  49   typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
  50
  51   enum FocusIndicatorState
  52   {
  53     UNKNOWN = -1,   ///< Unknown state
  54     HIDE = 0,          ///< FocusIndicator is hidden
  55     SHOW = 1,          ///< FocusIndicator is shown
  56   };
  57
  58   enum EnableFocusedIndicatorState
  59   {
  60     DISABLE = 0,          ///< FocusIndicator is disable
  61     ENABLE = 1,          ///< FocusIndicator is enable
  62   };
  63
  64   enum FocusedIndicatorModeState
  65   {
  66     NONE = 0,          ///< Set nothing
  67     ALWAYS_SHOW = 1,          ///< FocusIndicator is always shown
  68   };
  69
  70   /**
  71    * @copydoc Toolkit::KeyboardFocusManager::Get
  72    */
  73   static Toolkit::KeyboardFocusManager Get();
  74
  75   /**
  76    * Construct a new KeyboardFocusManager.
  77    */
  78   KeyboardFocusManager();
  79
  80   /**
  81    * @copydoc Toolkit::KeyboardFocusManager::SetCurrentFocusActor
  82    */
  83   bool SetCurrentFocusActor(Actor actor);
  84
  85   /**
  86    * @copydoc Toolkit::KeyboardFocusManager::GetCurrentFocusActor
  87    */
  88   Actor GetCurrentFocusActor();
  89
  90   /**
  91    * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
  92    */
  93   bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction);
  94
  95   /**
  96    * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
  97    */
  98   void ClearFocus();
  99
 100   /**
 101    * @copydoc Toolkit::KeyboardFocusManager::SetAsFocusGroup
 102    */
 103   void SetAsFocusGroup(Actor actor, bool isFocusGroup);
 104
 105   /**
 106    * @copydoc Toolkit::KeyboardFocusManager::IsFocusGroup
 107    */
 108   bool IsFocusGroup(Actor actor) const;
 109
 110   /**
 111    * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroup
 112    */
 113   Actor GetFocusGroup(Actor actor);
 114
 115   /**
 116    * @copydoc Toolkit::KeyboardFocusManager::SetFocusGroupLoop
 117    */
 118   void SetFocusGroupLoop(bool enabled);
 119
 120   /**
 121    * @copydoc Toolkit::KeyboardFocusManager::GetFocusGroupLoop
 122    */
 123   bool GetFocusGroupLoop() const;
 124
 125   /**
 126    * @copydoc Toolkit::KeyboardFocusManager::SetFocusIndicatorActor
 127    */
 128   void SetFocusIndicatorActor(Actor indicator);
 129
 130   /**
 131    * @copydoc Toolkit::KeyboardFocusManager::GetFocusIndicatorActor
 132    */
 133   Actor GetFocusIndicatorActor();
 134
 135   /**
 136    * Move current focus to backward
 137    */
 138   void MoveFocusBackward();
 139
 140   /**
 141    * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
 142    */
 143   void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
 144
 145   /**
 146    * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
 147    */
 148   void EnableFocusIndicator(bool enable);
 149
 150   /**
 151    * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
 152    */
 153   bool IsFocusIndicatorEnabled() const;
 154
 155 public:
 156
 157   /**
 158    * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
 159    */
 160   Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
 161
 162   /**
 163    * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
 164    */
 165   Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
 166
 167   /**
 168    * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
 169    */
 170   Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
 171
 172   /**
 173    * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
 174    */
 175   Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
 176
 177   /**
 178    * Connects a callback function with the object's signals.
 179    * @param[in] object The object providing the signal.
 180    * @param[in] tracker Used to disconnect the signal.
 181    * @param[in] signalName The signal to connect to.
 182    * @param[in] functor A newly allocated FunctorDelegate.
 183    * @return True if the signal was connected.
 184    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 185    */
 186   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 187
 188 protected:
 189
 190   /**
 191    * Destructor
 192    */
 193   virtual ~KeyboardFocusManager();
 194
 195 private:
 196
 197   typedef std::vector< WeakHandle< Actor > > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
 198   typedef FocusStack::iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
 199
 200   /**
 201    * This will be called when the adaptor is initialized
 202    */
 203   void OnAdaptorInit();
 204
 205   /**
 206    * This will be called when a new wndow is created
 207    * @param window The new window
 208    */
 209   void OnWindowCreated( Dali::Window& window );
 210
 211   /**
 212    * Get configuration from StyleManager.
 213    */
 214   void GetConfigurationFromStyleManger();
 215
 216   /**
 217    * Get the focus group of current focused actor.
 218    * @pre The FocusManager has been initialized.
 219    * @return A handle to the parent of the current focused actor which is a focus group,
 220    * or an empty handle if no actor is focused.
 221    */
 222   Actor GetCurrentFocusGroup();
 223
 224   /**
 225    * Move the focus to the specified actor and send notification for the focus change.
 226    * @param actor The actor to be queried
 227    * @return Whether the focus is successful or not
 228    */
 229   bool DoSetCurrentFocusActor(Actor actor);
 230
 231   /**
 232    * Move the focus to the next actor towards the specified direction within the layout control
 233    * @param control The layout control to move the focus in
 234    * @param actor The current focused actor
 235    * @param direction The direction of focus movement
 236    * @return Whether the focus is successful or not
 237    */
 238   bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
 239
 240   /**
 241    * Move the focus to the first focusable actor in the next focus group in the forward
 242    * or backward direction. The "Tab" key changes the focus group in the forward direction
 243    * and the "Shift-Tab" key changes it in the backward direction.
 244    * @param forward Whether the direction of focus group change is forward or backward
 245    * @return Whether the focus group change is successful or not
 246    */
 247   bool DoMoveFocusToNextFocusGroup(bool forward);
 248
 249   /**
 250    * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
 251    * This function will emit FocusedActorEnterKeySignal.
 252    * @param actor The actor to notify
 253    */
 254   void DoKeyboardEnter( Actor actor );
 255
 256   /**
 257    * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
 258    * The layout control needs to internally set the focus order for the child actor and be able to
 259    * tell KeyboardFocusmanager the next focusable actor in the given direction.
 260    * @pre The KeyboardFocusManager has been initialized.
 261    * @pre The Actor has been initialized.
 262    * @param actor The actor to be checked.
 263    * @return Whether the actor is a layout control or not.
 264    */
 265   bool IsLayoutControl(Actor actor) const;
 266
 267   /**
 268    * Returns the closest ancestor of the given actor that is a layout control.
 269    * @param actor The actor to be checked for its parent layout control
 270    * @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
 271    */
 272  Toolkit::Control GetParentLayoutControl(Actor actor) const;
 273
 274   /**
 275    * Callback for the key event when no actor in the stage has gained the key input focus
 276    * @param[in] event The KeyEvent event.
 277    */
 278   void OnKeyEvent( const KeyEvent& event );
 279
 280   /**
 281    * Callback for the touch event when the screen is touched and when the touch ends
 282    * (i.e. the down & up touch events only).
 283    * @param[in] touch The touch information
 284    */
 285   void OnTouch( const TouchData& touch );
 286
 287   /**
 288    * Called when the window focus is changed.
 289    * @param[in] window The window whose focus is changed
 290    * @param[in] focusIn Whether the focus is in/out
 291    */
 292   void OnWindowFocusChanged( Window window, bool focusIn );
 293
 294   /**
 295    * Get the focus Actor from current window
 296    */
 297   Actor GetFocusActorFromCurrentWindow();
 298
 299 private:
 300
 301   // Undefined
 302   KeyboardFocusManager(const KeyboardFocusManager&);
 303
 304   KeyboardFocusManager& operator=(const KeyboardFocusManager& rhs);
 305
 306 private:
 307
 308   Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
 309   Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
 310   Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
 311   Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
 312
 313   WeakHandle< Actor > mCurrentFocusActor; ///< A weak handle to the current focused actor
 314
 315   Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
 316
 317   FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
 318
 319   SlotDelegate< KeyboardFocusManager > mSlotDelegate;
 320
 321   CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
 322
 323   typedef std::vector< std::pair< WeakHandle< Layer >, WeakHandle< Actor > > > FocusActorContainer;
 324
 325   FocusActorContainer mCurrentFocusActors; ///< A container of focused actors
 326
 327   WeakHandle< Layer > mCurrentFocusedWindow; ///< A weak handle to the current focused window's root layer
 328
 329   FocusIndicatorState mIsFocusIndicatorShown; ///< Whether indicator should be shown / hidden when getting focus. It could be enabled when keyboard focus feature is enabled and navigation keys or 'Tab' key are pressed.
 330
 331   EnableFocusedIndicatorState mEnableFocusIndicator;  ///< Whether use focus indicator
 332
 333   FocusedIndicatorModeState mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused
 334
 335   bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
 336
 337   bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
 338
 339   bool mClearFocusOnTouch:1; ///< Whether clear focus on touch.
 340 };
 341
 342 } // namespace Internal
 343
 344 inline Internal::KeyboardFocusManager& GetImpl(Dali::Toolkit::KeyboardFocusManager& obj)
 345 {
 346   DALI_ASSERT_ALWAYS(obj);
 347
 348   Dali::BaseObject& handle = obj.GetBaseObject();
 349
 350   return static_cast<Internal::KeyboardFocusManager&>(handle);
 351 }
 352
 353 inline const Internal::KeyboardFocusManager& GetImpl(const Dali::Toolkit::KeyboardFocusManager& obj)
 354 {
 355   DALI_ASSERT_ALWAYS(obj);
 356
 357   const Dali::BaseObject& handle = obj.GetBaseObject();
 358
 359   return static_cast<const Internal::KeyboardFocusManager&>(handle);
 360 }
 361
 362 } // namespace Toolkit
 363
 364 } // namespace Dali
 365
 366 #endif // DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H