Fix SVACE error in KeyboardFocusManager
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / focus-manager / keyboard-focus-manager-impl.h
index a30b562..1ece0b1 100644 (file)
@@ -1,27 +1,29 @@
 #ifndef __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
 #define __DALI_TOOLKIT_INTERNAL_KEYBOARD_FOCUS_MANAGER_H__
 
-//
-// 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) 2016 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.
+ *
+ */
 
 // EXTERNAL INCLUDES
 #include <string>
+#include <dali/devel-api/adaptor-framework/physical-keyboard.h>
+#include <dali/public-api/object/base-object.h>
 
 // INTERNAL INCLUDES
-#include <dali/dali.h>
 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
 
 namespace Dali
@@ -63,7 +65,7 @@ public:
   /**
    * @copydoc Toolkit::KeyboardFocusManager::MoveFocus
    */
-  bool MoveFocus(Toolkit::Control::KeyboardFocusNavigationDirection direction);
+  bool MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction);
 
   /**
    * @copydoc Toolkit::KeyboardFocusManager::ClearFocus
@@ -105,27 +107,32 @@ public:
    */
   Actor GetFocusIndicatorActor();
 
+  /**
+   * Move current focus to backward
+   */
+  void MoveFocusBackward();
+
 public:
 
   /**
    * @copydoc Toolkit::KeyboardFocusManager::PreFocusChangeSignal()
    */
-  Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2& PreFocusChangeSignal();
+  Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& PreFocusChangeSignal();
 
   /**
    * @copydoc Toolkit::KeyboardFocusManager::FocusChangedSignal()
    */
-  Toolkit::KeyboardFocusManager::FocusChangedSignalV2& FocusChangedSignal();
+  Toolkit::KeyboardFocusManager::FocusChangedSignalType& FocusChangedSignal();
 
   /**
    * @copydoc Toolkit::KeyboardFocusManager::FocusGroupChangedSignal()
    */
-  Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2& FocusGroupChangedSignal();
+  Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& FocusGroupChangedSignal();
 
   /**
-   * @copydoc Toolkit::KeyboardFocusManager::FocusedActorActivatedSignal()
+   * @copydoc Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignal()
    */
-  Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2& FocusedActorActivatedSignal();
+  Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
 
   /**
    * Connects a callback function with the object's signals.
@@ -147,6 +154,9 @@ protected:
 
 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
+
   /**
    * Get the focus group of current focused actor.
    * @pre The FocusManager has been initialized.
@@ -169,7 +179,7 @@ private:
    * @param direction The direction of focus movement
    * @return Whether the focus is successful or not
    */
-  bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocusNavigationDirection direction);
+  bool DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction);
 
   /**
    * Move the focus to the first focusable actor in the next focus group in the forward
@@ -181,16 +191,11 @@ private:
   bool DoMoveFocusToNextFocusGroup(bool forward);
 
   /**
-   * Activate the actor. If the actor is control, call OnActivated virtual function.
-   * This function will emit FocusedActorActivatedSignal.
-   * @param actor The actor to activate
+   * Enter has been pressed on the actor. If the actor is control, call the OnKeybaordEnter virtual function.
+   * This function will emit FocusedActorEnterKeySignal.
+   * @param actor The actor to notify
    */
-  void DoActivate(Actor actor);
-
-  /**
-   * Create the default indicator actor to highlight the focused actor.
-   */
-  void CreateDefaultFocusIndicatorActor();
+  void DoKeyboardEnter( Actor actor );
 
   /**
    * Check whether the actor is a layout control that supports two dimensional keyboard navigation.
@@ -219,9 +224,9 @@ private:
   /**
    * 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] touchEvent The touch event
+   * @param[in] touch The touch information
    */
-  void OnTouched(const TouchEvent& touchEvent);
+  void OnTouch( const TouchData& touch );
 
   /**
    * Change the keyboard focus status when keyboard focus feature turned on or off.
@@ -238,10 +243,10 @@ private:
 
 private:
 
-  Toolkit::KeyboardFocusManager::PreFocusChangeSignalV2 mPreFocusChangeSignalV2; ///< The signal to notify the focus will be changed
-  Toolkit::KeyboardFocusManager::FocusChangedSignalV2 mFocusChangedSignalV2; ///< The signal to notify the focus change
-  Toolkit::KeyboardFocusManager::FocusGroupChangedSignalV2 mFocusGroupChangedSignalV2; ///< The signal to notify the focus group change
-  Toolkit::KeyboardFocusManager::FocusedActorActivatedSignalV2 mFocusedActorActivatedSignalV2; ///< The signal to notify the activation of focused actor
+  Toolkit::KeyboardFocusManager::PreFocusChangeSignalType mPreFocusChangeSignal; ///< The signal to notify the focus will be changed
+  Toolkit::KeyboardFocusManager::FocusChangedSignalType mFocusChangedSignal; ///< The signal to notify the focus change
+  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
 
@@ -255,7 +260,10 @@ private:
 
   bool mIsWaitingKeyboardFocusChangeCommit:1; /// A flag to indicate PreFocusChangeSignal emitted but the proposed focus actor is not commited by the application yet.
 
+  FocusStack mFocusHistory; ///< Stack to contain pre-focused actor's BaseObject*
+
   SlotDelegate< KeyboardFocusManager > mSlotDelegate;
+
 };
 
 } // namespace Internal