X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-constraints.h;h=2e2c2b2914fad35e1113383f374e0caa4463ad2d;hb=27a47ce10614f4b643f55b1d52e062d9ab2f00aa;hp=9faba3564b934db44dcb3a6a2b97c372d8fe2bef;hpb=306d2f61a1b64179e801fa8a0bb2bd7b4e9dd682;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git 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..2e2c2b2 100644 --- 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 @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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,8 +19,7 @@ */ // EXTERNAL INCLUDES - -// INTERNAL INCLUDES +#include namespace Dali { @@ -32,6 +31,10 @@ class PropertyInput; namespace Toolkit { +/** + * @addtogroup dali_toolkit_controls_scroll_view + * @{ + */ // Constraints //////////////////////////////////////////////////////////////////////////////////// @@ -40,26 +43,26 @@ 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_IMPORT_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_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs ); +/** + * @} + */ } // namespace Toolkit } // namespace Dali