2 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 // Licensed under the Flora License, Version 1.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
8 // http://floralicense.org/license/
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.
17 #include <dali-toolkit/public-api/controls/control-impl.h>
21 #include <dali/integration-api/debug.h>
23 #include "dali-toolkit/internal/controls/relayout-controller.h"
24 #include "dali-toolkit/internal/controls/relayout-helper.h"
25 #include "dali-toolkit/public-api/focus-manager/keyinput-focus-manager.h"
26 #include "dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h"
27 #include <dali-toolkit/public-api/controls/control.h>
29 #include <dali-toolkit/public-api/styling/style-manager.h>
30 #include <dali-toolkit/internal/styling/style-manager-impl.h>
38 const Property::Index Control::PROPERTY_BACKGROUND_COLOR = Internal::Control::CONTROL_PROPERTY_START_INDEX;
39 const Property::Index Control::PROPERTY_BACKGROUND = Internal::Control::CONTROL_PROPERTY_START_INDEX + 1;
40 const Property::Index Control::PROPERTY_WIDTH_POLICY = Internal::Control::CONTROL_PROPERTY_START_INDEX + 2;
41 const Property::Index Control::PROPERTY_HEIGHT_POLICY = Internal::Control::CONTROL_PROPERTY_START_INDEX + 3;
42 const Property::Index Control::PROPERTY_MINIMUM_SIZE = Internal::Control::CONTROL_PROPERTY_START_INDEX + 4;
43 const Property::Index Control::PROPERTY_MAXIMUM_SIZE = Internal::Control::CONTROL_PROPERTY_START_INDEX + 5;
44 const Property::Index Control::PROPERTY_KEY_INPUT_FOCUS = Internal::Control::CONTROL_PROPERTY_START_INDEX + 6;
49 const Scripting::StringEnum< Control::SizePolicy > SIZE_POLICY_STRING_TABLE[] =
51 { "FIXED", Control::Fixed },
52 { "MINIMUM", Control::Minimum },
53 { "MAXIMUM", Control::Maximum },
54 { "RANGE", Control::Range },
55 { "FLEXIBLE", Control::Flexible },
57 const unsigned int SIZE_POLICY_STRING_TABLE_COUNT = sizeof( SIZE_POLICY_STRING_TABLE ) / sizeof( SIZE_POLICY_STRING_TABLE[0] );
59 #if defined(DEBUG_ENABLED)
60 Integration::Log::Filter* gLogFilter = Integration::Log::Filter::New(Debug::NoLogging, false, "LOG_CONTROL");
63 const float MAX_FLOAT_VALUE( std::numeric_limits<float>::max() );
64 const float BACKGROUND_ACTOR_Z_POSITION( -0.1f );
68 return Internal::Control::New();
71 TypeRegistration CONTROL_TYPE( typeid(Control), typeid(CustomActor), Create );
73 // Property Registration after Internal::Control::Impl definition below
75 TypeAction ACTION_TYPE_1(CONTROL_TYPE, Toolkit::Control::ACTION_CONTROL_ACTIVATED, &Internal::Control::DoAction);
78 * Helper class used to set the Control's size through the Actor's API or through children added.
83 SetSizeLock( bool& lock )
99 * Structure which holds information about the background of a control
103 Actor actor; ///< Either a MeshActor or an ImageActor
104 Vector4 color; ///< The color of the actor.
111 color( Color::WHITE )
117 * Helper function to calculate a dimension given the policy of that dimension; the minimum &
118 * maximum values that dimension can be; and the allocated value for that dimension.
120 * @param[in] policy The size policy for that dimension.
121 * @param[in] minimum The minimum value that dimension can be.
122 * @param[in] maximum The maximum value that dimension can be.
123 * @param[in] allocated The value allocated for that dimension.
125 * @return The value that the dimension should be.
127 * @note This does not handle Control::Fixed policy.
129 float Calculate( Control::SizePolicy policy, float minimum, float maximum, float allocated )
131 float size( allocated );
137 // Use allocated value
141 case Control::Minimum:
143 // Size is always at least the minimum.
144 size = std::max( allocated, minimum );
148 case Control::Maximum:
150 // Size can grow but up to a maximum value.
151 size = std::min( allocated, maximum );
157 // Size is at least the minimum and can grow up to the maximum
158 size = std::max( size, minimum );
159 size = std::min( size, maximum );
163 case Control::Flexible:
165 // Size grows or shrinks with no limits.
172 DALI_ASSERT_DEBUG( false && "This function was not intended to be used by any other policy." );
181 * Creates a white coloured Mesh.
185 Vector3 white( Color::WHITE );
189 // Create vertices with a white color (actual color is set by actor color)
190 MeshData::VertexContainer vertices(4);
191 vertices[ 0 ] = MeshData::Vertex( Vector3( -0.5f, -0.5f, 0.0f ), Vector2::ZERO, white );
192 vertices[ 1 ] = MeshData::Vertex( Vector3( 0.5f, -0.5f, 0.0f ), Vector2::ZERO, white );
193 vertices[ 2 ] = MeshData::Vertex( Vector3( -0.5f, 0.5f, 0.0f ), Vector2::ZERO, white );
194 vertices[ 3 ] = MeshData::Vertex( Vector3( 0.5f, 0.5f, 0.0f ), Vector2::ZERO, white );
196 // Specify all the faces
197 MeshData::FaceIndices faces;
198 faces.reserve( 6 ); // 2 triangles in Quad
199 faces.push_back( 0 ); faces.push_back( 3 ); faces.push_back( 1 );
200 faces.push_back( 0 ); faces.push_back( 2 ); faces.push_back( 3 );
202 // Create the mesh data from the vertices and faces
203 meshData.SetMaterial( Material::New( "ControlMaterial" ) );
204 meshData.SetVertices( vertices );
205 meshData.SetFaceIndices( faces );
206 meshData.SetHasColor( true );
208 return Mesh::New( meshData );
212 * Sets all the required properties for the background actor.
214 * @param[in] actor The actor to set the properties on.
215 * @param[in] constrainingIndex The property index to constrain the parent's size on.
216 * @param[in] color The required color of the actor.
218 void SetupBackgroundActor( Actor actor, Property::Index constrainingIndex, const Vector4& color )
220 actor.SetColor( color );
221 actor.SetPositionInheritanceMode( USE_PARENT_POSITION_PLUS_LOCAL_POSITION );
222 actor.SetZ( BACKGROUND_ACTOR_Z_POSITION );
224 Constraint constraint = Constraint::New<Vector3>( constrainingIndex,
225 ParentSource( Actor::SIZE ),
226 EqualToConstraint() );
227 actor.ApplyConstraint( constraint );
230 } // unnamed namespace
235 class Control::Impl : public ConnectionTrackerInterface
238 // Construction & Destruction
239 Impl(Control& controlImpl)
240 : mControlImpl(controlImpl),
241 mInitialized( false ),
242 mPinchGestureDetector(),
243 mPanGestureDetector(),
244 mTapGestureDetector(),
245 mLongPressGestureDetector(),
246 mStartingPinchScale(),
247 mLockSetSize( false ),
248 mWidthPolicy( Toolkit::Control::Fixed ),
249 mHeightPolicy( Toolkit::Control::Fixed ),
253 mMaximumSize( MAX_FLOAT_VALUE, MAX_FLOAT_VALUE, MAX_FLOAT_VALUE ),
254 mIsKeyboardNavigationSupported(false),
255 mIsKeyboardFocusGroup(false),
258 mFlags( Control::CONTROL_BEHAVIOUR_NONE )
264 // All gesture detectors will be destroyed so no need to disconnect.
271 // Gesture Detection Methods
273 void PinchDetected(Actor actor, PinchGesture pinch)
275 mControlImpl.OnPinch(pinch);
278 void PanDetected(Actor actor, PanGesture pan)
280 mControlImpl.OnPan(pan);
283 void TapDetected(Actor actor, TapGesture tap)
285 mControlImpl.OnTap(tap);
288 void LongPressDetected(Actor actor, LongPressGesture longPress)
290 mControlImpl.OnLongPress(longPress);
294 * @copydoc ConnectionTrackerInterface::SignalConnected
296 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
298 mConnectionTracker.SignalConnected( slotObserver, callback );
302 * @copydoc ConnectionTrackerInterface::SignalDisconnected
304 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
306 mConnectionTracker.SignalDisconnected( slotObserver, callback );
310 * @copydoc ConnectionTrackerInterface::GetConnectionCount
312 virtual std::size_t GetConnectionCount() const
314 return mConnectionTracker.GetConnectionCount();
317 // Background Methods
320 * Only creates an instance of the background if we actually use it.
321 * @return A reference to the Background structure.
323 Background& GetBackground()
327 mBackground = new Background;
335 * Called when a property of an object of this type is set.
336 * @param[in] object The object whose property is set.
337 * @param[in] index The property index.
338 * @param[in] value The new property value.
340 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
342 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
346 Control& controlImpl( control.GetImplementation() );
350 case Toolkit::Control::PROPERTY_BACKGROUND_COLOR:
352 controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
356 case Toolkit::Control::PROPERTY_BACKGROUND:
358 if ( value.HasKey( "image" ) )
360 Property::Map imageMap = value.GetValue( "image" ).Get< Property::Map >();
361 Image image = Scripting::NewImage( imageMap );
365 controlImpl.SetBackground( image );
368 else if ( value.Get< Property::Map >().empty() )
370 // An empty map means the background is no longer required
371 controlImpl.ClearBackground();
376 case Toolkit::Control::PROPERTY_WIDTH_POLICY:
378 controlImpl.mImpl->mWidthPolicy = Scripting::GetEnumeration< Toolkit::Control::SizePolicy >( value.Get< std::string >(), SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT );
382 case Toolkit::Control::PROPERTY_HEIGHT_POLICY:
384 controlImpl.mImpl->mHeightPolicy = Scripting::GetEnumeration< Toolkit::Control::SizePolicy >( value.Get< std::string >(), SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT );
388 case Toolkit::Control::PROPERTY_MINIMUM_SIZE:
390 controlImpl.SetMinimumSize( value.Get< Vector3 >() );
394 case Toolkit::Control::PROPERTY_MAXIMUM_SIZE:
396 controlImpl.SetMaximumSize( value.Get< Vector3 >() );
400 case Toolkit::Control::PROPERTY_KEY_INPUT_FOCUS:
402 if ( value.Get< bool >() )
404 controlImpl.SetKeyInputFocus();
408 controlImpl.ClearKeyInputFocus();
417 * Called to retrieve a property of an object of this type.
418 * @param[in] object The object whose property is to be retrieved.
419 * @param[in] index The property index.
420 * @return The current value of the property.
422 static Property::Value GetProperty( BaseObject* object, Property::Index index )
424 Property::Value value;
426 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
430 Control& controlImpl( control.GetImplementation() );
434 case Toolkit::Control::PROPERTY_BACKGROUND_COLOR:
436 value = controlImpl.GetBackgroundColor();
440 case Toolkit::Control::PROPERTY_BACKGROUND:
444 Actor actor = controlImpl.GetBackgroundActor();
447 ImageActor imageActor = ImageActor::DownCast( actor );
450 Image image = imageActor.GetImage();
451 Property::Map imageMap;
452 Scripting::CreatePropertyMap( image, imageMap );
453 map.push_back( Property::StringValuePair( "image", imageMap ) );
461 case Toolkit::Control::PROPERTY_WIDTH_POLICY:
463 value = std::string( Scripting::GetEnumerationName< Toolkit::Control::SizePolicy >( controlImpl.mImpl->mWidthPolicy, SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT ) );
467 case Toolkit::Control::PROPERTY_HEIGHT_POLICY:
469 value = std::string( Scripting::GetEnumerationName< Toolkit::Control::SizePolicy >( controlImpl.mImpl->mHeightPolicy, SIZE_POLICY_STRING_TABLE, SIZE_POLICY_STRING_TABLE_COUNT ) );
473 case Toolkit::Control::PROPERTY_MINIMUM_SIZE:
475 value = controlImpl.mImpl->mMinimumSize;
479 case Toolkit::Control::PROPERTY_MAXIMUM_SIZE:
481 value = controlImpl.mImpl->mMaximumSize;
485 case Toolkit::Control::PROPERTY_KEY_INPUT_FOCUS:
487 value = controlImpl.HasKeyInputFocus();
498 Control& mControlImpl;
502 ConnectionTracker mConnectionTracker; // signal connection tracker
506 PinchGestureDetector mPinchGestureDetector;
507 PanGestureDetector mPanGestureDetector;
508 TapGestureDetector mTapGestureDetector;
509 LongPressGestureDetector mLongPressGestureDetector;
511 Vector3 mStartingPinchScale; ///< The scale when a pinch gesture starts
513 // Relayout and size negotiation
515 bool mLockSetSize; ///< Used to avoid. Can't be a bitfield as a reference to this member is used in SetSizeLock helper class.
517 Toolkit::Control::SizePolicy mWidthPolicy; ///< Stores the width policy.
518 Toolkit::Control::SizePolicy mHeightPolicy; ///< Stores the height policy.
520 Vector3 mSize; ///< Stores the current control's size.
521 Vector3 mSetSize; ///< Always stores the size set through the Actor's API. Useful when reset to the initial size is needed.
522 Vector3 mMinimumSize; ///< Stores the control's minimum size.
523 Vector3 mMaximumSize; ///< Stores the control's maximum size.
525 bool mIsKeyboardNavigationSupported; ///< Stores whether keyboard navigation is supported by the control.
526 bool mIsKeyboardFocusGroup; ///< Stores whether the control is a focus group.
528 Toolkit::Control::KeyEventSignalV2 mKeyEventSignalV2;
531 Background* mBackground; ///< Only create the background if we use it
533 ControlBehaviour mFlags; ///< Flags passed in from constructor
535 // Properties - these need to be members of Internal::Control::Impl as they need to functions within this class.
536 static PropertyRegistration PROPERTY_1;
537 static PropertyRegistration PROPERTY_2;
538 static PropertyRegistration PROPERTY_3;
539 static PropertyRegistration PROPERTY_4;
540 static PropertyRegistration PROPERTY_5;
541 static PropertyRegistration PROPERTY_6;
542 static PropertyRegistration PROPERTY_7;
545 PropertyRegistration Control::Impl::PROPERTY_1( CONTROL_TYPE, "background-color", Toolkit::Control::PROPERTY_BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
546 PropertyRegistration Control::Impl::PROPERTY_2( CONTROL_TYPE, "background", Toolkit::Control::PROPERTY_BACKGROUND, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
547 PropertyRegistration Control::Impl::PROPERTY_3( CONTROL_TYPE, "width-policy", Toolkit::Control::PROPERTY_WIDTH_POLICY, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
548 PropertyRegistration Control::Impl::PROPERTY_4( CONTROL_TYPE, "height-policy", Toolkit::Control::PROPERTY_HEIGHT_POLICY, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
549 PropertyRegistration Control::Impl::PROPERTY_5( CONTROL_TYPE, "minimum-size", Toolkit::Control::PROPERTY_MINIMUM_SIZE, Property::VECTOR3, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
550 PropertyRegistration Control::Impl::PROPERTY_6( CONTROL_TYPE, "maximum-size", Toolkit::Control::PROPERTY_MAXIMUM_SIZE, Property::VECTOR3, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
551 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 Toolkit::Control Control::New()
555 // Create the implementation, temporarily owned on stack
556 IntrusivePtr<Control> controlImpl = new Control( CONTROL_BEHAVIOUR_NONE );
558 // Pass ownership to handle
559 Toolkit::Control handle( *controlImpl );
561 // Second-phase init of the implementation
562 // This can only be done after the CustomActor connection has been made...
563 controlImpl->Initialize();
573 void Control::Initialize()
576 // Calling deriving classes
579 if( mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS )
581 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
583 // Register for style changes
584 styleManager.StyleChangeSignal().Connect( this, &ControlImpl::DoStyleChange );
587 mImpl->mInitialized = true;
590 void Control::EnableGestureDetection(Gesture::Type type)
592 if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
594 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
595 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
596 mImpl->mPinchGestureDetector.Attach(Self());
599 if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
601 mImpl->mPanGestureDetector = PanGestureDetector::New();
602 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
603 mImpl->mPanGestureDetector.Attach(Self());
606 if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
608 mImpl->mTapGestureDetector = TapGestureDetector::New();
609 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
610 mImpl->mTapGestureDetector.Attach(Self());
613 if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
615 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
616 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
617 mImpl->mLongPressGestureDetector.Attach(Self());
621 void Control::DisableGestureDetection(Gesture::Type type)
623 if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
625 mImpl->mPinchGestureDetector.Detach(Self());
626 mImpl->mPinchGestureDetector.Reset();
629 if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
631 mImpl->mPanGestureDetector.Detach(Self());
632 mImpl->mPanGestureDetector.Reset();
635 if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
637 mImpl->mTapGestureDetector.Detach(Self());
638 mImpl->mTapGestureDetector.Reset();
641 if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
643 mImpl->mLongPressGestureDetector.Detach(Self());
644 mImpl->mLongPressGestureDetector.Reset();
648 PinchGestureDetector Control::GetPinchGestureDetector() const
650 return mImpl->mPinchGestureDetector;
653 PanGestureDetector Control::GetPanGestureDetector() const
655 return mImpl->mPanGestureDetector;
658 TapGestureDetector Control::GetTapGestureDetector() const
660 return mImpl->mTapGestureDetector;
663 LongPressGestureDetector Control::GetLongPressGestureDetector() const
665 return mImpl->mLongPressGestureDetector;
668 void Control::SetBackgroundColor( const Vector4& color )
670 Background& background( mImpl->GetBackground() );
672 if ( background.actor )
674 // Just set the actor color
675 background.actor.SetColor( color );
680 MeshActor meshActor = MeshActor::New( CreateMesh() );
682 meshActor.SetAffectedByLighting( false );
683 SetupBackgroundActor( meshActor, Actor::SCALE, color );
685 // Set the background actor before adding so that we do not inform deriving classes
686 background.actor = meshActor;
687 Self().Add( meshActor );
690 background.color = color;
693 Vector4 Control::GetBackgroundColor() const
695 if ( mImpl->mBackground )
697 return mImpl->mBackground->color;
699 return Color::TRANSPARENT;
702 void Control::SetBackground( Image image )
704 Background& background( mImpl->GetBackground() );
706 if ( background.actor )
708 // Remove Current actor, unset AFTER removal so that we do not inform deriving classes
709 Self().Remove( background.actor );
710 background.actor = NULL;
713 ImageActor imageActor = ImageActor::New( image );
714 SetupBackgroundActor( imageActor, Actor::SIZE, background.color );
716 // Set the background actor before adding so that we do not inform derived classes
717 background.actor = imageActor;
718 Self().Add( imageActor );
721 void Control::ClearBackground()
723 if ( mImpl->mBackground )
725 Background& background( mImpl->GetBackground() );
726 Self().Remove( background.actor );
728 delete mImpl->mBackground;
729 mImpl->mBackground = NULL;
733 Actor Control::GetBackgroundActor() const
735 if ( mImpl->mBackground )
737 return mImpl->mBackground->actor;
743 void Control::OnThemeChange( Toolkit::StyleManager styleManager )
745 GetImpl( styleManager ).ApplyThemeStyle( GetOwner() );
748 void Control::OnPinch(PinchGesture pinch)
750 if (pinch.state == Gesture::Started)
752 mImpl->mStartingPinchScale = Self().GetCurrentScale();
755 Self().SetScale(mImpl->mStartingPinchScale * pinch.scale);
758 void Control::OnStageConnection()
762 // Notify derived classes.
763 OnControlStageConnection();
766 void Control::OnStageDisconnection()
768 // Notify derived classes
769 OnControlStageDisconnection();
772 void Control::OnChildAdd(Actor& child)
774 // If this is the background actor, then we do not want to relayout or inform deriving classes
775 if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) )
780 // Request for relayout.
783 // Notify derived classes.
784 OnControlChildAdd( child );
787 void Control::OnChildRemove(Actor& child)
789 // If this is the background actor, then we do not want to relayout or inform deriving classes
790 if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) )
795 // Request for relayout.
798 // Notify derived classes.
799 OnControlChildRemove( child );
802 void Control::OnSizeSet(const Vector3& targetSize)
804 if( ( !mImpl->mLockSetSize ) && ( targetSize != mImpl->mSetSize ) )
806 // Only updates size if set through Actor's API
807 mImpl->mSetSize = targetSize;
810 if( targetSize != mImpl->mSize )
812 // Update control size.
813 mImpl->mSize = targetSize;
815 // Notify derived classes.
816 OnControlSizeSet( targetSize );
820 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
825 bool Control::OnTouchEvent(const TouchEvent& event)
827 return false; // Do not consume
830 bool Control::OnKeyEvent(const KeyEvent& event)
832 return false; // Do not consume
835 bool Control::OnMouseWheelEvent(const MouseWheelEvent& event)
837 return false; // Do not consume
840 void Control::OnKeyInputFocusGained()
845 void Control::OnKeyInputFocusLost()
850 Actor Control::GetChildByAlias(const std::string& actorAlias)
855 bool Control::OnAccessibilityPan(PanGesture gesture)
857 return false; // Accessibility pan gesture is not handled by default
860 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
862 return false; // Accessibility touch event is not handled by default
865 bool Control::OnAccessibilityValueChange(bool isIncrease)
867 return false; // Accessibility value change action is not handled by default
871 void Control::SetKeyboardNavigationSupport(bool isSupported)
873 mImpl->mIsKeyboardNavigationSupported = isSupported;
876 bool Control::IsKeyboardNavigationSupported()
878 return mImpl->mIsKeyboardNavigationSupported;
881 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
883 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
885 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
886 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
889 bool Control::IsKeyboardFocusGroup()
891 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
894 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled)
899 bool Control::DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes)
906 void Control::DoActivatedAction(const PropertyValueContainer& attributes)
911 void Control::DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change )
913 if( change.themeChange )
915 OnThemeChange( styleManager );
917 else if( change.defaultFontChange || change.defaultFontSizeChange )
919 // This OnStyleChange(StyleChange change ) is deprecated, use OnFontChange instead
920 OnStyleChange( change );
922 OnFontChange( change.defaultFontChange, change.defaultFontSizeChange );
926 Toolkit::Control::KeyEventSignalV2& Control::KeyEventSignal()
928 return mImpl->mKeyEventSignalV2;
931 void Control::SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy )
933 bool relayoutRequest( false );
935 if ( ( mImpl->mWidthPolicy != widthPolicy ) || ( mImpl->mHeightPolicy != heightPolicy ) )
937 relayoutRequest = true;
940 mImpl->mWidthPolicy = widthPolicy;
941 mImpl->mHeightPolicy = heightPolicy;
943 // Ensure RelayoutRequest is called AFTER new policies have been set.
944 if ( relayoutRequest )
950 void Control::GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const
952 widthPolicy = mImpl->mWidthPolicy;
953 heightPolicy = mImpl->mHeightPolicy;
956 void Control::SetMinimumSize( const Vector3& size )
958 if ( mImpl->mMinimumSize != size )
960 mImpl->mMinimumSize = size;
962 // Only relayout if our control is using the minimum or range policy.
963 if ( ( mImpl->mHeightPolicy == Toolkit::Control::Minimum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Minimum ) ||
964 ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) )
971 const Vector3& Control::GetMinimumSize() const
973 return mImpl->mMinimumSize;
976 void Control::SetMaximumSize( const Vector3& size )
978 if ( mImpl->mMaximumSize != size )
980 mImpl->mMaximumSize = size;
982 // Only relayout if our control is using the maximum or range policy.
983 if ( ( mImpl->mHeightPolicy == Toolkit::Control::Maximum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Maximum ) ||
984 ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) )
991 const Vector3& Control::GetMaximumSize() const
993 return mImpl->mMaximumSize;
996 Vector3 Control::GetNaturalSize()
998 // could be overridden in derived classes.
999 return mImpl->mSetSize;
1002 float Control::GetHeightForWidth( float width )
1004 // could be overridden in derived classes.
1005 float height( 0.0f );
1006 if ( mImpl->mSetSize.width > 0.0f )
1008 height = mImpl->mSetSize.height * width / mImpl->mSetSize.width;
1013 float Control::GetWidthForHeight( float height )
1015 // could be overridden in derived classes.
1016 float width( 0.0f );
1017 if ( mImpl->mSetSize.height > 0.0f )
1019 width = mImpl->mSetSize.width * height / mImpl->mSetSize.height;
1024 const Vector3& Control::GetControlSize() const
1026 return mImpl->mSize;
1029 const Vector3& Control::GetSizeSet() const
1031 return mImpl->mSetSize;
1034 void Control::SetKeyInputFocus()
1036 if( Self().OnStage() )
1038 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
1042 bool Control::HasKeyInputFocus()
1044 bool result = false;
1045 if( Self().OnStage() )
1047 result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self()));
1052 void Control::ClearKeyInputFocus()
1054 if( Self().OnStage() )
1056 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
1060 void Control::RelayoutRequest()
1062 Internal::RelayoutController::Get().Request();
1065 void Control::Relayout( Vector2 size, ActorSizeContainer& container )
1067 // Avoids relayout again when OnSizeSet callback arrives.
1069 SetSizeLock lock( mImpl->mLockSetSize );
1070 Self().SetSize( size );
1073 // Only relayout controls which requested to be relaid out.
1074 OnRelaidOut( size, container );
1077 void Control::Relayout( Actor actor, Vector2 size, ActorSizeContainer& container )
1081 Toolkit::Control control( Toolkit::Control::DownCast( actor ) );
1084 control.GetImplementation().NegotiateSize( size, container );
1088 container.push_back( ActorSizePair( actor, size ) );
1093 void Control::OnRelaidOut( Vector2 size, ActorSizeContainer& container )
1095 unsigned int numChildren = Self().GetChildCount();
1097 for( unsigned int i=0; i<numChildren; ++i )
1099 container.push_back( ActorSizePair( Self().GetChildAt(i), size ) );
1103 void Control::NegotiateSize( Vector2 allocatedSize, ActorSizeContainer& container )
1107 if ( mImpl->mWidthPolicy == Toolkit::Control::Fixed )
1109 if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed )
1111 // If a control says it has a fixed size, then use the size set by the application / control.
1112 Vector2 setSize( mImpl->mSetSize );
1113 if ( setSize != Vector2::ZERO )
1117 // Policy is set to Fixed, so if the application / control has not set one of the dimensions,
1118 // then we should use the natural size of the control rather than the full allocation.
1119 if ( EqualsZero( size.width ) )
1121 size.width = GetWidthForHeight( size.height );
1123 else if ( EqualsZero( size.height ) )
1125 size.height = GetHeightForWidth( size.width );
1130 // If that is not set then set the size to the control's natural size
1131 size = Vector2( GetNaturalSize() );
1136 // Width is fixed so if the application / control has set it, then use that.
1137 if ( !EqualsZero( mImpl->mSetSize.width ) )
1139 size.width = mImpl->mSetSize.width;
1143 // Otherwise, set the width to what has been allocated.
1144 size.width = allocatedSize.width;
1147 // Height is flexible so ask control what the height should be for our width.
1148 size.height = GetHeightForWidth( size.width );
1150 // Ensure height is within our policy rules
1151 size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, size.height );
1156 if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed )
1158 // Height is fixed so if the application / control has set it, then use that.
1159 if ( !EqualsZero( mImpl->mSetSize.height ) )
1161 size.height = mImpl->mSetSize.height;
1165 // Otherwise, set the height to what has been allocated.
1166 size.height = allocatedSize.height;
1169 // Width is flexible so ask control what the width should be for our height.
1170 size.width = GetWidthForHeight( size.height );
1172 // Ensure width is within our policy rules
1173 size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, size.width );
1177 // Width and height are BOTH flexible.
1178 // Calculate the width and height using the policy rules.
1179 size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, allocatedSize.width );
1180 size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, allocatedSize.height );
1184 // If the width has not been set, then set to the allocated width.
1185 // Also if the width set is greater than the allocated, then set to allocated (no exceed support).
1186 if ( EqualsZero( size.width ) || ( size.width > allocatedSize.width ) )
1188 size.width = allocatedSize.width;
1191 // If the height has not been set, then set to the allocated height.
1192 // Also if the height set is greater than the allocated, then set to allocated (no exceed support).
1193 if ( EqualsZero( size.height ) || ( size.height > allocatedSize.height ) )
1195 size.height = allocatedSize.height;
1198 DALI_LOG_INFO( gLogFilter, Debug::Verbose,
1199 "%p: Natural: [%.2f, %.2f] Allocated: [%.2f, %.2f] Set: [%.2f, %.2f]\n",
1200 Self().GetObjectPtr(),
1201 GetNaturalSize().x, GetNaturalSize().y,
1202 allocatedSize.x, allocatedSize.y,
1205 Relayout( size, container );
1208 bool Control::EmitKeyEventSignal( const KeyEvent& event )
1210 // Guard against destruction during signal emission
1211 Dali::Toolkit::Control handle( GetOwner() );
1213 bool consumed = false;
1215 // signals are allocated dynamically when someone connects
1216 if ( !mImpl->mKeyEventSignalV2.Empty() )
1218 consumed = mImpl->mKeyEventSignalV2.Emit( handle, event );
1223 // Notification for derived classes
1224 consumed = OnKeyEvent(event);
1230 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
1232 mImpl->SignalConnected( slotObserver, callback );
1235 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
1237 mImpl->SignalDisconnected( slotObserver, callback );
1240 std::size_t Control::GetConnectionCount() const
1242 return mImpl->GetConnectionCount();
1245 Control::Control( bool requiresTouchEvents )
1246 : CustomActorImpl( requiresTouchEvents ),
1247 mImpl(new Impl(*this))
1251 Control::Control( ControlBehaviour behaviourFlags )
1252 : CustomActorImpl( behaviourFlags & REQUIRES_TOUCH_EVENTS ),
1253 mImpl(new Impl(*this))
1255 mImpl->mFlags = behaviourFlags;
1258 } // namespace Internal
1260 } // namespace Toolkit