dali-toolkit/internal/controls/text-controls/text-selection-popup-impl.cpp

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/controls/text-controls/text-selection-popup-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #if defined(__GLIBC__)
  23 #include <libintl.h>
  24 #endif
  25 #include <string.h>
  26 #include <cfloat>
  27 #include <dali/public-api/animation/animation.h>
  28 #include <dali/public-api/math/vector2.h>
  29 #include <dali/public-api/math/vector4.h>
  30 #include <dali/public-api/object/property-map.h>
  31 #include <dali/public-api/object/type-registry-helper.h>
  32 #include <dali/integration-api/debug.h>
  33
  34 // INTERNAL INCLUDES
  35 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
  36 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  37 #include <dali-toolkit/devel-api/controls/control-devel.h>
  38 #include <dali-toolkit/devel-api/controls/buttons/button-devel.h>
  39 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
  40 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
  41 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  42 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  43 #include <dali-toolkit/internal/helpers/color-conversion.h>
  44 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  45 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  46
  47 namespace Dali
  48 {
  49
  50 namespace Toolkit
  51 {
  52
  53 namespace Internal
  54 {
  55
  56 namespace
  57 {
  58 #if defined(__GLIBC__)
  59 #define GET_LOCALE_TEXT(string) dgettext("dali-toolkit", string)
  60 #endif
  61
  62 const std::string TEXT_SELECTION_POPUP_BUTTON_STYLE_NAME( "TextSelectionPopupButton" );
  63 const Dali::Vector4 DEFAULT_OPTION_PRESSED_COLOR( Dali::Vector4( 0.24f, 0.72f, 0.8f, 1.0f ) );
  64
  65 #if defined(DEBUG_ENABLED)
  66   Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  67 #endif
  68
  69 #ifdef DGETTEXT_ENABLED
  70
  71 #define POPUP_CUT_STRING GET_LOCALE_TEXT("IDS_COM_BODY_CUT")
  72 #define POPUP_COPY_STRING GET_LOCALE_TEXT("IDS_COM_BODY_COPY")
  73 #define POPUP_PASTE_STRING GET_LOCALE_TEXT("IDS_COM_BODY_PASTE")
  74 #define POPUP_SELECT_STRING GET_LOCALE_TEXT("IDS_COM_SK_SELECT")
  75 #define POPUP_SELECT_ALL_STRING GET_LOCALE_TEXT("IDS_COM_BODY_SELECT_ALL")
  76 #define POPUP_CLIPBOARD_STRING GET_LOCALE_TEXT("IDS_COM_BODY_CLIPBOARD")
  77
  78 #else
  79
  80 #define POPUP_CUT_STRING  "Cut"
  81 #define POPUP_COPY_STRING  "Copy"
  82 #define POPUP_PASTE_STRING  "Paste"
  83 #define POPUP_SELECT_STRING  "Select"
  84 #define POPUP_SELECT_ALL_STRING  "Select All"
  85 #define POPUP_CLIPBOARD_STRING  "Clipboard"
  86
  87 #endif
  88
  89 const char* const OPTION_SELECT_WORD = "option-select_word";                       // "Select Word" popup option.
  90 const char* const OPTION_SELECT_ALL("option-select_all");                          // "Select All" popup option.
  91 const char* const OPTION_CUT("optionCut");                                        // "Cut" popup option.
  92 const char* const OPTION_COPY("optionCopy");                                      // "Copy" popup option.
  93 const char* const OPTION_PASTE("optionPaste");                                    // "Paste" popup option.
  94 const char* const OPTION_CLIPBOARD("optionClipboard");                            // "Clipboard" popup option.
  95
  96 const std::string IDS_LTR( "IDS_LTR" );
  97 const std::string RTL_DIRECTION( "RTL" );
  98
  99 BaseHandle Create()
 100 {
 101   return Toolkit::TextSelectionPopup::New( NULL );
 102 }
 103
 104 // Setup properties, signals and actions using the type-registry.
 105
 106 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextSelectionPopup, Toolkit::Control, Create );
 107
 108 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupMaxSize", VECTOR2,   POPUP_MAX_SIZE )
 109 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupMinSize", VECTOR2,   POPUP_MIN_SIZE )
 110 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "optionMaxSize", VECTOR2,   OPTION_MAX_SIZE )
 111 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "optionMinSize", VECTOR2,   OPTION_MIN_SIZE )
 112 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "optionDividerSize", VECTOR2,   OPTION_DIVIDER_SIZE )
 113 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupClipboardButtonImage", STRING, POPUP_CLIPBOARD_BUTTON_ICON_IMAGE )
 114 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupCutButtonImage", STRING, POPUP_CUT_BUTTON_ICON_IMAGE )
 115 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupCopyButtonImage", STRING, POPUP_COPY_BUTTON_ICON_IMAGE )
 116 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupPasteButtonImage", STRING, POPUP_PASTE_BUTTON_ICON_IMAGE )
 117 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupSelectButtonImage", STRING, POPUP_SELECT_BUTTON_ICON_IMAGE )
 118 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupSelectAllButtonImage", STRING, POPUP_SELECT_ALL_BUTTON_ICON_IMAGE )
 119 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupDividerColor", VECTOR4, POPUP_DIVIDER_COLOR )
 120 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupIconColor", VECTOR4, POPUP_ICON_COLOR )
 121 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupPressedColor", VECTOR4, POPUP_PRESSED_COLOR )
 122 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupPressedImage", STRING, POPUP_PRESSED_IMAGE )
 123 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupFadeInDuration", FLOAT, POPUP_FADE_IN_DURATION )
 124 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "popupFadeOutDuration", FLOAT, POPUP_FADE_OUT_DURATION )
 125 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionPopup, "backgroundBorder", MAP, BACKGROUND_BORDER )
 126
 127 DALI_TYPE_REGISTRATION_END()
 128
 129 } // namespace
 130
 131
 132 Dali::Toolkit::TextSelectionPopup TextSelectionPopup::New( TextSelectionPopupCallbackInterface* callbackInterface )
 133 {
 134   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextSelectionPopup::New\n" );
 135
 136    // Create the implementation, temporarily owned by this handle on stack
 137   IntrusivePtr< TextSelectionPopup > impl = new TextSelectionPopup( callbackInterface );
 138
 139   // Pass ownership to CustomActor handle
 140   Dali::Toolkit::TextSelectionPopup handle( *impl );
 141
 142   // Second-phase init of the implementation
 143   // This can only be done after the CustomActor connection has been made...
 144   impl->Initialize();
 145
 146   return handle;
 147 }
 148
 149 void TextSelectionPopup::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 150 {
 151   Toolkit::TextSelectionPopup selectionPopup = Toolkit::TextSelectionPopup::DownCast( Dali::BaseHandle( object ) );
 152
 153   if( selectionPopup )
 154   {
 155     TextSelectionPopup& impl( GetImpl( selectionPopup ) );
 156
 157     switch( index )
 158     {
 159       case Toolkit::TextSelectionPopup::Property::POPUP_MAX_SIZE:
 160       {
 161        impl.SetDimensionToCustomise( POPUP_MAXIMUM_SIZE, value.Get< Vector2 >() );
 162        break;
 163       }
 164       case Toolkit::TextSelectionPopup::Property::OPTION_MAX_SIZE:
 165       {
 166         impl.SetDimensionToCustomise( OPTION_MAXIMUM_SIZE, value.Get< Vector2 >() );
 167         break;
 168       }
 169       case Toolkit::TextSelectionPopup::Property::OPTION_MIN_SIZE:
 170       {
 171         impl.SetDimensionToCustomise( OPTION_MINIMUM_SIZE, value.Get< Vector2>() );
 172         break;
 173       }
 174       case Toolkit::TextSelectionPopup::Property::OPTION_DIVIDER_SIZE:
 175       {
 176         impl.SetDimensionToCustomise( OPTION_DIVIDER_SIZE, value.Get< Vector2>() );
 177         break;
 178       }
 179       case Toolkit::TextSelectionPopup::Property::POPUP_CLIPBOARD_BUTTON_ICON_IMAGE:
 180       {
 181         impl.SetButtonImage( Toolkit::TextSelectionPopup::CLIPBOARD, value.Get< std::string >() );
 182         break;
 183       }
 184       case Toolkit::TextSelectionPopup::Property::POPUP_CUT_BUTTON_ICON_IMAGE:
 185       {
 186         impl.SetButtonImage( Toolkit::TextSelectionPopup::CUT, value.Get< std::string >() );
 187         break;
 188       }
 189       case Toolkit::TextSelectionPopup::Property::POPUP_COPY_BUTTON_ICON_IMAGE:
 190       {
 191         impl.SetButtonImage( Toolkit::TextSelectionPopup::COPY, value.Get< std::string >() );
 192         break;
 193       }
 194       case Toolkit::TextSelectionPopup::Property::POPUP_PASTE_BUTTON_ICON_IMAGE:
 195       {
 196         impl.SetButtonImage( Toolkit::TextSelectionPopup::PASTE, value.Get< std::string >() );
 197         break;
 198       }
 199       case Toolkit::TextSelectionPopup::Property::POPUP_SELECT_BUTTON_ICON_IMAGE:
 200       {
 201         impl.SetButtonImage( Toolkit::TextSelectionPopup::SELECT, value.Get< std::string >() );
 202         break;
 203       }
 204       case Toolkit::TextSelectionPopup::Property::POPUP_SELECT_ALL_BUTTON_ICON_IMAGE:
 205       {
 206         impl.SetButtonImage( Toolkit::TextSelectionPopup::SELECT_ALL, value.Get< std::string >() );
 207         break;
 208       }
 209       case Toolkit::TextSelectionPopup::Property::POPUP_DIVIDER_COLOR:
 210       {
 211         impl.mDividerColor = value.Get< Vector4 >();
 212         break;
 213       }
 214       case Toolkit::TextSelectionPopup::Property::POPUP_ICON_COLOR:
 215       {
 216         impl.mIconColor = value.Get< Vector4 >();
 217         break;
 218       }
 219       case Toolkit::TextSelectionPopup::Property::POPUP_PRESSED_COLOR:
 220       {
 221         impl.mPressedColor = value.Get< Vector4 >();
 222         break;
 223       }
 224       case Toolkit::TextSelectionPopup::Property::POPUP_PRESSED_IMAGE:
 225       {
 226         impl.SetPressedImage( value.Get< std::string >() );
 227         break;
 228       }
 229       case Toolkit::TextSelectionPopup::Property::POPUP_FADE_IN_DURATION:
 230       {
 231         impl.mFadeInDuration = value.Get < float >();
 232         break;
 233       }
 234       case Toolkit::TextSelectionPopup::Property::POPUP_FADE_OUT_DURATION:
 235       {
 236         impl.mFadeOutDuration = value.Get < float >();
 237         break;
 238       }
 239       case Toolkit::TextSelectionPopup::Property::BACKGROUND_BORDER:
 240       {
 241         Property::Map map = value.Get<Property::Map>();
 242         impl.CreateBackgroundBorder( map );
 243         break;
 244       }
 245     } // switch
 246   } // TextSelectionPopup
 247 }
 248
 249 Property::Value TextSelectionPopup::GetProperty( BaseObject* object, Property::Index index )
 250 {
 251   Property::Value value;
 252
 253   Toolkit::TextSelectionPopup selectionPopup = Toolkit::TextSelectionPopup::DownCast( Dali::BaseHandle( object ) );
 254
 255   if( selectionPopup )
 256   {
 257     TextSelectionPopup& impl( GetImpl( selectionPopup ) );
 258
 259     switch( index )
 260     {
 261       case Toolkit::TextSelectionPopup::Property::POPUP_MAX_SIZE:
 262       {
 263         value = impl.GetDimensionToCustomise( POPUP_MAXIMUM_SIZE );
 264         break;
 265       }
 266       case Toolkit::TextSelectionPopup::Property::OPTION_MAX_SIZE:
 267       {
 268         value = impl.GetDimensionToCustomise( OPTION_MAXIMUM_SIZE );
 269         break;
 270       }
 271       case Toolkit::TextSelectionPopup::Property::OPTION_MIN_SIZE:
 272       {
 273         value = impl.GetDimensionToCustomise( OPTION_MINIMUM_SIZE );
 274         break;
 275       }
 276       case Toolkit::TextSelectionPopup::Property::OPTION_DIVIDER_SIZE:
 277       {
 278         value = impl.GetDimensionToCustomise( OPTION_DIVIDER_SIZE );
 279         break;
 280       }
 281       case Toolkit::TextSelectionPopup::Property::POPUP_CLIPBOARD_BUTTON_ICON_IMAGE:
 282       {
 283         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::CLIPBOARD );
 284         break;
 285       }
 286       case Toolkit::TextSelectionPopup::Property::POPUP_CUT_BUTTON_ICON_IMAGE:
 287       {
 288         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::CUT );
 289         break;
 290       }
 291       case Toolkit::TextSelectionPopup::Property::POPUP_COPY_BUTTON_ICON_IMAGE:
 292       {
 293         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::COPY );
 294         break;
 295       }
 296       case Toolkit::TextSelectionPopup::Property::POPUP_PASTE_BUTTON_ICON_IMAGE:
 297       {
 298         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::PASTE );
 299         break;
 300       }
 301       case Toolkit::TextSelectionPopup::Property::POPUP_SELECT_BUTTON_ICON_IMAGE:
 302       {
 303         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::SELECT );
 304         break;
 305       }
 306       case Toolkit::TextSelectionPopup::Property::POPUP_SELECT_ALL_BUTTON_ICON_IMAGE:
 307       {
 308         value = impl.GetButtonImage( Toolkit::TextSelectionPopup::SELECT_ALL );
 309         break;
 310       }
 311       case Toolkit::TextSelectionPopup::Property::POPUP_PRESSED_IMAGE:
 312       {
 313         value = impl.GetPressedImage();
 314         break;
 315       }
 316       case Toolkit::TextSelectionPopup::Property::POPUP_FADE_IN_DURATION:
 317       {
 318         value = impl.mFadeInDuration;
 319         break;
 320       }
 321       case Toolkit::TextSelectionPopup::Property::POPUP_FADE_OUT_DURATION:
 322       {
 323         value = impl.mFadeOutDuration;
 324         break;
 325       }
 326       case Toolkit::TextSelectionPopup::Property::BACKGROUND_BORDER:
 327       {
 328         Property::Map map;
 329         Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::TextSelectionPopup::Property::BACKGROUND_BORDER );
 330         if( visual )
 331         {
 332           visual.CreatePropertyMap( map );
 333         }
 334         value = map;
 335         break;
 336       }
 337     } // switch
 338   }
 339   return value;
 340 }
 341
 342 void TextSelectionPopup::EnableButtons( Toolkit::TextSelectionPopup::Buttons buttonsToEnable )
 343 {
 344   mEnabledButtons = buttonsToEnable;
 345   mButtonsChanged = true;
 346 }
 347
 348 void TextSelectionPopup::RaiseAbove( Actor target )
 349 {
 350   if( mToolbar )
 351   {
 352     mToolbar.RaiseAbove( target );
 353   }
 354 }
 355
 356 void TextSelectionPopup::ShowPopup()
 357 {
 358   if( ( !mPopupShowing || mButtonsChanged ) &&
 359       ( Toolkit::TextSelectionPopup::NONE != mEnabledButtons ) )
 360   {
 361     Actor self = Self();
 362     AddPopupOptionsToToolbar( mShowIcons, mShowCaptions );
 363
 364     Animation animation = Animation::New( mFadeInDuration );
 365     animation.AnimateTo( Property(self, Actor::Property::COLOR_ALPHA), 1.0f  );
 366     animation.Play();
 367     mPopupShowing = true;
 368   }
 369 }
 370
 371 void TextSelectionPopup::HidePopup()
 372 {
 373   if ( mPopupShowing )
 374   {
 375     mPopupShowing = false;
 376     Actor self = Self();
 377     Animation animation = Animation::New( mFadeOutDuration );
 378     animation.AnimateTo( Property(self, Actor::Property::COLOR_ALPHA), 0.0f  );
 379     animation.FinishedSignal().Connect( this, &TextSelectionPopup::HideAnimationFinished );
 380     animation.Play();
 381   }
 382 }
 383
 384 void TextSelectionPopup::OnInitialize()
 385 {
 386   DALI_LOG_INFO( gLogFilter, Debug::General, "TextSelectionPopup::OnInitialize\n" );
 387   Actor self = Self();
 388   self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 389   self.SetProperty( Actor::Property::COLOR_ALPHA, 0.0f );
 390 }
 391
 392 void TextSelectionPopup::HideAnimationFinished( Animation& animation )
 393 {
 394   Actor self = Self();
 395   if ( !mPopupShowing ) // During the Hide/Fade animation there could be a call to Show the Popup again, mPopupShowing will be true in this case.
 396   {
 397     DALI_LOG_INFO( gLogFilter, Debug::General, "TextSelectionPopup::HideAnimationFinished\n" );
 398     UnparentAndReset( mToolbar );
 399   }
 400 }
 401
 402 bool TextSelectionPopup::OnCutButtonPressed( Toolkit::Button button )
 403 {
 404   if( mCallbackInterface )
 405   {
 406     mCallbackInterface->TextPopupButtonTouched( Toolkit::TextSelectionPopup::CUT );
 407   }
 408
 409   return true;
 410 }
 411
 412 bool TextSelectionPopup::OnCopyButtonPressed( Toolkit::Button button )
 413 {
 414   if( mCallbackInterface )
 415   {
 416     mCallbackInterface->TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::COPY );
 417   }
 418
 419   return true;
 420 }
 421
 422 bool TextSelectionPopup::OnPasteButtonPressed( Toolkit::Button button )
 423 {
 424   if( mCallbackInterface )
 425   {
 426     mCallbackInterface->TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::PASTE );
 427   }
 428
 429   return true;
 430 }
 431
 432 bool TextSelectionPopup::OnSelectButtonPressed( Toolkit::Button button )
 433 {
 434   if( mCallbackInterface )
 435   {
 436     mCallbackInterface->TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::SELECT );
 437   }
 438
 439   return true;
 440 }
 441
 442 bool TextSelectionPopup::OnSelectAllButtonPressed( Toolkit::Button button )
 443 {
 444   if( mCallbackInterface )
 445   {
 446     mCallbackInterface->TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::SELECT_ALL );
 447   }
 448
 449   return true;
 450 }
 451
 452 bool TextSelectionPopup::OnClipboardButtonPressed( Toolkit::Button button )
 453 {
 454   if( mCallbackInterface )
 455   {
 456     mCallbackInterface->TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::CLIPBOARD );
 457   }
 458
 459   return true;
 460 }
 461
 462 void TextSelectionPopup::SetDimensionToCustomise( const PopupCustomisations& settingToCustomise, const Size& dimension )
 463 {
 464   switch( settingToCustomise )
 465   {
 466     case POPUP_MAXIMUM_SIZE :
 467     {
 468       mPopupMaxSize = dimension;
 469       if ( mToolbar )
 470       {
 471         mToolbar.SetProperty( Toolkit::TextSelectionToolbar::Property::MAX_SIZE, dimension );
 472       }
 473       break;
 474     }
 475     case OPTION_MAXIMUM_SIZE :
 476     {
 477       mOptionMaxSize = dimension;
 478       // Option max size not currently currently supported
 479       break;
 480     }
 481     case OPTION_MINIMUM_SIZE :
 482     {
 483       mOptionMinSize = dimension;
 484       // Option min size not currently currently supported
 485       break;
 486     }
 487     case OPTION_DIVIDER_SIZE :
 488     {
 489       mOptionDividerSize = dimension;
 490       if ( mToolbar )
 491       {
 492         // Resize Dividers not currently supported
 493       }
 494       break;
 495     }
 496   } // switch
 497 }
 498
 499 Size TextSelectionPopup::GetDimensionToCustomise( const PopupCustomisations& settingToCustomise ) const
 500 {
 501   switch( settingToCustomise )
 502   {
 503     case POPUP_MAXIMUM_SIZE :
 504     {
 505       if ( mToolbar )
 506       {
 507         return mToolbar.GetProperty( Toolkit::TextSelectionToolbar::Property::MAX_SIZE ).Get< Vector2 >();
 508       }
 509       else
 510       {
 511         return mPopupMaxSize;
 512       }
 513     }
 514     case OPTION_MAXIMUM_SIZE :
 515     {
 516       return mOptionMaxSize;
 517     }
 518     case OPTION_MINIMUM_SIZE :
 519     {
 520       return mOptionMinSize;
 521     }
 522     case OPTION_DIVIDER_SIZE :
 523     {
 524       return mOptionDividerSize;
 525     }
 526   } // switch
 527
 528   return Size::ZERO;
 529 }
 530
 531 void TextSelectionPopup::SetButtonImage( Toolkit::TextSelectionPopup::Buttons button, const std::string& image )
 532 {
 533    switch ( button )
 534    {
 535      case Toolkit::TextSelectionPopup::CLIPBOARD:
 536      {
 537        mClipboardIconImage  = image;
 538        break;
 539      }
 540      case Toolkit::TextSelectionPopup::CUT :
 541      {
 542        mCutIconImage = image;
 543        break;
 544      }
 545      case Toolkit::TextSelectionPopup::COPY :
 546      {
 547        mCopyIconImage = image;
 548        break;
 549      }
 550      case Toolkit::TextSelectionPopup::PASTE :
 551      {
 552        mPasteIconImage = image;
 553        break;
 554      }
 555      case Toolkit::TextSelectionPopup::SELECT :
 556      {
 557        mSelectIconImage = image;
 558        break;
 559      }
 560      case Toolkit::TextSelectionPopup::SELECT_ALL :
 561      {
 562        mSelectAllIconImage = image;
 563        break;
 564      }
 565      default :
 566      {
 567        DALI_ASSERT_DEBUG( "TextSelectionPopup SetPopupImage Unknown Button" );
 568      }
 569    } // switch
 570 }
 571
 572 const std::string& TextSelectionPopup::GetButtonImage( Toolkit::TextSelectionPopup::Buttons button ) const
 573 {
 574   switch ( button )
 575   {
 576     case Toolkit::TextSelectionPopup::CLIPBOARD:
 577     {
 578       return mClipboardIconImage;
 579       break;
 580     }
 581     case Toolkit::TextSelectionPopup::CUT:
 582     {
 583       return mCutIconImage;
 584       break;
 585     }
 586     case Toolkit::TextSelectionPopup::COPY:
 587     {
 588       return mCopyIconImage;
 589       break;
 590     }
 591     case Toolkit::TextSelectionPopup::PASTE:
 592     {
 593       return mPasteIconImage;
 594       break;
 595     }
 596     case Toolkit::TextSelectionPopup::SELECT:
 597     {
 598       return mSelectIconImage;
 599       break;
 600     }
 601     case Toolkit::TextSelectionPopup::SELECT_ALL:
 602     {
 603       return mSelectAllIconImage;
 604       break;
 605     }
 606     case Toolkit::TextSelectionPopup::NONE:
 607     {
 608       break;
 609     }
 610   } // switch
 611
 612   DALI_ASSERT_DEBUG( "TextSelectionPopup GetPopupImage Unknown Button" );
 613   static std::string empty;
 614   return empty;
 615 }
 616
 617 void TextSelectionPopup::SetPressedImage( const std::string& filename )
 618 {
 619   mPressedImage = filename;
 620 }
 621
 622 std::string TextSelectionPopup::GetPressedImage() const
 623 {
 624   return mPressedImage;
 625 }
 626
 627  void TextSelectionPopup::CreateOrderedListOfPopupOptions()
 628  {
 629    mOrderListOfButtons.clear();
 630    mOrderListOfButtons.reserve( 8u );
 631
 632    // Create button for each possible option using Option priority
 633    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::CUT, mCutOptionPriority, OPTION_CUT, POPUP_CUT_STRING , 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::CUT)  ) );
 634    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::COPY, mCopyOptionPriority, OPTION_COPY, POPUP_COPY_STRING, 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::COPY)  ) );
 635    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::PASTE, mPasteOptionPriority, OPTION_PASTE, POPUP_PASTE_STRING, 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::PASTE)  ) );
 636    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::SELECT, mSelectOptionPriority, OPTION_SELECT_WORD, POPUP_SELECT_STRING, 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::SELECT)  ) );
 637    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::SELECT_ALL, mSelectAllOptionPriority, OPTION_SELECT_ALL, POPUP_SELECT_ALL_STRING, 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::SELECT_ALL)  ) );
 638    mOrderListOfButtons.push_back( ButtonRequirement( Toolkit::TextSelectionPopup::CLIPBOARD, mClipboardOptionPriority, OPTION_CLIPBOARD, POPUP_CLIPBOARD_STRING, 0 != ( mEnabledButtons & Toolkit::TextSelectionPopup::CLIPBOARD)  ) );
 639
 640    // Sort the buttons according their priorities.
 641    std::sort( mOrderListOfButtons.begin(), mOrderListOfButtons.end(), TextSelectionPopup::ButtonPriorityCompare() );
 642  }
 643
 644  void TextSelectionPopup::AddOption( const ButtonRequirement& button, bool showDivider, bool showIcons, bool showCaption  )
 645  {
 646    // 1. Create a option.
 647    DALI_LOG_INFO( gLogFilter, Debug::General, "TextSelectionPopup::AddOption\n" );
 648
 649    Toolkit::PushButton option = Toolkit::PushButton::New();
 650    option.SetProperty( Dali::Actor::Property::NAME, button.name );
 651    option.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::ALL_DIMENSIONS );
 652
 653    switch( button.id )
 654    {
 655      case Toolkit::TextSelectionPopup::CUT:
 656      {
 657        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnCutButtonPressed );
 658        break;
 659      }
 660      case Toolkit::TextSelectionPopup::COPY:
 661      {
 662        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnCopyButtonPressed );
 663        break;
 664      }
 665      case Toolkit::TextSelectionPopup::PASTE:
 666      {
 667        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnPasteButtonPressed );
 668        break;
 669      }
 670      case Toolkit::TextSelectionPopup::SELECT:
 671      {
 672        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnSelectButtonPressed );
 673        break;
 674      }
 675      case Toolkit::TextSelectionPopup::SELECT_ALL:
 676      {
 677        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnSelectAllButtonPressed );
 678        break;
 679      }
 680      case Toolkit::TextSelectionPopup::CLIPBOARD:
 681      {
 682        option.ClickedSignal().Connect( this, &TextSelectionPopup::OnClipboardButtonPressed );
 683        break;
 684      }
 685      case Toolkit::TextSelectionPopup::NONE:
 686      {
 687        // Nothing to do:
 688        break;
 689      }
 690    }
 691
 692    // 2. Set the options contents.
 693    if( showCaption )
 694    {
 695      // PushButton layout properties.
 696      option.SetProperty( Toolkit::PushButton::Property::LABEL_PADDING, Vector4( 24.0f, 24.0f, 14.0f, 14.0f ) );
 697
 698      // Label properties.
 699      Property::Map buttonLabelProperties;
 700      buttonLabelProperties.Insert( Toolkit::TextVisual::Property::TEXT, button.caption );
 701      option.SetProperty( Toolkit::Button::Property::LABEL, buttonLabelProperties );
 702    }
 703    if( showIcons )
 704    {
 705      option.SetProperty( Toolkit::PushButton::Property::ICON_PADDING, Vector4( 10.0f, 10.0f, 10.0f, 10.0f ) );
 706      option.SetProperty( Toolkit::DevelButton::Property::LABEL_RELATIVE_ALIGNMENT, "BOTTOM" );
 707
 708      // TODO: This is temporarily disabled until the text-selection-popup image API is changed to strings.
 709      //option.SetProperty(  Toolkit::Button::Property::SELECTED_VISUAL, button.icon );
 710      //option.SetProperty(  Toolkit::Button::Property::UNSELECTED_VISUAL, button.icon );
 711    }
 712
 713    // 3. Set the normal option image (blank / Transparent).
 714    option.SetProperty( Toolkit::Button::Property::UNSELECTED_BACKGROUND_VISUAL, "" );
 715
 716    // 4. Set the pressed option image.
 717    Property::Value selectedBackgroundValue( mPressedImage );
 718    if( mPressedImage.empty() )
 719    {
 720      // The image can be blank, the color can be used in that case.
 721      selectedBackgroundValue = Property::Value{ { Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR  },
 722                                                 { Toolkit::ColorVisual::Property::MIX_COLOR, mPressedColor } };
 723    }
 724    option.SetProperty( Toolkit::Button::Property::SELECTED_BACKGROUND_VISUAL, selectedBackgroundValue );
 725    option.SetProperty( Toolkit::Control::Property::STYLE_NAME, TEXT_SELECTION_POPUP_BUTTON_STYLE_NAME );
 726
 727    // 5 Add option to tool bar
 728    mToolbar.AddOption( option );
 729
 730    // 6. Add the divider
 731    if( showDivider )
 732    {
 733      const Size size( mOptionDividerSize.width, 0.0f ); // Height FILL_TO_PARENT
 734
 735      Toolkit::Control divider = Toolkit::Control::New();
 736 #ifdef DECORATOR_DEBUG
 737      divider.SetProperty( Dali::Actor::Property::NAME,"Text's popup divider");
 738 #endif
 739      divider.SetProperty( Actor::Property::SIZE, size );
 740      divider.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT );
 741      divider.SetBackgroundColor( mDividerColor  );
 742      mToolbar.AddDivider( divider );
 743    }
 744  }
 745
 746  std::size_t TextSelectionPopup::GetNumberOfEnabledOptions() const
 747  {
 748    std::size_t numberOfOptions = 0u;
 749    for( std::vector<ButtonRequirement>::const_iterator it = mOrderListOfButtons.begin(), endIt = mOrderListOfButtons.end(); ( it != endIt ); ++it )
 750    {
 751      const ButtonRequirement& button( *it );
 752      if( button.enabled )
 753      {
 754        ++numberOfOptions;
 755      }
 756    }
 757
 758    return numberOfOptions;
 759  }
 760
 761  void TextSelectionPopup::AddPopupOptionsToToolbar( bool showIcons, bool showCaptions )
 762  {
 763    DALI_LOG_INFO( gLogFilter, Debug::General, "TextSelectionPopup::AddPopupOptionsToToolbar\n" );
 764
 765    CreateOrderedListOfPopupOptions();
 766
 767    mButtonsChanged = false;
 768    UnparentAndReset( mToolbar);
 769
 770    if( !mToolbar )
 771    {
 772      Actor self = Self();
 773      mToolbar = Toolkit::TextSelectionToolbar::New();
 774      if ( mPopupMaxSize != Vector2::ZERO ) // If PopupMaxSize property set then apply to Toolbar. Toolbar currently is not retriving this from json
 775      {
 776        mToolbar.SetProperty( Toolkit::TextSelectionToolbar::Property::MAX_SIZE, mPopupMaxSize );
 777      }
 778      mToolbar.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
 779 #ifdef DECORATOR_DEBUG
 780      mToolbar.SetProperty( Dali::Actor::Property::NAME,"TextSelectionToolbar");
 781 #endif
 782      self.Add( mToolbar );
 783    }
 784
 785    // Whether to mirror the list of buttons (for right to left languages)
 786    bool mirror = false;
 787 #if defined(__GLIBC__)
 788    char* idsLtr = GET_LOCALE_TEXT( IDS_LTR.c_str() );
 789    if( NULL != idsLtr )
 790    {
 791      mirror = ( 0 == strcmp( idsLtr, RTL_DIRECTION.c_str() ) );
 792
 793      if( mirror )
 794      {
 795        std::reverse( mOrderListOfButtons.begin(), mOrderListOfButtons.end() );
 796      }
 797    }
 798 #endif
 799
 800    // Iterate list of buttons and add active ones to Toolbar
 801    std::size_t numberOfOptionsRequired =  GetNumberOfEnabledOptions();
 802    std::size_t numberOfOptionsAdded = 0u;
 803    for( std::vector<ButtonRequirement>::const_iterator it = mOrderListOfButtons.begin(), endIt = mOrderListOfButtons.end(); ( it != endIt ); ++it )
 804    {
 805      const ButtonRequirement& button( *it );
 806      if ( button.enabled )
 807      {
 808        numberOfOptionsAdded++;
 809        AddOption(  button, ( numberOfOptionsAdded < numberOfOptionsRequired ) , showIcons, showCaptions );
 810      }
 811    }
 812
 813    if( mirror )
 814    {
 815      mToolbar.ScrollTo( Vector2( mPopupMaxSize.x, 0.f ) );
 816    }
 817  }
 818
 819 void TextSelectionPopup::CreateBackgroundBorder( Property::Map& propertyMap )
 820 {
 821   // Removes previous image if necessary
 822   DevelControl::UnregisterVisual( *this, Toolkit::TextSelectionPopup::Property::BACKGROUND_BORDER );
 823
 824   if( ! propertyMap.Empty() )
 825   {
 826     Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( propertyMap );
 827
 828     if( visual )
 829     {
 830       DevelControl::RegisterVisual( *this, Toolkit::TextSelectionPopup::Property::BACKGROUND_BORDER, visual, DepthIndex::CONTENT );
 831     }
 832   }
 833 }
 834
 835 TextSelectionPopup::TextSelectionPopup( TextSelectionPopupCallbackInterface* callbackInterface )
 836 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 837   mToolbar(),
 838   mPopupMaxSize(),
 839   mOptionMaxSize(),
 840   mOptionMinSize(),
 841   mOptionDividerSize(),
 842   mEnabledButtons( Toolkit::TextSelectionPopup::NONE ),
 843   mCallbackInterface( callbackInterface ),
 844   mPressedColor( DEFAULT_OPTION_PRESSED_COLOR ),
 845   mDividerColor( Color::WHITE ),
 846   mIconColor( Color::WHITE ),
 847   mSelectOptionPriority( 1 ),
 848   mSelectAllOptionPriority ( 2 ),
 849   mCutOptionPriority ( 4 ),
 850   mCopyOptionPriority ( 3 ),
 851   mPasteOptionPriority ( 5 ),
 852   mClipboardOptionPriority( 6 ),
 853   mFadeInDuration(0.0f),
 854   mFadeOutDuration(0.0f),
 855   mShowIcons( false ),
 856   mShowCaptions( true ),
 857   mPopupShowing( false ),
 858   mButtonsChanged( false )
 859 {
 860   DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
 861     return std::unique_ptr< Dali::Accessibility::Accessible >(
 862       new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::DIALOG, true ) );
 863   } );
 864 }
 865
 866 TextSelectionPopup::~TextSelectionPopup()
 867 {
 868 }
 869
 870
 871 } // namespace Internal
 872
 873 } // namespace Toolkit
 874
 875 } // namespace Dali