X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol-impl.cpp;h=16b4e6738493aaa88c80ffa9845f6755444aedc8;hp=93e011714efc49a87a3bdaa279648e4a108c2904;hb=4b347781c8761d2909b235ded2e98d272fa9ac16;hpb=e2eda444afbe82e9591fe198eef339227f90a616 diff --git a/dali-toolkit/public-api/controls/control-impl.cpp b/dali-toolkit/public-api/controls/control-impl.cpp index 93e0117..16b4e67 100644 --- a/dali-toolkit/public-api/controls/control-impl.cpp +++ b/dali-toolkit/public-api/controls/control-impl.cpp @@ -1,32 +1,44 @@ -// -// Copyright (c) 2014 Samsung Electronics Co., Ltd. -// -// Licensed under the Flora License, Version 1.0 (the License); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://floralicense.org/license/ -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an AS IS BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// +/* + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +// CLASS HEADER #include -#include +// EXTERNAL INCLUDES +#include // for strcmp +#include #include - +#include +#include +#include +#include +#include +#include +#include +#include +#include #include -#include "dali-toolkit/internal/controls/style-change-processor.h" -#include "dali-toolkit/internal/controls/relayout-controller.h" -#include "dali-toolkit/internal/controls/relayout-helper.h" -#include "dali-toolkit/public-api/focus-manager/keyinput-focus-manager.h" -#include "dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h" +// INTERNAL INCLUDES +#include +#include #include +#include +#include namespace Dali { @@ -42,221 +54,353 @@ Integration::Log::Filter* gLogFilter = Integration::Log::Filter::New(Debug::NoL #endif const float MAX_FLOAT_VALUE( std::numeric_limits::max() ); +const Vector3 MAX_SIZE( MAX_FLOAT_VALUE, MAX_FLOAT_VALUE, MAX_FLOAT_VALUE ); +const float BACKGROUND_ACTOR_Z_POSITION( -0.1f ); BaseHandle Create() { - return ControlImpl::New(); + return Internal::Control::New(); } -TypeRegistration CONTROL_TYPE( typeid(Control), typeid(CustomActor), Create ); +// Setup signals and actions using the type-registry. +DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create ); + +// Note: Properties are registered separately below, + +DALI_SIGNAL_REGISTRATION( Control, "key-event", SIGNAL_KEY_EVENT ) +DALI_SIGNAL_REGISTRATION( Control, "tapped", SIGNAL_TAPPED ) +DALI_SIGNAL_REGISTRATION( Control, "panned", SIGNAL_PANNED ) +DALI_SIGNAL_REGISTRATION( Control, "pinched", SIGNAL_PINCHED ) +DALI_SIGNAL_REGISTRATION( Control, "long-pressed", SIGNAL_LONG_PRESSED ) -TypeAction ACTION_TYPE_1(CONTROL_TYPE, Toolkit::Control::ACTION_CONTROL_ACTIVATED, &ControlImpl::DoAction); +DALI_ACTION_REGISTRATION( Control, "control-activated", ACTION_CONTROL_ACTIVATED ) + +DALI_TYPE_REGISTRATION_END() /** - * Helper class used to set the Control's size through the Actor's API or through children added. + * Structure which holds information about the background of a control */ -class SetSizeLock +struct Background { -public: - SetSizeLock( bool& lock ) - : mLock( lock ) - { - mLock = true; - } + Actor actor; ///< Either a MeshActor or an ImageActor + Vector4 color; ///< The color of the actor. - ~SetSizeLock() + /** + * Constructor + */ + Background() + : actor(), + color( Color::WHITE ) { - mLock = false; } - -private: - bool& mLock; }; /** - * Helper function to calculate a dimension given the policy of that dimension; the minimum & - * maximum values that dimension can be; and the allocated value for that dimension. - * - * @param[in] policy The size policy for that dimension. - * @param[in] minimum The minimum value that dimension can be. - * @param[in] maximum The maximum value that dimension can be. - * @param[in] allocated The value allocated for that dimension. - * - * @return The value that the dimension should be. - * - * @note This does not handle Control::Fixed policy. + * Creates a white coloured Mesh. */ -float Calculate( Control::SizePolicy policy, float minimum, float maximum, float allocated ) +Mesh CreateMesh() { - float size( allocated ); - - switch( policy ) - { - case Control::Fixed: - { - // Use allocated value - break; - } - - case Control::Minimum: - { - // Size is always at least the minimum. - size = std::max( allocated, minimum ); - break; - } - - case Control::Maximum: - { - // Size can grow but up to a maximum value. - size = std::min( allocated, maximum ); - break; - } - - case Control::Range: - { - // Size is at least the minimum and can grow up to the maximum - size = std::max( size, minimum ); - size = std::min( size, maximum ); - break; - } - - case Control::Flexible: - { - // Size grows or shrinks with no limits. - size = allocated; - break; - } - - default: - { - DALI_ASSERT_DEBUG( false && "This function was not intended to be used by any other policy." ); - break; - } - } + Vector3 white( Color::WHITE ); + + MeshData meshData; + + // Create vertices with a white color (actual color is set by actor color) + MeshData::VertexContainer vertices(4); + vertices[ 0 ] = MeshData::Vertex( Vector3( -0.5f, -0.5f, 0.0f ), Vector2::ZERO, white ); + vertices[ 1 ] = MeshData::Vertex( Vector3( 0.5f, -0.5f, 0.0f ), Vector2::ZERO, white ); + vertices[ 2 ] = MeshData::Vertex( Vector3( -0.5f, 0.5f, 0.0f ), Vector2::ZERO, white ); + vertices[ 3 ] = MeshData::Vertex( Vector3( 0.5f, 0.5f, 0.0f ), Vector2::ZERO, white ); + + // Specify all the faces + MeshData::FaceIndices faces; + faces.reserve( 6 ); // 2 triangles in Quad + faces.push_back( 0 ); faces.push_back( 3 ); faces.push_back( 1 ); + faces.push_back( 0 ); faces.push_back( 2 ); faces.push_back( 3 ); + + // Create the mesh data from the vertices and faces + meshData.SetMaterial( Material::New( "ControlMaterial" ) ); + meshData.SetVertices( vertices ); + meshData.SetFaceIndices( faces ); + meshData.SetHasColor( true ); + + return Mesh::New( meshData ); +} - return size; +/** + * Sets all the required properties for the background actor. + * + * @param[in] actor The actor to set the properties on. + * @param[in] constrainingIndex The property index to constrain the parent's size on. + * @param[in] color The required color of the actor. + */ +void SetupBackgroundActor( Actor actor, Property::Index constrainingIndex, const Vector4& color ) +{ + actor.SetColor( color ); + actor.SetPositionInheritanceMode( USE_PARENT_POSITION_PLUS_LOCAL_POSITION ); + actor.SetColorMode( USE_OWN_MULTIPLY_PARENT_COLOR ); + actor.SetZ( BACKGROUND_ACTOR_Z_POSITION ); + actor.SetRelayoutEnabled( false ); + + Constraint constraint = Constraint::New( actor, + constrainingIndex, + EqualToConstraint() ); + constraint.AddSource( ParentSource( Actor::Property::SIZE ) ); + constraint.Apply(); } } // unnamed namespace -class ControlImpl::Impl : public ConnectionTrackerInterface +namespace Internal { + +class Control::Impl : public ConnectionTracker +{ +public: + + /** + * Size indices for mMinMaxSize array + */ + enum + { + MIN_SIZE_INDEX = 0, + MAX_SIZE_INDEX = 1 + }; + public: // Construction & Destruction - Impl(ControlImpl& controlImpl) - : mControlImpl(controlImpl), - mInitialized( false ), + Impl(Control& controlImpl) + : mControlImpl( controlImpl ), + mStyleName(""), + mBackground( NULL ), + mStartingPinchScale( NULL ), + mKeyEventSignal(), mPinchGestureDetector(), mPanGestureDetector(), mTapGestureDetector(), mLongPressGestureDetector(), - mStartingPinchScale(), - mLockSetSize( false ), - mWidthPolicy( Control::Fixed ), - mHeightPolicy( Control::Fixed ), - mSize(), - mSetSize(), - mMinimumSize(), - mMaximumSize( MAX_FLOAT_VALUE, MAX_FLOAT_VALUE, MAX_FLOAT_VALUE ), - mIsKeyboardNavigationSupported(false), - mIsKeyboardFocusGroup(false), - mKeyEventSignalV2() + mCurrentSize(), + mNaturalSize(), + mFlags( Control::CONTROL_BEHAVIOUR_NONE ), + mIsKeyboardNavigationSupported( false ), + mIsKeyboardFocusGroup( false ), + mInitialized( false ) { } ~Impl() { // All gesture detectors will be destroyed so no need to disconnect. + delete mBackground; + delete mStartingPinchScale; } // Gesture Detection Methods - void PinchDetected(Actor actor, PinchGesture pinch) + void PinchDetected(Actor actor, const PinchGesture& pinch) { mControlImpl.OnPinch(pinch); } - void PanDetected(Actor actor, PanGesture pan) + void PanDetected(Actor actor, const PanGesture& pan) { mControlImpl.OnPan(pan); } - void TapDetected(Actor actor, TapGesture tap) + void TapDetected(Actor actor, const TapGesture& tap) { mControlImpl.OnTap(tap); } - void LongPressDetected(Actor actor, LongPressGesture longPress) + void LongPressDetected(Actor actor, const LongPressGesture& longPress) { mControlImpl.OnLongPress(longPress); } + // Background Methods + /** - * @copydoc ConnectionTrackerInterface::SignalConnected + * Only creates an instance of the background if we actually use it. + * @return A reference to the Background structure. */ - virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) + Background& GetBackground() { - mConnectionTracker.SignalConnected( slotObserver, callback ); + if ( !mBackground ) + { + mBackground = new Background; + } + return *mBackground; } + // Properties + /** - * @copydoc ConnectionTrackerInterface::SignalDisconnected + * Called when a property of an object of this type is set. + * @param[in] object The object whose property is set. + * @param[in] index The property index. + * @param[in] value The new property value. */ - virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) + static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ) { - mConnectionTracker.SignalDisconnected( slotObserver, callback ); + Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) ); + + if ( control ) + { + Control& controlImpl( control.GetImplementation() ); + + switch ( index ) + { + case Toolkit::Control::Property::STYLE_NAME: + { + controlImpl.SetStyleName( value.Get< std::string >() ); + break; + } + + case Toolkit::Control::Property::BACKGROUND_COLOR: + { + controlImpl.SetBackgroundColor( value.Get< Vector4 >() ); + break; + } + + case Toolkit::Control::Property::BACKGROUND_IMAGE: + { + if ( value.HasKey( "image" ) ) + { + Property::Map imageMap = value.GetValue( "image" ).Get< Property::Map >(); + Image image = Scripting::NewImage( imageMap ); + + if ( image ) + { + controlImpl.SetBackgroundImage( image ); + } + } + else if ( value.Get< Property::Map >().Empty() ) + { + // An empty map means the background is no longer required + controlImpl.ClearBackground(); + } + break; + } + + case Toolkit::Control::Property::KEY_INPUT_FOCUS: + { + if ( value.Get< bool >() ) + { + controlImpl.SetKeyInputFocus(); + } + else + { + controlImpl.ClearKeyInputFocus(); + } + break; + } + } + } } /** - * @copydoc ConnectionTrackerInterface::GetConnectionCount + * Called to retrieve a property of an object of this type. + * @param[in] object The object whose property is to be retrieved. + * @param[in] index The property index. + * @return The current value of the property. */ - virtual std::size_t GetConnectionCount() const + static Property::Value GetProperty( BaseObject* object, Property::Index index ) { - return mConnectionTracker.GetConnectionCount(); - } - - // Data + Property::Value value; - ControlImpl& mControlImpl; + Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) ); - bool mInitialized:1; - - ConnectionTracker mConnectionTracker; // signal connection tracker - - // Gesture Detection + if ( control ) + { + Control& controlImpl( control.GetImplementation() ); - PinchGestureDetector mPinchGestureDetector; - PanGestureDetector mPanGestureDetector; - TapGestureDetector mTapGestureDetector; - LongPressGestureDetector mLongPressGestureDetector; + switch ( index ) + { + case Toolkit::Control::Property::STYLE_NAME: + { + value = controlImpl.GetStyleName(); + break; + } - Vector3 mStartingPinchScale; ///< The scale when a pinch gesture starts + case Toolkit::Control::Property::BACKGROUND_COLOR: + { + value = controlImpl.GetBackgroundColor(); + break; + } - // Relayout and size negotiation + case Toolkit::Control::Property::BACKGROUND_IMAGE: + { + Property::Map map; + + Actor actor = controlImpl.GetBackgroundActor(); + if ( actor ) + { + ImageActor imageActor = ImageActor::DownCast( actor ); + if ( imageActor ) + { + Image image = imageActor.GetImage(); + Property::Map imageMap; + Scripting::CreatePropertyMap( image, imageMap ); + map[ "image" ] = imageMap; + } + } + + value = map; + break; + } - bool mLockSetSize; ///< Used to avoid. Can't be a bitfield as a reference to this member is used in SetSizeLock helper class. + case Toolkit::Control::Property::KEY_INPUT_FOCUS: + { + value = controlImpl.HasKeyInputFocus(); + break; + } + } + } - Control::SizePolicy mWidthPolicy; ///< Stores the width policy. - Control::SizePolicy mHeightPolicy; ///< Stores the height policy. + return value; + } - Vector3 mSize; ///< Stores the current control's size. - Vector3 mSetSize; ///< Always stores the size set through the Actor's API. Useful when reset to the initial size is needed. - Vector3 mMinimumSize; ///< Stores the control's minimum size. - Vector3 mMaximumSize; ///< Stores the control's maximum size. + // Data - bool mIsKeyboardNavigationSupported; ///< Stores whether keyboard navigation is supported by the control. - bool mIsKeyboardFocusGroup; ///< Stores whether the control is a focus group. + Control& mControlImpl; + std::string mStyleName; + Background* mBackground; ///< Only create the background if we use it + Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this + Toolkit::Control::KeyEventSignalType mKeyEventSignal; - Toolkit::Control::KeyEventSignalV2 mKeyEventSignalV2; + // Gesture Detection + PinchGestureDetector mPinchGestureDetector; + PanGestureDetector mPanGestureDetector; + TapGestureDetector mTapGestureDetector; + LongPressGestureDetector mLongPressGestureDetector; + // @todo change all these to Vector2 when we have a chance to sanitize the public API as well + Vector3 mCurrentSize; ///< Stores the current control's size, this is the negotiated size + Vector3 mNaturalSize; ///< Stores the size set through the Actor's API. This is size the actor wants to be. Useful when reset to the initial size is needed. + + ControlBehaviour mFlags :6; ///< Flags passed in from constructor. Need to increase this size when new enums are added + bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control. + bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group. + bool mInitialized :1; + + // Properties - these need to be members of Internal::Control::Impl as they need to function within this class. + static PropertyRegistration PROPERTY_1; + static PropertyRegistration PROPERTY_2; + static PropertyRegistration PROPERTY_3; + static PropertyRegistration PROPERTY_4; }; -Control ControlImpl::New() +// Properties registered without macro to use specific member variables. +PropertyRegistration Control::Impl::PROPERTY_1( typeRegistration, "style-name", Toolkit::Control::Property::STYLE_NAME, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty ); +PropertyRegistration Control::Impl::PROPERTY_2( typeRegistration, "background-color", Toolkit::Control::Property::BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty ); +PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "background-image", Toolkit::Control::Property::BACKGROUND_IMAGE, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty ); +PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "key-input-focus", Toolkit::Control::Property::KEY_INPUT_FOCUS, Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty ); + +Toolkit::Control Control::New() { // Create the implementation, temporarily owned on stack - IntrusivePtr controlImpl = new ControlImpl( false ); + IntrusivePtr controlImpl = new Control( CONTROL_BEHAVIOUR_NONE ); // Pass ownership to handle - Control handle( *controlImpl ); + Toolkit::Control handle( *controlImpl ); // Second-phase init of the implementation // This can only be done after the CustomActor connection has been made... @@ -265,575 +409,617 @@ Control ControlImpl::New() return handle; } -ControlImpl::~ControlImpl() +Control::~Control() { - if( mImpl->mInitialized ) - { - // Unregister only if control has been initialized. - Internal::StyleChangeProcessor::Unregister( this ); - } delete mImpl; } -void ControlImpl::Initialize() +Vector3 Control::GetNaturalSize() { - // Register with the style change processor so we are informed when the default style changes - Internal::StyleChangeProcessor::Register( this ); - - // Calling deriving classes - OnInitialize(); + // could be overridden in derived classes. + return mImpl->mNaturalSize; +} - mImpl->mInitialized = true; +float Control::CalculateChildSize( const Dali::Actor& child, Dimension dimension ) +{ + // Could be overridden in derived classes. + return CalculateChildSizeBase( child, dimension ); } -void ControlImpl::EnableGestureDetection(Gesture::Type type) +bool Control::RelayoutDependentOnChildren( Dimension dimension ) { - if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector ) - { - mImpl->mPinchGestureDetector = PinchGestureDetector::New(); - mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected); - mImpl->mPinchGestureDetector.Attach(Self()); - } + return RelayoutDependentOnChildrenBase( dimension ); +} - if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector ) +float Control::GetHeightForWidth( float width ) +{ + // could be overridden in derived classes. + float height( 0.0f ); + if ( mImpl->mNaturalSize.width > 0.0f ) { - mImpl->mPanGestureDetector = PanGestureDetector::New(); - mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected); - mImpl->mPanGestureDetector.Attach(Self()); + height = mImpl->mNaturalSize.height * width / mImpl->mNaturalSize.width; } + return height; +} - if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector ) +float Control::GetWidthForHeight( float height ) +{ + // could be overridden in derived classes. + float width( 0.0f ); + if ( mImpl->mNaturalSize.height > 0.0f ) { - mImpl->mTapGestureDetector = TapGestureDetector::New(); - mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected); - mImpl->mTapGestureDetector.Attach(Self()); + width = mImpl->mNaturalSize.width * height / mImpl->mNaturalSize.height; } + return width; +} - if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector ) - { - mImpl->mLongPressGestureDetector = LongPressGestureDetector::New(); - mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected); - mImpl->mLongPressGestureDetector.Attach(Self()); - } +const Vector3& Control::GetControlSize() const +{ + return mImpl->mCurrentSize; } -void ControlImpl::DisableGestureDetection(Gesture::Type type) +const Vector3& Control::GetSizeSet() const { - if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector ) - { - mImpl->mPinchGestureDetector.Detach(Self()); - mImpl->mPinchGestureDetector.Reset(); - } + return mImpl->mNaturalSize; +} - if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector ) +void Control::SetKeyInputFocus() +{ + if( Self().OnStage() ) { - mImpl->mPanGestureDetector.Detach(Self()); - mImpl->mPanGestureDetector.Reset(); + Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self())); } +} - if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector ) +bool Control::HasKeyInputFocus() +{ + bool result = false; + if( Self().OnStage() ) { - mImpl->mTapGestureDetector.Detach(Self()); - mImpl->mTapGestureDetector.Reset(); + result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self())); } + return result; +} - if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector) +void Control::ClearKeyInputFocus() +{ + if( Self().OnStage() ) { - mImpl->mLongPressGestureDetector.Detach(Self()); - mImpl->mLongPressGestureDetector.Reset(); + Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self())); } } -PinchGestureDetector ControlImpl::GetPinchGestureDetector() const +PinchGestureDetector Control::GetPinchGestureDetector() const { return mImpl->mPinchGestureDetector; } -PanGestureDetector ControlImpl::GetPanGestureDetector() const +PanGestureDetector Control::GetPanGestureDetector() const { return mImpl->mPanGestureDetector; } -TapGestureDetector ControlImpl::GetTapGestureDetector() const +TapGestureDetector Control::GetTapGestureDetector() const { return mImpl->mTapGestureDetector; } -LongPressGestureDetector ControlImpl::GetLongPressGestureDetector() const +LongPressGestureDetector Control::GetLongPressGestureDetector() const { return mImpl->mLongPressGestureDetector; } -void ControlImpl::OnPinch(PinchGesture pinch) +void Control::SetStyleName( const std::string& styleName ) { - if (pinch.state == Gesture::Started) + if( styleName != mImpl->mStyleName ) { - mImpl->mStartingPinchScale = Self().GetCurrentScale(); - } + mImpl->mStyleName = styleName; - Self().SetScale(mImpl->mStartingPinchScale * pinch.scale); + // Apply new style + Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get(); + GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) ); + } } -void ControlImpl::OnStageConnection() +const std::string& Control::GetStyleName() const { - RelayoutRequest(); - - // Notify derived classes. - OnControlStageConnection(); + return mImpl->mStyleName; } -void ControlImpl::OnStageDisconnection() +void Control::SetBackgroundColor( const Vector4& color ) { - // Notify derived classes - OnControlStageDisconnection(); -} + Background& background( mImpl->GetBackground() ); -void ControlImpl::OnChildAdd(Actor& child) -{ - // Request for relayout. - RelayoutRequest(); + if ( background.actor ) + { + // Just set the actor color + background.actor.SetColor( color ); + } + else + { + // Create Mesh Actor + MeshActor meshActor = MeshActor::New( CreateMesh() ); - // Notify derived classes. - OnControlChildAdd( child ); -} + SetupBackgroundActor( meshActor, Actor::Property::SCALE, color ); -void ControlImpl::OnChildRemove(Actor& child) -{ - // Request for relayout. - RelayoutRequest(); + // Set the background actor before adding so that we do not inform deriving classes + background.actor = meshActor; + Self().Add( meshActor ); + } - // Notify derived classes. - OnControlChildRemove( child ); + background.color = color; } -void ControlImpl::OnSizeSet(const Vector3& targetSize) +Vector4 Control::GetBackgroundColor() const { - if( ( !mImpl->mLockSetSize ) && ( targetSize != mImpl->mSetSize ) ) + if ( mImpl->mBackground ) { - // Only updates size if set through Actor's API - mImpl->mSetSize = targetSize; + return mImpl->mBackground->color; } + return Color::TRANSPARENT; +} - if( targetSize != mImpl->mSize ) - { - // Update control size. - mImpl->mSize = targetSize; +void Control::SetBackgroundImage( Image image ) +{ + Background& background( mImpl->GetBackground() ); - // Notify derived classes. - OnControlSizeSet( targetSize ); + if ( background.actor ) + { + // Remove Current actor, unset AFTER removal so that we do not inform deriving classes + Self().Remove( background.actor ); + background.actor.Reset(); } -} -void ControlImpl::OnSizeAnimation(Animation& animation, const Vector3& targetSize) -{ - // Do Nothing -} + ImageActor imageActor = ImageActor::New( image ); + SetupBackgroundActor( imageActor, Actor::Property::SIZE, background.color ); -bool ControlImpl::OnTouchEvent(const TouchEvent& event) -{ - return false; // Do not consume + // Set the background actor before adding so that we do not inform derived classes + background.actor = imageActor; + Self().Add( imageActor ); } -bool ControlImpl::OnKeyEvent(const KeyEvent& event) +void Control::ClearBackground() { - return false; // Do not consume -} + if ( mImpl->mBackground ) + { + Background& background( mImpl->GetBackground() ); + Self().Remove( background.actor ); -bool ControlImpl::OnMouseWheelEvent(const MouseWheelEvent& event) -{ - return false; // Do not consume + delete mImpl->mBackground; + mImpl->mBackground = NULL; + } } -void ControlImpl::OnKeyInputFocusGained() +Actor Control::GetBackgroundActor() const { - // Do Nothing + if ( mImpl->mBackground ) + { + return mImpl->mBackground->actor; + } + + return Actor(); } -void ControlImpl::OnKeyInputFocusLost() +void Control::SetKeyboardNavigationSupport(bool isSupported) { - // Do Nothing + mImpl->mIsKeyboardNavigationSupported = isSupported; } -Actor ControlImpl::GetChildByAlias(const std::string& actorAlias) +bool Control::IsKeyboardNavigationSupported() { - return Actor(); + return mImpl->mIsKeyboardNavigationSupported; } -bool ControlImpl::OnAccessibilityPan(PanGesture gesture) +void Control::Activate() { - return false; // Accessibility pan gesture is not handled by default + // Inform deriving classes + OnActivated(); } -bool ControlImpl::OnAccessibilityValueChange(bool isIncrease) +bool Control::OnAccessibilityPan(PanGesture gesture) { - return false; // Accessibility value change action is not handled by default + return false; // Accessibility pan gesture is not handled by default } - -void ControlImpl::SetKeyboardNavigationSupport(bool isSupported) +bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent) { - mImpl->mIsKeyboardNavigationSupported = isSupported; + return false; // Accessibility touch event is not handled by default } -bool ControlImpl::IsKeyboardNavigationSupported() +bool Control::OnAccessibilityValueChange(bool isIncrease) { - return mImpl->mIsKeyboardNavigationSupported; + return false; // Accessibility value change action is not handled by default } -void ControlImpl::SetAsKeyboardFocusGroup(bool isFocusGroup) +void Control::SetAsKeyboardFocusGroup(bool isFocusGroup) { mImpl->mIsKeyboardFocusGroup = isFocusGroup; // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted - KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup); + Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup); } -bool ControlImpl::IsKeyboardFocusGroup() +bool Control::IsKeyboardFocusGroup() { - return KeyboardFocusManager::Get().IsFocusGroup(Self()); + return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self()); } -Actor ControlImpl::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled) +Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled) { return Actor(); } -bool ControlImpl::DoAction(BaseObject* object, const std::string& actionName, const std::vector& attributes) +void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) +{ +} + +bool Control::DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes) { bool ret = false; + if( object && ( 0 == strcmp( actionName.c_str(), ACTION_CONTROL_ACTIVATED ) ) ) + { + Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) ); + if( control ) + { + // if cast succeeds there is an implementation so no need to check + control.GetImplementation().OnActivated(); + } + } + return ret; } -void ControlImpl::DoActivatedAction(const PropertyValueContainer& attributes) +bool Control::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ) { - OnActivated(); + Dali::BaseHandle handle( object ); + + bool connected( false ); + Toolkit::Control control = Toolkit::Control::DownCast( handle ); + if ( control ) + { + Control& controlImpl( control.GetImplementation() ); + connected = true; + + if ( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) ) + { + controlImpl.KeyEventSignal().Connect( tracker, functor ); + } + else if( 0 == strcmp( signalName.c_str(), SIGNAL_TAPPED ) ) + { + controlImpl.EnableGestureDetection( Gesture::Tap ); + controlImpl.GetTapGestureDetector().DetectedSignal().Connect( tracker, functor ); + } + else if( 0 == strcmp( signalName.c_str(), SIGNAL_PANNED ) ) + { + controlImpl.EnableGestureDetection( Gesture::Pan ); + controlImpl.GetPanGestureDetector().DetectedSignal().Connect( tracker, functor ); + } + else if( 0 == strcmp( signalName.c_str(), SIGNAL_PINCHED ) ) + { + controlImpl.EnableGestureDetection( Gesture::Pinch ); + controlImpl.GetPinchGestureDetector().DetectedSignal().Connect( tracker, functor ); + } + else if( 0 == strcmp( signalName.c_str(), SIGNAL_LONG_PRESSED ) ) + { + controlImpl.EnableGestureDetection( Gesture::LongPress ); + controlImpl.GetLongPressGestureDetector().DetectedSignal().Connect( tracker, functor ); + } + else + { + // signalName does not match any signal + connected = false; + } + } + return connected; } -Toolkit::Control::KeyEventSignalV2& ControlImpl::KeyEventSignal() +Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal() { - return mImpl->mKeyEventSignalV2; + return mImpl->mKeyEventSignal; } -void ControlImpl::SetSizePolicy( Control::SizePolicy widthPolicy, Control::SizePolicy heightPolicy ) +bool Control::EmitKeyEventSignal( const KeyEvent& event ) { - bool relayoutRequest( false ); + // Guard against destruction during signal emission + Dali::Toolkit::Control handle( GetOwner() ); + + bool consumed = false; - if ( ( mImpl->mWidthPolicy != widthPolicy ) || ( mImpl->mHeightPolicy != heightPolicy ) ) + // signals are allocated dynamically when someone connects + if ( !mImpl->mKeyEventSignal.Empty() ) { - relayoutRequest = true; + consumed = mImpl->mKeyEventSignal.Emit( handle, event ); } - mImpl->mWidthPolicy = widthPolicy; - mImpl->mHeightPolicy = heightPolicy; - - // Ensure RelayoutRequest is called AFTER new policies have been set. - if ( relayoutRequest ) + if (!consumed) { - RelayoutRequest(); + // Notification for derived classes + consumed = OnKeyEvent(event); } + + return consumed; } -void ControlImpl::GetSizePolicy( Control::SizePolicy& widthPolicy, Control::SizePolicy& heightPolicy ) const +Control::Control( ControlBehaviour behaviourFlags ) +: CustomActorImpl( behaviourFlags & REQUIRES_TOUCH_EVENTS ), + mImpl(new Impl(*this)) { - widthPolicy = mImpl->mWidthPolicy; - heightPolicy = mImpl->mHeightPolicy; + mImpl->mFlags = behaviourFlags; } -void ControlImpl::SetMinimumSize( const Vector3& size ) +void Control::Initialize() { - if ( mImpl->mMinimumSize != size ) + // Calling deriving classes + OnInitialize(); + + // Test if the no size negotiation flag is not set + if( ( mImpl->mFlags & NO_SIZE_NEGOTIATION ) == 0 ) { - mImpl->mMinimumSize = size; + // Size negotiate disabled by default, so turn it on for this actor + Self().SetRelayoutEnabled( true ); + } - // Only relayout if our control is using the minimum or range policy. - if ( ( mImpl->mHeightPolicy == Control::Minimum ) || ( mImpl->mWidthPolicy == Control::Minimum ) || - ( mImpl->mHeightPolicy == Control::Range ) || ( mImpl->mWidthPolicy == Control::Range ) ) - { - RelayoutRequest(); - } + if( mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS ) + { + Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get(); + + // Register for style changes + styleManager.StyleChangeSignal().Connect( this, &Control::OnStyleChange ); + + // SetTheme + GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) ); } + + SetRequiresHoverEvents(mImpl->mFlags & REQUIRES_HOVER_EVENTS); + SetRequiresMouseWheelEvents(mImpl->mFlags & REQUIRES_MOUSE_WHEEL_EVENTS); + + mImpl->mInitialized = true; } -const Vector3& ControlImpl::GetMinimumSize() const +void Control::EnableGestureDetection(Gesture::Type type) { - return mImpl->mMinimumSize; + if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector ) + { + mImpl->mPinchGestureDetector = PinchGestureDetector::New(); + mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected); + mImpl->mPinchGestureDetector.Attach(Self()); + } + + if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector ) + { + mImpl->mPanGestureDetector = PanGestureDetector::New(); + mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected); + mImpl->mPanGestureDetector.Attach(Self()); + } + + if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector ) + { + mImpl->mTapGestureDetector = TapGestureDetector::New(); + mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected); + mImpl->mTapGestureDetector.Attach(Self()); + } + + if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector ) + { + mImpl->mLongPressGestureDetector = LongPressGestureDetector::New(); + mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected); + mImpl->mLongPressGestureDetector.Attach(Self()); + } } -void ControlImpl::SetMaximumSize( const Vector3& size ) +void Control::DisableGestureDetection(Gesture::Type type) { - if ( mImpl->mMaximumSize != size ) + if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector ) { - mImpl->mMaximumSize = size; + mImpl->mPinchGestureDetector.Detach(Self()); + mImpl->mPinchGestureDetector.Reset(); + } - // Only relayout if our control is using the maximum or range policy. - if ( ( mImpl->mHeightPolicy == Control::Maximum ) || ( mImpl->mWidthPolicy == Control::Maximum ) || - ( mImpl->mHeightPolicy == Control::Range ) || ( mImpl->mWidthPolicy == Control::Range ) ) - { - RelayoutRequest(); - } + if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector ) + { + mImpl->mPanGestureDetector.Detach(Self()); + mImpl->mPanGestureDetector.Reset(); + } + + if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector ) + { + mImpl->mTapGestureDetector.Detach(Self()); + mImpl->mTapGestureDetector.Reset(); + } + + if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector) + { + mImpl->mLongPressGestureDetector.Detach(Self()); + mImpl->mLongPressGestureDetector.Reset(); } } -const Vector3& ControlImpl::GetMaximumSize() const +void Control::OnInitialize() { - return mImpl->mMaximumSize; } -Vector3 ControlImpl::GetNaturalSize() +void Control::OnActivated() { - // could be overridden in derived classes. - return mImpl->mSetSize; } -float ControlImpl::GetHeightForWidth( float width ) +void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change ) { - // could be overridden in derived classes. - float height( 0.0f ); - if ( mImpl->mSetSize.width > 0.0f ) + // By default the control is only interested in theme (not font) changes + if( change.themeChange ) { - height = mImpl->mSetSize.height * width / mImpl->mSetSize.width; + GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) ); } - return height; } -float ControlImpl::GetWidthForHeight( float height ) +void Control::OnPinch(const PinchGesture& pinch) { - // could be overridden in derived classes. - float width( 0.0f ); - if ( mImpl->mSetSize.height > 0.0f ) + if( !( mImpl->mStartingPinchScale ) ) { - width = mImpl->mSetSize.width * height / mImpl->mSetSize.height; + // lazy allocate + mImpl->mStartingPinchScale = new Vector3; } - return width; + + if( pinch.state == Gesture::Started ) + { + *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale(); + } + + Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale ); } -const Vector3& ControlImpl::GetControlSize() const +void Control::OnPan( const PanGesture& pan ) { - return mImpl->mSize; } -const Vector3& ControlImpl::GetSizeSet() const +void Control::OnTap(const TapGesture& tap) { - return mImpl->mSetSize; } -void ControlImpl::SetKeyInputFocus() +void Control::OnLongPress( const LongPressGesture& longPress ) { - if( Self().OnStage() ) - { - KeyInputFocusManager::Get().SetFocus(Control::DownCast(Self())); - } } -bool ControlImpl::HasKeyInputFocus() +void Control::OnControlStageConnection() { - bool result = false; - if( Self().OnStage() ) - { - result = KeyInputFocusManager::Get().IsKeyboardListener(Control::DownCast(Self())); - } - return result; } -void ControlImpl::ClearKeyInputFocus() +void Control::OnControlStageDisconnection() { - if( Self().OnStage() ) - { - KeyInputFocusManager::Get().RemoveFocus(Control::DownCast(Self())); - } } -void ControlImpl::RelayoutRequest() +void Control::OnControlChildAdd( Actor& child ) { - Internal::RelayoutController::Get().Request(); } -void ControlImpl::Relayout( Vector2 size, ActorSizeContainer& container ) +void Control::OnControlChildRemove( Actor& child ) { - // Avoids relayout again when OnSizeSet callback arrives. - { - SetSizeLock lock( mImpl->mLockSetSize ); - Self().SetSize( size ); - } +} - // Only relayout controls which requested to be relaid out. - OnRelaidOut( size, container ); +void Control::OnControlSizeSet( const Vector3& size ) +{ } -void ControlImpl::Relayout( Actor actor, Vector2 size, ActorSizeContainer& container ) +void Control::OnCalculateRelayoutSize( Dimension dimension ) { - if ( actor ) - { - Control control( Control::DownCast( actor ) ); - if( control ) - { - control.GetImplementation().NegotiateSize( size, container ); - } - else - { - container.push_back( ActorSizePair( actor, size ) ); - } - } } -void ControlImpl::OnRelaidOut( Vector2 size, ActorSizeContainer& container ) +void Control::OnLayoutNegotiated( float size, Dimension dimension ) { - unsigned int numChildren = Self().GetChildCount(); +} - for( unsigned int i=0; imWidthPolicy == Control::Fixed ) - { - if ( mImpl->mHeightPolicy == Control::Fixed ) - { - // If a control says it has a fixed size, then use the size set by the application / control. - Vector2 setSize( mImpl->mSetSize ); - if ( setSize != Vector2::ZERO ) - { - size = setSize; +void Control::OnKeyInputFocusGained() +{ + // Do Nothing +} - // Policy is set to Fixed, so if the application / control has not set one of the dimensions, - // then we should use the natural size of the control rather than the full allocation. - if ( EqualsZero( size.width ) ) - { - size.width = GetWidthForHeight( size.height ); - } - else if ( EqualsZero( size.height ) ) - { - size.height = GetHeightForWidth( size.width ); - } - } - else - { - // If that is not set then set the size to the control's natural size - size = Vector2( GetNaturalSize() ); - } - } - else - { - // Width is fixed so if the application / control has set it, then use that. - if ( !EqualsZero( mImpl->mSetSize.width ) ) - { - size.width = mImpl->mSetSize.width; - } - else - { - // Otherwise, set the width to what has been allocated. - size.width = allocatedSize.width; - } +void Control::OnKeyInputFocusLost() +{ + // Do Nothing +} - // Height is flexible so ask control what the height should be for our width. - size.height = GetHeightForWidth( size.width ); +void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize) +{ + // @todo consider animating negotiated child sizes to target size +} - // Ensure height is within our policy rules - size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, size.height ); - } - } - else - { - if ( mImpl->mHeightPolicy == Control::Fixed ) - { - // Height is fixed so if the application / control has set it, then use that. - if ( !EqualsZero( mImpl->mSetSize.height ) ) - { - size.height = mImpl->mSetSize.height; - } - else - { - // Otherwise, set the height to what has been allocated. - size.height = allocatedSize.height; - } +bool Control::OnTouchEvent(const TouchEvent& event) +{ + return false; // Do not consume +} - // Width is flexible so ask control what the width should be for our height. - size.width = GetWidthForHeight( size.height ); +bool Control::OnHoverEvent(const HoverEvent& event) +{ + return false; // Do not consume +} - // Ensure width is within our policy rules - size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, size.width ); - } - else - { - // Width and height are BOTH flexible. - // Calculate the width and height using the policy rules. - size.width = Calculate( mImpl->mWidthPolicy, mImpl->mMinimumSize.width, mImpl->mMaximumSize.width, allocatedSize.width ); - size.height = Calculate( mImpl->mHeightPolicy, mImpl->mMinimumSize.height, mImpl->mMaximumSize.height, allocatedSize.height ); - } - } +bool Control::OnKeyEvent(const KeyEvent& event) +{ + return false; // Do not consume +} - // If the width has not been set, then set to the allocated width. - // Also if the width set is greater than the allocated, then set to allocated (no exceed support). - if ( EqualsZero( size.width ) || ( size.width > allocatedSize.width ) ) - { - size.width = allocatedSize.width; - } +bool Control::OnMouseWheelEvent(const MouseWheelEvent& event) +{ + return false; // Do not consume +} + +void Control::OnStageConnection() +{ + // Notify derived classes. + OnControlStageConnection(); +} - // If the height has not been set, then set to the allocated height. - // Also if the height set is greater than the allocated, then set to allocated (no exceed support). - if ( EqualsZero( size.height ) || ( size.height > allocatedSize.height ) ) +void Control::OnStageDisconnection() +{ + // Notify derived classes + OnControlStageDisconnection(); +} + +void Control::OnChildAdd(Actor& child) +{ + // If this is the background actor, then we do not want to relayout or inform deriving classes + if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) { - size.height = allocatedSize.height; + return; } - DALI_LOG_INFO( gLogFilter, Debug::Verbose, - "%p: Natural: [%.2f, %.2f] Allocated: [%.2f, %.2f] Set: [%.2f, %.2f]\n", - Self().GetObjectPtr(), - GetNaturalSize().x, GetNaturalSize().y, - allocatedSize.x, allocatedSize.y, - size.x, size.y ); - - Relayout( size, container ); + // Notify derived classes. + OnControlChildAdd( child ); } -bool ControlImpl::EmitKeyEventSignal( const KeyEvent& event ) +void Control::OnChildRemove(Actor& child) { - // Guard against destruction during signal emission - Dali::Toolkit::Control handle( GetOwner() ); + // If this is the background actor, then we do not want to relayout or inform deriving classes + if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) + { + return; + } - bool consumed = false; + // Notify derived classes. + OnControlChildRemove( child ); +} - // signals are allocated dynamically when someone connects - if ( !mImpl->mKeyEventSignalV2.Empty() ) +void Control::OnSizeSet(const Vector3& targetSize) +{ + if( targetSize != mImpl->mNaturalSize ) { - consumed = mImpl->mKeyEventSignalV2.Emit( handle, event ); + // Only updates size if set through Actor's API + mImpl->mNaturalSize = targetSize; } - if (!consumed) + if( targetSize != mImpl->mCurrentSize ) { - // Notification for derived classes - consumed = OnKeyEvent(event); - } + // Update control size. + mImpl->mCurrentSize = targetSize; - return consumed; + // Notify derived classes. + OnControlSizeSet( targetSize ); + } } -void ControlImpl::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) +void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) { mImpl->SignalConnected( slotObserver, callback ); } -void ControlImpl::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) +void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) { mImpl->SignalDisconnected( slotObserver, callback ); } -std::size_t ControlImpl::GetConnectionCount() const -{ - return mImpl->GetConnectionCount(); -} - -ControlImpl::ControlImpl( bool requiresTouchEvents ) -: CustomActorImpl( requiresTouchEvents ), - mImpl(new Impl(*this)) -{ -} +} // namespace Internal } // namespace Toolkit