capi/dali-toolkit/public-api/controls/control-impl.h

   1 #ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
   2 #define __DALI_TOOLKIT_CONTROL_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/control.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 class StyleManager;
  36
  37 namespace Internal DALI_INTERNAL
  38 {
  39 class RelayoutControllerImpl;
  40 class KeyInputFocusManager;
  41 }
  42
  43 typedef std::pair< Actor, Vector2 > ActorSizePair;       ///< Pair of actor and size
  44 typedef std::vector< ActorSizePair > ActorSizeContainer; ///< Container of actors and their sizes
  45
  46 namespace Internal
  47 {
  48
  49 /**
  50  * @brief This is the internal base class for all controls.
  51  *
  52  * It will provide some common functionality required by all controls.
  53  * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
  54  * be disconnected automatically when the control is destroyed.
  55  */
  56 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
  57 {
  58 public:
  59
  60   // Properties
  61   enum
  62   {
  63     CONTROL_PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX,
  64     CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
  65   };
  66
  67   // Creation
  68
  69   /**
  70    * @brief Create a new ControlImpl instance that does not require touch by default.
  71    *
  72    * If touch is required then the user can connect to this class' touch signal.
  73    * @return A handle to the ConntrolImpl instance.
  74    */
  75   static Toolkit::Control New();
  76
  77   // Destruction
  78
  79   /**
  80    * @brief Virtual destructor.
  81    */
  82   virtual ~Control();
  83
  84   // Actions
  85
  86   /**
  87    * @brief This method should be overridden by deriving classes when they wish to be notified when they
  88    * are activated.
  89    */
  90   virtual void OnActivated() { }
  91
  92   /**
  93    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
  94    * pan gesture.
  95    *
  96    * @param[in] gesture The pan gesture.
  97    * @return true if the pan gesture has been consumed by this control
  98    */
  99   virtual bool OnAccessibilityPan(PanGesture gesture);
 100
 101   /**
 102    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 103    * touch event.
 104    *
 105    * @param[in] touchEvent The touch event.
 106    * @return true if the touch event has been consumed by this control
 107    */
 108   virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
 109
 110   /**
 111    * @brief This method should be overridden by deriving classes when they wish to respond
 112    * the accessibility up and down action (i.e. value change of slider control).
 113    *
 114    * @param[in] isIncrease Whether the value should be increased or decreased
 115    * @return true if the value changed action has been consumed by this control
 116    */
 117   virtual bool OnAccessibilityValueChange(bool isIncrease);
 118
 119   /**
 120    * @brief Sets whether this control supports two dimensional
 121    * keyboard navigation (i.e. whether it knows how to handle the
 122    * keyboardn focus movement between its child actors).
 123    *
 124    * The control doesn't support it by default.
 125    * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
 126    */
 127   void SetKeyboardNavigationSupport(bool isSupported);
 128
 129   /**
 130    * @brief Gets whether this control supports two dimensional keyboard navigation.
 131    *
 132    * @return true if this control supports two dimensional keyboard navigation.
 133    */
 134   bool IsKeyboardNavigationSupported();
 135
 136   /**
 137    * @brief Sets whether this control is a focus group for keyboard navigation.
 138    *
 139    * (i.e. the scope of keyboard focus movement
 140    * can be limitied to its child actors). The control is not a focus group by default.
 141    * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
 142    */
 143   void SetAsKeyboardFocusGroup(bool isFocusGroup);
 144
 145   /**
 146    * @brief Gets whether this control is a focus group for keyboard navigation.
 147    *
 148    * @return true if this control is set as a focus group for keyboard navigation.
 149    */
 150   bool IsKeyboardFocusGroup();
 151
 152   /**
 153    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 154    *
 155    * A control needs to override this function in order to support two dimensional keyboard navigation.
 156    * @param[in] currentFocusedActor The current focused actor.
 157    * @param[in] direction The direction to move the focus towards.
 158    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
 159    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
 160    */
 161   virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
 162
 163   /**
 164    * @brief Informs this control that its chosen focusable actor will be focused.
 165    *
 166    * This allows the application to preform any actions if wishes
 167    * before the focus is actually moved to the chosen actor.
 168    *
 169    * @param[in] commitedFocusableActor The commited focusable actor.
 170    */
 171   virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) { }
 172
 173   /**
 174    * @brief Performs actions as requested using the action name.
 175    *
 176    * @param[in] object The object on which to perform the action.
 177    * @param[in] actionName The action to perform.
 178    * @param[in] attributes The attributes with which to perfrom this action.
 179    * @return true if action has been accepted by this control
 180    */
 181   static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
 182
 183   /**
 184    * @brief If deriving classes wish to fine tune pinch gesture
 185    * detection then they can access the gesture detector through this
 186    * API and modify the detection.
 187    *
 188    * @return The pinch gesture detector.
 189    * @pre Pinch detection should have been enabled via EnableGestureDetection().
 190    * @see EnableGestureDetection
 191    */
 192   PinchGestureDetector GetPinchGestureDetector() const;
 193
 194   /**
 195    * @brief If deriving classes wish to fine tune pan gesture
 196    * detection then they can access the gesture detector through this
 197    * API and modify the detection.
 198    *
 199    * @return The pan gesture detector.
 200    * @pre Pan detection should have been enabled via EnableGestureDetection().
 201    * @see EnableGestureDetection
 202    */
 203   PanGestureDetector GetPanGestureDetector() const;
 204
 205   /**
 206    * @brief If deriving classes wish to fine tune tap gesture
 207    * detection then they can access the gesture detector through this
 208    * API and modify the detection.
 209    *
 210    * @return The tap gesture detector.
 211    * @pre Tap detection should have been enabled via EnableGestureDetection().
 212    * @see EnableGestureDetection
 213    */
 214   TapGestureDetector GetTapGestureDetector() const;
 215
 216   /**
 217    * @brief If deriving classes wish to fine tune long press gesture
 218    * detection then they can access the gesture detector through this
 219    * API and modify the detection.
 220    *
 221    * @return The long press gesture detector.
 222    * @pre Long press detection should have been enabled via EnableGestureDetection().
 223    * @see EnableGestureDetection
 224    */
 225   LongPressGestureDetector GetLongPressGestureDetector() const;
 226
 227   // Background
 228
 229   /**
 230    * @copydoc Dali::Toolkit::Control::SetBackgroundColor
 231    */
 232   void SetBackgroundColor( const Vector4& color );
 233
 234   /**
 235    * @copydoc Dali::Toolkit::Control::GetBackgroundColor
 236    */
 237   Vector4 GetBackgroundColor() const;
 238
 239   /**
 240    * @copydoc Dali::Toolkit::Control::SetBackground
 241    */
 242   void SetBackground( Image image );
 243
 244   /**
 245    * @copydoc Dali::Toolkit::Control::ClearBackground
 246    */
 247   void ClearBackground();
 248
 249   /**
 250    * @copydoc Dali::Toolkit::Control::GetBackgroundActor
 251    */
 252   Actor GetBackgroundActor() const;
 253
 254 public:
 255
 256   /**
 257    * @copydoc Dali::Toolkit::Control::KeyEventSignal()
 258    */
 259   Toolkit::Control::KeyEventSignalV2& KeyEventSignal();
 260
 261 protected:
 262
 263   // Construction
 264
 265   /**
 266    * @brief Second phase initialization.
 267    */
 268   void Initialize();
 269
 270   // Gesture Detection
 271
 272   /**
 273    * @brief Allows deriving classes to enable any of the gesture detectors that are available.
 274    *
 275    * Gesture detection can be enabled one at a time or in bitwise format as shown:
 276    * @code
 277    * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
 278    * @endcode
 279    * @param[in]  type  The gesture type(s) to enable.
 280    */
 281   void EnableGestureDetection(Gesture::Type type);
 282
 283   /**
 284    * @brief Allows deriving classes to disable any of the gesture detectors.
 285    *
 286    * Like EnableGestureDetection, this can also be called using bitwise or.
 287    * @param[in]  type  The gesture type(s) to disable.
 288    * @see EnableGetureDetection
 289    */
 290   void DisableGestureDetection(Gesture::Type type);
 291
 292 private: // For derived classes to override
 293
 294   /**
 295    * @brief This method is called after the Control has been initialized.
 296    *
 297    * Derived classes should do any second phase initialization by
 298    * overriding this method.
 299    */
 300   virtual void OnInitialize() { }
 301
 302   /**
 303    * @brief This method should be overridden by deriving classes when
 304    * they wish to be notified when the style manager changes the theme.
 305    *
 306    * @param[in] styleManager  The StyleManager object.
 307    */
 308   virtual void OnThemeChange( Toolkit::StyleManager styleManager );
 309
 310   /**
 311    * @brief This method should be overridden by deriving classes when
 312    * they wish to be notified when the style changes the default font.
 313    *
 314    * @param[in] defaultFontChange  Information denoting whether the default font has changed.
 315    * @param[in] defaultFontSizeChange Information denoting whether the default font size has changed.
 316    */
 317   virtual void OnFontChange( bool defaultFontChange, bool defaultFontSizeChange ){ }
 318
 319   /**
 320    * @deprecated Use OnFontChange() instead.
 321    * Before the using of StyleManager, the StyleChange only deals with font change.
 322    *
 323    * @brief This method should be overridden by deriving classes when
 324    * they wish to be notified when the style changes.
 325    *
 326    * @param[in] change  Information denoting what has changed.
 327    */
 328   virtual void OnStyleChange( StyleChange change ) { }
 329
 330   /**
 331    * @brief Called whenever a pinch gesture is detected on this control.
 332    *
 333    * This can be overridden by deriving classes when pinch detection
 334    * is enabled.  The default behaviour is to scale the control by the
 335    * pinch scale.
 336    *
 337    * @note If overridden, then the default behaviour will not occur.
 338    * @note Pinch detection should be enabled via EnableGestureDetection().
 339    * @param[in]  pinch  The pinch gesture.
 340    * @see EnableGestureDetection
 341    */
 342   virtual void OnPinch(PinchGesture pinch);
 343
 344   /**
 345    * @brief Called whenever a pan gesture is detected on this control.
 346    *
 347    * This should be overridden by deriving classes when pan detection
 348    * is enabled.
 349    *
 350    * @note There is no default behaviour with panning.
 351    * @note Pan detection should be enabled via EnableGestureDetection().
 352    * @param[in]  pan  The pan gesture.
 353    * @see EnableGestureDetection
 354    */
 355   virtual void OnPan(PanGesture pan) { }
 356
 357   /**
 358    * @brief Called whenever a tap gesture is detected on this control.
 359    *
 360    * This should be overridden by deriving classes when tap detection
 361    * is enabled.
 362    *
 363    * @note There is no default behaviour with a tap.
 364    * @note Tap detection should be enabled via EnableGestureDetection().
 365    * @param[in]  tap  The tap gesture.
 366    * @see EnableGestureDetection
 367    */
 368   virtual void OnTap(TapGesture tap) { }
 369
 370   /**
 371    * @brief Called whenever a long press gesture is detected on this control.
 372    *
 373    * This should be overridden by deriving classes when long press
 374    * detection is enabled.
 375    *
 376    * @note There is no default behaviour associated with a long press.
 377    * @note Long press detection should be enabled via EnableGestureDetection().
 378    * @param[in]  longPress  The long press gesture.
 379    * @see EnableGestureDetection
 380    */
 381   virtual void OnLongPress(LongPressGesture longPress) { }
 382
 383   /**
 384    * @brief Called whenever the control is added to the stage.
 385    *
 386    * Could be overridden by derived classes.
 387    */
 388   virtual void OnControlStageConnection() { }
 389
 390   /**
 391    * @brief Called whenever the control is removed from the stage.
 392    *
 393    * Could be overridden by derived classes.
 394    */
 395   virtual void OnControlStageDisconnection() { }
 396
 397   /**
 398    * @brief Called whenever an Actor is added to the control.
 399    *
 400    * Could be overridden by derived classes.
 401    *
 402    * @param[in] child The added actor.
 403    */
 404   virtual void OnControlChildAdd( Actor& child ) { }
 405
 406   /**
 407    * @brief Called whenever an Actor is removed from the control.
 408    *
 409    * Could be overridden by derived classes.
 410    *
 411    * @param[in] child The removed actor.
 412    */
 413   virtual void OnControlChildRemove( Actor& child ) { }
 414
 415   /**
 416    * @brief Called whenever the Control's size is set.
 417    *
 418    * Could be overridden by derived classes.
 419    *
 420    * @param[in] size The new size.
 421    */
 422   virtual void OnControlSizeSet( const Vector3& size ) { }
 423
 424   /**
 425    * @brief Called after the Dali::Stage::SignalMessageQueueFlushed()
 426    * signal is emitted if this control requested to be relaid-out.
 427    *
 428    * Should be overridden by derived classes if they need to layout
 429    * actors differently after certain operations like add or remove
 430    * actors, resize or after changing especific properties.
 431    *
 432    * @param[in]      size       The allocated size.
 433    * @param[in,out]  container  The control should add actors to this container that it is not able
 434    *                            to allocate a size for.
 435    */
 436   virtual void OnRelaidOut( Vector2 size, ActorSizeContainer& container );
 437
 438 private: // From CustomActorImpl, derived classes can override these.
 439
 440   /**
 441    * @brief Sends a request to relayout this control.
 442    *
 443    * The control will be relaid out after the
 444    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
 445    *
 446    * It calls OnControlStageConnection() to notify derived classes.
 447    *
 448    * @see Dali::CustomActorImpl::OnStageConnection()
 449    */
 450   virtual void OnStageConnection();
 451
 452   /**
 453    * @brief Calls OnControlStageDisconnection() to notify derived classed.
 454    *
 455    * @see Dali::CustomActorImpl::OnStageDisconnection()
 456    */
 457   virtual void OnStageDisconnection();
 458
 459   /**
 460    * @brief Sends a request to relayout this control.
 461    *
 462    * The control will be relaid out after the
 463    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.  It
 464    * calls OnControlChildAdd() to notify derived classes.
 465    *
 466    * @note This method shouldn't be overridden by derived classes.
 467    *
 468    * @param[in] child The added actor.
 469    *
 470    * @see Dali::CustomActorImpl::OnChildAdd(Actor&)
 471    */
 472   virtual void OnChildAdd(Actor& child);
 473
 474   /**
 475    * @brief Sends a request to relayout this control.
 476    *
 477    * The control will be relaid out after the
 478    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.  It
 479    * calls OnControlChildRemove() to notify derived classes.
 480    *
 481    * @note This method shouldn't be overridden by derived classes.
 482    *
 483    * @param[in] child The removed actor.
 484    *
 485    * @see Dali::CustomActorImpl::OnChildRemove(Actor&)
 486    */
 487   virtual void OnChildRemove(Actor& child);
 488
 489   /**
 490    * @brief It stores the size set by size negotiation and relayout.
 491    *
 492    * It also keeps a backup of the size set through the Actor's API used in the size negotiation.
 493    * It calls the OnControlSizeSet() to notify derived classes.
 494    *
 495    * @param[in] targetSize The new size.
 496    *
 497    * @see Dali::CustomActorImpl::OnSizeSet(const Vector3&)
 498    */
 499   virtual void OnSizeSet(const Vector3& targetSize);
 500
 501   /**
 502    * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
 503    */
 504   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
 505
 506   /**
 507    * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
 508    */
 509   virtual bool OnTouchEvent(const TouchEvent& event);
 510
 511   /**
 512    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 513    */
 514   virtual bool OnKeyEvent(const KeyEvent& event);
 515
 516   /**
 517    * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
 518    */
 519   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 520
 521   /**
 522    * @copydoc Dali::CustomActorImpl::OnKeyInputFocusGained()
 523    */
 524   virtual void OnKeyInputFocusGained();
 525
 526   /**
 527    * @copydoc Dali::CustomActorImpl::OnKeyInputFocusLost()
 528    */
 529   virtual void OnKeyInputFocusLost();
 530
 531   /**
 532    * @copydoc Dali::CustomActorImpl::GetChildByAlias(const std::string& actorAlias)
 533    */
 534   virtual Actor GetChildByAlias(const std::string& actorAlias);
 535
 536 private:
 537
 538   /**
 539    * @brief Perform the activated action.
 540    *
 541    * @param[in] attributes The attributes to perfrom this action.
 542    */
 543   void DoActivatedAction(const PropertyValueContainer& attributes);
 544
 545   /**
 546    * @brief This method is the callback for the StyleChangeSignal from StyleManager
 547    *
 548    * @param[in] styleManager The StyleManager Object
 549    * @param[in] change  Information denoting what has changed.
 550    */
 551   void DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
 552
 553 protected: // Construction
 554
 555   // Flags for the constructor
 556   enum ControlBehaviour
 557   {
 558     CONTROL_BEHAVIOUR_NONE         = 0x0,
 559     REQUIRES_TOUCH_EVENTS          = 0x1,     ///< True if the OnTouchEvent() callback is required.
 560     REQUIRES_STYLE_CHANGE_SIGNALS  = 0x2      ///< True if needs to monitor style change signals such as theme/font change
 561   };
 562
 563   /**
 564    * @deprecated Use the constructor taking flags instead
 565    * @brief Create a Control.
 566    *
 567    * @param[in] requiresTouchEvents True if the OnTouchEvent() callback is required.
 568    */
 569   Control(bool requiresTouchEvents);
 570
 571   /**
 572    * @brief Create a Control.
 573    *
 574    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 575    */
 576   Control(ControlBehaviour behaviourFlags);
 577
 578 public:
 579
 580   // Size negotiation
 581
 582   /**
 583    * @copydoc Toolkit::Control::SetSizePolicy()
 584    */
 585   void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy );
 586
 587   /**
 588    * @copydoc Toolkit::Control::GetSizePolicy()
 589    */
 590   void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const;
 591
 592   /**
 593    * @copydoc Toolkit::Control::SetMinimumSize()
 594    */
 595   void SetMinimumSize( const Vector3& size );
 596
 597   /**
 598    * @copydoc Toolkit::Control::GetMinimumSize()
 599    */
 600   const Vector3& GetMinimumSize() const;
 601
 602   /**
 603    * @copydoc Toolkit::Control::SetMaximumSize()
 604    */
 605   void SetMaximumSize( const Vector3& size );
 606
 607   /**
 608    * @copydoc Toolkit::Control::GetMaximumSize()
 609    */
 610   const Vector3& GetMaximumSize() const;
 611
 612   /**
 613    * @copydoc Toolkit::Control::GetNaturalSize()
 614    */
 615   virtual Vector3 GetNaturalSize();
 616
 617   /**
 618    * @copydoc Toolkit::Control::GetHeightForWidth()
 619    */
 620   virtual float GetHeightForWidth( float width );
 621
 622   /**
 623    * @copydoc Toolkit::Control::GetWidthForHeight()
 624    */
 625   virtual float GetWidthForHeight( float height );
 626
 627   /**
 628    * @brief Retrieves the current Control's size.
 629    *
 630    * @return The control's size.
 631    */
 632   const Vector3& GetControlSize() const;
 633
 634   /**
 635    * @brief Retrieves the Control's size set by the Application / Control.
 636    *
 637    * @return The control's size.
 638    */
 639   const Vector3& GetSizeSet() const;
 640
 641   //KeyInput
 642
 643   /**
 644    * @copydoc Toolkit::Control::SetKeyInputFocus()
 645    */
 646   void SetKeyInputFocus();
 647
 648   /**
 649    * @copydoc Toolkit::Control::HasKeyInputFocus()
 650    */
 651   bool HasKeyInputFocus();
 652
 653   /**
 654    * @copydoc Toolkit::Control::ClearKeyInputFocus()
 655    */
 656   void ClearKeyInputFocus();
 657
 658   /**
 659    * @copydoc ConnectionTrackerInterface::SignalConnected
 660    */
 661   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 662
 663   /**
 664    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 665    */
 666   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 667
 668   /**
 669    * @copydoc ConnectionTrackerInterface::GetConnectionCount
 670    */
 671   virtual std::size_t GetConnectionCount() const;
 672
 673 protected:
 674
 675   /**
 676    * @brief Sends a request to be relaid-out.
 677    *
 678    * This method is called from OnStageConnection(), OnChildAdd(),
 679    * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and
 680    * SetMaximumSize().
 681    *
 682    * This method could also be called from derived classes every time
 683    * a control's poperty change and it needs to be relaid-out.  After
 684    * the Dali::Stage::SignalMessageQueueFlushed() is emitted a
 685    * relayout process starts and all controls which called this method
 686    * will be relaid-out.
 687    *
 688    * @note RelayoutRequest() only sends a request per Control before
 689    * the Dali::Stage::SignalMessageQueueFlushed() signal is
 690    * emitted. That means a control will be relaid-out only once, even
 691    * if more than one request is sent between two consecutive signals.
 692    */
 693   void RelayoutRequest();
 694
 695   /**
 696    * @brief Helper method for controls to Relayout their children if
 697    * they do not know whether that child is a control or not.
 698    *
 699    * @param[in]      actor      The actor to relayout.
 700    * @param[in]      size       The size to allocate to the actor.
 701    * @param[in,out]  container  The container that holds actors that have not been allocated a size yet.
 702    */
 703   static void Relayout( Actor actor, Vector2 size, ActorSizeContainer& container );
 704
 705 private: // Used by the RelayoutController
 706
 707   /**
 708    * @brief Called by the RelayoutController to negotiate the size of a control.
 709    *
 710    * The size allocated by the the algorithm is passed in which the
 711    * control must adhere to.  A container is passed in as well which
 712    * the control should populate with actors it has not / or does not
 713    * need to handle in its size negotiation.
 714    *
 715    * @param[in]      size       The allocated size.
 716    * @param[in,out]  container  The container that holds actors that are fed back into the
 717    *                            RelayoutController algorithm.
 718    */
 719   void NegotiateSize( Vector2 size, ActorSizeContainer& container );
 720
 721 private:
 722
 723   /**
 724    * @brief Called by NegotiateSize when the size to allocate to the control has been calculated.
 725    *
 726    * It calls the OnRelaidOut() method which can be overridden by derived classes.
 727    *
 728    * @param[in]      size       The allocated size.
 729    * @param[in,out]  container  The control should add actors to this container that it is not able
 730    *                            to allocate a size for.
 731    */
 732   void Relayout( Vector2 size, ActorSizeContainer& container );
 733
 734   /**
 735    * @brief Used by the KeyInputFocusManager to emit key event signals.
 736    *
 737    * @param[in] event The key event.
 738    * @return True if the event was consumed.
 739    */
 740   bool EmitKeyEventSignal(const KeyEvent& event);
 741
 742
 743
 744 private:
 745
 746   // Undefined
 747   Control(const Control&);
 748   Control& operator=(const Control&);
 749
 750   class Impl;
 751   Impl *mImpl;
 752
 753   friend class Internal::RelayoutControllerImpl;   ///< Relayout controller needs to call Relayout() which is private.
 754   friend class Internal::KeyInputFocusManager;     ///< KeyInputFocusManager needs to call which is private.
 755 };
 756
 757 } // namespace Internal
 758
 759 typedef Internal::Control ControlImpl; ///< @deprecated, Use Internal::Control
 760
 761 } // namespace Toolkit
 762
 763 } // namespace Dali
 764
 765 /**
 766  * @}
 767  */
 768 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__