-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
// CLASS HEADER
#include "keyinput-focus-manager-impl.h"
+// EXTERNAL INCLUDES
+#include <cstring> // for strcmp
+#include <dali/public-api/actors/layer.h>
+#include <dali/public-api/common/stage.h>
+
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/control-impl.h>
#include <dali/integration-api/debug.h>
namespace Internal
{
+namespace
+{
+
+// Signals
+
+const char* const SIGNAL_KEY_INPUT_FOCUS_CHANGED = "keyInputFocusChanged";
+const char* const SIGNAL_UNHANDLED_KEY_EVENT = "unhandledKeyEvent";
+
+}
+
KeyInputFocusManager::KeyInputFocusManager()
: mSlotDelegate( this )
{
Stage::GetCurrent().KeyEventSignal().Connect(mSlotDelegate, &KeyInputFocusManager::OnKeyEvent);
+ mObjectRegistry = Dali::Stage::GetCurrent().GetObjectRegistry();
+ mObjectRegistry.ObjectDestroyedSignal().Connect( this, &KeyInputFocusManager::OnObjectDestroyed );
}
KeyInputFocusManager::~KeyInputFocusManager()
{
}
-void KeyInputFocusManager::SetFocus(Toolkit::Control control)
+void KeyInputFocusManager::SetFocus( Toolkit::Control control )
{
- if(!control)
+ if( !control )
{
- //No-op
+ // No-op
return;
}
- unsigned int actorID = control.GetId();
+ FocusStackIterator pos = FindFocusControlInStack( control );
- ActorQueueIterator pos = std::find( mFocusActorsQueue.begin(), mFocusActorsQueue.end(), actorID);
-
- if((!mFocusActorsQueue.empty()) && (pos == mFocusActorsQueue.begin()))
+ if( ( mFocusStack.Count() != 0 ) && ( pos == mFocusStack.End()-1 ) )
{
- //Actor allready in front, so No-op
+ // Control already in front, so No-op
return;
}
- if(pos != mFocusActorsQueue.end())
+ if( pos != mFocusStack.End() )
{
- //A previously focused actor wants to regain focus
- mFocusActorsQueue.erase(pos);
+ // A previously focused control wants to regain focus
+ mFocusStack.Erase( pos );
}
else
{
- control.OffStageSignal().Connect( mSlotDelegate, &KeyInputFocusManager::OnFocusActorStageDisconnection );
+ control.OffStageSignal().Connect( mSlotDelegate, &KeyInputFocusManager::OnFocusControlStageDisconnection );
}
- Dali::Toolkit::Control previousFocusControl;
- if(!mFocusActorsQueue.empty())
+ Dali::Toolkit::Control previousFocusControl = GetCurrentFocusControl();
+ if( previousFocusControl )
{
- previousFocusControl = Dali::Toolkit::Control::DownCast(Stage::GetCurrent().GetRootLayer().FindChildById(mFocusActorsQueue.front()));
- if(previousFocusControl)
- {
- // Notify the control that it has lost key input focus
- previousFocusControl.GetImplementation().OnKeyInputFocusLost();
- }
+ // Notify the control that it has lost key input focus
+ GetImplementation( previousFocusControl ).OnKeyInputFocusLost();
}
- mFocusActorsQueue.push_front(actorID);
+ mFocusStack.PushBack( &control.GetBaseObject() );
// 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 ( !mKeyInputFocusChangedSignalV2.Empty() )
+ if ( !mKeyInputFocusChangedSignal.Empty() )
{
- mKeyInputFocusChangedSignalV2.Emit( control, previousFocusControl );
+ mKeyInputFocusChangedSignal.Emit( control, previousFocusControl );
}
}
-Control KeyInputFocusManager::GetCurrentFocusControl() const
+void KeyInputFocusManager::RemoveFocus( Toolkit::Control control )
{
- Control currentFocusControl;
-
- if(!mFocusActorsQueue.empty())
+ if( control )
{
- currentFocusControl = Dali::Toolkit::Control::DownCast(Stage::GetCurrent().GetRootLayer().FindChildById(mFocusActorsQueue.front()));
- }
-
- return currentFocusControl;
-}
-
-void KeyInputFocusManager::RemoveFocus(Toolkit::Control control)
-{
- if(control)
- {
- unsigned int actorId = control.GetId();
- ActorQueueIterator pos = std::find( mFocusActorsQueue.begin(), mFocusActorsQueue.end(), actorId);
-
- if(pos != mFocusActorsQueue.end())
+ FocusStackIterator pos = FindFocusControlInStack( control );
+ if( pos != mFocusStack.End() )
{
- control.OffStageSignal().Disconnect( mSlotDelegate, &KeyInputFocusManager::OnFocusActorStageDisconnection );
+ control.OffStageSignal().Disconnect( mSlotDelegate, &KeyInputFocusManager::OnFocusControlStageDisconnection );
// Notify the control that it has lost key input focus
- control.GetImplementation().OnKeyInputFocusLost();
+ GetImplementation( control ).OnKeyInputFocusLost();
- if(pos == mFocusActorsQueue.begin())
+ // If this is the top-most actor, pop it and change focus to the previous control
+ if( pos == mFocusStack.End() - 1 )
{
- Actor previousFocusActor;
+ mFocusStack.Erase( pos );
- mFocusActorsQueue.erase(pos);
- if(!mFocusActorsQueue.empty())
+ Toolkit::Control previouslyFocusedControl = GetCurrentFocusControl();
+ if( previouslyFocusedControl )
{
- previousFocusActor = Stage::GetCurrent().GetRootLayer().FindChildById(mFocusActorsQueue.front());
- }
-
- Dali::Toolkit::Control previouscontrol = Dali::Toolkit::Control::DownCast(previousFocusActor);
- if(previouscontrol)
- {
- // Tell the new actor that it has gained focus.
- previouscontrol.GetImplementation().OnKeyInputFocusGained();
+ // Tell the control that it has gained focus.
+ GetImplementation( previouslyFocusedControl ).OnKeyInputFocusGained();
}
}
else
{
- //If the removed actor is not currently focused, then no need to emit signal.
- mFocusActorsQueue.erase(pos);
+ // If the removed control is not currently focused, then no need to emit signal.
+ mFocusStack.Erase( pos );
}
-
}
}
}
-bool KeyInputFocusManager::IsKeyboardListener(Toolkit::Control control) const
+Toolkit::Control KeyInputFocusManager::GetCurrentFocusControl() const
{
- bool result = false;
+ Toolkit::Control currentControl;
- if(!mFocusActorsQueue.empty())
+ FocusStack::SizeType count = mFocusStack.Count();
+ if( count != 0 )
{
- unsigned int actorId = control.GetId();
- ActorQueueConstIterator pos = std::find(mFocusActorsQueue.begin(), mFocusActorsQueue.end(), actorId);
+ BaseObject* object = mFocusStack[ count - 1 ];
+ BaseHandle handle( object );
+ currentControl = Dali::Toolkit::Control::DownCast( handle );
+ }
+ return currentControl;
+}
- if(pos != mFocusActorsQueue.end())
- {
- result = true;
- }
+bool KeyInputFocusManager::IsKeyboardListener( Toolkit::Control control ) const
+{
+ bool result = false;
+
+ if( FindFocusControlInStack( control ) != mFocusStack.End() )
+ {
+ result = true;
}
return result;
}
-Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalV2& KeyInputFocusManager::KeyInputFocusChangedSignal()
+Toolkit::KeyInputFocusManager::KeyInputFocusChangedSignalType& KeyInputFocusManager::KeyInputFocusChangedSignal()
{
- return mKeyInputFocusChangedSignalV2;
+ return mKeyInputFocusChangedSignal;
}
-Toolkit::KeyInputFocusManager::UnhandledKeyEventSignalV2& KeyInputFocusManager::UnhandledKeyEventSignal()
+Toolkit::KeyInputFocusManager::UnhandledKeyEventSignalType& KeyInputFocusManager::UnhandledKeyEventSignal()
{
- return mUnhandledKeyEventSignalV2;
+ return mUnhandledKeyEventSignal;
}
-void KeyInputFocusManager::OnKeyEvent(const KeyEvent& event)
+KeyInputFocusManager::FocusStackIterator KeyInputFocusManager::FindFocusControlInStack( Toolkit::Control control ) const
{
- bool consumed = false;
-
- ActorQueueIterator iter = mFocusActorsQueue.begin();
+ BaseObject* controlObject = &control.GetBaseObject();
+ return std::find( mFocusStack.Begin(), mFocusStack.End(), controlObject );
+}
- Layer rootLayer = Stage::GetCurrent().GetRootLayer();
+void KeyInputFocusManager::OnKeyEvent( const KeyEvent& event )
+{
+ bool consumed = false;
- while(!mFocusActorsQueue.empty() && !consumed && (iter != mFocusActorsQueue.end()))
+ if( mFocusStack.Count() > 0 )
{
- Actor actor = rootLayer.FindChildById(*iter);
- Dali::Toolkit::Control control = Dali::Toolkit::Control::DownCast(actor);
- if(control)
+ FocusStack::SizeType index = mFocusStack.Count();
+ while( mFocusStack.Count() != 0 && !consumed && index > 0 )
{
- // Notify the control about the key event
- consumed = control.GetImplementation().EmitKeyEventSignal(event);
+ --index;
+ BaseObject* object = mFocusStack[ index ];
+ BaseHandle handle( object );
+ Toolkit::Control control = Toolkit::Control::DownCast( object );
+ if( control )
+ {
+ // Notify the control about the key event
+ consumed = GetImplementation( control ).EmitKeyEventSignal( event );
+ }
}
- iter++;
}
- if(!consumed)
+ if( !consumed )
{
// Emit signal to inform that a key event is not consumed.
- if( !mUnhandledKeyEventSignalV2.Empty() )
+ if( !mUnhandledKeyEventSignal.Empty() )
{
- mUnhandledKeyEventSignalV2.Emit(event);
+ mUnhandledKeyEventSignal.Emit(event);
}
}
}
-void KeyInputFocusManager::OnFocusActorStageDisconnection( Dali::Actor actor )
+void KeyInputFocusManager::OnFocusControlStageDisconnection( Dali::Actor actor )
{
- RemoveFocus(Dali::Toolkit::Control::DownCast(actor));
+ RemoveFocus( Dali::Toolkit::Control::DownCast( actor ) );
}
-bool KeyInputFocusManager::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
+void KeyInputFocusManager::OnObjectDestroyed( const Dali::RefObject* object )
{
- Dali::BaseHandle handle( object );
+ // 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 );
+ }
+}
+bool KeyInputFocusManager::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
+{
bool connected( true );
- KeyInputFocusManager* manager = dynamic_cast<KeyInputFocusManager*>(object);
+ KeyInputFocusManager* manager = dynamic_cast<KeyInputFocusManager*>( object );
- if( Dali::Toolkit::KeyInputFocusManager::SIGNAL_KEY_INPUT_FOCUS_CHANGED == signalName )
- {
- manager->KeyInputFocusChangedSignal().Connect( tracker, functor );
- }
- else
+ if( manager )
{
- // 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 if( 0 == strcmp( signalName.c_str(), SIGNAL_UNHANDLED_KEY_EVENT ) )
+ {
+ manager->UnhandledKeyEventSignal().Connect( tracker, functor );
+ }
+ else
+ {
+ // signalName does not match any signal
+ connected = false;
+ }
}
return connected;