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

   1 /*
   2  * Copyright (c) 2014 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 #include <dali-toolkit/public-api/controls/control-impl.h>
  19
  20 #include <stack>
  21
  22 #include <dali/integration-api/debug.h>
  23
  24 #include "dali-toolkit/internal/controls/relayout-controller.h"
  25 #include "dali-toolkit/internal/controls/relayout-helper.h"
  26 #include "dali-toolkit/public-api/focus-manager/keyinput-focus-manager.h"
  27 #include "dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h"
  28 #include <dali-toolkit/public-api/controls/control.h>
  29
  30 #include <dali-toolkit/public-api/styling/style-manager.h>
  31 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 const Property::Index Control::PROPERTY_BACKGROUND_COLOR      = Internal::Control::CONTROL_PROPERTY_START_INDEX;
  40 const Property::Index Control::PROPERTY_BACKGROUND            = Internal::Control::CONTROL_PROPERTY_START_INDEX + 1;
  41 const Property::Index Control::PROPERTY_WIDTH_POLICY          = Internal::Control::CONTROL_PROPERTY_START_INDEX + 2;
  42 const Property::Index Control::PROPERTY_HEIGHT_POLICY         = Internal::Control::CONTROL_PROPERTY_START_INDEX + 3;
  43 const Property::Index Control::PROPERTY_MINIMUM_SIZE          = Internal::Control::CONTROL_PROPERTY_START_INDEX + 4;
  44 const Property::Index Control::PROPERTY_MAXIMUM_SIZE          = Internal::Control::CONTROL_PROPERTY_START_INDEX + 5;
  45 const Property::Index Control::PROPERTY_KEY_INPUT_FOCUS       = Internal::Control::CONTROL_PROPERTY_START_INDEX + 6;
  46
  47 namespace
  48 {
  49
  50 const Scripting::StringEnum< Control::SizePolicy > SIZE_POLICY_STRING_TABLE[] =
  51 {
  52   { "FIXED",      Control::Fixed      },
  53   { "MINIMUM",    Control::Minimum    },
  54   { "MAXIMUM",    Control::Maximum    },
  55   { "RANGE",      Control::Range      },
  56   { "FLEXIBLE",   Control::Flexible   },
  57 };
  58 const unsigned int SIZE_POLICY_STRING_TABLE_COUNT = sizeof( SIZE_POLICY_STRING_TABLE ) / sizeof( SIZE_POLICY_STRING_TABLE[0] );
  59
  60 #if defined(DEBUG_ENABLED)
  61 Integration::Log::Filter* gLogFilter  = Integration::Log::Filter::New(Debug::NoLogging, false, "LOG_CONTROL");
  62 #endif
  63
  64 const float MAX_FLOAT_VALUE( std::numeric_limits<float>::max() );
  65 const float BACKGROUND_ACTOR_Z_POSITION( -0.1f );
  66
  67 BaseHandle Create()
  68 {
  69   return Internal::Control::New();
  70 }
  71
  72 TypeRegistration CONTROL_TYPE( typeid(Control), typeid(CustomActor), Create );
  73
  74 // Property Registration after Internal::Control::Impl definition below
  75
  76 TypeAction ACTION_TYPE_1(CONTROL_TYPE, Toolkit::Control::ACTION_CONTROL_ACTIVATED, &Internal::Control::DoAction);
  77
  78 /**
  79  * Helper class used to set the Control's size through the Actor's API or through children added.
  80  */
  81 class SetSizeLock
  82 {
  83 public:
  84   SetSizeLock( bool& lock )
  85   : mLock( lock )
  86   {
  87     mLock = true;
  88   }
  89
  90   ~SetSizeLock()
  91   {
  92     mLock = false;
  93   }
  94
  95 private:
  96   bool& mLock;
  97 };
  98
  99 /**
 100  * Structure which holds information about the background of a control
 101  */
 102 struct Background
 103 {
 104   Actor actor;   ///< Either a MeshActor or an ImageActor
 105   Vector4 color; ///< The color of the actor.
 106
 107   /**
 108    * Constructor
 109    */
 110   Background()
 111   : actor(),
 112     color( Color::WHITE )
 113   {
 114   }
 115 };
 116
 117 /**
 118  * Helper function to calculate a dimension given the policy of that dimension; the minimum &
 119  * maximum values that dimension can be; and the allocated value for that dimension.
 120  *
 121  * @param[in]  policy     The size policy for that dimension.
 122  * @param[in]  minimum    The minimum value that dimension can be.
 123  * @param[in]  maximum    The maximum value that dimension can be.
 124  * @param[in]  allocated  The value allocated for that dimension.
 125  *
 126  * @return The value that the dimension should be.
 127  *
 128  * @note This does not handle Control::Fixed policy.
 129  */
 130 float Calculate( Control::SizePolicy policy, float minimum, float maximum, float allocated )
 131 {
 132   float size( allocated );
 133
 134   switch( policy )
 135   {
 136     case Control::Fixed:
 137     {
 138       // Use allocated value
 139       break;
 140     }
 141
 142     case Control::Minimum:
 143     {
 144       // Size is always at least the minimum.
 145       size = std::max( allocated, minimum );
 146       break;
 147     }
 148
 149     case Control::Maximum:
 150     {
 151       // Size can grow but up to a maximum value.
 152       size = std::min( allocated, maximum );
 153       break;
 154     }
 155
 156     case Control::Range:
 157     {
 158       // Size is at least the minimum and can grow up to the maximum
 159       size = std::max( size, minimum );
 160       size = std::min( size, maximum );
 161      break;
 162     }
 163
 164     case Control::Flexible:
 165     {
 166       // Size grows or shrinks with no limits.
 167       size = allocated;
 168       break;
 169     }
 170
 171     default:
 172     {
 173       DALI_ASSERT_DEBUG( false && "This function was not intended to be used by any other policy." );
 174       break;
 175     }
 176   }
 177
 178   return size;
 179 }
 180
 181 /**
 182  * Creates a white coloured Mesh.
 183  */
 184 Mesh CreateMesh()
 185 {
 186   Vector3 white( Color::WHITE );
 187
 188   MeshData meshData;
 189
 190   // Create vertices with a white color (actual color is set by actor color)
 191   MeshData::VertexContainer vertices(4);
 192   vertices[ 0 ] = MeshData::Vertex( Vector3( -0.5f, -0.5f, 0.0f ), Vector2::ZERO, white );
 193   vertices[ 1 ] = MeshData::Vertex( Vector3(  0.5f, -0.5f, 0.0f ), Vector2::ZERO, white );
 194   vertices[ 2 ] = MeshData::Vertex( Vector3( -0.5f,  0.5f, 0.0f ), Vector2::ZERO, white );
 195   vertices[ 3 ] = MeshData::Vertex( Vector3(  0.5f,  0.5f, 0.0f ), Vector2::ZERO, white );
 196
 197   // Specify all the faces
 198   MeshData::FaceIndices faces;
 199   faces.reserve( 6 ); // 2 triangles in Quad
 200   faces.push_back( 0 ); faces.push_back( 3 ); faces.push_back( 1 );
 201   faces.push_back( 0 ); faces.push_back( 2 ); faces.push_back( 3 );
 202
 203   // Create the mesh data from the vertices and faces
 204   meshData.SetMaterial( Material::New( "ControlMaterial" ) );
 205   meshData.SetVertices( vertices );
 206   meshData.SetFaceIndices( faces );
 207   meshData.SetHasColor( true );
 208
 209   return Mesh::New( meshData );
 210 }
 211
 212 /**
 213  * Sets all the required properties for the background actor.
 214  *
 215  * @param[in]  actor              The actor to set the properties on.
 216  * @param[in]  constrainingIndex  The property index to constrain the parent's size on.
 217  * @param[in]  color              The required color of the actor.
 218  */
 219 void SetupBackgroundActor( Actor actor, Property::Index constrainingIndex, const Vector4& color )
 220 {
 221   actor.SetColor( color );
 222   actor.SetPositionInheritanceMode( USE_PARENT_POSITION_PLUS_LOCAL_POSITION );
 223   actor.SetZ( BACKGROUND_ACTOR_Z_POSITION );
 224
 225   Constraint constraint = Constraint::New<Vector3>( constrainingIndex,
 226                                                     ParentSource( Actor::SIZE ),
 227                                                     EqualToConstraint() );
 228   actor.ApplyConstraint( constraint );
 229 }
 230
 231 } // unnamed namespace
 232
 233 namespace Internal
 234 {
 235
 236 class Control::Impl : public ConnectionTrackerInterface
 237 {
 238 public:
 239   // Construction & Destruction
 240   Impl(Control& controlImpl)
 241   : mControlImpl(controlImpl),
 242     mInitialized( false ),
 243     mPinchGestureDetector(),
 244     mPanGestureDetector(),
 245     mTapGestureDetector(),
 246     mLongPressGestureDetector(),
 247     mStartingPinchScale(),
 248     mLockSetSize( false ),
 249     mWidthPolicy( Toolkit::Control::Fixed ),
 250     mHeightPolicy( Toolkit::Control::Fixed ),
 251     mSize(),
 252     mSetSize(),
 253     mMinimumSize(),
 254     mMaximumSize( MAX_FLOAT_VALUE, MAX_FLOAT_VALUE, MAX_FLOAT_VALUE ),
 255     mIsKeyboardNavigationSupported(false),
 256     mIsKeyboardFocusGroup(false),
 257     mKeyEventSignalV2(),
 258     mBackground( NULL ),
 259     mFlags( Control::CONTROL_BEHAVIOUR_NONE )
 260   {
 261   }
 262
 263   ~Impl()
 264   {
 265     // All gesture detectors will be destroyed so no need to disconnect.
 266     if ( mBackground )
 267     {
 268       delete mBackground;
 269     }
 270   }
 271
 272   // Gesture Detection Methods
 273
 274   void PinchDetected(Actor actor, PinchGesture pinch)
 275   {
 276     mControlImpl.OnPinch(pinch);
 277   }
 278
 279   void PanDetected(Actor actor, PanGesture pan)
 280   {
 281     mControlImpl.OnPan(pan);
 282   }
 283
 284   void TapDetected(Actor actor, TapGesture tap)
 285   {
 286     mControlImpl.OnTap(tap);
 287   }
 288
 289   void LongPressDetected(Actor actor, LongPressGesture longPress)
 290   {
 291     mControlImpl.OnLongPress(longPress);
 292   }
 293
 294   /**
 295    * @copydoc ConnectionTrackerInterface::SignalConnected
 296    */
 297   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
 298   {
 299     mConnectionTracker.SignalConnected( slotObserver, callback );
 300   }
 301
 302   /**
 303    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 304    */
 305   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
 306   {
 307     mConnectionTracker.SignalDisconnected( slotObserver, callback );
 308   }
 309
 310   /**
 311    * @copydoc ConnectionTrackerInterface::GetConnectionCount
 312    */
 313   virtual std::size_t GetConnectionCount() const
 314   {
 315     return mConnectionTracker.GetConnectionCount();
 316   }
 317
 318   // Background Methods
 319
 320   /**
 321    * Only creates an instance of the background if we actually use it.
 322    * @return A reference to the Background structure.
 323    */
 324   Background& GetBackground()
 325   {
 326     if ( !mBackground )
 327     {
 328       mBackground = new Background;
 329     }
 330     return *mBackground;
 331   }
 332
 333   // Properties
 334
 335   /**
 336    * Called when a property of an object of this type is set.
 337    * @param[in] object The object whose property is set.
 338    * @param[in] index The property index.
 339    * @param[in] value The new property value.
 340    */
 341   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 342   {
 343     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 344
 345     if ( control )
 346     {
 347       Control& controlImpl( control.GetImplementation() );
 348
 349       switch ( index )
 350       {
 351         case Toolkit::Control::PROPERTY_BACKGROUND_COLOR:
 352         {
 353           controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
 354           break;
 355         }
 356
 357         case Toolkit::Control::PROPERTY_BACKGROUND:
 358         {
 359           if ( value.HasKey( "image" ) )
 360           {
 361             Property::Map imageMap = value.GetValue( "image" ).Get< Property::Map >();
 362             Image image = Scripting::NewImage( imageMap );
 363
 364             if ( image )
 365             {
 366               controlImpl.SetBackground( image );
 367             }
 368           }
 369           else if ( value.Get< Property::Map >().empty() )
 370           {
 371             // An empty map means the background is no longer required
 372             controlImpl.ClearBackground();
 373           }
 374           break;
 375         }
 376
 377         case Toolkit::Control::PROPERTY_WIDTH_POLICY:
 378         {
 379           controlImpl.mImpl->mWidthPolicy = Scripting::GetEnumeration< Toolkit::Control::SizePolicy >( value.Get< std::string >(), SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT );
 380           break;
 381         }
 382
 383         case Toolkit::Control::PROPERTY_HEIGHT_POLICY:
 384         {
 385           controlImpl.mImpl->mHeightPolicy = Scripting::GetEnumeration< Toolkit::Control::SizePolicy >( value.Get< std::string >(), SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT );
 386           break;
 387         }
 388
 389         case Toolkit::Control::PROPERTY_MINIMUM_SIZE:
 390         {
 391           controlImpl.SetMinimumSize( value.Get< Vector3 >() );
 392           break;
 393         }
 394
 395         case Toolkit::Control::PROPERTY_MAXIMUM_SIZE:
 396         {
 397           controlImpl.SetMaximumSize( value.Get< Vector3 >() );
 398           break;
 399         }
 400
 401         case Toolkit::Control::PROPERTY_KEY_INPUT_FOCUS:
 402         {
 403           if ( value.Get< bool >() )
 404           {
 405             controlImpl.SetKeyInputFocus();
 406           }
 407           else
 408           {
 409             controlImpl.ClearKeyInputFocus();
 410           }
 411           break;
 412         }
 413       }
 414     }
 415   }
 416
 417   /**
 418    * Called to retrieve a property of an object of this type.
 419    * @param[in] object The object whose property is to be retrieved.
 420    * @param[in] index The property index.
 421    * @return The current value of the property.
 422    */
 423   static Property::Value GetProperty( BaseObject* object, Property::Index index )
 424   {
 425     Property::Value value;
 426
 427     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 428
 429     if ( control )
 430     {
 431       Control& controlImpl( control.GetImplementation() );
 432
 433       switch ( index )
 434       {
 435         case Toolkit::Control::PROPERTY_BACKGROUND_COLOR:
 436         {
 437           value = controlImpl.GetBackgroundColor();
 438           break;
 439         }
 440
 441         case Toolkit::Control::PROPERTY_BACKGROUND:
 442         {
 443           Property::Map map;
 444
 445           Actor actor = controlImpl.GetBackgroundActor();
 446           if ( actor )
 447           {
 448             ImageActor imageActor = ImageActor::DownCast( actor );
 449             if ( imageActor )
 450             {
 451               Image image = imageActor.GetImage();
 452               Property::Map imageMap;
 453               Scripting::CreatePropertyMap( image, imageMap );
 454               map.push_back( Property::StringValuePair( "image", imageMap ) );
 455             }
 456           }
 457
 458           value = map;
 459           break;
 460         }
 461
 462         case Toolkit::Control::PROPERTY_WIDTH_POLICY:
 463         {
 464           value = std::string( Scripting::GetEnumerationName< Toolkit::Control::SizePolicy >( controlImpl.mImpl->mWidthPolicy, SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT ) );
 465           break;
 466         }
 467
 468         case Toolkit::Control::PROPERTY_HEIGHT_POLICY:
 469         {
 470           value = std::string( Scripting::GetEnumerationName< Toolkit::Control::SizePolicy >( controlImpl.mImpl->mHeightPolicy, SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT ) );
 471           break;
 472         }
 473
 474         case Toolkit::Control::PROPERTY_MINIMUM_SIZE:
 475         {
 476           value = controlImpl.mImpl->mMinimumSize;
 477           break;
 478         }
 479
 480         case Toolkit::Control::PROPERTY_MAXIMUM_SIZE:
 481         {
 482           value = controlImpl.mImpl->mMaximumSize;
 483           break;
 484         }
 485
 486         case Toolkit::Control::PROPERTY_KEY_INPUT_FOCUS:
 487         {
 488           value = controlImpl.HasKeyInputFocus();
 489           break;
 490         }
 491       }
 492     }
 493
 494     return value;
 495   }
 496
 497   // Data
 498
 499   Control& mControlImpl;
 500
 501   bool mInitialized:1;
 502
 503   ConnectionTracker mConnectionTracker; // signal connection tracker
 504
 505   // Gesture Detection
 506
 507   PinchGestureDetector     mPinchGestureDetector;
 508   PanGestureDetector       mPanGestureDetector;
 509   TapGestureDetector       mTapGestureDetector;
 510   LongPressGestureDetector mLongPressGestureDetector;
 511
 512   Vector3 mStartingPinchScale;       ///< The scale when a pinch gesture starts
 513
 514   // Relayout and size negotiation
 515
 516   bool mLockSetSize;                 ///< Used to avoid. Can't be a bitfield as a reference to this member is used in SetSizeLock helper class.
 517
 518   Toolkit::Control::SizePolicy mWidthPolicy;  ///< Stores the width policy.
 519   Toolkit::Control::SizePolicy mHeightPolicy; ///< Stores the height policy.
 520
 521   Vector3 mSize;                     ///< Stores the current control's size.
 522   Vector3 mSetSize;                  ///< Always stores the size set through the Actor's API. Useful when reset to the initial size is needed.
 523   Vector3 mMinimumSize;              ///< Stores the control's minimum size.
 524   Vector3 mMaximumSize;              ///< Stores the control's maximum size.
 525
 526   bool mIsKeyboardNavigationSupported;  ///< Stores whether keyboard navigation is supported by the control.
 527   bool mIsKeyboardFocusGroup;        ///< Stores whether the control is a focus group.
 528
 529   Toolkit::Control::KeyEventSignalV2 mKeyEventSignalV2;
 530
 531   // Background
 532   Background* mBackground;           ///< Only create the background if we use it
 533
 534   ControlBehaviour mFlags;           ///< Flags passed in from constructor
 535
 536   // Properties - these need to be members of Internal::Control::Impl as they need to functions within this class.
 537   static PropertyRegistration PROPERTY_1;
 538   static PropertyRegistration PROPERTY_2;
 539   static PropertyRegistration PROPERTY_3;
 540   static PropertyRegistration PROPERTY_4;
 541   static PropertyRegistration PROPERTY_5;
 542   static PropertyRegistration PROPERTY_6;
 543   static PropertyRegistration PROPERTY_7;
 544 };
 545
 546 PropertyRegistration Control::Impl::PROPERTY_1( CONTROL_TYPE, "background-color", Toolkit::Control::PROPERTY_BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 547 PropertyRegistration Control::Impl::PROPERTY_2( CONTROL_TYPE, "background",       Toolkit::Control::PROPERTY_BACKGROUND,       Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 548 PropertyRegistration Control::Impl::PROPERTY_3( CONTROL_TYPE, "width-policy",     Toolkit::Control::PROPERTY_WIDTH_POLICY,     Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 549 PropertyRegistration Control::Impl::PROPERTY_4( CONTROL_TYPE, "height-policy",    Toolkit::Control::PROPERTY_HEIGHT_POLICY,    Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 550 PropertyRegistration Control::Impl::PROPERTY_5( CONTROL_TYPE, "minimum-size",     Toolkit::Control::PROPERTY_MINIMUM_SIZE,     Property::VECTOR3, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 551 PropertyRegistration Control::Impl::PROPERTY_6( CONTROL_TYPE, "maximum-size",     Toolkit::Control::PROPERTY_MAXIMUM_SIZE,     Property::VECTOR3, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 552 PropertyRegistration Control::Impl::PROPERTY_7( CONTROL_TYPE, "key-input-focus",  Toolkit::Control::PROPERTY_KEY_INPUT_FOCUS,  Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 553
 554 Toolkit::Control Control::New()
 555 {
 556   // Create the implementation, temporarily owned on stack
 557   IntrusivePtr<Control> controlImpl = new Control( CONTROL_BEHAVIOUR_NONE );
 558
 559   // Pass ownership to handle
 560   Toolkit::Control handle( *controlImpl );
 561
 562   // Second-phase init of the implementation
 563   // This can only be done after the CustomActor connection has been made...
 564   controlImpl->Initialize();
 565
 566   return handle;
 567 }
 568
 569 Control::~Control()
 570 {
 571   delete mImpl;
 572 }
 573
 574 void Control::Initialize()
 575 {
 576
 577   // Calling deriving classes
 578   OnInitialize();
 579
 580   if( mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS )
 581   {
 582     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 583
 584     // Register for style changes
 585     styleManager.StyleChangeSignal().Connect( this, &ControlImpl::DoStyleChange );
 586   }
 587
 588   mImpl->mInitialized = true;
 589 }
 590
 591 void Control::EnableGestureDetection(Gesture::Type type)
 592 {
 593   if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
 594   {
 595     mImpl->mPinchGestureDetector = PinchGestureDetector::New();
 596     mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
 597     mImpl->mPinchGestureDetector.Attach(Self());
 598   }
 599
 600   if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
 601   {
 602     mImpl->mPanGestureDetector = PanGestureDetector::New();
 603     mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
 604     mImpl->mPanGestureDetector.Attach(Self());
 605   }
 606
 607   if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
 608   {
 609     mImpl->mTapGestureDetector = TapGestureDetector::New();
 610     mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
 611     mImpl->mTapGestureDetector.Attach(Self());
 612   }
 613
 614   if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
 615   {
 616     mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
 617     mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
 618     mImpl->mLongPressGestureDetector.Attach(Self());
 619   }
 620 }
 621
 622 void Control::DisableGestureDetection(Gesture::Type type)
 623 {
 624   if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
 625   {
 626     mImpl->mPinchGestureDetector.Detach(Self());
 627     mImpl->mPinchGestureDetector.Reset();
 628   }
 629
 630   if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
 631   {
 632     mImpl->mPanGestureDetector.Detach(Self());
 633     mImpl->mPanGestureDetector.Reset();
 634   }
 635
 636   if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
 637   {
 638     mImpl->mTapGestureDetector.Detach(Self());
 639     mImpl->mTapGestureDetector.Reset();
 640   }
 641
 642   if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
 643   {
 644     mImpl->mLongPressGestureDetector.Detach(Self());
 645     mImpl->mLongPressGestureDetector.Reset();
 646   }
 647 }
 648
 649 PinchGestureDetector Control::GetPinchGestureDetector() const
 650 {
 651   return mImpl->mPinchGestureDetector;
 652 }
 653
 654 PanGestureDetector Control::GetPanGestureDetector() const
 655 {
 656   return mImpl->mPanGestureDetector;
 657 }
 658
 659 TapGestureDetector Control::GetTapGestureDetector() const
 660 {
 661   return mImpl->mTapGestureDetector;
 662 }
 663
 664 LongPressGestureDetector Control::GetLongPressGestureDetector() const
 665 {
 666   return mImpl->mLongPressGestureDetector;
 667 }
 668
 669 void Control::SetBackgroundColor( const Vector4& color )
 670 {
 671   Background& background( mImpl->GetBackground() );
 672
 673   if ( background.actor )
 674   {
 675     // Just set the actor color
 676     background.actor.SetColor( color );
 677   }
 678   else
 679   {
 680     // Create Mesh Actor
 681     MeshActor meshActor = MeshActor::New( CreateMesh() );
 682
 683     meshActor.SetAffectedByLighting( false );
 684     SetupBackgroundActor( meshActor, Actor::SCALE, color );
 685
 686     // Set the background actor before adding so that we do not inform deriving classes
 687     background.actor = meshActor;
 688     Self().Add( meshActor );
 689   }
 690
 691   background.color = color;
 692 }
 693
 694 Vector4 Control::GetBackgroundColor() const
 695 {
 696   if ( mImpl->mBackground )
 697   {
 698     return mImpl->mBackground->color;
 699   }
 700   return Color::TRANSPARENT;
 701 }
 702
 703 void Control::SetBackground( Image image )
 704 {
 705   Background& background( mImpl->GetBackground() );
 706
 707   if ( background.actor )
 708   {
 709     // Remove Current actor, unset AFTER removal so that we do not inform deriving classes
 710     Self().Remove( background.actor );
 711     background.actor = NULL;
 712   }
 713
 714   ImageActor imageActor = ImageActor::New( image );
 715   SetupBackgroundActor( imageActor, Actor::SIZE, background.color );
 716
 717   // Set the background actor before adding so that we do not inform derived classes
 718   background.actor = imageActor;
 719   Self().Add( imageActor );
 720 }
 721
 722 void Control::ClearBackground()
 723 {
 724   if ( mImpl->mBackground )
 725   {
 726     Background& background( mImpl->GetBackground() );
 727     Self().Remove( background.actor );
 728
 729     delete mImpl->mBackground;
 730     mImpl->mBackground = NULL;
 731   }
 732 }
 733
 734 Actor Control::GetBackgroundActor() const
 735 {
 736   if ( mImpl->mBackground )
 737   {
 738     return mImpl->mBackground->actor;
 739   }
 740
 741   return Actor();
 742 }
 743
 744 void Control::OnThemeChange( Toolkit::StyleManager styleManager )
 745 {
 746   GetImpl( styleManager ).ApplyThemeStyle( GetOwner() );
 747 }
 748
 749 void Control::OnPinch(PinchGesture pinch)
 750 {
 751   if (pinch.state == Gesture::Started)
 752   {
 753     mImpl->mStartingPinchScale = Self().GetCurrentScale();
 754   }
 755
 756   Self().SetScale(mImpl->mStartingPinchScale * pinch.scale);
 757 }
 758
 759 void Control::OnStageConnection()
 760 {
 761   RelayoutRequest();
 762
 763   // Notify derived classes.
 764   OnControlStageConnection();
 765 }
 766
 767 void Control::OnStageDisconnection()
 768 {
 769   // Notify derived classes
 770   OnControlStageDisconnection();
 771 }
 772
 773 void Control::OnChildAdd(Actor& child)
 774 {
 775   // If this is the background actor, then we do not want to relayout or inform deriving classes
 776   if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) )
 777   {
 778     return;
 779   }
 780
 781   // Request for relayout.
 782   RelayoutRequest();
 783
 784   // Notify derived classes.
 785   OnControlChildAdd( child );
 786 }
 787
 788 void Control::OnChildRemove(Actor& child)
 789 {
 790   // If this is the background actor, then we do not want to relayout or inform deriving classes
 791   if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) )
 792   {
 793     return;
 794   }
 795
 796   // Request for relayout.
 797   RelayoutRequest();
 798
 799   // Notify derived classes.
 800   OnControlChildRemove( child );
 801 }
 802
 803 void Control::OnSizeSet(const Vector3& targetSize)
 804 {
 805   if( ( !mImpl->mLockSetSize ) && ( targetSize != mImpl->mSetSize ) )
 806   {
 807     // Only updates size if set through Actor's API
 808     mImpl->mSetSize = targetSize;
 809   }
 810
 811   if( targetSize != mImpl->mSize )
 812   {
 813     // Update control size.
 814     mImpl->mSize = targetSize;
 815
 816     // Notify derived classes.
 817     OnControlSizeSet( targetSize );
 818   }
 819 }
 820
 821 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
 822 {
 823   // Do Nothing
 824 }
 825
 826 bool Control::OnTouchEvent(const TouchEvent& event)
 827 {
 828   return false; // Do not consume
 829 }
 830
 831 bool Control::OnKeyEvent(const KeyEvent& event)
 832 {
 833   return false; // Do not consume
 834 }
 835
 836 bool Control::OnMouseWheelEvent(const MouseWheelEvent& event)
 837 {
 838   return false; // Do not consume
 839 }
 840
 841 void Control::OnKeyInputFocusGained()
 842 {
 843   // Do Nothing
 844 }
 845
 846 void Control::OnKeyInputFocusLost()
 847 {
 848   // Do Nothing
 849 }
 850
 851 Actor Control::GetChildByAlias(const std::string& actorAlias)
 852 {
 853   return Actor();
 854 }
 855
 856 bool Control::OnAccessibilityPan(PanGesture gesture)
 857 {
 858   return false; // Accessibility pan gesture is not handled by default
 859 }
 860
 861 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
 862 {
 863   return false; // Accessibility touch event is not handled by default
 864 }
 865
 866 bool Control::OnAccessibilityValueChange(bool isIncrease)
 867 {
 868   return false; // Accessibility value change action is not handled by default
 869 }
 870
 871
 872 void Control::SetKeyboardNavigationSupport(bool isSupported)
 873 {
 874   mImpl->mIsKeyboardNavigationSupported = isSupported;
 875 }
 876
 877 bool Control::IsKeyboardNavigationSupported()
 878 {
 879   return mImpl->mIsKeyboardNavigationSupported;
 880 }
 881
 882 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
 883 {
 884   mImpl->mIsKeyboardFocusGroup = isFocusGroup;
 885
 886   // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
 887   Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
 888 }
 889
 890 bool Control::IsKeyboardFocusGroup()
 891 {
 892   return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
 893 }
 894
 895 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled)
 896 {
 897   return Actor();
 898 }
 899
 900 bool Control::DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes)
 901 {
 902   bool ret = false;
 903
 904   return ret;
 905 }
 906
 907 void Control::DoActivatedAction(const PropertyValueContainer& attributes)
 908 {
 909   OnActivated();
 910 }
 911
 912 void Control::DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change )
 913 {
 914   if( change.themeChange )
 915   {
 916     OnThemeChange( styleManager );
 917   }
 918   else if( change.defaultFontChange || change.defaultFontSizeChange )
 919   {
 920     // This OnStyleChange(StyleChange change ) is deprecated, use OnFontChange instead
 921     OnStyleChange( change );
 922
 923     OnFontChange( change.defaultFontChange, change.defaultFontSizeChange );
 924   }
 925 }
 926
 927 Toolkit::Control::KeyEventSignalV2& Control::KeyEventSignal()
 928 {
 929   return mImpl->mKeyEventSignalV2;
 930 }
 931
 932 void Control::SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy )
 933 {
 934   bool relayoutRequest( false );
 935
 936   if ( ( mImpl->mWidthPolicy != widthPolicy ) || ( mImpl->mHeightPolicy != heightPolicy ) )
 937   {
 938     relayoutRequest = true;
 939   }
 940
 941   mImpl->mWidthPolicy = widthPolicy;
 942   mImpl->mHeightPolicy = heightPolicy;
 943
 944   // Ensure RelayoutRequest is called AFTER new policies have been set.
 945   if ( relayoutRequest )
 946   {
 947     RelayoutRequest();
 948   }
 949 }
 950
 951 void Control::GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const
 952 {
 953   widthPolicy = mImpl->mWidthPolicy;
 954   heightPolicy = mImpl->mHeightPolicy;
 955 }
 956
 957 void Control::SetMinimumSize( const Vector3& size )
 958 {
 959   if ( mImpl->mMinimumSize != size )
 960   {
 961     mImpl->mMinimumSize = size;
 962
 963     // Only relayout if our control is using the minimum or range policy.
 964     if ( ( mImpl->mHeightPolicy == Toolkit::Control::Minimum ) || ( mImpl->mWidthPolicy  == Toolkit::Control::Minimum ) ||
 965          ( mImpl->mHeightPolicy == Toolkit::Control::Range   ) || ( mImpl->mWidthPolicy  == Toolkit::Control::Range   ) )
 966     {
 967       RelayoutRequest();
 968     }
 969   }
 970 }
 971
 972 const Vector3& Control::GetMinimumSize() const
 973 {
 974   return mImpl->mMinimumSize;
 975 }
 976
 977 void Control::SetMaximumSize( const Vector3& size )
 978 {
 979   if ( mImpl->mMaximumSize != size )
 980   {
 981     mImpl->mMaximumSize = size;
 982
 983     // Only relayout if our control is using the maximum or range policy.
 984     if ( ( mImpl->mHeightPolicy == Toolkit::Control::Maximum ) || ( mImpl->mWidthPolicy  == Toolkit::Control::Maximum ) ||
 985          ( mImpl->mHeightPolicy == Toolkit::Control::Range   ) || ( mImpl->mWidthPolicy  == Toolkit::Control::Range   ) )
 986     {
 987       RelayoutRequest();
 988     }
 989   }
 990 }
 991
 992 const Vector3& Control::GetMaximumSize() const
 993 {
 994   return mImpl->mMaximumSize;
 995 }
 996
 997 Vector3 Control::GetNaturalSize()
 998 {
 999   // could be overridden in derived classes.
1000   return mImpl->mSetSize;
1001 }
1002
1003 float Control::GetHeightForWidth( float width )
1004 {
1005   // could be overridden in derived classes.
1006   float height( 0.0f );
1007   if ( mImpl->mSetSize.width > 0.0f )
1008   {
1009     height = mImpl->mSetSize.height * width / mImpl->mSetSize.width;
1010   }
1011   return height;
1012 }
1013
1014 float Control::GetWidthForHeight( float height )
1015 {
1016   // could be overridden in derived classes.
1017   float width( 0.0f );
1018   if ( mImpl->mSetSize.height > 0.0f )
1019   {
1020     width = mImpl->mSetSize.width * height / mImpl->mSetSize.height;
1021   }
1022   return width;
1023 }
1024
1025 const Vector3& Control::GetControlSize() const
1026 {
1027   return mImpl->mSize;
1028 }
1029
1030 const Vector3& Control::GetSizeSet() const
1031 {
1032   return mImpl->mSetSize;
1033 }
1034
1035 void Control::SetKeyInputFocus()
1036 {
1037   if( Self().OnStage() )
1038   {
1039     Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
1040   }
1041 }
1042
1043 bool Control::HasKeyInputFocus()
1044 {
1045   bool result = false;
1046   if( Self().OnStage() )
1047   {
1048     result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self()));
1049   }
1050   return result;
1051 }
1052
1053 void Control::ClearKeyInputFocus()
1054 {
1055   if( Self().OnStage() )
1056   {
1057     Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
1058   }
1059 }
1060
1061 void Control::RelayoutRequest()
1062 {
1063   Internal::RelayoutController::Get().Request();
1064 }
1065
1066 void Control::Relayout( Vector2 size, ActorSizeContainer& container )
1067 {
1068   // Avoids relayout again when OnSizeSet callback arrives.
1069   {
1070     SetSizeLock lock( mImpl->mLockSetSize );
1071     Self().SetSize( size );
1072   }
1073
1074   // Only relayout controls which requested to be relaid out.
1075   OnRelaidOut( size, container );
1076 }
1077
1078 void Control::Relayout( Actor actor, Vector2 size, ActorSizeContainer& container )
1079 {
1080   if ( actor )
1081   {
1082     Toolkit::Control control( Toolkit::Control::DownCast( actor ) );
1083     if( control )
1084     {
1085       control.GetImplementation().NegotiateSize( size, container );
1086     }
1087     else
1088     {
1089       container.push_back( ActorSizePair( actor, size ) );
1090     }
1091   }
1092 }
1093
1094 void Control::OnRelaidOut( Vector2 size, ActorSizeContainer& container )
1095 {
1096   unsigned int numChildren = Self().GetChildCount();
1097
1098   for( unsigned int i=0; i<numChildren; ++i )
1099   {
1100     container.push_back( ActorSizePair( Self().GetChildAt(i), size ) );
1101   }
1102 }
1103
1104 void Control::NegotiateSize( Vector2 allocatedSize, ActorSizeContainer& container )
1105 {
1106   Vector2 size;
1107
1108   if ( mImpl->mWidthPolicy == Toolkit::Control::Fixed )
1109   {
1110     if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed )
1111     {
1112       // If a control says it has a fixed size, then use the size set by the application / control.
1113       Vector2 setSize( mImpl->mSetSize );
1114       if ( setSize != Vector2::ZERO )
1115       {
1116         size = setSize;
1117
1118         // Policy is set to Fixed, so if the application / control has not set one of the dimensions,
1119         // then we should use the natural size of the control rather than the full allocation.
1120         if ( EqualsZero( size.width ) )
1121         {
1122           size.width = GetWidthForHeight( size.height );
1123         }
1124         else if ( EqualsZero( size.height ) )
1125         {
1126           size.height = GetHeightForWidth( size.width );
1127         }
1128       }
1129       else
1130       {
1131         // If that is not set then set the size to the control's natural size
1132         size = Vector2( GetNaturalSize() );
1133       }
1134     }
1135     else
1136     {
1137       // Width is fixed so if the application / control has set it, then use that.
1138       if ( !EqualsZero( mImpl->mSetSize.width ) )
1139       {
1140         size.width = mImpl->mSetSize.width;
1141       }
1142       else
1143       {
1144         // Otherwise, set the width to what has been allocated.
1145         size.width = allocatedSize.width;
1146       }
1147
1148       // Height is flexible so ask control what the height should be for our width.
1149       size.height = GetHeightForWidth( size.width );
1150
1151       // Ensure height is within our policy rules
1152       size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, size.height );
1153     }
1154   }
1155   else
1156   {
1157     if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed )
1158     {
1159       // Height is fixed so if the application / control has set it, then use that.
1160       if ( !EqualsZero( mImpl->mSetSize.height ) )
1161       {
1162         size.height = mImpl->mSetSize.height;
1163       }
1164       else
1165       {
1166         // Otherwise, set the height to what has been allocated.
1167         size.height = allocatedSize.height;
1168       }
1169
1170       // Width is flexible so ask control what the width should be for our height.
1171       size.width = GetWidthForHeight( size.height );
1172
1173       // Ensure width is within our policy rules
1174       size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, size.width );
1175     }
1176     else
1177     {
1178       // Width and height are BOTH flexible.
1179       // Calculate the width and height using the policy rules.
1180       size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, allocatedSize.width );
1181       size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, allocatedSize.height );
1182     }
1183   }
1184
1185   // If the width has not been set, then set to the allocated width.
1186   // Also if the width set is greater than the allocated, then set to allocated (no exceed support).
1187   if ( EqualsZero( size.width ) || ( size.width > allocatedSize.width ) )
1188   {
1189     size.width = allocatedSize.width;
1190   }
1191
1192   // If the height has not been set, then set to the allocated height.
1193   // Also if the height set is greater than the allocated, then set to allocated (no exceed support).
1194   if ( EqualsZero( size.height ) || ( size.height > allocatedSize.height ) )
1195   {
1196     size.height = allocatedSize.height;
1197   }
1198
1199   DALI_LOG_INFO( gLogFilter, Debug::Verbose,
1200                  "%p: Natural: [%.2f, %.2f] Allocated: [%.2f, %.2f] Set: [%.2f, %.2f]\n",
1201                  Self().GetObjectPtr(),
1202                  GetNaturalSize().x, GetNaturalSize().y,
1203                  allocatedSize.x, allocatedSize.y,
1204                  size.x, size.y );
1205
1206   Relayout( size, container );
1207 }
1208
1209 bool Control::EmitKeyEventSignal( const KeyEvent& event )
1210 {
1211   // Guard against destruction during signal emission
1212   Dali::Toolkit::Control handle( GetOwner() );
1213
1214   bool consumed = false;
1215
1216   // signals are allocated dynamically when someone connects
1217   if ( !mImpl->mKeyEventSignalV2.Empty() )
1218   {
1219     consumed = mImpl->mKeyEventSignalV2.Emit( handle, event );
1220   }
1221
1222   if (!consumed)
1223   {
1224     // Notification for derived classes
1225     consumed = OnKeyEvent(event);
1226   }
1227
1228   return consumed;
1229 }
1230
1231 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
1232 {
1233   mImpl->SignalConnected( slotObserver, callback );
1234 }
1235
1236 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
1237 {
1238   mImpl->SignalDisconnected( slotObserver, callback );
1239 }
1240
1241 std::size_t Control::GetConnectionCount() const
1242 {
1243   return mImpl->GetConnectionCount();
1244 }
1245
1246 Control::Control( bool requiresTouchEvents )
1247 : CustomActorImpl( requiresTouchEvents ),
1248   mImpl(new Impl(*this))
1249 {
1250 }
1251
1252 Control::Control( ControlBehaviour behaviourFlags )
1253 : CustomActorImpl( behaviourFlags & REQUIRES_TOUCH_EVENTS ),
1254   mImpl(new Impl(*this))
1255 {
1256   mImpl->mFlags = behaviourFlags;
1257 }
1258
1259 } // namespace Internal
1260
1261 } // namespace Toolkit
1262
1263 } // namespace Dali