Ensure not to emit the resource ready signal during the callback
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / control / control-data-impl.h
index d2eb48e..e042113 100755 (executable)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
 
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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 <string>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-resource-observer.h>
+#include <dali-toolkit/internal/visuals/visual-event-observer.h>
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali/devel-api/common/owner-container.h>
-#include <dali-toolkit/devel-api/layouting/layout-item-impl.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
 #include <dali-toolkit/internal/builder/style.h>
@@ -65,7 +64,7 @@ typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
 /**
  * @brief Holds the Implementation for the internal control class
  */
-class Control::Impl : public ConnectionTracker, public Visual::ResourceObserver
+class Control::Impl : public ConnectionTracker, public Visual::EventObserver
 {
 
 public:
@@ -124,9 +123,17 @@ public:
   /**
    * @brief Called when a resource is ready.
    * @param[in] object The visual whose resources are ready
-   * @note Overriding method in Visual::ResourceObserver.
+   * @note Overriding method in Visual::EventObserver.
    */
-  virtual void ResourceReady( Visual::Base& object );
+  void ResourceReady( Visual::Base& object ) override;
+
+  /**
+   * @brief Called when an event occurs.
+   * @param[in] object The visual whose events occur
+   * @param[in] signalId The signal to emit. See Visual to find supported signals
+   * @note Overriding method in Visual::EventObserver.
+   */
+  void NotifyVisualEvent( Visual::Base& object, Property::Index signalId ) override;
 
   /**
    * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
@@ -283,9 +290,9 @@ public:
   bool IsResourceReady() const;
 
   /**
-   * @copydoc CustomActorImpl::OnStageDisconnection()
+   * @copydoc CustomActorImpl::OnSceneDisconnection()
    */
-  void OnStageDisconnection();
+  void OnSceneDisconnection();
 
   /**
    * @brief Sets the margin.
@@ -325,25 +332,20 @@ public:
   bool FilterKeyEvent( const KeyEvent& event );
 
   /**
-   * @brief Get the layout associated with this control, if any.
-   *
-   * @return A pointer to the layout, or NULL.
+   * @copydoc DevelControl::VisualEventSignal()
    */
-  Toolkit::Internal::LayoutItemPtr GetLayout() const;
+  DevelControl::VisualEventSignalType& VisualEventSignal();
 
   /**
-   * @brief Set the layout on this control.
-   * @param[in] layout Pointer to the layout
+   * @brief Sets the shadow with a property map.
+   * @param[in] map The shadow property map
    */
-  void SetLayout( Toolkit::Internal::LayoutItem& layout );
+  void SetShadow(const Property::Map& map);
 
   /**
-   * @brief Remove the layout from this control
-   *
-   * @note This does not remove any children from this control, nor does it strip
-   * layouts from them but it does remove them from the layout hierarchy.
+   * @brief Clear the shadow.
    */
-  void RemoveLayout();
+  void ClearShadow();
 
 private:
 
@@ -384,15 +386,22 @@ private:
    */
   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
 
+  /**
+   * @brief Emits the resource ready signal.
+   */
+  void EmitResourceReadySignal();
+
+  /**
+   * @brief Callbacks called on idle.
+   */
+  void OnIdleCallback();
+
 public:
 
   Control& mControlImpl;
   DevelControl::State mState;
   std::string mSubStateName;
 
-  // Layout
-  Toolkit::Internal::LayoutItemPtr mLayout;
-
   int mLeftFocusableActorId;       ///< Actor ID of Left focusable control.
   int mRightFocusableActorId;      ///< Actor ID of Right focusable control.
   int mUpFocusableActorId;         ///< Actor ID of Up focusable control.
@@ -408,6 +417,7 @@ public:
   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
   Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
+  DevelControl::VisualEventSignalType mVisualEventSignal;
 
   // Gesture Detection
   PinchGestureDetector mPinchGestureDetector;
@@ -419,10 +429,13 @@ public:
   TooltipPtr mTooltip;
 
   InputMethodContext mInputMethodContext;
+  CallbackBase* mIdleCallback;             ///< The idle callback to emit the resource ready signal.
 
   ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT;    ///< Flags passed in from constructor.
   bool mIsKeyboardNavigationSupported :1;  ///< Stores whether keyboard navigation is supported by the control.
   bool mIsKeyboardFocusGroup :1;           ///< Stores whether the control is a focus group.
+  bool mIsEmittingResourceReadySignal :1;  ///< True during ResourceReady().
+  bool mNeedToEmitResourceReady :1;        ///< True if need to emit the resource ready signal again.
 
   RegisteredVisualContainer mRemoveVisuals;         ///< List of visuals that are being replaced by another visual once ready
 
@@ -442,6 +455,7 @@ public:
   static const PropertyRegistration PROPERTY_12;
   static const PropertyRegistration PROPERTY_13;
   static const PropertyRegistration PROPERTY_14;
+  static const PropertyRegistration PROPERTY_15;
 };