dali-toolkit/public-api/controls/control-impl.cpp

   1 /*
   2  * Copyright (c) 2016 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/public-api/controls/control-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstring> // for strcmp
  23 #include <limits>
  24 #include <stack>
  25 #include <dali/public-api/animation/constraint.h>
  26 #include <dali/public-api/animation/constraints.h>
  27 #include <dali/public-api/object/type-registry.h>
  28 #include <dali/public-api/object/type-registry-helper.h>
  29 #include <dali/public-api/rendering/renderer.h>
  30 #include <dali/public-api/size-negotiation/relayout-container.h>
  31 #include <dali/devel-api/common/owner-container.h>
  32 #include <dali/devel-api/scripting/scripting.h>
  33 #include <dali/integration-api/debug.h>
  34
  35 // INTERNAL INCLUDES
  36 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
  37 #include <dali-toolkit/public-api/controls/control.h>
  38 #include <dali-toolkit/public-api/styling/style-manager.h>
  39 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
  40 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  41 #include <dali-toolkit/devel-api/visual-factory/devel-visual-properties.h>
  42 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  43 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
  44 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  45 #include <dali-toolkit/internal/visuals/color/color-visual.h>
  46 #include <dali-toolkit/internal/visuals/transition-data-impl.h>
  47
  48 namespace Dali
  49 {
  50
  51 namespace Toolkit
  52 {
  53
  54 namespace
  55 {
  56
  57 #if defined(DEBUG_ENABLED)
  58 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::General, false, "LOG_CONTROL_VISUALS");
  59 #endif
  60
  61 /**
  62  * Struct used to store Visual within the control, index is a unique key for each visual.
  63  */
  64 struct RegisteredVisual
  65 {
  66   Property::Index index;
  67   Toolkit::Visual::Base visual;
  68   bool enabled;
  69
  70   RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled) :
  71                    index(aIndex), visual(aVisual), enabled(aEnabled) {}
  72 };
  73
  74 struct HandleIndex
  75 {
  76   Handle handle; ///< a handle to the target object
  77   Property::Index index; ///< The index of a property provided by the referenced object
  78
  79   HandleIndex( )
  80   : handle(),
  81     index( Property::INVALID_INDEX )
  82   {
  83   }
  84
  85   HandleIndex( Handle& handle, Property::Index index )
  86   : handle( handle ),
  87     index( index )
  88   {
  89   }
  90 };
  91
  92
  93 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
  94
  95 /**
  96  *  Finds visual in given array, returning true if found along with the iterator for that visual as a out parameter
  97  */
  98 bool FindVisual( Property::Index targetIndex, RegisteredVisualContainer& visuals, RegisteredVisualContainer::Iterator& iter )
  99 {
 100   for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
 101   {
 102     if ( (*iter)->index ==  targetIndex )
 103     {
 104       return true;
 105     }
 106   }
 107   return false;
 108 }
 109
 110 HandleIndex GetVisualProperty(
 111   Internal::Control& controlImpl,
 112   RegisteredVisualContainer& visuals,
 113   const std::string& visualName,
 114   Property::Key propertyKey )
 115 {
 116 #if defined(DEBUG_ENABLED)
 117   std::ostringstream oss;
 118   oss << "Control::GetHandleIndex(" << visualName << ", " << propertyKey << ")" << std::endl;
 119   DALI_LOG_INFO( gLogFilter, Debug::General, oss.str().c_str() );
 120 #endif
 121
 122   // Find visualName in the control
 123   RegisteredVisualContainer::Iterator iter;
 124   for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
 125   {
 126     if ( (*iter)->visual.GetName() == visualName )
 127     {
 128       break;
 129     }
 130   }
 131
 132   // Does it's renderer have an associated property?
 133   if( iter != visuals.End() )
 134   {
 135     Actor self = controlImpl.Self();
 136     Property::Index index = self.GetPropertyIndex( propertyKey );
 137     if( index != Property::INVALID_INDEX )
 138     {
 139       // It's an actor property:
 140       return HandleIndex( self, index );
 141     }
 142     else
 143     {
 144       // Check if it is a renderer property:
 145       if( self.GetRendererCount() > 0 )
 146       {
 147         // @todo Need to use correct renderer index
 148         Renderer renderer = self.GetRendererAt(0);
 149         Property::Index index = renderer.GetPropertyIndex( propertyKey );
 150         if( index != Property::INVALID_INDEX )
 151         {
 152           // It's a renderer property:
 153           return HandleIndex( renderer, index );
 154         }
 155       }
 156       else
 157       {
 158         std::ostringstream oss;
 159         oss << propertyKey;
 160         DALI_LOG_WARNING( "Control::GetHandleIndex(%s, %s) No renderers\n", visualName.c_str(), oss.str().c_str() );
 161       }
 162     }
 163   }
 164   Handle handle;
 165   return HandleIndex( handle, Property::INVALID_INDEX );
 166 }
 167
 168
 169 /**
 170  * Creates control through type registry
 171  */
 172 BaseHandle Create()
 173 {
 174   return Internal::Control::New();
 175 }
 176
 177 /**
 178  * Performs actions as requested using the action name.
 179  * @param[in] object The object on which to perform the action.
 180  * @param[in] actionName The action to perform.
 181  * @param[in] attributes The attributes with which to perfrom this action.
 182  * @return true if action has been accepted by this control
 183  */
 184 const char* ACTION_ACCESSIBILITY_ACTIVATED = "accessibilityActivated";
 185 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
 186 {
 187   bool ret = false;
 188
 189   if( object && ( 0 == strcmp( actionName.c_str(), ACTION_ACCESSIBILITY_ACTIVATED ) ) )
 190   {
 191     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 192     if( control )
 193     {
 194       // if cast succeeds there is an implementation so no need to check
 195       ret = Internal::GetImplementation( control ).OnAccessibilityActivated();
 196     }
 197   }
 198
 199   return ret;
 200 }
 201
 202 /**
 203  * Connects a callback function with the object's signals.
 204  * @param[in] object The object providing the signal.
 205  * @param[in] tracker Used to disconnect the signal.
 206  * @param[in] signalName The signal to connect to.
 207  * @param[in] functor A newly allocated FunctorDelegate.
 208  * @return True if the signal was connected.
 209  * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 210  */
 211 const char* SIGNAL_KEY_EVENT = "keyEvent";
 212 const char* SIGNAL_KEY_INPUT_FOCUS_GAINED = "keyInputFocusGained";
 213 const char* SIGNAL_KEY_INPUT_FOCUS_LOST = "keyInputFocusLost";
 214 const char* SIGNAL_TAPPED = "tapped";
 215 const char* SIGNAL_PANNED = "panned";
 216 const char* SIGNAL_PINCHED = "pinched";
 217 const char* SIGNAL_LONG_PRESSED = "longPressed";
 218 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 219 {
 220   Dali::BaseHandle handle( object );
 221
 222   bool connected( false );
 223   Toolkit::Control control = Toolkit::Control::DownCast( handle );
 224   if ( control )
 225   {
 226     Internal::Control& controlImpl( Internal::GetImplementation( control ) );
 227     connected = true;
 228
 229     if ( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
 230     {
 231       controlImpl.KeyEventSignal().Connect( tracker, functor );
 232     }
 233     else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_GAINED ) )
 234     {
 235       controlImpl.KeyInputFocusGainedSignal().Connect( tracker, functor );
 236     }
 237     else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_LOST ) )
 238     {
 239       controlImpl.KeyInputFocusLostSignal().Connect( tracker, functor );
 240     }
 241     else if( 0 == strcmp( signalName.c_str(), SIGNAL_TAPPED ) )
 242     {
 243       controlImpl.EnableGestureDetection( Gesture::Tap );
 244       controlImpl.GetTapGestureDetector().DetectedSignal().Connect( tracker, functor );
 245     }
 246     else if( 0 == strcmp( signalName.c_str(), SIGNAL_PANNED ) )
 247     {
 248       controlImpl.EnableGestureDetection( Gesture::Pan );
 249       controlImpl.GetPanGestureDetector().DetectedSignal().Connect( tracker, functor );
 250     }
 251     else if( 0 == strcmp( signalName.c_str(), SIGNAL_PINCHED ) )
 252     {
 253       controlImpl.EnableGestureDetection( Gesture::Pinch );
 254       controlImpl.GetPinchGestureDetector().DetectedSignal().Connect( tracker, functor );
 255     }
 256     else if( 0 == strcmp( signalName.c_str(), SIGNAL_LONG_PRESSED ) )
 257     {
 258       controlImpl.EnableGestureDetection( Gesture::LongPress );
 259       controlImpl.GetLongPressGestureDetector().DetectedSignal().Connect( tracker, functor );
 260     }
 261   }
 262   return connected;
 263 }
 264
 265 // Setup signals and actions using the type-registry.
 266 DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create );
 267
 268 // Note: Properties are registered separately below.
 269
 270 SignalConnectorType registerSignal1( typeRegistration, SIGNAL_KEY_EVENT, &DoConnectSignal );
 271 SignalConnectorType registerSignal2( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_GAINED, &DoConnectSignal );
 272 SignalConnectorType registerSignal3( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_LOST, &DoConnectSignal );
 273 SignalConnectorType registerSignal4( typeRegistration, SIGNAL_TAPPED, &DoConnectSignal );
 274 SignalConnectorType registerSignal5( typeRegistration, SIGNAL_PANNED, &DoConnectSignal );
 275 SignalConnectorType registerSignal6( typeRegistration, SIGNAL_PINCHED, &DoConnectSignal );
 276 SignalConnectorType registerSignal7( typeRegistration, SIGNAL_LONG_PRESSED, &DoConnectSignal );
 277
 278 TypeAction registerAction( typeRegistration, ACTION_ACCESSIBILITY_ACTIVATED, &DoAction );
 279
 280 DALI_TYPE_REGISTRATION_END()
 281
 282 } // unnamed namespace
 283
 284 namespace Internal
 285 {
 286
 287 class Control::Impl : public ConnectionTracker
 288 {
 289 public:
 290
 291   // Construction & Destruction
 292   Impl(Control& controlImpl)
 293   : mControlImpl( controlImpl ),
 294     mStyleName(""),
 295     mBackgroundVisual(),
 296     mBackgroundColor(Color::TRANSPARENT),
 297     mStartingPinchScale( NULL ),
 298     mKeyEventSignal(),
 299     mPinchGestureDetector(),
 300     mPanGestureDetector(),
 301     mTapGestureDetector(),
 302     mLongPressGestureDetector(),
 303     mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 304     mIsKeyboardNavigationSupported( false ),
 305     mIsKeyboardFocusGroup( false )
 306   {
 307   }
 308
 309   ~Impl()
 310   {
 311     // All gesture detectors will be destroyed so no need to disconnect.
 312     delete mStartingPinchScale;
 313   }
 314
 315   // Gesture Detection Methods
 316
 317   void PinchDetected(Actor actor, const PinchGesture& pinch)
 318   {
 319     mControlImpl.OnPinch(pinch);
 320   }
 321
 322   void PanDetected(Actor actor, const PanGesture& pan)
 323   {
 324     mControlImpl.OnPan(pan);
 325   }
 326
 327   void TapDetected(Actor actor, const TapGesture& tap)
 328   {
 329     mControlImpl.OnTap(tap);
 330   }
 331
 332   void LongPressDetected(Actor actor, const LongPressGesture& longPress)
 333   {
 334     mControlImpl.OnLongPress(longPress);
 335   }
 336
 337   // Properties
 338
 339   /**
 340    * Called when a property of an object of this type is set.
 341    * @param[in] object The object whose property is set.
 342    * @param[in] index The property index.
 343    * @param[in] value The new property value.
 344    */
 345   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 346   {
 347     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 348
 349     if ( control )
 350     {
 351       Control& controlImpl( GetImplementation( control ) );
 352
 353       switch ( index )
 354       {
 355         case Toolkit::Control::Property::STYLE_NAME:
 356         {
 357           controlImpl.SetStyleName( value.Get< std::string >() );
 358           break;
 359         }
 360
 361         case Toolkit::Control::Property::BACKGROUND_COLOR:
 362         {
 363           DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 364           controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
 365           break;
 366         }
 367
 368         case Toolkit::Control::Property::BACKGROUND_IMAGE:
 369         {
 370           DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 371           Image image = Scripting::NewImage( value );
 372           if ( image )
 373           {
 374             controlImpl.SetBackgroundImage( image );
 375           }
 376           else
 377           {
 378             // An empty map means the background is no longer required
 379             controlImpl.ClearBackground();
 380           }
 381           break;
 382         }
 383
 384         case Toolkit::Control::Property::KEY_INPUT_FOCUS:
 385         {
 386           if ( value.Get< bool >() )
 387           {
 388             controlImpl.SetKeyInputFocus();
 389           }
 390           else
 391           {
 392             controlImpl.ClearKeyInputFocus();
 393           }
 394           break;
 395         }
 396
 397         case Toolkit::Control::Property::BACKGROUND:
 398         {
 399           const Property::Map* map = value.GetMap();
 400           if( map )
 401           {
 402             controlImpl.SetBackground( *map );
 403           }
 404           else
 405           {
 406             // The background is not a property map, so we should clear the background
 407             controlImpl.ClearBackground();
 408           }
 409           break;
 410         }
 411       }
 412     }
 413   }
 414
 415   /**
 416    * Called to retrieve a property of an object of this type.
 417    * @param[in] object The object whose property is to be retrieved.
 418    * @param[in] index The property index.
 419    * @return The current value of the property.
 420    */
 421   static Property::Value GetProperty( BaseObject* object, Property::Index index )
 422   {
 423     Property::Value value;
 424
 425     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 426
 427     if ( control )
 428     {
 429       Control& controlImpl( GetImplementation( control ) );
 430
 431       switch ( index )
 432       {
 433         case Toolkit::Control::Property::STYLE_NAME:
 434         {
 435           value = controlImpl.GetStyleName();
 436           break;
 437         }
 438
 439         case Toolkit::Control::Property::BACKGROUND_COLOR:
 440         {
 441           DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 442           value = controlImpl.GetBackgroundColor();
 443           break;
 444         }
 445
 446         case Toolkit::Control::Property::BACKGROUND_IMAGE:
 447         {
 448           DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 449           Property::Map map;
 450           if( controlImpl.mImpl->mBackgroundVisual )
 451           {
 452             controlImpl.mImpl->mBackgroundVisual.CreatePropertyMap( map );
 453           }
 454           value = map;
 455           break;
 456         }
 457
 458         case Toolkit::Control::Property::KEY_INPUT_FOCUS:
 459         {
 460           value = controlImpl.HasKeyInputFocus();
 461           break;
 462         }
 463
 464         case Toolkit::Control::Property::BACKGROUND:
 465         {
 466           Property::Map map;
 467           if( controlImpl.mImpl->mBackgroundVisual )
 468           {
 469             (controlImpl.mImpl->mBackgroundVisual).CreatePropertyMap( map );
 470           }
 471
 472           value = map;
 473           break;
 474         }
 475
 476       }
 477     }
 478
 479     return value;
 480   }
 481
 482   // Data
 483
 484   Control& mControlImpl;
 485   RegisteredVisualContainer mVisuals; // Stores visuals needed by the control, non trivial type so std::vector used.
 486   std::string mStyleName;
 487   Toolkit::Visual::Base mBackgroundVisual;   ///< The visual to render the background
 488   Vector4 mBackgroundColor;                       ///< The color of the background visual
 489   Vector3* mStartingPinchScale;      ///< The scale when a pinch gesture starts, TODO: consider removing this
 490   Toolkit::Control::KeyEventSignalType mKeyEventSignal;
 491   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
 492   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
 493
 494   // Gesture Detection
 495   PinchGestureDetector mPinchGestureDetector;
 496   PanGestureDetector mPanGestureDetector;
 497   TapGestureDetector mTapGestureDetector;
 498   LongPressGestureDetector mLongPressGestureDetector;
 499
 500   ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT;    ///< Flags passed in from constructor.
 501   bool mIsKeyboardNavigationSupported :1;  ///< Stores whether keyboard navigation is supported by the control.
 502   bool mIsKeyboardFocusGroup :1;           ///< Stores whether the control is a focus group.
 503
 504   // Properties - these need to be members of Internal::Control::Impl as they need to function within this class.
 505   static const PropertyRegistration PROPERTY_1;
 506   static const PropertyRegistration PROPERTY_2;
 507   static const PropertyRegistration PROPERTY_3;
 508   static const PropertyRegistration PROPERTY_4;
 509   static const PropertyRegistration PROPERTY_5;
 510 };
 511
 512 // Properties registered without macro to use specific member variables.
 513 const PropertyRegistration Control::Impl::PROPERTY_1( typeRegistration, "styleName",       Toolkit::Control::Property::STYLE_NAME,       Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 514 const PropertyRegistration Control::Impl::PROPERTY_2( typeRegistration, "backgroundColor", Toolkit::Control::Property::BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 515 const PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "backgroundImage", Toolkit::Control::Property::BACKGROUND_IMAGE, Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 516 const PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "keyInputFocus",   Toolkit::Control::Property::KEY_INPUT_FOCUS,  Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 517 const PropertyRegistration Control::Impl::PROPERTY_5( typeRegistration, "background",      Toolkit::Control::Property::BACKGROUND,       Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 518
 519 Toolkit::Control Control::New()
 520 {
 521   // Create the implementation, temporarily owned on stack
 522   IntrusivePtr<Control> controlImpl = new Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) );
 523
 524   // Pass ownership to handle
 525   Toolkit::Control handle( *controlImpl );
 526
 527   // Second-phase init of the implementation
 528   // This can only be done after the CustomActor connection has been made...
 529   controlImpl->Initialize();
 530
 531   return handle;
 532 }
 533
 534 Control::~Control()
 535 {
 536   delete mImpl;
 537 }
 538
 539 void Control::SetStyleName( const std::string& styleName )
 540 {
 541   if( styleName != mImpl->mStyleName )
 542   {
 543     mImpl->mStyleName = styleName;
 544
 545     // Apply new style, if stylemanager is available
 546     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 547     if( styleManager )
 548     {
 549       GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
 550     }
 551   }
 552 }
 553
 554 const std::string& Control::GetStyleName() const
 555 {
 556   return mImpl->mStyleName;
 557 }
 558
 559 void Control::SetBackgroundColor( const Vector4& color )
 560 {
 561   mImpl->mBackgroundColor = color;
 562   Property::Map map;
 563   map[ Toolkit::VisualProperty::TYPE ] = Toolkit::Visual::COLOR;
 564   map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
 565   mImpl->mBackgroundVisual = Toolkit::VisualFactory::Get().CreateVisual( map );
 566   RegisterVisual( Toolkit::Control::Property::BACKGROUND, mImpl->mBackgroundVisual );
 567   if( mImpl->mBackgroundVisual )
 568   {
 569     mImpl->mBackgroundVisual.SetDepthIndex( DepthIndex::BACKGROUND );
 570   }
 571 }
 572
 573 Vector4 Control::GetBackgroundColor() const
 574 {
 575   return mImpl->mBackgroundColor;
 576 }
 577
 578 void Control::SetBackground( const Property::Map& map )
 579 {
 580   mImpl->mBackgroundVisual = Toolkit::VisualFactory::Get().CreateVisual( map );
 581   RegisterVisual( Toolkit::Control::Property::BACKGROUND, mImpl->mBackgroundVisual );
 582   if( mImpl->mBackgroundVisual )
 583   {
 584     mImpl->mBackgroundVisual.SetDepthIndex( DepthIndex::BACKGROUND );
 585   }
 586 }
 587
 588 void Control::SetBackgroundImage( Image image )
 589 {
 590   mImpl->mBackgroundVisual = Toolkit::VisualFactory::Get().CreateVisual( image );
 591   RegisterVisual( Toolkit::Control::Property::BACKGROUND, mImpl->mBackgroundVisual );
 592   if( mImpl->mBackgroundVisual )
 593   {
 594     mImpl->mBackgroundVisual.SetDepthIndex( DepthIndex::BACKGROUND );
 595   }
 596 }
 597
 598 void Control::ClearBackground()
 599 {
 600   Actor self( Self() );
 601   mImpl->mBackgroundVisual.RemoveAndReset( self );
 602   mImpl->mBackgroundColor = Color::TRANSPARENT;
 603 }
 604
 605 void Control::EnableGestureDetection(Gesture::Type type)
 606 {
 607   if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
 608   {
 609     mImpl->mPinchGestureDetector = PinchGestureDetector::New();
 610     mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
 611     mImpl->mPinchGestureDetector.Attach(Self());
 612   }
 613
 614   if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
 615   {
 616     mImpl->mPanGestureDetector = PanGestureDetector::New();
 617     mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
 618     mImpl->mPanGestureDetector.Attach(Self());
 619   }
 620
 621   if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
 622   {
 623     mImpl->mTapGestureDetector = TapGestureDetector::New();
 624     mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
 625     mImpl->mTapGestureDetector.Attach(Self());
 626   }
 627
 628   if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
 629   {
 630     mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
 631     mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
 632     mImpl->mLongPressGestureDetector.Attach(Self());
 633   }
 634 }
 635
 636 void Control::DisableGestureDetection(Gesture::Type type)
 637 {
 638   if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
 639   {
 640     mImpl->mPinchGestureDetector.Detach(Self());
 641     mImpl->mPinchGestureDetector.Reset();
 642   }
 643
 644   if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
 645   {
 646     mImpl->mPanGestureDetector.Detach(Self());
 647     mImpl->mPanGestureDetector.Reset();
 648   }
 649
 650   if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
 651   {
 652     mImpl->mTapGestureDetector.Detach(Self());
 653     mImpl->mTapGestureDetector.Reset();
 654   }
 655
 656   if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
 657   {
 658     mImpl->mLongPressGestureDetector.Detach(Self());
 659     mImpl->mLongPressGestureDetector.Reset();
 660   }
 661 }
 662
 663 PinchGestureDetector Control::GetPinchGestureDetector() const
 664 {
 665   return mImpl->mPinchGestureDetector;
 666 }
 667
 668 PanGestureDetector Control::GetPanGestureDetector() const
 669 {
 670   return mImpl->mPanGestureDetector;
 671 }
 672
 673 TapGestureDetector Control::GetTapGestureDetector() const
 674 {
 675   return mImpl->mTapGestureDetector;
 676 }
 677
 678 LongPressGestureDetector Control::GetLongPressGestureDetector() const
 679 {
 680   return mImpl->mLongPressGestureDetector;
 681 }
 682
 683 void Control::SetKeyboardNavigationSupport(bool isSupported)
 684 {
 685   mImpl->mIsKeyboardNavigationSupported = isSupported;
 686 }
 687
 688 bool Control::IsKeyboardNavigationSupported()
 689 {
 690   return mImpl->mIsKeyboardNavigationSupported;
 691 }
 692
 693 void Control::SetKeyInputFocus()
 694 {
 695   if( Self().OnStage() )
 696   {
 697     Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
 698   }
 699 }
 700
 701 bool Control::HasKeyInputFocus()
 702 {
 703   bool result = false;
 704   if( Self().OnStage() )
 705   {
 706     result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self()));
 707   }
 708   return result;
 709 }
 710
 711 void Control::ClearKeyInputFocus()
 712 {
 713   if( Self().OnStage() )
 714   {
 715     Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
 716   }
 717 }
 718
 719 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
 720 {
 721   mImpl->mIsKeyboardFocusGroup = isFocusGroup;
 722
 723   // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
 724   Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
 725 }
 726
 727 bool Control::IsKeyboardFocusGroup()
 728 {
 729   return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
 730 }
 731
 732 void Control::AccessibilityActivate()
 733 {
 734   // Inform deriving classes
 735   OnAccessibilityActivated();
 736 }
 737
 738 void Control::KeyboardEnter()
 739 {
 740   // Inform deriving classes
 741   OnKeyboardEnter();
 742 }
 743
 744 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
 745 {
 746   RegisterVisual( index, visual, true );
 747 }
 748
 749 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
 750 {
 751   bool visualReplaced ( false );
 752   Actor self = Self();
 753
 754   if ( !mImpl->mVisuals.Empty() )
 755   {
 756       RegisteredVisualContainer::Iterator iter;
 757       // Check if visual (index) is already registered.  Replace if so.
 758       if ( FindVisual( index, mImpl->mVisuals, iter ) )
 759       {
 760         if( (*iter)->visual && self.OnStage() )
 761         {
 762           (*iter)->visual.SetOffStage( self );
 763         }
 764         (*iter)->visual = visual;
 765         visualReplaced = true;
 766       }
 767   }
 768
 769   if ( !visualReplaced ) // New registration entry
 770   {
 771     mImpl->mVisuals.PushBack( new RegisteredVisual( index, visual, enabled ) );
 772   }
 773
 774   if( visual && self.OnStage() && enabled )
 775   {
 776     visual.SetOnStage( self );
 777   }
 778 }
 779
 780 void Control::UnregisterVisual( Property::Index index )
 781 {
 782    RegisteredVisualContainer::Iterator iter;
 783    if ( FindVisual( index, mImpl->mVisuals, iter ) )
 784    {
 785      mImpl->mVisuals.Erase( iter );
 786    }
 787 }
 788
 789 Toolkit::Visual::Base Control::GetVisual( Property::Index index ) const
 790 {
 791   RegisteredVisualContainer::Iterator iter;
 792   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 793   {
 794     return (*iter)->visual;
 795   }
 796
 797   return Toolkit::Visual::Base();
 798 }
 799
 800 void Control::EnableVisual( Property::Index index, bool enable )
 801 {
 802   RegisteredVisualContainer::Iterator iter;
 803   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 804   {
 805     if (  (*iter)->enabled == enable )
 806     {
 807       return;
 808     }
 809
 810     (*iter)->enabled = enable;
 811     Actor parentActor = Self();
 812     if ( Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
 813     {
 814       if ( enable )
 815       {
 816
 817         (*iter)->visual.SetOnStage( parentActor );
 818       }
 819       else
 820       {
 821         (*iter)->visual.SetOffStage( parentActor );  // No need to call if control not staged.
 822       }
 823     }
 824   }
 825 }
 826
 827 bool Control::IsVisualEnabled( Property::Index index ) const
 828 {
 829   RegisteredVisualContainer::Iterator iter;
 830   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 831   {
 832     return (*iter)->enabled;
 833   }
 834   return false;
 835 }
 836
 837 Dali::Animation Control::CreateTransition( const Toolkit::TransitionData& handle )
 838 {
 839   Dali::Animation transition;
 840   const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
 841
 842   if( transitionData.Count() > 0 )
 843   {
 844     // Setup a Transition from TransitionData.
 845     TransitionData::Iterator end = transitionData.End();
 846     for( TransitionData::Iterator iter = transitionData.Begin() ;
 847          iter != end; ++iter )
 848     {
 849       TransitionData::Animator* animator = (*iter);
 850       HandleIndex handleIndex;
 851
 852       // Attempt to find the object name as a child actor
 853       Actor child = Self().FindChildByName( animator->objectName );
 854       if( child )
 855       {
 856         Property::Index propertyIndex = child.GetPropertyIndex( animator->propertyKey );
 857         handleIndex = HandleIndex( child, propertyIndex );
 858       }
 859       else
 860       {
 861         handleIndex = GetVisualProperty( *this, mImpl->mVisuals,
 862                                             animator->objectName,
 863                                             animator->propertyKey );
 864       }
 865
 866       if( handleIndex.handle && handleIndex.index != Property::INVALID_INDEX )
 867       {
 868         if( animator->animate == false )
 869         {
 870           if( animator->targetValue.GetType() != Property::NONE )
 871           {
 872             handleIndex.handle.SetProperty( handleIndex.index, animator->targetValue );
 873           }
 874         }
 875         else
 876         {
 877           if( animator->initialValue.GetType() != Property::NONE )
 878           {
 879             handleIndex.handle.SetProperty( handleIndex.index, animator->initialValue );
 880           }
 881
 882           if( ! transition )
 883           {
 884             // Create an animation with a default .1 second duration - the animators
 885             // will automatically force it to the 'right' duration.
 886             transition = Dali::Animation::New( 0.1f );
 887           }
 888
 889           transition.AnimateTo( Property( handleIndex.handle, handleIndex.index ),
 890                                 animator->targetValue,
 891                                 animator->alphaFunction,
 892                                 TimePeriod( animator->timePeriodDelay,
 893                                             animator->timePeriodDuration ) );
 894         }
 895       }
 896     }
 897   }
 898
 899   return transition;
 900 }
 901
 902 bool Control::OnAccessibilityActivated()
 903 {
 904   return false; // Accessibility activation is not handled by default
 905 }
 906
 907 bool Control::OnKeyboardEnter()
 908 {
 909   return false; // Keyboard enter is not handled by default
 910 }
 911
 912 bool Control::OnAccessibilityPan(PanGesture gesture)
 913 {
 914   return false; // Accessibility pan gesture is not handled by default
 915 }
 916
 917 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
 918 {
 919   return false; // Accessibility touch event is not handled by default
 920 }
 921
 922 bool Control::OnAccessibilityValueChange(bool isIncrease)
 923 {
 924   return false; // Accessibility value change action is not handled by default
 925 }
 926
 927 bool Control::OnAccessibilityZoom()
 928 {
 929   return false; // Accessibility zoom action is not handled by default
 930 }
 931
 932 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
 933 {
 934   return Actor();
 935 }
 936
 937 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
 938 {
 939 }
 940
 941 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
 942 {
 943   return mImpl->mKeyEventSignal;
 944 }
 945
 946 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
 947 {
 948   return mImpl->mKeyInputFocusGainedSignal;
 949 }
 950
 951 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
 952 {
 953   return mImpl->mKeyInputFocusLostSignal;
 954 }
 955
 956 bool Control::EmitKeyEventSignal( const KeyEvent& event )
 957 {
 958   // Guard against destruction during signal emission
 959   Dali::Toolkit::Control handle( GetOwner() );
 960
 961   bool consumed = false;
 962
 963   // signals are allocated dynamically when someone connects
 964   if ( !mImpl->mKeyEventSignal.Empty() )
 965   {
 966     consumed = mImpl->mKeyEventSignal.Emit( handle, event );
 967   }
 968
 969   if (!consumed)
 970   {
 971     // Notification for derived classes
 972     consumed = OnKeyEvent(event);
 973   }
 974
 975   return consumed;
 976 }
 977
 978 Control::Control( ControlBehaviour behaviourFlags )
 979 : CustomActorImpl( static_cast< ActorFlags >( behaviourFlags ) ),
 980   mImpl(new Impl(*this))
 981 {
 982   mImpl->mFlags = behaviourFlags;
 983 }
 984
 985 void Control::Initialize()
 986 {
 987   // Call deriving classes so initialised before styling is applied to them.
 988   OnInitialize();
 989
 990   if( (mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS) ||
 991       !(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS) )
 992   {
 993     Toolkit::StyleManager styleManager = StyleManager::Get();
 994
 995     // if stylemanager is available
 996     if( styleManager )
 997     {
 998       StyleManager& styleManagerImpl = GetImpl( styleManager );
 999
1000       // Register for style changes
1001       styleManagerImpl.ControlStyleChangeSignal().Connect( this, &Control::OnStyleChange );
1002
1003       // Apply the current style
1004       styleManagerImpl.ApplyThemeStyleAtInit( Toolkit::Control( GetOwner() ) );
1005     }
1006   }
1007
1008   if( mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT )
1009   {
1010     SetKeyboardNavigationSupport( true );
1011   }
1012 }
1013
1014 void Control::OnInitialize()
1015 {
1016 }
1017
1018 void Control::OnControlChildAdd( Actor& child )
1019 {
1020 }
1021
1022 void Control::OnControlChildRemove( Actor& child )
1023 {
1024 }
1025
1026 void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
1027 {
1028   // By default the control is only interested in theme (not font) changes
1029   if( styleManager && change == StyleChange::THEME_CHANGE )
1030   {
1031     GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
1032   }
1033   RelayoutRequest();
1034 }
1035
1036 void Control::OnPinch(const PinchGesture& pinch)
1037 {
1038   if( !( mImpl->mStartingPinchScale ) )
1039   {
1040     // lazy allocate
1041     mImpl->mStartingPinchScale = new Vector3;
1042   }
1043
1044   if( pinch.state == Gesture::Started )
1045   {
1046     *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale();
1047   }
1048
1049   Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale );
1050 }
1051
1052 void Control::OnPan( const PanGesture& pan )
1053 {
1054 }
1055
1056 void Control::OnTap(const TapGesture& tap)
1057 {
1058 }
1059
1060 void Control::OnLongPress( const LongPressGesture& longPress )
1061 {
1062 }
1063
1064 void Control::EmitKeyInputFocusSignal( bool focusGained )
1065 {
1066   Dali::Toolkit::Control handle( GetOwner() );
1067
1068   if ( focusGained )
1069   {
1070     // signals are allocated dynamically when someone connects
1071     if ( !mImpl->mKeyInputFocusGainedSignal.Empty() )
1072     {
1073       mImpl->mKeyInputFocusGainedSignal.Emit( handle );
1074     }
1075   }
1076   else
1077   {
1078     // signals are allocated dynamically when someone connects
1079     if ( !mImpl->mKeyInputFocusLostSignal.Empty() )
1080     {
1081       mImpl->mKeyInputFocusLostSignal.Emit( handle );
1082     }
1083   }
1084 }
1085
1086 void Control::OnStageConnection( int depth )
1087 {
1088   for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1089   {
1090     // Check whether the visual is empty and enabled
1091     if( (*iter)->visual && (*iter)->enabled )
1092     {
1093       Actor self( Self() );
1094       (*iter)->visual.SetOnStage( self );
1095     }
1096   }
1097 }
1098
1099 void Control::OnStageDisconnection()
1100 {
1101   for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1102   {
1103     // Check whether the visual is empty
1104     if( (*iter)->visual )
1105     {
1106       Actor self( Self() );
1107       (*iter)->visual.SetOffStage( self );
1108     }
1109   }
1110 }
1111
1112 void Control::OnKeyInputFocusGained()
1113 {
1114   EmitKeyInputFocusSignal( true );
1115 }
1116
1117 void Control::OnKeyInputFocusLost()
1118 {
1119   EmitKeyInputFocusSignal( false );
1120 }
1121
1122 void Control::OnChildAdd(Actor& child)
1123 {
1124   // Notify derived classes.
1125   OnControlChildAdd( child );
1126 }
1127
1128 void Control::OnChildRemove(Actor& child)
1129 {
1130   // Notify derived classes.
1131   OnControlChildRemove( child );
1132 }
1133
1134 void Control::OnSizeSet(const Vector3& targetSize)
1135 {
1136   if( mImpl->mBackgroundVisual )
1137   {
1138     Vector2 size( targetSize );
1139     mImpl->mBackgroundVisual.SetSize( size );
1140   }
1141 }
1142
1143 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
1144 {
1145   // @todo size negotiate background to new size, animate as well?
1146 }
1147
1148 bool Control::OnTouchEvent(const TouchEvent& event)
1149 {
1150   return false; // Do not consume
1151 }
1152
1153 bool Control::OnHoverEvent(const HoverEvent& event)
1154 {
1155   return false; // Do not consume
1156 }
1157
1158 bool Control::OnKeyEvent(const KeyEvent& event)
1159 {
1160   return false; // Do not consume
1161 }
1162
1163 bool Control::OnWheelEvent(const WheelEvent& event)
1164 {
1165   return false; // Do not consume
1166 }
1167
1168 void Control::OnRelayout( const Vector2& size, RelayoutContainer& container )
1169 {
1170   for( unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i )
1171   {
1172     container.Add( Self().GetChildAt( i ), size );
1173   }
1174 }
1175
1176 void Control::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
1177 {
1178 }
1179
1180 Vector3 Control::GetNaturalSize()
1181 {
1182   if( mImpl->mBackgroundVisual )
1183   {
1184     Vector2 naturalSize;
1185     mImpl->mBackgroundVisual.GetNaturalSize(naturalSize);
1186     return Vector3(naturalSize);
1187   }
1188   return Vector3::ZERO;
1189 }
1190
1191 float Control::CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension )
1192 {
1193   return CalculateChildSizeBase( child, dimension );
1194 }
1195
1196 float Control::GetHeightForWidth( float width )
1197 {
1198   return GetHeightForWidthBase( width );
1199 }
1200
1201 float Control::GetWidthForHeight( float height )
1202 {
1203   return GetWidthForHeightBase( height );
1204 }
1205
1206 bool Control::RelayoutDependentOnChildren( Dimension::Type dimension )
1207 {
1208   return RelayoutDependentOnChildrenBase( dimension );
1209 }
1210
1211 void Control::OnCalculateRelayoutSize( Dimension::Type dimension )
1212 {
1213 }
1214
1215 void Control::OnLayoutNegotiated( float size, Dimension::Type dimension )
1216 {
1217 }
1218
1219 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
1220 {
1221   mImpl->SignalConnected( slotObserver, callback );
1222 }
1223
1224 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
1225 {
1226   mImpl->SignalDisconnected( slotObserver, callback );
1227 }
1228
1229 Control& GetImplementation( Dali::Toolkit::Control& handle )
1230 {
1231   CustomActorImpl& customInterface = handle.GetImplementation();
1232   // downcast to control
1233   Control& impl = dynamic_cast< Internal::Control& >( customInterface );
1234   return impl;
1235 }
1236
1237 const Control& GetImplementation( const Dali::Toolkit::Control& handle )
1238 {
1239   const CustomActorImpl& customInterface = handle.GetImplementation();
1240   // downcast to control
1241   const Control& impl = dynamic_cast< const Internal::Control& >( customInterface );
1242   return impl;
1243 }
1244
1245 } // namespace Internal
1246
1247 } // namespace Toolkit
1248
1249 } // namespace Dali