dali-toolkit/internal/controls/slider/slider-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SLIDER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_SLIDER_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  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>
  25
  26 // INTERNAL INCLUDES
  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>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 class Button;
  39
  40 namespace Internal
  41 {
  42
  43 class Slider;
  44
  45 typedef Dali::IntrusivePtr< Slider > SliderPtr;
  46
  47 /**
  48  * @copydoc Toolkit::Slider
  49  */
  50 class Slider : public Control
  51 {
  52 public:
  53
  54   typedef Property::Array MarkList;
  55
  56   /**
  57    * Create a new Slider.
  58    *
  59    * @return A public handle to the newly allocated Slider.
  60    */
  61   static Dali::Toolkit::Slider New();
  62
  63 public:
  64
  65   // Properties
  66
  67   /**
  68    * Set marks from a list
  69    *
  70    * @param[in] marks The list of marks to set
  71    */
  72   void SetMarks( const MarkList& marks );
  73
  74   /**
  75    * Get the list of marks
  76    *
  77    * @return The marks list
  78    */
  79   const MarkList& GetMarks() const;
  80
  81   /**
  82    * Set if should snap to marks or not
  83    *
  84    * @param[in] snap Flag to snap to marks or not
  85    */
  86   void SetSnapToMarks( bool snap );
  87
  88   /**
  89    * Return if snap to marks is set or not
  90    *
  91    * @return If snap to marks is set
  92    */
  93   bool GetSnapToMarks() const;
  94
  95   /**
  96    * Set the value of the slider
  97    *
  98    * @param[in] value The value to set. Will be clamped to [lowerBound .. upperBound]
  99    */
 100   void SetValue( float value );
 101
 102   /**
 103    * Get the value of the slider
 104    *
 105    * @return The current value of the slider
 106    */
 107   float GetValue() const;
 108
 109   /**
 110    * Set hit region
 111    *
 112    * @param[in] region The hit region
 113    */
 114   void SetHitRegion( const Vector2& region );
 115
 116   /**
 117    * Get hit region
 118    *
 119    * @return The hit region
 120    */
 121   const Vector2& GetHitRegion() const;
 122
 123   /**
 124    * Set the track region
 125    *
 126    * @param[in] region The track region
 127    */
 128   void SetTrackRegion( const Vector2& region );
 129
 130   /**
 131    * Get the track region
 132    *
 133    * @return The track region
 134    */
 135   const Vector2& GetTrackRegion() const;
 136
 137   /**
 138    * @brief Set the disabled color.
 139    *
 140    * @param[in] color The disabled color.
 141    */
 142   void SetDisabledColor( const Vector4& color );
 143
 144   /**
 145    * @brief Get disabled color
 146    *
 147    * @return The disabled color
 148    */
 149   Vector4 GetDisabledColor() const;
 150
 151   /**
 152    * Set the value precision to be used for numbers in the slider
 153    *
 154    * @param[in] precision The number of decimal places to use for printing numbers
 155    */
 156   void SetValuePrecision( int precision );
 157
 158   /**
 159    * Get value precision
 160    *
 161    * @return The value precision
 162    */
 163   int GetValuePrecision() const;
 164
 165   /**
 166    * Show the popup
 167    *
 168    * @param[in] showPopup The show popup flag
 169    */
 170   void SetShowPopup( bool showPopup );
 171
 172   /**
 173    * Get show value in popup
 174    *
 175    * @return The show value flag
 176    */
 177   bool GetShowPopup() const;
 178
 179   /**
 180    * Set show value on handle
 181    *
 182    * @param[in] showValue The show value flag
 183    */
 184   void SetShowValue( bool showValue );
 185
 186   /**
 187    * Get show value on handle
 188    *
 189    * @return The show value flag
 190    */
 191   bool GetShowValue() const;
 192
 193   /**
 194    * Set enabled
 195    *
 196    * param[in] enabled Set the enabled flag
 197    */
 198   void SetEnabled( bool enabled );
 199
 200   /**
 201    * Return if enabled or not
 202    *
 203    * @return If enabled
 204    */
 205   bool IsEnabled() const;
 206
 207   /**
 208    * @brief Set the mark tolerance
 209    *
 210    * The tolerance is the percentage of the slider width for which snapping to
 211    * marks occurs
 212    *
 213    * @param[in] tolerance The percentage of width for which to snap
 214    */
 215   void SetMarkTolerance( float tolerance );
 216
 217   /**
 218    * Return the mark tolerance
 219    *
 220    * @return The tolerance set for snapping to marks
 221    */
 222   float GetMarkTolerance() const;
 223
 224 public:
 225   //Signals
 226
 227   /**
 228    * @copydoc Toolkit::Slider::ValueChangedSignal()
 229    */
 230   Toolkit::Slider::ValueChangedSignalType& ValueChangedSignal();
 231
 232   /**
 233    * copydoc Toolkit::Slider::SlidingFinishedSignal()
 234    */
 235   Toolkit::Slider::ValueChangedSignalType& SlidingFinishedSignal();
 236
 237   /**
 238    * @copydoc Toolkit::Slider::MarkReachedSignal()
 239    */
 240   Toolkit::Slider::MarkReachedSignalType& MarkReachedSignal();
 241
 242   /**
 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.
 250    */
 251   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName,
 252                                FunctorDelegate* functor );
 253
 254   // Properties
 255
 256   /**
 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.
 261    */
 262   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 263
 264   /**
 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.
 269    */
 270   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
 271
 272 protected:
 273
 274   /**
 275    * Construct a new Slider.
 276    */
 277   Slider();
 278
 279   /**
 280    * A reference counted object may only be deleted by calling Unreference()
 281    */
 282   virtual ~Slider();
 283
 284   /**
 285    * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
 286    */
 287   virtual void OnSizeSet( const Vector3& size );
 288
 289 private:
 290
 291   /**
 292    * Domain is a from/to pair
 293    */
 294   struct Domain
 295   {
 296     Vector2 from;
 297     Vector2 to;
 298
 299     Domain()
 300     {
 301     }
 302     Domain( Vector2 fromVal, Vector2 toVal )
 303         : from( fromVal ), to( toVal )
 304     {
 305     }
 306   };
 307
 308   /**
 309    * Slider states
 310    */
 311   enum SliderState
 312   {
 313     NORMAL,
 314     DISABLED,
 315     PRESSED,
 316     FOCUSED
 317   };
 318
 319 private:
 320
 321   /**
 322    * @copydoc Toolkit::Control::OnInitialize()
 323    */
 324   virtual void OnInitialize();
 325
 326   /**
 327    * Hit region touch event
 328    *
 329    * @param[in] actor The actor the event is raised for
 330    * @param[in] event The touch event info
 331    * @return If the event is handled or not
 332    */
 333   bool OnTouchEvent( Actor actor, const TouchEvent& event );
 334
 335   /**
 336    * Pan gesture event
 337    *
 338    * @param[in] actor The actor the event is raised for
 339    * @param[in] gesture The pan event info
 340    */
 341   void OnPan( Actor actor, const PanGesture& gesture );
 342
 343   /**
 344    * Map a position onto a domain and return the result as a percentage
 345    *
 346    * @param[in] point The point to map onto the domain
 347    * @return The result as a percentage [0..1]
 348    */
 349   float MapPercentage( const Vector2& point );
 350
 351   /**
 352    * Map a value in the range to a percentage
 353    *
 354    * @param[in] point The value in range [lowerBound..upperBound]
 355    * @return The result as a percentage [0..1]
 356    */
 357   float MapValuePercentage( float value );
 358
 359   /**
 360    * Convert a point in local hit space into domain space
 361    *
 362    * @param[in] x The x position to convert
 363    * @return The x position in domain space
 364    */
 365   float HitSpaceToDomain( float x );
 366
 367   /**
 368    * Map a percentage onto the slider's bounds
 369    *
 370    * @param[in] percent The current value of slider in percent
 371    * @param[in] lowerBound The lower bound to map onto
 372    * @param[in] upperBound The upper bound to map onto
 373    * @return The value of percent mapped from lowerBound to upperBound
 374    */
 375   float MapBounds( float percent, float lowerBound, float upperBound );
 376
 377   /**
 378    * Get the range of the valid values the slider handle can move between
 379    *
 380    * @param[in] currentSize The current size of the slider
 381    * @return The range as a domain pair
 382    */
 383   Domain CalcDomain( const Vector2& currentSize );
 384
 385   /**
 386    * Create the hit region
 387    *
 388    * @return The hit region actor
 389    */
 390   Actor CreateHitRegion();
 391
 392   /**
 393    * Create the track for the slider
 394    *
 395    * @return The track actor
 396    */
 397   Toolkit::ImageView CreateTrack();
 398
 399   /**
 400    * Create the progress track for the slider
 401    *
 402    * @return The track actor
 403    */
 404   Toolkit::ImageView CreateProgress();
 405
 406   /**
 407    * Create the handle for the slider
 408    *
 409    * @return The created image handle
 410    */
 411   Toolkit::ImageView CreateHandle();
 412
 413   /**
 414    * Create the popup arrow
 415    *
 416    * @return The created image handle
 417    */
 418   Toolkit::ImageView CreatePopupArrow();
 419
 420   /**
 421    * Create the popup
 422    *
 423    * @return The created image handle
 424    */
 425   Toolkit::ImageView CreatePopup();
 426
 427   /**
 428    * Create the textview for the popup
 429    *
 430    * @return The textview created for the popup
 431    */
 432   Toolkit::TextLabel CreatePopupText();
 433
 434   /**
 435    * Create the value display for the slider
 436    *
 437    * @return The created root actor of the display
 438    */
 439   Actor CreateValueDisplay();
 440
 441   /**
 442    * Set the skin based on the current state
 443    */
 444   void UpdateSkin();
 445
 446   /**
 447    * Create all the children
 448    */
 449   void CreateChildren();
 450
 451   /**
 452    * Create value popup
 453    */
 454   void AddPopup();
 455
 456   /**
 457    * Remove value popup
 458    */
 459   void RemovePopup();
 460
 461   /**
 462    * Display the popup for a set duration with the given value
 463    *
 464    * @param[in] value The value to display in the popup
 465    */
 466   void DisplayPopup( float value );
 467
 468   /**
 469    * If there are marks present, filter the incoming percent based on snapping to any nearby marks
 470    *
 471    * @param[in] value The incoming value on the slider to filter
 472    * @return The filtered percentage snapped to any nearby marks
 473    */
 474   float MarkFilter( float value );
 475
 476   /**
 477    * If there are marks present, snap the incoming percent to the nearest mark
 478    *
 479    * @param[in] value The incoming value on the slider to snap
 480    * @return The filtered percentage snapped to the nearest mark
 481    */
 482   float SnapToMark( float value );
 483
 484   /**
 485    * Search for if a mark has been reached
 486    *
 487    * @param[in] value The value to search against
 488    * @param[out] outIndex The index of the mark if found
 489    * @return If a mark has been found to match percent
 490    */
 491   bool MarkReached( float value, int& outIndex );
 492
 493   /**
 494    * Handler for when the value view needs to be hidden
 495    *
 496    * @return If handled or not
 497    */
 498   bool HideValueView();
 499
 500   /**
 501    * Set value choosing whether to fire signals or not
 502    *
 503    * @paramp[in] value The value to set
 504    * @param[in] raiseSignals Configure signals to be raised or not.
 505    */
 506   void DisplayValue( float value, bool raiseSignals );
 507
 508   /**
 509    * Create the image for the track
 510    *
 511    * @param[in] filename The track image
 512    */
 513   void SetTrackVisual( const std::string& filename );
 514
 515   /**
 516    * @brief Set the track visual from an Dali::Property::Map
 517    *
 518    * @param[in] map The Dali::Property::Map to use for to display
 519    */
 520   void SetTrackVisual( Dali::Property::Map map );
 521
 522   /**
 523    * @brief Return the track image.
 524    *
 525    * @return The track image.
 526    */
 527   std::string GetTrackVisual();
 528
 529   /**
 530    * Create the image for the progress bar
 531    *
 532    * @param[in] filename The progress bar image
 533    */
 534   void SetProgressVisual( const std::string& filename );
 535
 536   /**
 537    * @brief Set the progress visual from an Dali::Property::Map
 538    *
 539    * @param[in] map The Dali::Property::Map to use for to display
 540    */
 541   void SetProgressVisual( Dali::Property::Map map );
 542
 543   /**
 544    * @brief Return the progress bar image.
 545    *
 546    * @return The progress bar image if it exists.
 547    */
 548   std::string GetProgressVisual();
 549
 550   /**
 551    * @brief Create the image for the popup
 552    *
 553    * @param[in] filename The popup image
 554    */
 555   void CreatePopupImage( const std::string& filename );
 556
 557   /**
 558    * @brief Set the popup image
 559    *
 560    * @param[in] filename The popup image to set
 561    */
 562   void SetPopupVisual( const std::string& filename );
 563
 564   /**
 565    * @brief Set the popup from an Dali::Property::Map
 566    *
 567    * @param[in] map The Dali::Property::Map to use for to display
 568    */
 569   void SetPopupVisual( Dali::Property::Map map );
 570
 571   /**
 572    * @brief Return the popup image.
 573    *
 574    * @return The popup image if it exists.
 575    */
 576   std::string GetPopupVisual();
 577
 578   /**
 579    * @brief Set the popup arrow image
 580    *
 581    * @param[in] filename The popup arrow image to set
 582    */
 583   void SetPopupArrowVisual( const std::string& filename );
 584
 585   /**
 586    * @brief Set the popup arrow from an Dali::Property::Map
 587    *
 588    * @param[in] map The Dali::Property::Map to use for to display
 589    */
 590   void SetPopupArrowVisual( Dali::Property::Map map );
 591
 592   /**
 593    * @brief Return the popup arrow image.
 594    *
 595    * @return The popup arrow image if it exists.
 596    */
 597   std::string GetPopupArrowVisual();
 598
 599   /**
 600    * Create the image for the popup arrow
 601    *
 602    * @param[in] filename The popup arrow image to load and set
 603    */
 604   void CreatePopupArrowImage( const std::string& filename );
 605
 606   /**
 607    * Set the size of the progress bar region
 608    *
 609    * @param[in] region The size of the region to set
 610    */
 611   void ResizeProgressRegion( const Vector2& region );
 612
 613   /**
 614    * Create the image for the handle
 615    *
 616    * @param[in] filename The handle image
 617    */
 618   void SetHandleVisual( const std::string& filename );
 619
 620   /**
 621    * @brief Set the handle visual from an Dali::Property::Map
 622    *
 623    * @param[in] map The Dali::Property::Map to use for to display
 624    */
 625   void SetHandleVisual( Property::Map map );
 626
 627   /**
 628    * @brief Return the handle image.
 629    *
 630    * @return The handle image if it exists.
 631    */
 632   std::string GetHandleVisual();
 633
 634   /**
 635    * Reset the size of the handle
 636    *
 637    * @param[in] size The size of the handle to set
 638    */
 639   void ResizeHandleSize( const Vector2& size );
 640
 641   /**
 642    * Create and display the value on the handle
 643    */
 644   void CreateHandleValueDisplay();
 645
 646   /**
 647    * Remove and destroy the handle value display
 648    */
 649   void DestroyHandleValueDisplay();
 650
 651   /**
 652    * Set the size of the handle
 653    *
 654    * @param[in] size The handle size
 655    */
 656   void SetHandleSize( const Vector2& size );
 657
 658   /**
 659    * Get the size of the handle
 660    *
 661    * @return The handle size
 662    */
 663   const Vector2& GetHandleSize() const;
 664
 665   /**
 666    * Set the lower bound of the slider's value
 667    *
 668    * @param[in] bound The value to set for the lower bound
 669    */
 670   void SetLowerBound( float bound );
 671
 672   /**
 673    * Get the lower bound of the slider's value
 674    *
 675    * @return The lower bound value
 676    */
 677   float GetLowerBound() const;
 678
 679   /**
 680    * Set the upper bound of the slider's value
 681    *
 682    * @param[in] bound The value to set for the upper bound
 683    */
 684   void SetUpperBound( float bound );
 685
 686   /**
 687    * Get the upper bound of the slider's value
 688    *
 689    * @return The upper bound value
 690    */
 691   float GetUpperBound() const;
 692
 693 private:
 694
 695   // Undefined
 696   Slider( const Slider& );
 697
 698   // Undefined
 699   Slider& operator=( const Slider& rhs );
 700
 701 private:
 702
 703   Domain mDomain;                           ///< Current domain of the handle
 704
 705   Actor mHitArea;                           ///< The input handler
 706   Actor mValueDisplay;                      ///< Display of the value
 707   Toolkit::ImageView mTrack;                ///< Track image
 708   Toolkit::ImageView mHandle;               ///< Slider handle
 709   Toolkit::ImageView mProgress;             ///< Progress bar
 710   Toolkit::ImageView mPopup;                ///< Popup backing
 711   Toolkit::ImageView mPopupArrow;           ///< Popup arrow backing
 712
 713   Toolkit::TextLabel mValueTextLabel;       //< The text value in popup
 714   Toolkit::TextLabel mHandleValueTextLabel; ///< The text value on handle
 715   Vector2 mHandleLastTouchPoint;            ///< The last touch point for the handle
 716   Timer mValueTimer;                        ///< Timer used to hide value view
 717
 718   Toolkit::Slider::ValueChangedSignalType mValueChangedSignal;       ///< Signal emitted when the value is changed
 719   Toolkit::Slider::ValueChangedSignalType mSlidingFinishedSignal;    ///< Signal emitted when a sliding is finished
 720   Toolkit::Slider::MarkReachedSignalType mMarkReachedSignal;         ///< Signal emitted when a mark is reached
 721
 722   SliderState mState;                 ///< The state of the slider
 723
 724   PanGestureDetector mPanDetector;    ///< Hit region pan detector
 725
 726   MarkList mMarks;                    ///< List of discreet marks
 727
 728   std::string mPopupVisual;           ///< Image for popup image
 729   std::string mPopupArrowVisual;      ///< Image for popup arrow image
 730   std::string mTrackVisual;           ///< Image for track image
 731   std::string mHandleVisual;          ///< Image for handle image
 732   std::string mProgressVisual;        ///< Image for progress bar image
 733
 734   Property::Map mPopupMap;         ///< the Property::Map if the image came from a Property::Map, empty otherwise
 735   Property::Map mTrackMap;         ///< the Property::Map if the image came from a Property::Map, empty otherwise
 736   Property::Map mHandleMap;        ///< the Property::Map if the image came from a Property::Map, empty otherwise
 737   Property::Map mProgressMap;      ///< the Property::Map if the image came from a Property::Map, empty otherwise
 738   Property::Map mPopupArrowMap;    ///< the Property::Map if the image came from a Property::Map, empty otherwise
 739
 740   Vector4 mDisabledColor;    ///< The color to tint the slider when disabled
 741
 742   Vector2 mHitRegion;     ///< Size of hit region
 743   Vector2 mTrackRegion;   ///< Size of track region
 744   Vector2 mHandleSize;    ///< Size of the handle
 745
 746   float mLowerBound;        ///< Lower bound on value
 747   float mUpperBound;        ///< Upper bound on value
 748   float mValue;             ///< Current value of slider
 749
 750   float mMarkTolerance;     ///< Tolerance in percentage of slider width for which to snap to marks
 751
 752   int mValuePrecision;      ///< The precision to use for outputting the value
 753
 754   bool mShowPopup   : 1,      ///< Show the popup or not
 755        mShowValue   : 1,      ///< Whether to display the value number or not on the handle
 756        mSnapToMarks : 1;      ///< Turn on or off snapping to marks
 757 };
 758
 759 } // namespace Internal
 760
 761 // Helpers for public-api forwarding methods
 762
 763 inline Toolkit::Internal::Slider& GetImpl( Toolkit::Slider& pub )
 764 {
 765   DALI_ASSERT_ALWAYS( pub );
 766
 767   Dali::RefObject& handle = pub.GetImplementation();
 768
 769   return static_cast< Toolkit::Internal::Slider& >( handle );
 770 }
 771
 772 inline const Toolkit::Internal::Slider& GetImpl( const Toolkit::Slider& pub )
 773 {
 774   DALI_ASSERT_ALWAYS( pub );
 775
 776   const Dali::RefObject& handle = pub.GetImplementation();
 777
 778   return static_cast< const Toolkit::Internal::Slider& >( handle );
 779 }
 780
 781 } // namespace Toolkit
 782
 783 } // namespace Dali
 784
 785 #endif // __DALI_TOOLKIT_INTERNAL_SLIDER_H__