Formatting API

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / scroll-view / scroll-view-constraints.h

diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
index 9faba35..d4a3b00 100644 (file)
--- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
+++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
-#define __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
+#ifndef DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H
+#define DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H
 
 /*
- * Copyright (c) 2014 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.
@@ -19,12 +19,13 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/animation/constraint.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
 
 namespace Dali
 {
-
 struct Vector2;
 struct Vector3;
 struct Vector4;
@@ -32,6 +33,10 @@ class PropertyInput;
 
 namespace Toolkit
 {
+/**
+ * @addtogroup dali_toolkit_controls_scroll_view
+ * @{
+ */
 
 // Constraints ////////////////////////////////////////////////////////////////////////////////////
 
@@ -40,28 +45,28 @@ namespace Toolkit
  */
 
 /**
- * Move Actor constraint.
+ * @brief Moves an Actor in accordance with the scroll position.
  *
- * Moves an Actor in accordance to scroll position.
+ * @SINCE_1_0.0
+ * @param[in] current Current position
+ * @param[in] inputs The position input that Actor will move
  */
-DALI_IMPORT_API Vector3 MoveActorConstraint(const Vector3&    current,
-                                           const PropertyInput& scrollPositionProperty);
+DALI_TOOLKIT_API void MoveActorConstraint(Vector3& current, const PropertyInputContainer& inputs);
 
 /**
- * Wrap Actor constraint.
+ * @brief Wraps an Actor's position in accordance with the min/max bounds of domain.
  *
- * Wraps an Actors position in accordance to min/max bounds of domain.
+ * @SINCE_1_0.0
+ * @param[in] position Position to be wrapped
+ * @param[in] inputs The input that Actor's position will be wrapped
  */
-DALI_IMPORT_API Vector3 WrapActorConstraint(const Vector3&    current,
-                                            const PropertyInput& actorScaleProperty,
-                                            const PropertyInput& actorAnchorPointProperty,
-                                            const PropertyInput& actorSizeProperty,
-                                            const PropertyInput& scrollPositionMin,
-                                            const PropertyInput& scrollPositionMax,
-                                            const PropertyInput& scrollWrap);
+DALI_TOOLKIT_API void WrapActorConstraint(Vector3& position, const PropertyInputContainer& inputs);
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
+#endif // DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H