1 #ifndef __DALI_TOOLKIT_INTERNAL_SLIDER_H__
2 #define __DALI_TOOLKIT_INTERNAL_SLIDER_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/public-api/adaptor-framework/timer.h>
23 #include <dali/public-api/object/property-array.h>
24 #include <dali/public-api/object/property-map.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/public-api/controls/slider/slider.h>
29 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
45 typedef Dali::IntrusivePtr< Slider > SliderPtr;
48 * @copydoc Toolkit::Slider
50 class Slider : public Control
54 typedef Property::Array MarkList;
57 * Create a new Slider.
59 * @return A public handle to the newly allocated Slider.
61 static Dali::Toolkit::Slider New();
68 * Set marks from a list
70 * @param[in] marks The list of marks to set
72 void SetMarks( const MarkList& marks );
75 * Get the list of marks
77 * @return The marks list
79 const MarkList& GetMarks() const;
82 * Set if should snap to marks or not
84 * @param[in] snap Flag to snap to marks or not
86 void SetSnapToMarks( bool snap );
89 * Return if snap to marks is set or not
91 * @return If snap to marks is set
93 bool GetSnapToMarks() const;
96 * Set the value of the slider
98 * @param[in] value The value to set. Will be clamped to [lowerBound .. upperBound]
100 void SetValue( float value );
103 * Get the value of the slider
105 * @return The current value of the slider
107 float GetValue() const;
112 * @param[in] region The hit region
114 void SetHitRegion( const Vector2& region );
119 * @return The hit region
121 const Vector2& GetHitRegion() const;
124 * Set the track region
126 * @param[in] region The track region
128 void SetTrackRegion( const Vector2& region );
131 * Get the track region
133 * @return The track region
135 const Vector2& GetTrackRegion() const;
138 * @brief Set the disabled color.
140 * @param[in] color The disabled color.
142 void SetDisabledColor( const Vector4& color );
145 * @brief Get disabled color
147 * @return The disabled color
149 Vector4 GetDisabledColor() const;
152 * Set the value precision to be used for numbers in the slider
154 * @param[in] precision The number of decimal places to use for printing numbers
156 void SetValuePrecision( int precision );
159 * Get value precision
161 * @return The value precision
163 int GetValuePrecision() const;
168 * @param[in] showPopup The show popup flag
170 void SetShowPopup( bool showPopup );
173 * Get show value in popup
175 * @return The show value flag
177 bool GetShowPopup() const;
180 * Set show value on handle
182 * @param[in] showValue The show value flag
184 void SetShowValue( bool showValue );
187 * Get show value on handle
189 * @return The show value flag
191 bool GetShowValue() const;
196 * param[in] enabled Set the enabled flag
198 void SetEnabled( bool enabled );
201 * Return if enabled or not
205 bool IsEnabled() const;
208 * @brief Set the mark tolerance
210 * The tolerance is the percentage of the slider width for which snapping to
213 * @param[in] tolerance The percentage of width for which to snap
215 void SetMarkTolerance( float tolerance );
218 * Return the mark tolerance
220 * @return The tolerance set for snapping to marks
222 float GetMarkTolerance() const;
228 * @copydoc Toolkit::Slider::ValueChangedSignal()
230 Toolkit::Slider::ValueChangedSignalType& ValueChangedSignal();
233 * copydoc Toolkit::Slider::SlidingFinishedSignal()
235 Toolkit::Slider::ValueChangedSignalType& SlidingFinishedSignal();
238 * @copydoc Toolkit::Slider::MarkReachedSignal()
240 Toolkit::Slider::MarkReachedSignalType& MarkReachedSignal();
243 * Connects a callback function with the object's signals.
244 * @param[in] object The object providing the signal.
245 * @param[in] tracker Used to disconnect the signal.
246 * @param[in] signalName The signal to connect to.
247 * @param[in] functor A newly allocated FunctorDelegate.
248 * @return True if the signal was connected.
249 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
251 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName,
252 FunctorDelegate* functor );
257 * Called when a property of an object of this type is set.
258 * @param[in] object The object whose property is set.
259 * @param[in] index The property index.
260 * @param[in] value The new property value.
262 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
265 * Called to retrieve a property of an object of this type.
266 * @param[in] object The object whose property is to be retrieved.
267 * @param[in] index The property index.
268 * @return The current value of the property.
270 static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
275 * Construct a new Slider.
280 * A reference counted object may only be deleted by calling Unreference()
285 * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
287 virtual void OnSizeSet( const Vector3& size );
290 * @copydoc CustomActorImpl::OnRelayout
292 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
298 * Domain is a from/to pair
308 Domain( Vector2 fromVal, Vector2 toVal )
309 : from( fromVal ), to( toVal )
328 * @copydoc Toolkit::Control::OnInitialize()
330 virtual void OnInitialize();
335 * @param[in] actor The actor the event is raised for
336 * @param[in] touch The touch info
337 * @return If touch is handled or not
339 bool OnTouch( Actor actor, const TouchData& touch );
344 * @param[in] actor The actor the event is raised for
345 * @param[in] gesture The pan event info
347 void OnPan( Actor actor, const PanGesture& gesture );
350 * Map a position onto a domain and return the result as a percentage
352 * @param[in] point The point to map onto the domain
353 * @return The result as a percentage [0..1]
355 float MapPercentage( const Vector2& point );
358 * Map a value in the range to a percentage
360 * @param[in] point The value in range [lowerBound..upperBound]
361 * @return The result as a percentage [0..1]
363 float MapValuePercentage( float value );
366 * Convert a point in local hit space into domain space
368 * @param[in] x The x position to convert
369 * @return The x position in domain space
371 float HitSpaceToDomain( float x );
374 * Map a percentage onto the slider's bounds
376 * @param[in] percent The current value of slider in percent
377 * @param[in] lowerBound The lower bound to map onto
378 * @param[in] upperBound The upper bound to map onto
379 * @return The value of percent mapped from lowerBound to upperBound
381 float MapBounds( float percent, float lowerBound, float upperBound );
384 * Get the range of the valid values the slider handle can move between
386 * @param[in] currentSize The current size of the slider
387 * @return The range as a domain pair
389 Domain CalcDomain( const Vector2& currentSize );
392 * Create the hit region
394 * @return The hit region actor
396 Actor CreateHitRegion();
399 * Create the track for the slider
401 * @return The track actor
403 Toolkit::ImageView CreateTrack();
406 * Create the progress track for the slider
408 * @return The track actor
410 Toolkit::ImageView CreateProgress();
413 * Create the handle for the slider
415 * @return The created image handle
417 Toolkit::ImageView CreateHandle();
420 * Create the popup arrow
422 * @return The created image handle
424 Toolkit::ImageView CreatePopupArrow();
429 * @return The created image handle
431 Toolkit::ImageView CreatePopup();
434 * Create the textview for the popup
436 * @return The textview created for the popup
438 Toolkit::TextLabel CreatePopupText();
441 * Create the value display for the slider
443 * @return The created root actor of the display
445 Actor CreateValueDisplay();
448 * Set the skin based on the current state
453 * Create all the children
455 void CreateChildren();
468 * Display the popup for a set duration with the given value
470 * @param[in] value The value to display in the popup
472 void DisplayPopup( float value );
475 * If there are marks present, filter the incoming percent based on snapping to any nearby marks
477 * @param[in] value The incoming value on the slider to filter
478 * @return The filtered percentage snapped to any nearby marks
480 float MarkFilter( float value );
483 * If there are marks present, snap the incoming percent to the nearest mark
485 * @param[in] value The incoming value on the slider to snap
486 * @return The filtered percentage snapped to the nearest mark
488 float SnapToMark( float value );
491 * Search for if a mark has been reached
493 * @param[in] value The value to search against
494 * @param[out] outIndex The index of the mark if found
495 * @return If a mark has been found to match percent
497 bool MarkReached( float value, int& outIndex );
500 * Handler for when the value view needs to be hidden
502 * @return If handled or not
504 bool HideValueView();
507 * Set value choosing whether to fire signals or not
509 * @paramp[in] value The value to set
510 * @param[in] raiseSignals Configure signals to be raised or not.
512 void DisplayValue( float value, bool raiseSignals );
515 * Create the image for the track
517 * @param[in] filename The track image
519 void SetTrackVisual( const std::string& filename );
522 * @brief Set the track visual from an Dali::Property::Map
524 * @param[in] map The Dali::Property::Map to use for to display
526 void SetTrackVisual( Dali::Property::Map map );
529 * @brief Return the track image.
531 * @return The track image.
533 std::string GetTrackVisual();
536 * Create the image for the progress bar
538 * @param[in] filename The progress bar image
540 void SetProgressVisual( const std::string& filename );
543 * @brief Set the progress visual from an Dali::Property::Map
545 * @param[in] map The Dali::Property::Map to use for to display
547 void SetProgressVisual( Dali::Property::Map map );
550 * @brief Return the progress bar image.
552 * @return The progress bar image if it exists.
554 std::string GetProgressVisual();
557 * @brief Create the image for the popup
559 * @param[in] filename The popup image
561 void CreatePopupImage( const std::string& filename );
564 * @brief Set the popup image
566 * @param[in] filename The popup image to set
568 void SetPopupVisual( const std::string& filename );
571 * @brief Set the popup from an Dali::Property::Map
573 * @param[in] map The Dali::Property::Map to use for to display
575 void SetPopupVisual( Dali::Property::Map map );
578 * @brief Return the popup image.
580 * @return The popup image if it exists.
582 std::string GetPopupVisual();
585 * @brief Set the popup arrow image
587 * @param[in] filename The popup arrow image to set
589 void SetPopupArrowVisual( const std::string& filename );
592 * @brief Set the popup arrow from an Dali::Property::Map
594 * @param[in] map The Dali::Property::Map to use for to display
596 void SetPopupArrowVisual( Dali::Property::Map map );
599 * @brief Return the popup arrow image.
601 * @return The popup arrow image if it exists.
603 std::string GetPopupArrowVisual();
606 * Create the image for the popup arrow
608 * @param[in] filename The popup arrow image to load and set
610 void CreatePopupArrowImage( const std::string& filename );
613 * Set the size of the progress bar region
615 * @param[in] region The size of the region to set
617 void ResizeProgressRegion( const Vector2& region );
620 * Create the image for the handle
622 * @param[in] filename The handle image
624 void SetHandleVisual( const std::string& filename );
627 * @brief Set the handle visual from an Dali::Property::Map
629 * @param[in] map The Dali::Property::Map to use for to display
631 void SetHandleVisual( Property::Map map );
634 * @brief Return the handle image.
636 * @return The handle image if it exists.
638 std::string GetHandleVisual();
641 * Reset the size of the handle
643 * @param[in] size The size of the handle to set
645 void ResizeHandleSize( const Vector2& size );
648 * Create and display the value on the handle
650 void CreateHandleValueDisplay();
653 * Remove and destroy the handle value display
655 void DestroyHandleValueDisplay();
658 * Set the size of the handle
660 * @param[in] size The handle size
662 void SetHandleSize( const Vector2& size );
665 * Get the size of the handle
667 * @return The handle size
669 const Vector2& GetHandleSize() const;
672 * Set the lower bound of the slider's value
674 * @param[in] bound The value to set for the lower bound
676 void SetLowerBound( float bound );
679 * Get the lower bound of the slider's value
681 * @return The lower bound value
683 float GetLowerBound() const;
686 * Set the upper bound of the slider's value
688 * @param[in] bound The value to set for the upper bound
690 void SetUpperBound( float bound );
693 * Get the upper bound of the slider's value
695 * @return The upper bound value
697 float GetUpperBound() const;
702 Slider( const Slider& );
705 Slider& operator=( const Slider& rhs );
709 Domain mDomain; ///< Current domain of the handle
711 Actor mHitArea; ///< The input handler
712 Actor mValueDisplay; ///< Display of the value
713 Toolkit::ImageView mTrack; ///< Track image
714 Toolkit::ImageView mHandle; ///< Slider handle
715 Toolkit::ImageView mProgress; ///< Progress bar
716 Toolkit::ImageView mPopup; ///< Popup backing
717 Toolkit::ImageView mPopupArrow; ///< Popup arrow backing
719 Toolkit::TextLabel mValueTextLabel; //< The text value in popup
720 Toolkit::TextLabel mHandleValueTextLabel; ///< The text value on handle
721 Vector2 mHandleLastTouchPoint; ///< The last touch point for the handle
722 Timer mValueTimer; ///< Timer used to hide value view
724 Toolkit::Slider::ValueChangedSignalType mValueChangedSignal; ///< Signal emitted when the value is changed
725 Toolkit::Slider::ValueChangedSignalType mSlidingFinishedSignal; ///< Signal emitted when a sliding is finished
726 Toolkit::Slider::MarkReachedSignalType mMarkReachedSignal; ///< Signal emitted when a mark is reached
728 SliderState mState; ///< The state of the slider
730 PanGestureDetector mPanDetector; ///< Hit region pan detector
732 MarkList mMarks; ///< List of discreet marks
734 std::string mPopupVisual; ///< Image for popup image
735 std::string mPopupArrowVisual; ///< Image for popup arrow image
736 std::string mTrackVisual; ///< Image for track image
737 std::string mHandleVisual; ///< Image for handle image
738 std::string mProgressVisual; ///< Image for progress bar image
740 Property::Map mPopupMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
741 Property::Map mTrackMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
742 Property::Map mHandleMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
743 Property::Map mProgressMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
744 Property::Map mPopupArrowMap; ///< the Property::Map if the image came from a Property::Map, empty otherwise
746 Vector4 mDisabledColor; ///< The color to tint the slider when disabled
748 Vector2 mHitRegion; ///< Size of hit region
749 Vector2 mTrackRegion; ///< Size of track region
750 Vector2 mHandleSize; ///< Size of the handle
752 float mLowerBound; ///< Lower bound on value
753 float mUpperBound; ///< Upper bound on value
754 float mValue; ///< Current value of slider
756 float mMarkTolerance; ///< Tolerance in percentage of slider width for which to snap to marks
758 int mValuePrecision; ///< The precision to use for outputting the value
760 bool mShowPopup : 1, ///< Show the popup or not
761 mShowValue : 1, ///< Whether to display the value number or not on the handle
762 mSnapToMarks : 1; ///< Turn on or off snapping to marks
765 } // namespace Internal
767 // Helpers for public-api forwarding methods
769 inline Toolkit::Internal::Slider& GetImpl( Toolkit::Slider& pub )
771 DALI_ASSERT_ALWAYS( pub );
773 Dali::RefObject& handle = pub.GetImplementation();
775 return static_cast< Toolkit::Internal::Slider& >( handle );
778 inline const Toolkit::Internal::Slider& GetImpl( const Toolkit::Slider& pub )
780 DALI_ASSERT_ALWAYS( pub );
782 const Dali::RefObject& handle = pub.GetImplementation();
784 return static_cast< const Toolkit::Internal::Slider& >( handle );
787 } // namespace Toolkit
791 #endif // __DALI_TOOLKIT_INTERNAL_SLIDER_H__