Merge branch 'devel/master' into tizen
[platform/core/uifw/dali-core.git] / dali / public-api / object / property-conditions.h
index 81b1362..36a0df3 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_PROPERTY_CONDITIONS_H__
-#define __DALI_PROPERTY_CONDITIONS_H__
+#ifndef DALI_PROPERTY_CONDITIONS_H
+#define DALI_PROPERTY_CONDITIONS_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -39,10 +39,9 @@ class PropertyCondition;
  * @brief This represents a condition that can be evaluated on a Property::Value.
  * @SINCE_1_0.0
  */
-class DALI_IMPORT_API PropertyCondition : public BaseHandle
+class DALI_CORE_API PropertyCondition : public BaseHandle
 {
 public:
-
   /**
    * @brief Constructor for condition clause.
    * @SINCE_1_0.0
@@ -59,23 +58,39 @@ public:
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
    * @SINCE_1_0.0
-   * @param [in] handle A reference to the copied handle
+   * @param[in] handle A reference to the copied handle
    */
-  PropertyCondition( const PropertyCondition& handle );
+  PropertyCondition(const PropertyCondition& handle);
 
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
    * @SINCE_1_0.0
-   * @param [in] rhs  A reference to the copied handle
+   * @param[in] rhs A reference to the copied handle
    * @return A reference to this
    */
-  PropertyCondition& operator=( const PropertyCondition& rhs );
+  PropertyCondition& operator=(const PropertyCondition& rhs);
 
-public:
+  /**
+   * @brief Move constructor.
+   *
+   * @SINCE_1_9.22
+   * @param[in] rhs A reference to the moved handle
+   */
+  PropertyCondition(PropertyCondition&& rhs);
 
   /**
-   * @brief Retrieve the arguments that this condition uses.
+   * @brief Move assignment operator.
+   *
+   * @SINCE_1_9.22
+   * @param[in] rhs A reference to the moved handle
+   * @return A reference to this handle
+   */
+  PropertyCondition& operator=(PropertyCondition&& rhs);
+
+public:
+  /**
+   * @brief Retrieves the arguments that this condition uses.
    *
    * @SINCE_1_0.0
    * @return The arguments used for this condition
@@ -83,14 +98,14 @@ public:
   std::size_t GetArgumentCount() const;
 
   /**
-   * @brief Retrieve the arguments that this condition uses.
+   * @brief Retrieves the arguments that this condition uses.
    *
    * @SINCE_1_0.0
+   * @param[in] index The condition index to get the argument
    * @return The arguments used for this condition
    * @note The container will only be valid as long PropertyCondition is valid.
    */
-  float GetArgument( std::size_t index ) const;
-
+  float GetArgument(std::size_t index) const;
 };
 
 /**
@@ -106,7 +121,7 @@ public:
  * @param[in] arg The argument for the condition
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition LessThanCondition( float arg );
+DALI_CORE_API PropertyCondition LessThanCondition(float arg);
 
 /**
  * @brief GreaterThanCondition compares whether property is greater than arg.
@@ -121,7 +136,7 @@ DALI_IMPORT_API PropertyCondition LessThanCondition( float arg );
  * @param[in] arg The argument for the condition
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition GreaterThanCondition( float arg );
+DALI_CORE_API PropertyCondition GreaterThanCondition(float arg);
 
 /**
  * @brief InsideCondition compares whether property is greater than arg0 and less than arg1.
@@ -137,7 +152,7 @@ DALI_IMPORT_API PropertyCondition GreaterThanCondition( float arg );
  * @param[in] arg1 The second argument for the condition
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition InsideCondition( float arg0, float arg1 );
+DALI_CORE_API PropertyCondition InsideCondition(float arg0, float arg1);
 
 /**
  * @brief OutsideCondition compares whether property is less than arg0 or greater than arg1.
@@ -153,10 +168,10 @@ DALI_IMPORT_API PropertyCondition InsideCondition( float arg0, float arg1 );
  * @param[in] arg1 The second argument for the condition
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 );
+DALI_CORE_API PropertyCondition OutsideCondition(float arg0, float arg1);
 
 /**
- * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount
+ * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
  *
  * property type:
  * float (float)
@@ -168,10 +183,10 @@ DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 );
  * @param[in] initialValue The initial value to step from
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f );
+DALI_CORE_API PropertyCondition StepCondition(float stepAmount, float initialValue = 0.0f);
 
 /**
- * @brief Receive notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending
+ * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
  *
  * property type:
  * float (float)
@@ -182,11 +197,11 @@ DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initial
  * @param[in] steps List of values to receive notifications for as a property crosses them
  * @return A property condition function object
  */
-DALI_IMPORT_API PropertyCondition VariableStepCondition( const Dali::Vector<float>& steps );
+DALI_CORE_API PropertyCondition VariableStepCondition(const Dali::Vector<float>& steps);
 
 /**
  * @}
  */
 } // namespace Dali
 
-#endif // __DALI_PROPERTY_CONDITIONS_H__
+#endif // DALI_PROPERTY_CONDITIONS_H