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.h;h=6592fd67fa4513ac66c82ab92cfcbdf002351cd0;hp=79a42f301794334b6f1ceae2ce465c580b0ade6e;hb=2ce55266059eb3dfc3b8a90a5a3ca266bb84674a;hpb=30f6ca1e541089b19f2b349a8a12d8a5bcaf2f9e diff --git a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index 79a42f3..6592fd6 100644 --- a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -1,21 +1,22 @@ #ifndef __DALI_TOOLKIT_SCROLL_VIEW_H__ #define __DALI_TOOLKIT_SCROLL_VIEW_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_TOOLKIT_SCROLL_VIEW_MODULE @@ -700,6 +701,7 @@ public: void SetWrapMode(bool enable); /** + * @deprecated * @brief Gets the current refresh interval in milliseconds. * * @return Current refresh interval in milliseconds @@ -707,6 +709,7 @@ public: int GetRefreshInterval() const; /** + * @deprecated * @brief Sets the refresh interval in milliseconds. * * The refresh interval is a notification signal @@ -720,6 +723,23 @@ public: void SetRefreshInterval(int milliseconds); /** + * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted + * + * @return Current scroll update distance + */ + int GetScrollUpdateDistance() const; + + /** + * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted + * + * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application. + * Each time the ScrollView crosses this distance the signal will be emitted + * + * @param[in] distance The distance for ScrollView to move before emitting update signal + */ + void SetScrollUpdateDistance(int distance); + + /** * @brief Returns state of Axis Auto Lock mode. * * @return Whether Axis Auto Lock mode has been enabled or not. @@ -858,6 +878,14 @@ public: Vector3 GetCurrentScrollPosition() const; /** + * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place + * SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function. + * + * @param[in] position The new scroll position to set. + */ + void SetScrollPosition(const Vector3& position); + + /** * @brief Retrieves current scroll scale. * * @returns The current scroll scale.