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     mBackgroundColor(Color::TRANSPARENT),
 296     mStartingPinchScale( NULL ),
 297     mKeyEventSignal(),
 298     mPinchGestureDetector(),
 299     mPanGestureDetector(),
 300     mTapGestureDetector(),
 301     mLongPressGestureDetector(),
 302     mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 303     mIsKeyboardNavigationSupported( false ),
 304     mIsKeyboardFocusGroup( false )
 305   {
 306   }
 307
 308   ~Impl()
 309   {
 310     // All gesture detectors will be destroyed so no need to disconnect.
 311     delete mStartingPinchScale;
 312   }
 313
 314   // Gesture Detection Methods
 315
 316   void PinchDetected(Actor actor, const PinchGesture& pinch)
 317   {
 318     mControlImpl.OnPinch(pinch);
 319   }
 320
 321   void PanDetected(Actor actor, const PanGesture& pan)
 322   {
 323     mControlImpl.OnPan(pan);
 324   }
 325
 326   void TapDetected(Actor actor, const TapGesture& tap)
 327   {
 328     mControlImpl.OnTap(tap);
 329   }
 330
 331   void LongPressDetected(Actor actor, const LongPressGesture& longPress)
 332   {
 333     mControlImpl.OnLongPress(longPress);
 334   }
 335
 336   // Properties
 337
 338   /**
 339    * Called when a property of an object of this type is set.
 340    * @param[in] object The object whose property is set.
 341    * @param[in] index The property index.
 342    * @param[in] value The new property value.
 343    */
 344   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 345   {
 346     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 347
 348     if ( control )
 349     {
 350       Control& controlImpl( GetImplementation( control ) );
 351
 352       switch ( index )
 353       {
 354         case Toolkit::Control::Property::STYLE_NAME:
 355         {
 356           controlImpl.SetStyleName( value.Get< std::string >() );
 357           break;
 358         }
 359
 360         case Toolkit::Control::Property::BACKGROUND_COLOR:
 361         {
 362           DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 363           controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
 364           break;
 365         }
 366
 367         case Toolkit::Control::Property::BACKGROUND_IMAGE:
 368         {
 369           DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 370           Image image = Scripting::NewImage( value );
 371           if ( image )
 372           {
 373             controlImpl.SetBackgroundImage( image );
 374           }
 375           else
 376           {
 377             // An empty image means the background is no longer required
 378             controlImpl.ClearBackground();
 379           }
 380           break;
 381         }
 382
 383         case Toolkit::Control::Property::KEY_INPUT_FOCUS:
 384         {
 385           if ( value.Get< bool >() )
 386           {
 387             controlImpl.SetKeyInputFocus();
 388           }
 389           else
 390           {
 391             controlImpl.ClearKeyInputFocus();
 392           }
 393           break;
 394         }
 395
 396         case Toolkit::Control::Property::BACKGROUND:
 397         {
 398           const Property::Map* map = value.GetMap();
 399           if( map && !map->Empty() )
 400           {
 401             controlImpl.SetBackground( *map );
 402           }
 403           else
 404           {
 405             // The background is an empty property map, so we should clear the background
 406             controlImpl.ClearBackground();
 407           }
 408           break;
 409         }
 410       }
 411     }
 412   }
 413
 414   /**
 415    * Called to retrieve a property of an object of this type.
 416    * @param[in] object The object whose property is to be retrieved.
 417    * @param[in] index The property index.
 418    * @return The current value of the property.
 419    */
 420   static Property::Value GetProperty( BaseObject* object, Property::Index index )
 421   {
 422     Property::Value value;
 423
 424     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 425
 426     if ( control )
 427     {
 428       Control& controlImpl( GetImplementation( control ) );
 429
 430       switch ( index )
 431       {
 432         case Toolkit::Control::Property::STYLE_NAME:
 433         {
 434           value = controlImpl.GetStyleName();
 435           break;
 436         }
 437
 438         case Toolkit::Control::Property::BACKGROUND_COLOR:
 439         {
 440           DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 441           value = controlImpl.GetBackgroundColor();
 442           break;
 443         }
 444
 445         case Toolkit::Control::Property::BACKGROUND_IMAGE:
 446         {
 447           DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 448           Property::Map map;
 449           Toolkit::Visual::Base visual = controlImpl.GetVisual( Toolkit::Control::Property::BACKGROUND );
 450           if( visual )
 451           {
 452             visual.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           Toolkit::Visual::Base visual = controlImpl.GetVisual( Toolkit::Control::Property::BACKGROUND );
 468           if( visual )
 469           {
 470             visual.CreatePropertyMap( map );
 471           }
 472
 473           value = map;
 474           break;
 475         }
 476
 477       }
 478     }
 479
 480     return value;
 481   }
 482
 483   // Data
 484
 485   Control& mControlImpl;
 486   RegisteredVisualContainer mVisuals; // Stores visuals needed by the control, non trivial type so std::vector used.
 487   std::string mStyleName;
 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
 566   SetBackground( map );
 567 }
 568
 569 Vector4 Control::GetBackgroundColor() const
 570 {
 571   return mImpl->mBackgroundColor;
 572 }
 573
 574 void Control::SetBackground( const Property::Map& map )
 575 {
 576   Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
 577   if( visual )
 578   {
 579     RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
 580     visual.SetDepthIndex( DepthIndex::BACKGROUND );
 581   }
 582 }
 583
 584 void Control::SetBackgroundImage( Image image )
 585 {
 586   DALI_LOG_WARNING( "SetBackgroundImage is for the depreciated Property::BACKGROUND_IMAGE use SetBackground( const Property::Map& map )\n" );
 587   Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
 588   if( visual )
 589   {
 590     RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
 591     visual.SetDepthIndex( DepthIndex::BACKGROUND );
 592   }
 593 }
 594
 595 void Control::ClearBackground()
 596 {
 597    UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
 598    mImpl->mBackgroundColor = Color::TRANSPARENT;
 599 }
 600
 601 void Control::EnableGestureDetection(Gesture::Type type)
 602 {
 603   if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
 604   {
 605     mImpl->mPinchGestureDetector = PinchGestureDetector::New();
 606     mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
 607     mImpl->mPinchGestureDetector.Attach(Self());
 608   }
 609
 610   if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
 611   {
 612     mImpl->mPanGestureDetector = PanGestureDetector::New();
 613     mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
 614     mImpl->mPanGestureDetector.Attach(Self());
 615   }
 616
 617   if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
 618   {
 619     mImpl->mTapGestureDetector = TapGestureDetector::New();
 620     mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
 621     mImpl->mTapGestureDetector.Attach(Self());
 622   }
 623
 624   if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
 625   {
 626     mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
 627     mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
 628     mImpl->mLongPressGestureDetector.Attach(Self());
 629   }
 630 }
 631
 632 void Control::DisableGestureDetection(Gesture::Type type)
 633 {
 634   if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
 635   {
 636     mImpl->mPinchGestureDetector.Detach(Self());
 637     mImpl->mPinchGestureDetector.Reset();
 638   }
 639
 640   if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
 641   {
 642     mImpl->mPanGestureDetector.Detach(Self());
 643     mImpl->mPanGestureDetector.Reset();
 644   }
 645
 646   if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
 647   {
 648     mImpl->mTapGestureDetector.Detach(Self());
 649     mImpl->mTapGestureDetector.Reset();
 650   }
 651
 652   if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
 653   {
 654     mImpl->mLongPressGestureDetector.Detach(Self());
 655     mImpl->mLongPressGestureDetector.Reset();
 656   }
 657 }
 658
 659 PinchGestureDetector Control::GetPinchGestureDetector() const
 660 {
 661   return mImpl->mPinchGestureDetector;
 662 }
 663
 664 PanGestureDetector Control::GetPanGestureDetector() const
 665 {
 666   return mImpl->mPanGestureDetector;
 667 }
 668
 669 TapGestureDetector Control::GetTapGestureDetector() const
 670 {
 671   return mImpl->mTapGestureDetector;
 672 }
 673
 674 LongPressGestureDetector Control::GetLongPressGestureDetector() const
 675 {
 676   return mImpl->mLongPressGestureDetector;
 677 }
 678
 679 void Control::SetKeyboardNavigationSupport(bool isSupported)
 680 {
 681   mImpl->mIsKeyboardNavigationSupported = isSupported;
 682 }
 683
 684 bool Control::IsKeyboardNavigationSupported()
 685 {
 686   return mImpl->mIsKeyboardNavigationSupported;
 687 }
 688
 689 void Control::SetKeyInputFocus()
 690 {
 691   if( Self().OnStage() )
 692   {
 693     Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
 694   }
 695 }
 696
 697 bool Control::HasKeyInputFocus()
 698 {
 699   bool result = false;
 700   if( Self().OnStage() )
 701   {
 702     result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self()));
 703   }
 704   return result;
 705 }
 706
 707 void Control::ClearKeyInputFocus()
 708 {
 709   if( Self().OnStage() )
 710   {
 711     Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
 712   }
 713 }
 714
 715 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
 716 {
 717   mImpl->mIsKeyboardFocusGroup = isFocusGroup;
 718
 719   // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
 720   Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
 721 }
 722
 723 bool Control::IsKeyboardFocusGroup()
 724 {
 725   return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
 726 }
 727
 728 void Control::AccessibilityActivate()
 729 {
 730   // Inform deriving classes
 731   OnAccessibilityActivated();
 732 }
 733
 734 void Control::KeyboardEnter()
 735 {
 736   // Inform deriving classes
 737   OnKeyboardEnter();
 738 }
 739
 740 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
 741 {
 742   RegisterVisual( index, visual, true );
 743 }
 744
 745 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
 746 {
 747   bool visualReplaced ( false );
 748   Actor self = Self();
 749
 750   if ( !mImpl->mVisuals.Empty() )
 751   {
 752       RegisteredVisualContainer::Iterator iter;
 753       // Check if visual (index) is already registered.  Replace if so.
 754       if ( FindVisual( index, mImpl->mVisuals, iter ) )
 755       {
 756         if( (*iter)->visual && self.OnStage() )
 757         {
 758           Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
 759         }
 760         (*iter)->visual = visual;
 761         visualReplaced = true;
 762       }
 763   }
 764
 765   if ( !visualReplaced ) // New registration entry
 766   {
 767     mImpl->mVisuals.PushBack( new RegisteredVisual( index, visual, enabled ) );
 768   }
 769
 770   if( visual && self.OnStage() && enabled )
 771   {
 772     Toolkit::GetImplementation(visual).SetOnStage( self );
 773   }
 774 }
 775
 776 void Control::UnregisterVisual( Property::Index index )
 777 {
 778    RegisteredVisualContainer::Iterator iter;
 779    if ( FindVisual( index, mImpl->mVisuals, iter ) )
 780    {
 781      Actor self( Self() );
 782      Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
 783      (*iter)->visual.Reset();
 784      mImpl->mVisuals.Erase( iter );
 785    }
 786 }
 787
 788 Toolkit::Visual::Base Control::GetVisual( Property::Index index ) const
 789 {
 790   RegisteredVisualContainer::Iterator iter;
 791   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 792   {
 793     return (*iter)->visual;
 794   }
 795
 796   return Toolkit::Visual::Base();
 797 }
 798
 799 void Control::EnableVisual( Property::Index index, bool enable )
 800 {
 801   RegisteredVisualContainer::Iterator iter;
 802   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 803   {
 804     if (  (*iter)->enabled == enable )
 805     {
 806       return;
 807     }
 808
 809     (*iter)->enabled = enable;
 810     Actor parentActor = Self();
 811     if ( Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
 812     {
 813       if ( enable )
 814       {
 815
 816         Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
 817       }
 818       else
 819       {
 820         Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor );  // No need to call if control not staged.
 821       }
 822     }
 823   }
 824 }
 825
 826 bool Control::IsVisualEnabled( Property::Index index ) const
 827 {
 828   RegisteredVisualContainer::Iterator iter;
 829   if ( FindVisual( index, mImpl->mVisuals, iter ) )
 830   {
 831     return (*iter)->enabled;
 832   }
 833   return false;
 834 }
 835
 836 Dali::Animation Control::CreateTransition( const Toolkit::TransitionData& handle )
 837 {
 838   Dali::Animation transition;
 839   const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
 840
 841   if( transitionData.Count() > 0 )
 842   {
 843     // Setup a Transition from TransitionData.
 844     TransitionData::Iterator end = transitionData.End();
 845     for( TransitionData::Iterator iter = transitionData.Begin() ;
 846          iter != end; ++iter )
 847     {
 848       TransitionData::Animator* animator = (*iter);
 849       HandleIndex handleIndex;
 850
 851       // Attempt to find the object name as a child actor
 852       Actor child = Self().FindChildByName( animator->objectName );
 853       if( child )
 854       {
 855         Property::Index propertyIndex = child.GetPropertyIndex( animator->propertyKey );
 856         handleIndex = HandleIndex( child, propertyIndex );
 857       }
 858       else
 859       {
 860         handleIndex = GetVisualProperty( *this, mImpl->mVisuals,
 861                                             animator->objectName,
 862                                             animator->propertyKey );
 863       }
 864
 865       if( handleIndex.handle && handleIndex.index != Property::INVALID_INDEX )
 866       {
 867         if( animator->animate == false )
 868         {
 869           if( animator->targetValue.GetType() != Property::NONE )
 870           {
 871             handleIndex.handle.SetProperty( handleIndex.index, animator->targetValue );
 872           }
 873         }
 874         else
 875         {
 876           if( animator->initialValue.GetType() != Property::NONE )
 877           {
 878             handleIndex.handle.SetProperty( handleIndex.index, animator->initialValue );
 879           }
 880
 881           if( ! transition )
 882           {
 883             // Create an animation with a default .1 second duration - the animators
 884             // will automatically force it to the 'right' duration.
 885             transition = Dali::Animation::New( 0.1f );
 886           }
 887
 888           transition.AnimateTo( Property( handleIndex.handle, handleIndex.index ),
 889                                 animator->targetValue,
 890                                 animator->alphaFunction,
 891                                 TimePeriod( animator->timePeriodDelay,
 892                                             animator->timePeriodDuration ) );
 893         }
 894       }
 895     }
 896   }
 897
 898   return transition;
 899 }
 900
 901 bool Control::OnAccessibilityActivated()
 902 {
 903   return false; // Accessibility activation is not handled by default
 904 }
 905
 906 bool Control::OnKeyboardEnter()
 907 {
 908   return false; // Keyboard enter is not handled by default
 909 }
 910
 911 bool Control::OnAccessibilityPan(PanGesture gesture)
 912 {
 913   return false; // Accessibility pan gesture is not handled by default
 914 }
 915
 916 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
 917 {
 918   return false; // Accessibility touch event is not handled by default
 919 }
 920
 921 bool Control::OnAccessibilityValueChange(bool isIncrease)
 922 {
 923   return false; // Accessibility value change action is not handled by default
 924 }
 925
 926 bool Control::OnAccessibilityZoom()
 927 {
 928   return false; // Accessibility zoom action is not handled by default
 929 }
 930
 931 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
 932 {
 933   return Actor();
 934 }
 935
 936 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
 937 {
 938 }
 939
 940 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
 941 {
 942   return mImpl->mKeyEventSignal;
 943 }
 944
 945 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
 946 {
 947   return mImpl->mKeyInputFocusGainedSignal;
 948 }
 949
 950 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
 951 {
 952   return mImpl->mKeyInputFocusLostSignal;
 953 }
 954
 955 bool Control::EmitKeyEventSignal( const KeyEvent& event )
 956 {
 957   // Guard against destruction during signal emission
 958   Dali::Toolkit::Control handle( GetOwner() );
 959
 960   bool consumed = false;
 961
 962   // signals are allocated dynamically when someone connects
 963   if ( !mImpl->mKeyEventSignal.Empty() )
 964   {
 965     consumed = mImpl->mKeyEventSignal.Emit( handle, event );
 966   }
 967
 968   if (!consumed)
 969   {
 970     // Notification for derived classes
 971     consumed = OnKeyEvent(event);
 972   }
 973
 974   return consumed;
 975 }
 976
 977 Control::Control( ControlBehaviour behaviourFlags )
 978 : CustomActorImpl( static_cast< ActorFlags >( behaviourFlags ) ),
 979   mImpl(new Impl(*this))
 980 {
 981   mImpl->mFlags = behaviourFlags;
 982 }
 983
 984 void Control::Initialize()
 985 {
 986   // Call deriving classes so initialised before styling is applied to them.
 987   OnInitialize();
 988
 989   if( (mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS) ||
 990       !(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS) )
 991   {
 992     Toolkit::StyleManager styleManager = StyleManager::Get();
 993
 994     // if stylemanager is available
 995     if( styleManager )
 996     {
 997       StyleManager& styleManagerImpl = GetImpl( styleManager );
 998
 999       // Register for style changes
1000       styleManagerImpl.ControlStyleChangeSignal().Connect( this, &Control::OnStyleChange );
1001
1002       // Apply the current style
1003       styleManagerImpl.ApplyThemeStyleAtInit( Toolkit::Control( GetOwner() ) );
1004     }
1005   }
1006
1007   if( mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT )
1008   {
1009     SetKeyboardNavigationSupport( true );
1010   }
1011 }
1012
1013 void Control::OnInitialize()
1014 {
1015 }
1016
1017 void Control::OnControlChildAdd( Actor& child )
1018 {
1019 }
1020
1021 void Control::OnControlChildRemove( Actor& child )
1022 {
1023 }
1024
1025 void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
1026 {
1027   // By default the control is only interested in theme (not font) changes
1028   if( styleManager && change == StyleChange::THEME_CHANGE )
1029   {
1030     GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
1031   }
1032   RelayoutRequest();
1033 }
1034
1035 void Control::OnPinch(const PinchGesture& pinch)
1036 {
1037   if( !( mImpl->mStartingPinchScale ) )
1038   {
1039     // lazy allocate
1040     mImpl->mStartingPinchScale = new Vector3;
1041   }
1042
1043   if( pinch.state == Gesture::Started )
1044   {
1045     *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale();
1046   }
1047
1048   Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale );
1049 }
1050
1051 void Control::OnPan( const PanGesture& pan )
1052 {
1053 }
1054
1055 void Control::OnTap(const TapGesture& tap)
1056 {
1057 }
1058
1059 void Control::OnLongPress( const LongPressGesture& longPress )
1060 {
1061 }
1062
1063 void Control::EmitKeyInputFocusSignal( bool focusGained )
1064 {
1065   Dali::Toolkit::Control handle( GetOwner() );
1066
1067   if ( focusGained )
1068   {
1069     // signals are allocated dynamically when someone connects
1070     if ( !mImpl->mKeyInputFocusGainedSignal.Empty() )
1071     {
1072       mImpl->mKeyInputFocusGainedSignal.Emit( handle );
1073     }
1074   }
1075   else
1076   {
1077     // signals are allocated dynamically when someone connects
1078     if ( !mImpl->mKeyInputFocusLostSignal.Empty() )
1079     {
1080       mImpl->mKeyInputFocusLostSignal.Emit( handle );
1081     }
1082   }
1083 }
1084
1085 void Control::OnStageConnection( int depth )
1086 {
1087   for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1088   {
1089     // Check whether the visual is empty and enabled
1090     if( (*iter)->visual && (*iter)->enabled )
1091     {
1092       Actor self( Self() );
1093       Toolkit::GetImplementation((*iter)->visual).SetOnStage( self );
1094     }
1095   }
1096 }
1097
1098 void Control::OnStageDisconnection()
1099 {
1100   for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1101   {
1102     // Check whether the visual is empty
1103     if( (*iter)->visual )
1104     {
1105       Actor self( Self() );
1106       Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
1107     }
1108   }
1109 }
1110
1111 void Control::OnKeyInputFocusGained()
1112 {
1113   EmitKeyInputFocusSignal( true );
1114 }
1115
1116 void Control::OnKeyInputFocusLost()
1117 {
1118   EmitKeyInputFocusSignal( false );
1119 }
1120
1121 void Control::OnChildAdd(Actor& child)
1122 {
1123   // Notify derived classes.
1124   OnControlChildAdd( child );
1125 }
1126
1127 void Control::OnChildRemove(Actor& child)
1128 {
1129   // Notify derived classes.
1130   OnControlChildRemove( child );
1131 }
1132
1133 void Control::OnSizeSet(const Vector3& targetSize)
1134 {
1135   Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
1136   if( visual )
1137   {
1138     Vector2 size( targetSize );
1139     visual.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   Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
1183   if( visual )
1184   {
1185     Vector2 naturalSize;
1186     visual.GetNaturalSize( naturalSize );
1187     return Vector3( naturalSize );
1188   }
1189   return Vector3::ZERO;
1190 }
1191
1192 float Control::CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension )
1193 {
1194   return CalculateChildSizeBase( child, dimension );
1195 }
1196
1197 float Control::GetHeightForWidth( float width )
1198 {
1199   return GetHeightForWidthBase( width );
1200 }
1201
1202 float Control::GetWidthForHeight( float height )
1203 {
1204   return GetWidthForHeightBase( height );
1205 }
1206
1207 bool Control::RelayoutDependentOnChildren( Dimension::Type dimension )
1208 {
1209   return RelayoutDependentOnChildrenBase( dimension );
1210 }
1211
1212 void Control::OnCalculateRelayoutSize( Dimension::Type dimension )
1213 {
1214 }
1215
1216 void Control::OnLayoutNegotiated( float size, Dimension::Type dimension )
1217 {
1218 }
1219
1220 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
1221 {
1222   mImpl->SignalConnected( slotObserver, callback );
1223 }
1224
1225 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
1226 {
1227   mImpl->SignalDisconnected( slotObserver, callback );
1228 }
1229
1230 Control& GetImplementation( Dali::Toolkit::Control& handle )
1231 {
1232   CustomActorImpl& customInterface = handle.GetImplementation();
1233   // downcast to control
1234   Control& impl = dynamic_cast< Internal::Control& >( customInterface );
1235   return impl;
1236 }
1237
1238 const Control& GetImplementation( const Dali::Toolkit::Control& handle )
1239 {
1240   const CustomActorImpl& customInterface = handle.GetImplementation();
1241   // downcast to control
1242   const Control& impl = dynamic_cast< const Internal::Control& >( customInterface );
1243   return impl;
1244 }
1245
1246 } // namespace Internal
1247
1248 } // namespace Toolkit
1249
1250 } // namespace Dali