Button refactoring: rename properties

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

diff --git a/base/dali-toolkit/public-api/controls/control.h b/base/dali-toolkit/public-api/controls/control.h
index 1500115..1911030 100644 (file)
--- a/base/dali-toolkit/public-api/controls/control.h
+++ b/base/dali-toolkit/public-api/controls/control.h
@@ -112,7 +112,7 @@ public:
   // Typedefs
 
   /// @brief Key Event signal type;
-  typedef SignalV2<bool ( Control, const KeyEvent& ) > KeyEventSignalV2;
+  typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
 
 public: // Creation & Destruction
 
@@ -297,7 +297,7 @@ public:
    * @brief Retrieves the pinch gesture detector of the control.
    *
    * @return The pinch gesture detector.
-   * @pre Pinch detection should have been enabled in the control.
+   * @note Will return an empty handle if the control does not handle the gesture itself.
    */
   PinchGestureDetector GetPinchGestureDetector() const;
 
@@ -305,7 +305,7 @@ public:
    * @brief Retrieves the pan gesture detector of the control.
    *
    * @return The pan gesture detector.
-   * @pre Pan detection should have been enabled in the control.
+   * @note Will return an empty handle if the control does not handle the gesture itself.
    */
   PanGestureDetector GetPanGestureDetector() const;
 
@@ -313,7 +313,7 @@ public:
    * @brief Retrieves the tap gesture detector of the control.
    *
    * @return The tap gesture detector.
-   * @pre Tap detection should have been enabled in the control.
+   * @note Will return an empty handle if the control does not handle the gesture itself.
    */
   TapGestureDetector GetTapGestureDetector() const;
 
@@ -321,7 +321,7 @@ public:
    * @brief Retrieves the long press gesture detector of the control.
    *
    * @return The long press gesture detector.
-   * @pre Long press detection should have been enabled in the control.
+   * @note Will return an empty handle if the control does not handle the gesture itself.
    */
   LongPressGestureDetector GetLongPressGestureDetector() const;
 
@@ -378,17 +378,19 @@ public:
    * @pre The Control has been initialized.
    * @return The signal to connect to.
    */
-  KeyEventSignalV2& KeyEventSignal();
+  KeyEventSignalType& KeyEventSignal();
 
-public: // Intended for control developers (used implicitly)
+public: // Intended for control developers
 
   /**
    * @brief Create an initialised Control.
    *
    * @param[in] implementation The implementation for this control.
    * @return A handle to a newly allocated Dali resource.
+   *
+   * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
    */
-  Control(Internal::Control& implementation);
+  explicit Control(Internal::Control& implementation);
 
   /**
    * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
@@ -396,7 +398,7 @@ public: // Intended for control developers (used implicitly)
    *
    * @param [in] internal A pointer to a newly allocated Dali resource
    */
-  Control(Dali::Internal::CustomActor* internal);
+  explicit Control(Dali::Internal::CustomActor* internal);
 
 public: // Templates for Deriving Classes