/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
#include <cstring> // for strcmp
#include <limits>
#include <stack>
+#include <typeinfo>
#include <dali/public-api/animation/constraint.h>
#include <dali/public-api/animation/constraints.h>
#include <dali/public-api/object/type-registry.h>
#include <dali/public-api/rendering/renderer.h>
#include <dali/public-api/size-negotiation/relayout-container.h>
#include <dali/devel-api/common/owner-container.h>
+#include <dali/devel-api/object/handle-devel.h>
+#include <dali/devel-api/scripting/enum-helper.h>
#include <dali/devel-api/scripting/scripting.h>
#include <dali/integration-api/debug.h>
#include <dali-toolkit/public-api/styling/style-manager.h>
#include <dali-toolkit/public-api/visuals/color-visual-properties.h>
#include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
-#include <dali-toolkit/devel-api/visual-factory/devel-visual-properties.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
+#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
#include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
#include <dali-toolkit/internal/styling/style-manager-impl.h>
#include <dali-toolkit/internal/visuals/color/color-visual.h>
#include <dali-toolkit/internal/visuals/transition-data-impl.h>
+#include <dali-toolkit/internal/visuals/visual-string-constants.h>
+#include <dali-toolkit/devel-api/align-enums.h>
+#include <dali-toolkit/internal/controls/tooltip/tooltip.h>
namespace Dali
{
{
#if defined(DEBUG_ENABLED)
-Debug::Filter* gLogFilter = Debug::Filter::New( Debug::General, false, "LOG_CONTROL_VISUALS");
+Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
#endif
+DALI_ENUM_TO_STRING_TABLE_BEGIN( CLIPPING_MODE )
+DALI_ENUM_TO_STRING_WITH_SCOPE( ClippingMode, DISABLED )
+DALI_ENUM_TO_STRING_WITH_SCOPE( ClippingMode, CLIP_CHILDREN )
+DALI_ENUM_TO_STRING_TABLE_END( CLIPPING_MODE )
+
/**
* Struct used to store Visual within the control, index is a unique key for each visual.
*/
Toolkit::Visual::Base visual;
bool enabled;
- RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled) :
- index(aIndex), visual(aVisual), enabled(aEnabled) {}
-};
-
-struct HandleIndex
-{
- Handle handle; ///< a handle to the target object
- Property::Index index; ///< The index of a property provided by the referenced object
-
- HandleIndex( )
- : handle(),
- index( Property::INVALID_INDEX )
- {
- }
-
- HandleIndex( Handle& handle, Property::Index index )
- : handle( handle ),
- index( index )
+ RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled)
+ : index(aIndex), visual(aVisual), enabled(aEnabled)
{
}
};
-
typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
/**
return false;
}
-HandleIndex GetVisualProperty(
- Internal::Control& controlImpl,
+Toolkit::Visual::Base GetVisualByName(
RegisteredVisualContainer& visuals,
- const std::string& visualName,
- Property::Key propertyKey )
+ const std::string& visualName )
{
-#if defined(DEBUG_ENABLED)
- std::ostringstream oss;
- oss << "Control::GetHandleIndex(" << visualName << ", " << propertyKey << ")" << std::endl;
- DALI_LOG_INFO( gLogFilter, Debug::General, oss.str().c_str() );
-#endif
+ Toolkit::Visual::Base visualHandle;
- // Find visualName in the control
RegisteredVisualContainer::Iterator iter;
for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
{
- if ( (*iter)->visual.GetName() == visualName )
+ Toolkit::Visual::Base visual = (*iter)->visual;
+ if( visual && visual.GetName() == visualName )
{
+ visualHandle = visual;
break;
}
}
-
- // Does it's renderer have an associated property?
- if( iter != visuals.End() )
- {
- Actor self = controlImpl.Self();
- Property::Index index = self.GetPropertyIndex( propertyKey );
- if( index != Property::INVALID_INDEX )
- {
- // It's an actor property:
- return HandleIndex( self, index );
- }
- else
- {
- // Check if it is a renderer property:
- if( self.GetRendererCount() > 0 )
- {
- // @todo Need to use correct renderer index
- Renderer renderer = self.GetRendererAt(0);
- Property::Index index = renderer.GetPropertyIndex( propertyKey );
- if( index != Property::INVALID_INDEX )
- {
- // It's a renderer property:
- return HandleIndex( renderer, index );
- }
- }
- else
- {
- std::ostringstream oss;
- oss << propertyKey;
- DALI_LOG_WARNING( "Control::GetHandleIndex(%s, %s) No renderers\n", visualName.c_str(), oss.str().c_str() );
- }
- }
- }
- Handle handle;
- return HandleIndex( handle, Property::INVALID_INDEX );
+ return visualHandle;
}
-
/**
* Creates control through type registry
*/
return connected;
}
+const Scripting::StringEnum ControlStateTable[] = {
+ { "NORMAL", Toolkit::DevelControl::NORMAL },
+ { "FOCUSED", Toolkit::DevelControl::FOCUSED },
+ { "DISABLED", Toolkit::DevelControl::DISABLED },
+}; const unsigned int ControlStateTableCount = sizeof( ControlStateTable ) / sizeof( ControlStateTable[0] );
+
// Setup signals and actions using the type-registry.
DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create );
// Construction & Destruction
Impl(Control& controlImpl)
: mControlImpl( controlImpl ),
+ mState( Toolkit::DevelControl::NORMAL ),
+ mSubState(""),
mStyleName(""),
mBackgroundColor(Color::TRANSPARENT),
mStartingPinchScale( NULL ),
break;
}
+ case Toolkit::DevelControl::Property::STATE:
+ {
+ Toolkit::DevelControl::State state( DevelControl::NORMAL );
+
+ if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( value, ControlStateTable, ControlStateTableCount, state ) )
+ {
+ controlImpl.mImpl->SetState( state );
+ }
+ }
+ break;
+
+ case Toolkit::DevelControl::Property::SUB_STATE:
+ {
+ std::string subState;
+ if( value.Get( subState ) )
+ {
+ controlImpl.mImpl->SetSubState( subState );
+ }
+ }
+ break;
+
case Toolkit::Control::Property::BACKGROUND_COLOR:
{
DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
case Toolkit::Control::Property::BACKGROUND:
{
+ std::string url;
const Property::Map* map = value.GetMap();
if( map && !map->Empty() )
{
controlImpl.SetBackground( *map );
}
+ else if( value.Get( url ) )
+ {
+ // don't know the size to load
+ Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
+ if( visual )
+ {
+ controlImpl.RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
+ visual.SetDepthIndex( DepthIndex::BACKGROUND );
+ }
+ }
else
{
// The background is an empty property map, so we should clear the background
}
break;
}
+
+ case Toolkit::DevelControl::Property::TOOLTIP:
+ {
+ TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
+ if( ! tooltipPtr )
+ {
+ tooltipPtr = Tooltip::New( control );
+ }
+ tooltipPtr->SetProperties( value );
+ }
}
}
}
break;
}
+ case Toolkit::DevelControl::Property::STATE:
+ {
+ value = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( controlImpl.mImpl->mState, ControlStateTable, ControlStateTableCount );
+ break;
+ }
+
case Toolkit::Control::Property::BACKGROUND_COLOR:
{
DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
break;
}
+ case Toolkit::DevelControl::Property::TOOLTIP:
+ {
+ Property::Map map;
+ if( controlImpl.mImpl->mTooltip )
+ {
+ controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
+ }
+ value = map;
+ break;
+ }
+
}
}
return value;
}
+ void SetState( DevelControl::State state )
+ {
+ if( mState != state )
+ {
+ mState = state;
+
+ // Trigger state change and transitions
+ // Apply new style, if stylemanager is available
+ Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
+ if( styleManager )
+ {
+ const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
+ if( stylePtr )
+ {
+ for( int i=mVisuals.Count()-1; i >= 0; i-- )
+ {
+ mControlImpl.UnregisterVisual( mVisuals[i]->index );
+ }
+
+ Dali::CustomActor handle( mControlImpl.GetOwner() );
+ stylePtr->ApplyVisualsAndPropertiesRecursively( handle );
+ }
+ }
+ }
+ }
+
+ void SetSubState( const std::string& state )
+ {
+ if( mSubState != state )
+ {
+ mSubState = state;
+ // Trigger transitions
+
+ }
+ }
+
// Data
Control& mControlImpl;
+ DevelControl::State mState;
+ std::string mSubState;
+
RegisteredVisualContainer mVisuals; // Stores visuals needed by the control, non trivial type so std::vector used.
std::string mStyleName;
Vector4 mBackgroundColor; ///< The color of the background visual
TapGestureDetector mTapGestureDetector;
LongPressGestureDetector mLongPressGestureDetector;
+ // Tooltip
+ TooltipPtr mTooltip;
+
ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
- // Properties - these need to be members of Internal::Control::Impl as they need to function within this class.
+ // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
static const PropertyRegistration PROPERTY_1;
static const PropertyRegistration PROPERTY_2;
static const PropertyRegistration PROPERTY_3;
static const PropertyRegistration PROPERTY_4;
static const PropertyRegistration PROPERTY_5;
+ static const PropertyRegistration PROPERTY_6;
+ static const PropertyRegistration PROPERTY_7;
+ static const PropertyRegistration PROPERTY_8;
};
// Properties registered without macro to use specific member variables.
const PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "backgroundImage", Toolkit::Control::Property::BACKGROUND_IMAGE, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
const PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "keyInputFocus", Toolkit::Control::Property::KEY_INPUT_FOCUS, Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
const PropertyRegistration Control::Impl::PROPERTY_5( typeRegistration, "background", Toolkit::Control::Property::BACKGROUND, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
+const PropertyRegistration Control::Impl::PROPERTY_6( typeRegistration, "tooltip", Toolkit::DevelControl::Property::TOOLTIP, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
+const PropertyRegistration Control::Impl::PROPERTY_7( typeRegistration, "state", Toolkit::DevelControl::Property::STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
+const PropertyRegistration Control::Impl::PROPERTY_8( typeRegistration, "subState", Toolkit::DevelControl::Property::SUB_STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
Toolkit::Control Control::New()
{
return handle;
}
-Control::~Control()
-{
- delete mImpl;
-}
-
void Control::SetStyleName( const std::string& styleName )
{
if( styleName != mImpl->mStyleName )
{
mImpl->mBackgroundColor = color;
Property::Map map;
- map[ Toolkit::VisualProperty::TYPE ] = Toolkit::Visual::COLOR;
+ map[ Toolkit::DevelVisual::Property::TYPE ] = Toolkit::Visual::COLOR;
map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
SetBackground( map );
{
RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
visual.SetDepthIndex( DepthIndex::BACKGROUND );
+
+ // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
+ RelayoutRequest();
}
}
void Control::SetBackgroundImage( Image image )
{
- DALI_LOG_WARNING( "SetBackgroundImage is for the depreciated Property::BACKGROUND_IMAGE use SetBackground( const Property::Map& map )\n" );
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
if( visual )
{
{
UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
mImpl->mBackgroundColor = Color::TRANSPARENT;
+
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
}
void Control::EnableGestureDetection(Gesture::Type type)
bool visualReplaced ( false );
Actor self = Self();
- if ( !mImpl->mVisuals.Empty() )
+ if( !mImpl->mVisuals.Empty() )
{
- RegisteredVisualContainer::Iterator iter;
- // Check if visual (index) is already registered. Replace if so.
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
+ RegisteredVisualContainer::Iterator iter;
+ // Check if visual (index) is already registered. Replace if so.
+ if ( FindVisual( index, mImpl->mVisuals, iter ) )
+ {
+ if( (*iter)->visual && self.OnStage() )
{
- if( (*iter)->visual && self.OnStage() )
- {
- Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
- }
- (*iter)->visual = visual;
- visualReplaced = true;
+ Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
+ }
+ (*iter)->visual = visual;
+ visualReplaced = true;
+ }
+ }
+
+ // If not set, set the name of the visual to the same name as the control's property.
+ // ( If the control has been type registered )
+ if( visual.GetName().empty() )
+ {
+ // Check if the control has been type registered:
+ TypeInfo typeInfo = TypeRegistry::Get().GetTypeInfo( typeid(*this) );
+ if( typeInfo )
+ {
+ // Check if the property index has been registered:
+ Property::IndexContainer indices;
+ typeInfo.GetPropertyIndices( indices );
+ Property::IndexContainer::Iterator iter = std::find( indices.Begin(), indices.End(), index );
+ if( iter != indices.End() )
+ {
+ // If it has, then get it's name and use that for the visual
+ std::string visualName = typeInfo.GetPropertyName( index );
+ visual.SetName( visualName );
}
+ }
}
- if ( !visualReplaced ) // New registration entry
+ if( !visualReplaced ) // New registration entry
{
mImpl->mVisuals.PushBack( new RegisteredVisual( index, visual, enabled ) );
}
{
Toolkit::GetImplementation(visual).SetOnStage( self );
}
+
+ DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n", visual.GetName().c_str(), index, enabled?"T":"F" );
}
void Control::UnregisterVisual( Property::Index index )
{
if ( (*iter)->enabled == enable )
{
- DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual Already enabled set (%s) \n", enable?"enabled":"disabled");
+ DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
return;
}
{
if ( enable )
{
- DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting Visual(%d) on stage \n", index );
+ DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
}
else
{
- DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting Visual(%d) off stage \n", index );
+ DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor ); // No need to call if control not staged.
}
}
iter != end; ++iter )
{
TransitionData::Animator* animator = (*iter);
- HandleIndex handleIndex;
- // Attempt to find the object name as a child actor
- Actor child = Self().FindChildByName( animator->objectName );
- if( child )
+ Toolkit::Visual::Base visual = GetVisualByName( mImpl->mVisuals, animator->objectName );
+
+ if( visual )
{
- Property::Index propertyIndex = child.GetPropertyIndex( animator->propertyKey );
- handleIndex = HandleIndex( child, propertyIndex );
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.AnimateProperty( transition, *animator );
}
else
{
- handleIndex = GetVisualProperty( *this, mImpl->mVisuals,
- animator->objectName,
- animator->propertyKey );
- }
-
- if( handleIndex.handle && handleIndex.index != Property::INVALID_INDEX )
- {
- if( animator->animate == false )
+ // Otherwise, try any actor children of control (Including the control)
+ Actor child = Self().FindChildByName( animator->objectName );
+ if( child )
{
- if( animator->targetValue.GetType() != Property::NONE )
+ Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
+ if( propertyIndex != Property::INVALID_INDEX )
{
- handleIndex.handle.SetProperty( handleIndex.index, animator->targetValue );
+ if( animator->animate == false )
+ {
+ if( animator->targetValue.GetType() != Property::NONE )
+ {
+ child.SetProperty( propertyIndex, animator->targetValue );
+ }
+ }
+ else // animate the property
+ {
+ if( animator->initialValue.GetType() != Property::NONE )
+ {
+ child.SetProperty( propertyIndex, animator->initialValue );
+ }
+
+ if( ! transition )
+ {
+ transition = Dali::Animation::New( 0.1f );
+ }
+
+ transition.AnimateTo( Property( child, propertyIndex ),
+ animator->targetValue,
+ animator->alphaFunction,
+ TimePeriod( animator->timePeriodDelay,
+ animator->timePeriodDuration ) );
+ }
}
}
- else
- {
- if( animator->initialValue.GetType() != Property::NONE )
- {
- handleIndex.handle.SetProperty( handleIndex.index, animator->initialValue );
- }
-
- if( ! transition )
- {
- // Create an animation with a default .1 second duration - the animators
- // will automatically force it to the 'right' duration.
- transition = Dali::Animation::New( 0.1f );
- }
-
- transition.AnimateTo( Property( handleIndex.handle, handleIndex.index ),
- animator->targetValue,
- animator->alphaFunction,
- TimePeriod( animator->timePeriodDelay,
- animator->timePeriodDuration ) );
- }
}
}
}
mImpl->mFlags = behaviourFlags;
}
+Control::~Control()
+{
+ delete mImpl;
+}
+
void Control::Initialize()
{
// Call deriving classes so initialised before styling is applied to them.
{
DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size() );
+ Actor self( Self() );
+
for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
{
// Check whether the visual is empty and enabled
if( (*iter)->visual && (*iter)->enabled )
{
DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection Setting visual(%d) on stage\n", (*iter)->index );
- Actor self( Self() );
Toolkit::GetImplementation((*iter)->visual).SetOnStage( self );
}
}
+
+ if( mImpl->mVisuals.Empty() && ! self.GetRendererCount() )
+ {
+ Property::Value clippingValue = self.GetProperty( Actor::Property::CLIPPING_MODE );
+ int clippingMode = ClippingMode::DISABLED;
+ if( clippingValue.Get( clippingMode ) )
+ {
+ // Add a transparent background if we do not have any renderers or visuals so we clip our children
+
+ if( clippingMode == ClippingMode::CLIP_CHILDREN )
+ {
+ // Create a transparent background visual which will also get staged.
+ SetBackgroundColor( Color::TRANSPARENT );
+ }
+ }
+ }
}
void Control::OnStageDisconnection()
OnControlChildRemove( child );
}
+void Control::OnPropertySet( Property::Index index, Property::Value propertyValue )
+{
+ Actor self( Self() );
+ if( index == Actor::Property::CLIPPING_MODE )
+ {
+ // Only set the background if we're already on the stage and have no renderers or visuals
+
+ if( mImpl->mVisuals.Empty() && ! self.GetRendererCount() && self.OnStage() )
+ {
+ ClippingMode::Type clippingMode = ClippingMode::DISABLED;
+ if( Scripting::GetEnumerationProperty< ClippingMode::Type >( propertyValue, CLIPPING_MODE_TABLE, CLIPPING_MODE_TABLE_COUNT, clippingMode ) )
+ {
+ // Add a transparent background if we do not have one so we clip children
+
+ if( clippingMode == ClippingMode::CLIP_CHILDREN )
+ {
+ SetBackgroundColor( Color::TRANSPARENT );
+ }
+ }
+ }
+ }
+}
+
void Control::OnSizeSet(const Vector3& targetSize)
{
Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
if( visual )
{
Vector2 size( targetSize );
- visual.SetSize( size );
+ visual.SetTransformAndSize( Property::Map(), size ); // Send an empty map as we do not want to modify the visual's set transform
}
}
{
container.Add( Self().GetChildAt( i ), size );
}
+
+ Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
+ if( visual )
+ {
+ visual.SetTransformAndSize( Property::Map(), size ); // Send an empty map as we do not want to modify the visual's set transform
+ }
}
void Control::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )