License conversion from Flora to Apache 2.0
[platform/core/uifw/dali-core.git] / capi / dali / public-api / object / handle.h
index 7a613f6..16d6f13 100644 (file)
@@ -1,21 +1,22 @@
 #ifndef __DALI_HANDLE_H__
 #define __DALI_HANDLE_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 /**
  * @addtogroup CAPI_DALI_OBJECT_MODULE
@@ -144,7 +145,6 @@ public:
   /**
    * @brief Query the name of a property.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @return The name of the property.
    */
@@ -161,7 +161,7 @@ public:
   /**
    * @brief Query whether a property can be set using SetProperty().
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
+   * @pre Property::INVALID_INDEX < index.
    * @param [in] index The index of the property.
    * @return True if the property is writable.
    */
@@ -170,16 +170,22 @@ public:
   /**
    * @brief Query whether a writable property can be the target of an animation or constraint.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @return True if the property is animatable.
    */
   bool IsPropertyAnimatable(Property::Index index) const;
 
   /**
+   * @brief Query whether a property can be used as in input to a constraint.
+   *
+   * @param [in] index The index of the property.
+   * @return True if the property can be used as a constraint input.
+   */
+  bool IsPropertyAConstraintInput(Property::Index index) const;
+
+  /**
    * @brief Query the type of a property.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @return The type of the property.
    */
@@ -189,7 +195,6 @@ public:
    * @brief Set the value of an existing property.
    *
    * @pre Handle::IsPropertyWritable(index) returns true.
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
    * @param [in] index The index of the property.
    * @param [in] propertyValue The new value of the property.
@@ -223,7 +228,6 @@ public:
   /**
    * @brief Retrieve a property value.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @return The property value.
    */
@@ -232,7 +236,6 @@ public:
   /**
    * @brief Convenience function for obtaining a property of a known type.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @pre The property types match i.e. PropertyTypes::Get<T>() is equal to GetPropertyType(index).
    * @param [in] index The index of the property.
    * @return The property value.
@@ -256,7 +259,6 @@ public:
   /**
    * @brief Add a property notification to this object.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @param [in] condition The notification will be triggered when this condition is satisfied.
    *
@@ -268,7 +270,6 @@ public:
   /**
    * @brief Add a property notification to this object.
    *
-   * @pre Property::INVALID_INDEX < index < GetPropertyCount().
    * @param [in] index The index of the property.
    * @param [in] componentIndex Index to the component of a complex property such as a Vector
    * @param [in] condition The notification will be triggered when this condition is satisfied.