1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_CONNECTOR_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_CONNECTOR_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
34 * @copydoc Toolkit::ScrollConnector
36 class ScrollConnector : public Dali::BaseObject
40 typedef Toolkit::ScrollConnector::DomainChangedSignalType DomainChangedSignalType;
41 typedef Toolkit::ScrollConnector::ScrollPositionChangedSignalType ScrollPositionChangedSignalType;
43 static const Property::Index SCROLL_POSITION;
44 static const Property::Index OVERSHOOT;
47 * Create a ScrollConnector.
48 * @return A newly allocated ScrollConnector.
50 static ScrollConnector* New();
53 * @copydoc Toolkit::ScrollConnector::SetScrollDomain()
55 void SetScrollDomain( float min, float max, float length );
58 * @copydoc Toolkit::ScrollConnector::GetMinLimit()
60 float GetMinLimit() const
66 * @copydoc Toolkit::ScrollConnector::GetMaxLimit()
68 float GetMaxLimit() const
74 * @copydoc Toolkit::ScrollConnector::GetContentLength()
76 float GetContentLength() const
78 return mContentLength;
82 * @copydoc Toolkit::ScrollConnector::SetScrollPosition()
84 void SetScrollPosition( float position );
87 * @copydoc Toolkit::ScrollConnector::GetScrollPosition()
89 float GetScrollPosition() const
91 return mScrollPositionObject.GetProperty<float>( Toolkit::ScrollConnector::SCROLL_POSITION );
95 * Signal emitted after the SetScrollPosition() method has been called.
97 ScrollPositionChangedSignalType& ScrollPositionChangedSignal()
99 return mScrollPositionChangedSignal;
103 * Signal emitted after the SetScrollDomain() method has been called.
105 DomainChangedSignalType& DomainChangedSignal()
107 return mDomainChangedSignal;
111 * Retrieve the object which provides the "scroll-position" property.
112 * @return The scroll-position object.
114 Constrainable GetScrollPositionObject() const
116 return mScrollPositionObject;
122 * Create a new ScrollConnector.
129 virtual ~ScrollConnector();
132 ScrollConnector(const ScrollConnector&);
135 ScrollConnector& operator=(const ScrollConnector& rhs);
139 Constrainable mScrollPositionObject;
141 DomainChangedSignalType mDomainChangedSignal;
142 ScrollPositionChangedSignalType mScrollPositionChangedSignal;
146 float mContentLength;
149 } // namespace Internal
151 inline Internal::ScrollConnector& GetImpl(Dali::Toolkit::ScrollConnector& obj)
153 DALI_ASSERT_ALWAYS(obj);
155 Dali::BaseObject& handle = obj.GetBaseObject();
157 return static_cast<Internal::ScrollConnector&>(handle);
160 inline const Internal::ScrollConnector& GetImpl(const Dali::Toolkit::ScrollConnector& obj)
162 DALI_ASSERT_ALWAYS(obj);
164 const Dali::BaseObject& handle = obj.GetBaseObject();
166 return static_cast<const Internal::ScrollConnector&>(handle);
169 } // namespace Toolkit
173 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_CONNECTOR_H__