(Control Base) Add GetVisual() & GetPlacementActor() methods

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h

diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h
index ba6315d..e8a71fe 100644 (file)
--- a/dali-toolkit/public-api/controls/control-impl.h
+++ b/dali-toolkit/public-api/controls/control-impl.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
-#define __DALI_TOOLKIT_CONTROL_IMPL_H__
+#ifndef DALI_TOOLKIT_CONTROL_IMPL_H
+#define DALI_TOOLKIT_CONTROL_IMPL_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * 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.
@@ -42,6 +42,10 @@ namespace Toolkit
 
 class StyleManager;
 
+namespace Visual
+{
+class Base;
+}
 namespace Internal
 {
 /**
@@ -247,6 +251,7 @@ public:
    */
   bool IsKeyboardFocusGroup();
 
+  /// @cond internal
   /**
    * @brief Called by the AccessibilityManager to activate the Control.
    * @SINCE_1_0.0
@@ -258,6 +263,7 @@ public:
    * @SINCE_1_0.0
    */
   DALI_INTERNAL void KeyboardEnter();
+  /// @endcond
 
   // Signals
 
@@ -276,6 +282,7 @@ public:
    */
   Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
 
+  /// @cond internal
   /**
    * @brief Called by the KeyInputFocusManager to emit key event signals.
    *
@@ -284,10 +291,54 @@ public:
    * @return True if the event was consumed.
    */
   DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
+  /// @endcond
 
 protected: // For derived classes to call
 
   /**
+   * @brief Register a visual by Property Index, linking an Actor to controlRenderer when required.
+   * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer 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] placementActor The actor used to by the visual.
+   * @param[in] visual The visual to register
+   */
+   void RegisterVisual( Property::Index index, Actor placementActor, Toolkit::Visual::Base visual );
+
+   /**
+    * @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 );
+
+   /**
+    * @brief Retrieve the placement actor associated with the given index.
+    *
+    * @SINCE_1_2.2
+    *
+    * @@param[in] index The Property index of the visual.
+    * @return Then placement actor if exist, otherwise empty handle.
+    * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count.
+    */
+   Actor GetPlacementActor( Property::Index index );
+
+  /**
    * @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.
@@ -301,31 +352,37 @@ protected: // From CustomActorImpl, not to be used by application developers
 
   /**
    * @copydoc CustomActorImpl::OnStageConnection()
+   * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
    */
   virtual void OnStageConnection( int depth );
 
   /**
    * @copydoc CustomActorImpl::OnStageDisconnection()
+   * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
    */
   virtual void OnStageDisconnection();
 
   /**
    * @copydoc CustomActorImpl::OnChildAdd()
+   * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
    */
   virtual void OnChildAdd( Actor& child );
 
   /**
    * @copydoc CustomActorImpl::OnChildRemove()
+   * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
    */
   virtual void OnChildRemove( Actor& child );
 
   /**
    * @copydoc CustomActorImpl::OnSizeSet()
+   * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
    */
   virtual void OnSizeSet( const Vector3& targetSize );
 
   /**
    * @copydoc CustomActorImpl::OnSizeAnimation()
+   * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
    */
   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
 
@@ -436,6 +493,8 @@ public: // API for derived classes to override
   virtual void OnInitialize();
 
   /**
+   * @DEPRECATED_1_1.30. Override OnChildAdd instead.
+   *
    * @brief Called whenever an Actor is added to the control.
    *
    * Could be overridden by derived classes.
@@ -446,6 +505,8 @@ public: // API for derived classes to override
   virtual void OnControlChildAdd( Actor& child );
 
   /**
+   * @DEPRECATED_1_1.30. Override OnChildRemove instead.
+   *
    * @brief Called whenever an Actor is removed from the control.
    *
    * Could be overridden by derived classes.
@@ -509,7 +570,7 @@ public: // API for derived classes to override
 
   /**
    * @brief This method should be overridden by deriving classes when they wish to respond
-   * the accessibility zoom action
+   * the accessibility zoom action.
    *
    * @SINCE_1_0.0
    * @return true if the zoom action has been consumed by this control
@@ -650,17 +711,19 @@ public: // API for derived classes to override
 
 private:
 
+  /// @cond internal
   // Undefined
   DALI_INTERNAL Control( const Control& );
   DALI_INTERNAL Control& operator=( const Control& );
 
   class Impl;
   Impl* mImpl;
+  /// @endcond
 
 };
 
 /**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
  *
  * @SINCE_1_0.0
  * @param handle
@@ -670,7 +733,7 @@ private:
 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 
 /**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
  *
  * @SINCE_1_0.0
  * @param handle
@@ -688,4 +751,4 @@ DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit:
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_CONTROL_IMPL_H__
+#endif // DALI_TOOLKIT_CONTROL_IMPL_H