Move shadow APIs to Internal::Control::Impl from Internal::Control
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h
index 45eff9f..f2e4402 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_CONTROL_IMPL_H
 
 /*
- * Copyright (c) 2017 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.
@@ -41,12 +41,6 @@ namespace Toolkit
  */
 
 class StyleManager;
-class TransitionData;
-
-namespace Visual
-{
-class Base;
-}
 
 namespace Internal
 {
@@ -59,7 +53,7 @@ namespace Internal
  * be disconnected automatically when the control is destroyed.
  * @SINCE_1_0.0
  */
-class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
+class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
 {
 public:
 
@@ -104,16 +98,6 @@ public:
   void SetBackgroundColor( const Vector4& color );
 
   /**
-   * @copydoc Dali::Toolkit::Control::GetBackgroundColor
-   */
-  Vector4 GetBackgroundColor() const;
-
-  /**
-   * @copydoc Dali::Toolkit::Control::SetBackgroundImage
-   */
-  void SetBackgroundImage( Image image );
-
-  /**
    * @brief Sets the background with a property map.
    *
    * @SINCE_1_0.0
@@ -301,90 +285,6 @@ public:
 protected: // For derived classes to call
 
   /**
-   * @brief Register a visual by Property Index, linking an Actor to visual when required.
-   * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
-   * No parenting is done during registration, this should be done by derived class.
-   *
-   * @SINCE_1_2.0
-   *
-   * @param[in] index The Property index of the visual, used to reference visual
-   * @param[in] visual The visual to register
-   * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
-   *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
-   */
-  void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
-
-  /**
-   * @brief Register a visual by Property Index, linking an Actor to visual when required.
-   * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
-   * If enabled is false then the visual is not set on stage until enabled by the derived class.
-   * @see EnableVisual
-   *
-   * @SINCE_1_2.11
-   *
-   * @param[in] index The Property index of the visual, used to reference visual
-   * @param[in] visual The visual to register
-   * @param[in] enabled false if derived class wants to control when visual is set on stage.
-   *
-   */
-  void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
-
-  /**
-   * @brief Erase the entry matching the given index from the list of registered visuals
-   * @param[in] index The Property index of the visual, used to reference visual
-   *
-   * @SINCE_1_2.0
-   */
-  void UnregisterVisual( Property::Index index );
-
-  /**
-   * @brief Retrieve the visual associated with the given property index.
-   *
-   * @SINCE_1_2.2
-   *
-   * @param[in] index The Property index of the visual.
-   * @return The registered visual if exist, otherwise empty handle.
-   * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
-   */
-  Toolkit::Visual::Base GetVisual( Property::Index index ) const;
-
-  /**
-   * @brief Sets the given visual to be displayed or not when parent staged.
-   *
-   * @SINCE_1_2.11
-   *
-   * @param[in] index The Property index of the visual
-   * @param[in] enable flag to set enabled or disabled.
-   */
-  void EnableVisual( Property::Index index, bool enable );
-
-  /**
-   * @brief Queries if the given visual is to be displayed when parent staged.
-   *
-   * @SINCE_1_2.11
-   *
-   * @param[in] index The Property index of the visual
-   * @return bool whether visual is enabled or not
-   */
-  bool IsVisualEnabled( Property::Index index ) const;
-
-  /**
-   * @brief Create a transition effect on the control.
-   *
-   * Only generates an animation if the properties described in the transition
-   * data are staged (e.g. the visual is Enabled and the control is on stage).
-   * Otherwise the target values are stored, and will get set onto the properties
-   * when the visual is next staged.
-   *
-   * @SINCE_1_2.12
-   *
-   * @param[in] transitionData The transition data describing the effect to create
-   * @return A handle to an animation defined with the given effect, or an empty
-   * handle if no properties match.
-   */
-  Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
-
-  /**
    * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
    *
    * Should be called last by the control after it acts on the Input Focus change.
@@ -774,7 +674,10 @@ private:
   DALI_INTERNAL Control( const Control& );
   DALI_INTERNAL Control& operator=( const Control& );
 
-  class Impl;
+public:
+  class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
+
+private:
   Impl* mImpl;
   /// @endcond
 
@@ -788,7 +691,7 @@ private:
  * @return Implementation
  * @pre handle is initialized and points to a control
  */
-DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
+DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 
 /**
  * @brief Gets implementation from the handle.
@@ -798,7 +701,7 @@ DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& ha
  * @return Implementation
  * @pre Handle is initialized and points to a control.
  */
-DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
+DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
 
 } // namespace Internal