Merge "(Vector) Change event processing" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / focus-manager / keyboard-focus-manager-impl.h
index 967e9e1..4ab0ea3 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
 #include <dali-toolkit/devel-api/focus-manager/keyboard-focus-manager-devel.h>
+#include <dali/devel-api/adaptor-framework/window-devel.h>
 
 namespace Dali
 {
 
-class Window;
+namespace Integration
+{
+
+class SceneHolder;
+
+} // namespace Integration
 
 namespace Toolkit
 {
@@ -47,6 +53,25 @@ public:
 
   typedef Toolkit::DevelKeyboardFocusManager::CustomAlgorithmInterface CustomAlgorithmInterface;
 
+  enum FocusIndicatorState
+  {
+    UNKNOWN = -1,   ///< Unknown state
+    HIDE = 0,          ///< FocusIndicator is hidden
+    SHOW = 1,          ///< FocusIndicator is shown
+  };
+
+  enum EnableFocusedIndicatorState
+  {
+    DISABLE = 0,          ///< FocusIndicator is disable
+    ENABLE = 1,          ///< FocusIndicator is enable
+  };
+
+  enum FocusedIndicatorModeState
+  {
+    NONE = 0,          ///< Set nothing
+    ALWAYS_SHOW = 1,          ///< FocusIndicator is always shown
+  };
+
   /**
    * @copydoc Toolkit::KeyboardFocusManager::Get
    */
@@ -183,10 +208,10 @@ private:
   void OnAdaptorInit();
 
   /**
-   * This will be called when a new wndow is created
-   * @param window The new window
+   * This will be called when a new scene holder is created
+   * @param sceneHolder The new scene holder
    */
-  void OnWindowCreated( Dali::Window& window );
+  void OnSceneHolderCreated( Dali::Integration::SceneHolder& sceneHolder );
 
   /**
    * Get configuration from StyleManager.
@@ -255,14 +280,26 @@ private:
    * Callback for the key event when no actor in the stage has gained the key input focus
    * @param[in] event The KeyEvent event.
    */
-  void OnKeyEvent(const KeyEvent& event);
+  void OnKeyEvent( const KeyEvent& event );
 
   /**
    * Callback for the touch event when the screen is touched and when the touch ends
    * (i.e. the down & up touch events only).
    * @param[in] touch The touch information
    */
-  void OnTouch( const TouchData& touch );
+  void OnTouch( const TouchEvent& touch );
+
+  /**
+   * Called when the window focus is changed.
+   * @param[in] window The window whose focus is changed
+   * @param[in] focusIn Whether the focus is in/out
+   */
+  void OnWindowFocusChanged( Window window, bool focusIn );
+
+  /**
+   * Get the focus Actor from current window
+   */
+  Actor GetFocusActorFromCurrentWindow();
 
 private:
 
@@ -282,24 +319,29 @@ private:
 
   Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
 
-  int 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.
+  FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
+
+  SlotDelegate< KeyboardFocusManager > mSlotDelegate;
 
-  bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
+  CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
 
-  bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
+  typedef std::vector< std::pair< WeakHandle< Layer >, WeakHandle< Actor > > > FocusActorContainer;
 
-  bool mClearFocusOnTouch:1; ///< Whether clear focus on touch.
+  FocusActorContainer mCurrentFocusActors; ///< A container of focused actors
 
-  bool mEnableFocusIndicator;  ///< Whether use focus indicator
+  WeakHandle< Layer > mCurrentFocusedWindow; ///< A weak handle to the current focused window's root layer
 
-  bool mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused.
+  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.
 
-  FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
+  EnableFocusedIndicatorState mEnableFocusIndicator;  ///< Whether use focus indicator
 
-  SlotDelegate< KeyboardFocusManager > mSlotDelegate;
+  FocusedIndicatorModeState mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused
 
-  CustomAlgorithmInterface* mCustomAlgorithmInterface; ///< The user's (application / toolkit) implementation of CustomAlgorithmInterface
+  bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
 
+  bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
+
+  bool mClearFocusOnTouch:1; ///< Whether clear focus on touch.
 };
 
 } // namespace Internal