-#ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
-#define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
+#ifndef DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
+#define DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
/*
- * Copyright (c) 2016 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.
*/
// EXTERNAL INCLUDES
-#include <string>
-#include <dali/devel-api/adaptor-framework/physical-keyboard.h>
#include <dali/public-api/object/base-object.h>
+#include <dali/public-api/object/weak-handle.h>
+#include <dali/public-api/common/vector-wrapper.h>
// 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
{
+namespace Integration
+{
+
+class SceneHolder;
+
+} // namespace Integration
+
namespace Toolkit
{
/**
* @copydoc Toolkit::KeyboardFocusManager
*/
-class KeyboardFocusManager : public Dali::BaseObject
+class KeyboardFocusManager : public Dali::BaseObject, public ConnectionTracker
{
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
*/
*/
void MoveFocusBackward();
+ /**
+ * @copydoc Toolkit::DevelKeyboardFocusManager::SetCustomAlgorithm
+ */
+ void SetCustomAlgorithm(CustomAlgorithmInterface& interface);
+
+ /**
+ * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
+ */
+ void EnableFocusIndicator(bool enable);
+
+ /**
+ * @copydoc Toolkit::DevelKeyboardFocusManager::UseFocusIndicator
+ */
+ bool IsFocusIndicatorEnabled() const;
+
public:
/**
private:
- typedef Dali::Vector< Dali::BaseObject* > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
- typedef FocusStack::Iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
+ typedef std::vector< WeakHandle< Actor > > FocusStack; ///< Define Dali::Vector< Dali::BaseObject* > as FocusStack to contain focus history
+ typedef FocusStack::iterator FocusStackIterator; ///< Define FocusStack::Iterator as FocusStackIterator to navigate FocusStack
+
+ /**
+ * This will be called when the adaptor is initialized
+ */
+ void OnAdaptorInit();
+
+ /**
+ * This will be called when a new scene holder is created
+ * @param sceneHolder The new scene holder
+ */
+ void OnSceneHolderCreated( Dali::Integration::SceneHolder& sceneHolder );
+
+ /**
+ * Get configuration from StyleManager.
+ */
+ void GetConfigurationFromStyleManger();
/**
* Get the focus group of current focused actor.
/**
* Move the focus to the specified actor and send notification for the focus change.
- * @param actorID The ID of the actor to be queried
+ * @param actor The actor to be queried
* @return Whether the focus is successful or not
*/
- bool DoSetCurrentFocusActor(const unsigned int actorID);
+ bool DoSetCurrentFocusActor(Actor actor);
/**
* Move the focus to the next actor towards the specified direction within the layout control
* 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 );
/**
- * Change the keyboard focus status when keyboard focus feature turned on or off.
- * @return Whether the status is changed or not.
+ * 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 OnPhysicalKeyboardStatusChanged(PhysicalKeyboard keyboard);
+ void OnWindowFocusChanged( Window window, bool focusIn );
+
+ /**
+ * Get the focus Actor from current window
+ */
+ Actor GetFocusActorFromCurrentWindow();
private:
Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType mFocusGroupChangedSignal; ///< The signal to notify the focus group change
Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType mFocusedActorEnterKeySignal; ///< The signal to notify that enter has been pressed on the focused actor
- unsigned int mCurrentFocusActor; ///< The actor ID of current focused actor
+ WeakHandle< Actor > mCurrentFocusActor; ///< A weak handle to the current focused actor
Actor mFocusIndicatorActor; ///< The focus indicator actor shared by all the keyboard focusable actors for highlight
- bool mFocusGroupLoopEnabled:1; ///< Whether the focus movement is looped within the same focus group
+ FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
- bool mIsKeyboardFocusEnabled:1; ///< Whether keyboard focus feature turned on/off
+ SlotDelegate< KeyboardFocusManager > mSlotDelegate;
- 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.
+ 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;
- FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
+ FocusActorContainer mCurrentFocusActors; ///< A container of focused actors
- SlotDelegate< KeyboardFocusManager > mSlotDelegate;
+ WeakHandle< Layer > mCurrentFocusedWindow; ///< A weak handle to the current focused window's root layer
+
+ 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.
+
+ EnableFocusedIndicatorState mEnableFocusIndicator; ///< Whether use focus indicator
+
+ FocusedIndicatorModeState mAlwaysShowIndicator; ///< Whether always show indicator. If true, the indicator would be directly shown when focused
+
+ 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
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
+#endif // DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff