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