X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=capi%2Fdali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-twist-effect.h;h=9d2d81a6dc736169d34a3086a8fe96e59d78aa98;hp=26f7070fcde1a0d0136dcdb3aa30ea636ac79e36;hb=d5e3ed5f5b1c8fdba3ae97ead8729620f54b3836;hpb=bf2155ead4441b35df9e85eb10743c5bedba777e diff --git a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-twist-effect.h b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-twist-effect.h index 26f7070..9d2d81a 100644 --- a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-twist-effect.h +++ b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-twist-effect.h @@ -1,24 +1,25 @@ #ifndef __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__ #define __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_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_FRAMEWORK + * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE * @{ */ @@ -41,31 +42,35 @@ class ScrollViewTwistEffect; } /** - * ScrollView Twist-Effect. + * @brief ScrollView effect that twists pages onto screen when transitioning. */ class ScrollViewTwistEffect : public ScrollViewEffect { public: - static const float DEFAULT_MINIMUM_DISTANCE_FOR_SHRINK; + static const float DEFAULT_MINIMUM_DISTANCE_FOR_SHRINK; ///< The min distance for shrink public: /** - * Create an initialized ScrollViewTwistEffect. + * @brief Create an initialized ScrollViewTwistEffect. + * * @return A handle to a newly allocated Dali resource. */ static ScrollViewTwistEffect New(); /** - * Create an uninitialized ScrollViewTwistEffect; this can be initialized with ScrollViewTwistEffect::New() + * @brief Create an uninitialized ScrollViewTwistEffect; this can be initialized with ScrollViewTwistEffect::New(). + * * Calling member functions with an uninitialized Toolkit::ScrollViewTwistEffect is not allowed. */ ScrollViewTwistEffect(); /** - * Downcast an Object handle to ScrollViewTwistEffect. If handle points to a ScrollViewTwistEffect the + * @brief Downcast an Object handle to ScrollViewTwistEffect. + * + * If handle points to a ScrollViewTwistEffect the * downcast produces valid handle. If not the returned handle is left uninitialized. * @param[in] handle Handle to an object * @return handle to a ScrollViewTwistEffect or an uninitialized handle @@ -73,28 +78,32 @@ public: static ScrollViewTwistEffect DownCast( BaseHandle handle ); /** - * Gets the minimum animation distance for the shrink effect to - * occur + * @brief Gets the minimum animation distance for the shrink effect to + * occur. + * * @return The minimum distance in seconds is returned. */ float GetMinimumDistanceForShrink() const; /** - * Sets the minimum animation distance for the shrink effect + * @brief Sets the minimum animation distance for the shrink effect * to occur. + * * @param[in] distance The minimum distance in pixels (default = 0.0) * i.e. any flick will result in shrinking. */ void SetMinimumDistanceForShrink(float distance); /** - * Enable or disable this effect. + * @brief Enable or disable this effect. + * * @param[in] enableFlag Set to true if the effect should be enabled. */ void EnableEffect(bool enableFlag); /** - * Manually apply effect to an Actor. + * @brief Manually apply effect to an Actor. + * * @param[in] child The child Actor to be affected by this effect. * @param[in] additionalEffects Whether just the basic effect (delay) * should be applied. Or all effects (delay, rotation, scaling). @@ -119,16 +128,19 @@ public: float delayMax = 0.9f ); /** - * Set the maximum swing angle when at zero drop off + * @brief Set the maximum swing angle when at zero drop off. * * @param[in] maxSwingAngle maximum swing angle for x and y axes */ void SetMaxSwingAngle(const Vector2& maxSwingAngle); /** - * Set the drop off values to affect the amount of swing angle applied to an actor the further it is from - * the scroll position. A drop off of 0.0f means no angle drop off while 1.0f will reduce the angle to zero - * over the distance supplied for that axis. + * @brief Set the drop off values to affect the amount of swing + * angle applied to an actor the further it is from the scroll + * position. + * + * A drop off of 0.0f means no angle drop off while 1.0f will reduce + * the angle to zero over the distance supplied for that axis. * * Example maxSwingAngle.x is Pi, dropOff.x is 0.5f and distance.x is 100.0f: * The angle on the x axis will reduce to (0.5f * Pi) over 100 pixels @@ -142,7 +154,8 @@ public: protected: /** - * This constructor is used by Dali New() methods. + * @brief This constructor is used by Dali New() methods. + * * @param [in] impl A pointer to a newly allocated Dali resource */ ScrollViewTwistEffect(Internal::ScrollViewTwistEffect *impl);