2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/public-api/object/type-registry.h>
22 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
23 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
30 } // unnamed namespace
38 const Property::Index Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR( Toolkit::Internal::Control::CONTROL_PROPERTY_END_INDEX + 1 );
45 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
49 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
53 TypeRegistration mType( typeid(Toolkit::Scrollable), typeid(Toolkit::Control), Create );
55 SignalConnectorType s1(mType, Toolkit::Scrollable::SIGNAL_SCROLL_STARTED, &Scrollable::DoConnectSignal);
56 SignalConnectorType s2(mType, Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED, &Scrollable::DoConnectSignal);
57 SignalConnectorType s3(mType, Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED, &Scrollable::DoConnectSignal);
58 SignalConnectorType s4(mType, Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED, &Scrollable::DoConnectSignal);
60 PropertyRegistration property1( mType,
61 "overshoot-effect-color",
62 Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR,
64 &Scrollable::SetProperty,
65 &Scrollable::GetProperty );
69 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_VERTICAL( "scrollable-can-scroll-vertical" );
70 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_HORIZONTAL( "scrollable-can-scroll-horizontal" );
72 ///////////////////////////////////////////////////////////////////////////////////////////////////
74 ///////////////////////////////////////////////////////////////////////////////////////////////////
76 // Scrollable controls are not layout containers so they dont need size negotiation..
77 // we dont want size negotiation while scrolling if we can avoid it
78 Scrollable::Scrollable()
79 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | NO_SIZE_NEGOTIATION ) ),
80 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
81 mPropertyRelativePosition(Property::INVALID_INDEX),
82 mPropertyPositionMin(Property::INVALID_INDEX),
83 mPropertyPositionMax(Property::INVALID_INDEX),
84 mPropertyScrollDirection(Property::INVALID_INDEX),
85 mPropertyCanScrollVertical(Property::INVALID_INDEX),
86 mPropertyCanScrollHorizontal(Property::INVALID_INDEX),
87 mOvershootEnabled(false)
91 Scrollable::~Scrollable()
93 // Clear scroll components, forces their destruction before Scrollable is destroyed.
97 void Scrollable::RegisterCommonProperties()
101 // Register properties.
102 mPropertyRelativePosition = self.RegisterProperty(Toolkit::Scrollable::SCROLL_RELATIVE_POSITION_PROPERTY_NAME, Vector3::ZERO);
103 mPropertyPositionMin = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MIN_PROPERTY_NAME, Vector3::ZERO);
104 mPropertyPositionMax = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MAX_PROPERTY_NAME, Vector3::ZERO);
105 mPropertyScrollDirection = self.RegisterProperty(Toolkit::Scrollable::SCROLL_DIRECTION_PROPERTY_NAME, Vector3::ZERO);
106 mPropertyCanScrollVertical = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_VERTICAL, true);
107 mPropertyCanScrollHorizontal = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_HORIZONTAL, true);
110 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
112 if(type == Toolkit::Scrollable::OvershootIndicator)
114 return mOvershootEnabled;
116 return (mComponents.find(type) != mComponents.end());
119 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
121 if(type == Toolkit::Scrollable::OvershootIndicator)
123 if( !mOvershootEnabled )
125 SetOvershootEnabled(true);
126 mOvershootEnabled = true;
130 if( mComponents.find(type) == mComponents.end() )
132 // Create ScrollComponent
133 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
134 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
135 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
136 ScrollComponentPtr componentPtr(&component);
138 mComponents[type] = componentPtr;
142 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
144 if(type == Toolkit::Scrollable::OvershootIndicator)
146 if( mOvershootEnabled )
148 SetOvershootEnabled(false);
149 mOvershootEnabled = false;
153 ComponentIter pair = mComponents.find( type );
155 if( mComponents.end() != pair )
157 ScrollComponentPtr component = pair->second;
159 // Disconnect the scroll component first.
160 component->OnDisconnect();
162 // Destroy ScrollComponent.
163 mComponents.erase( type );
167 Vector4 Scrollable::GetOvershootEffectColor() const
169 return mOvershootEffectColor;
172 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
174 return mScrollStartedSignalV2;
177 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
179 return mScrollUpdatedSignalV2;
182 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
184 return mScrollCompletedSignalV2;
187 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
189 return mScrollClampedSignalV2;
192 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
194 Dali::BaseHandle handle( object );
196 bool connected( true );
197 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
199 if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
201 scrollable.ScrollStartedSignal().Connect( tracker, functor );
203 else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
205 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
207 else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
209 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
211 else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
213 scrollable.ScrollClampedSignal().Connect( tracker, functor );
217 // signalName does not match any signal
224 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
226 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
230 Scrollable& scrollableImpl( GetImpl( scrollable ) );
233 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
235 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
242 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
244 Property::Value value;
246 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
250 Scrollable& scrollableImpl( GetImpl( scrollable ) );
253 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
255 value = scrollableImpl.GetOvershootEffectColor();
264 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
266 Toolkit::ScrollComponent instance;
270 case Toolkit::Scrollable::VerticalScrollBar:
272 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
275 case Toolkit::Scrollable::HorizontalScrollBar:
277 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
280 case Toolkit::Scrollable::OvershootIndicator:
282 DALI_ASSERT_ALWAYS(!"Unrecognized component type");
290 } // namespace Internal
292 } // namespace Toolkit