/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
#include "keyinput-focus-manager-impl.h"
// EXTERNAL INCLUDES
+#include <dali-toolkit/public-api/controls/control-impl.h>
+#include <dali/integration-api/adaptor-framework/adaptor.h>
+#include <dali/integration-api/adaptor-framework/scene-holder.h>
+#include <dali/integration-api/debug.h>
#include <dali/public-api/actors/layer.h>
-#include <dali/public-api/common/stage.h>
+#include <cstring> // for strcmp
// INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali/integration-api/debug.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
namespace
{
-
// Signals
-const char* const SIGNAL_KEY_INPUT_FOCUS_CHANGED = "key-input-focus-changed";
-const char* const SIGNAL_UNHANDLED_KEY_EVENT = "unhandled-key-event";
+const char* const SIGNAL_KEY_INPUT_FOCUS_CHANGED = "keyInputFocusChanged";
-}
+} // namespace
KeyInputFocusManager::KeyInputFocusManager()
-: mSlotDelegate( this )
+: mSlotDelegate(this),
+ mCurrentFocusControl()
{
- Stage::GetCurrent().KeyEventSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnKeyEvent);
- mObjectRegistry = Dali::Stage::GetCurrent().GetObjectRegistry();
- mObjectRegistry.ObjectDestroyedSignal().Connect( this, &KeyInputFocusManager::OnObjectDestroyed );
+ // Retrieve all the existing widnows
+ Dali::SceneHolderList sceneHolders = Adaptor::Get().GetSceneHolders();
+ for(auto iter = sceneHolders.begin(); iter != sceneHolders.end(); ++iter)
+ {
+ (*iter).KeyEventGeneratedSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnKeyEvent);
+ }
+
+ // Get notified when any new scene holder is created afterwards
+ Adaptor::Get().WindowCreatedSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnSceneHolderCreated);
}
KeyInputFocusManager::~KeyInputFocusManager()
{
}
-void KeyInputFocusManager::SetFocus( Toolkit::Control control )
+void KeyInputFocusManager::OnSceneHolderCreated(Dali::Integration::SceneHolder& sceneHolder)
+{
+ sceneHolder.KeyEventGeneratedSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnKeyEvent);
+}
+
+void KeyInputFocusManager::SetFocus(Toolkit::Control control)
{
- if( !control )
+ if(!control)
{
// No-op
return;
}
- FocusStackIterator pos = FindFocusControlInStack( control );
-
- if( ( mFocusStack.Count() != 0 ) && ( pos == mFocusStack.End()-1 ) )
+ if(control == mCurrentFocusControl)
{
- // Control already in front, so No-op
+ // Control already has focus
return;
}
- if( pos != mFocusStack.End() )
- {
- // A previously focused control wants to regain focus
- mFocusStack.Erase( pos );
- }
- else
- {
- control.OffStageSignal().Connect( mSlotDelegate, &KeyInputFocusManager::OnFocusControlStageDisconnection );
- }
+ control.OffSceneSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnFocusControlSceneDisconnection);
Dali::Toolkit::Control previousFocusControl = GetCurrentFocusControl();
- if( previousFocusControl )
+ if(previousFocusControl)
{
// Notify the control that it has lost key input focus
- previousFocusControl.GetImplementation().OnKeyInputFocusLost();
+ GetImplementation(previousFocusControl).OnKeyInputFocusLost();
}
- mFocusStack.PushBack( &control.GetBaseObject() );
+ // Set control to currentFocusControl
+ mCurrentFocusControl = control;
// Tell the new actor that it has gained focus.
- control.GetImplementation().OnKeyInputFocusGained();
+ GetImplementation(control).OnKeyInputFocusGained();
// Emit the signal to inform focus change to the application.
- if ( !mKeyInputFocusChangedSignal.Empty() )
+ if(!mKeyInputFocusChangedSignal.Empty())
{
- mKeyInputFocusChangedSignal.Emit( control, previousFocusControl );
+ mKeyInputFocusChangedSignal.Emit(control, previousFocusControl);
}
}
-void KeyInputFocusManager::RemoveFocus( Toolkit::Control control )
+void KeyInputFocusManager::RemoveFocus(Toolkit::Control control)
{
- if( control )
+ if(control == mCurrentFocusControl)
{
- FocusStackIterator pos = FindFocusControlInStack( control );
- if( pos != mFocusStack.End() )
- {
- control.OffStageSignal().Disconnect( mSlotDelegate, &KeyInputFocusManager::OnFocusControlStageDisconnection );
+ control.OffSceneSignal().Disconnect(mSlotDelegate, &KeyInputFocusManager::OnFocusControlSceneDisconnection);
- // Notify the control that it has lost key input focus
- control.GetImplementation().OnKeyInputFocusLost();
+ // Notify the control that it has lost key input focus
+ GetImplementation(control).OnKeyInputFocusLost();
- // If this is the top-most actor, pop it and change focus to the previous control
- if( pos == mFocusStack.End() - 1 )
- {
- mFocusStack.Erase( pos );
-
- Toolkit::Control previouslyFocusedControl = GetCurrentFocusControl();
- if( previouslyFocusedControl )
- {
- // Tell the control that it has gained focus.
- previouslyFocusedControl.GetImplementation().OnKeyInputFocusGained();
- }
- }
- else
- {
- // If the removed control is not currently focused, then no need to emit signal.
- mFocusStack.Erase( pos );
- }
- }
+ mCurrentFocusControl.Reset();
}
}
Toolkit::Control KeyInputFocusManager::GetCurrentFocusControl() const
{
- Toolkit::Control currentControl;
-
- FocusStack::SizeType count = mFocusStack.Count();
- if( count != 0 )
- {
- BaseObject* object = mFocusStack[ count - 1 ];
- BaseHandle handle( object );
- currentControl = Dali::Toolkit::Control::DownCast( handle );
- }
- return currentControl;
-}
-
-bool KeyInputFocusManager::IsKeyboardListener( Toolkit::Control control ) const
-{
- bool result = false;
-
- if( FindFocusControlInStack( control ) != mFocusStack.End() )
- {
- result = true;
- }
-
- return result;
+ return mCurrentFocusControl;
}
Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType& KeyInputFocusManager::KeyInputFocusChangedSignal()
return mKeyInputFocusChangedSignal;
}
-Toolkit::KeyInputFocusManager::UnhandledKeyEventSignalType& KeyInputFocusManager::UnhandledKeyEventSignal()
-{
- return mUnhandledKeyEventSignal;
-}
-
-KeyInputFocusManager::FocusStackIterator KeyInputFocusManager::FindFocusControlInStack( Toolkit::Control control ) const
-{
- BaseObject* controlObject = &control.GetBaseObject();
- return std::find( mFocusStack.Begin(), mFocusStack.End(), controlObject );
-}
-
-void KeyInputFocusManager::OnKeyEvent( const KeyEvent& event )
+bool KeyInputFocusManager::OnKeyEvent(const KeyEvent& event)
{
bool consumed = false;
- if( mFocusStack.Count() > 0 )
+ Toolkit::Control control = GetCurrentFocusControl();
+ if(control)
{
- FocusStack::SizeType index = mFocusStack.Count();
- while( mFocusStack.Count() != 0 && !consumed && index > 0 )
+ Dali::Actor dispatch = control;
+ while(dispatch)
{
- --index;
- BaseObject* object = mFocusStack[ index ];
- BaseHandle handle( object );
- Toolkit::Control control = Toolkit::Control::DownCast( object );
- if( control )
+ // If the DISPATCH_KEY_EVENTS is false, it cannot emit key event.
+ Toolkit::Control dispatchControl = Toolkit::Control::DownCast(dispatch);
+ if(dispatchControl && !dispatchControl.GetProperty<bool>(Toolkit::DevelControl::Property::DISPATCH_KEY_EVENTS))
{
- // Notify the control about the key event
- consumed = control.GetImplementation().EmitKeyEventSignal( event );
+ return true;
}
+ dispatch = dispatch.GetParent();
}
+
+ // Notify the control about the key event
+ consumed = EmitKeyEventSignal(control, event);
}
- if( !consumed )
+ return consumed;
+}
+
+bool KeyInputFocusManager::EmitKeyEventSignal(Toolkit::Control control, const KeyEvent& event)
+{
+ bool consumed = false;
+
+ if(control)
{
- // Emit signal to inform that a key event is not consumed.
- if( !mUnhandledKeyEventSignal.Empty() )
+ consumed = GetImplementation(control).EmitKeyEventSignal(event);
+
+ // if control doesn't consume KeyEvent, give KeyEvent to its parent.
+ if(!consumed)
{
- mUnhandledKeyEventSignal.Emit(event);
+ Toolkit::Control parent = Toolkit::Control::DownCast(control.GetParent());
+
+ if(parent)
+ {
+ consumed = EmitKeyEventSignal(parent, event);
+ }
}
}
-}
-void KeyInputFocusManager::OnFocusControlStageDisconnection( Dali::Actor actor )
-{
- RemoveFocus( Dali::Toolkit::Control::DownCast( actor ) );
+ return consumed;
}
-void KeyInputFocusManager::OnObjectDestroyed( const Dali::RefObject* object )
+void KeyInputFocusManager::OnFocusControlSceneDisconnection(Dali::Actor actor)
{
- // The object is already destroyed. Don't create handles to it, or try sending
- // signals to it. Remove it's pointer from the stack.
- const BaseObject* baseObject = static_cast<const BaseObject*>( object );
- FocusStackIterator pos = std::find( mFocusStack.Begin(), mFocusStack.End(), baseObject );
- if( pos != mFocusStack.End() )
- {
- mFocusStack.Erase( pos );
- }
+ RemoveFocus(Dali::Toolkit::Control::DownCast(actor));
}
-bool KeyInputFocusManager::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
+bool KeyInputFocusManager::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
{
- Dali::BaseHandle handle( object );
-
- bool connected( true );
- KeyInputFocusManager* manager = dynamic_cast<KeyInputFocusManager*>( object );
+ bool connected(true);
+ KeyInputFocusManager* manager = dynamic_cast<KeyInputFocusManager*>(object);
- if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_CHANGED ) )
+ if(manager)
{
- manager->KeyInputFocusChangedSignal().Connect( tracker, functor );
- }
- else if( 0 == strcmp( signalName.c_str(), SIGNAL_UNHANDLED_KEY_EVENT ) )
- {
- manager->UnhandledKeyEventSignal().Connect( tracker, functor );
- }
- else
- {
- // signalName does not match any signal
- connected = false;
+ if(0 == strcmp(signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_CHANGED))
+ {
+ manager->KeyInputFocusChangedSignal().Connect(tracker, functor);
+ }
+ else
+ {
+ // signalName does not match any signal
+ connected = false;
+ }
}
return connected;