#include <dali/public-api/animation/constraint.h>
#include <dali/public-api/object/type-registry-helper.h>
#include <dali/public-api/size-negotiation/relayout-container.h>
-#include <dali/devel-api/object/handle-devel.h>
#include <dali/devel-api/scripting/scripting.h>
#include <dali/integration-api/debug.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/controls/control-devel.h>
-#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.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/visual-string-constants.h>
-#include <dali-toolkit/devel-api/align-enums.h>
+#include <dali-toolkit/public-api/align-enumerations.h>
#include <dali-toolkit/internal/controls/control/control-data-impl.h>
namespace Dali
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 )
-
/**
- * Finds visual in given array, returning true if found along with the iterator for that visual as a out parameter
+ * @brief Creates a clipping renderer if required.
+ * (EG. If no renders exist and clipping is enabled).
+ * @param[in] controlImpl The control implementation.
*/
-bool FindVisual( Property::Index targetIndex, RegisteredVisualContainer& visuals, RegisteredVisualContainer::Iterator& iter )
+void CreateClippingRenderer( Control& controlImpl )
{
- for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
+ // We want to add a transparent background if we do not have one for clipping.
+ Actor self( controlImpl.Self() );
+ int clippingMode = ClippingMode::DISABLED;
+ if( self.GetProperty( Actor::Property::CLIPPING_MODE ).Get( clippingMode ) )
{
- if ( (*iter)->index == targetIndex )
+ Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( controlImpl );
+
+ if( ( clippingMode == ClippingMode::CLIP_CHILDREN ) &&
+ controlDataImpl.mVisuals.Empty() &&
+ ( self.GetRendererCount() == 0u ) )
{
- return true;
+ controlImpl.SetBackgroundColor( Color::TRANSPARENT );
}
}
- return false;
}
-Toolkit::Visual::Base GetVisualByName(
- RegisteredVisualContainer& visuals,
- const std::string& visualName )
+/**
+ * @brief Sets Control::Property::BACKGROUND visual
+ * @param[in] controlImpl The control implementation
+ * @param[in] visual The control background visual
+ * @param[in] size The current size
+ */
+void SetBackgroundVisual( Control::Impl& controlImpl, Toolkit::Visual::Base& visual, const Vector2& size )
{
- Toolkit::Visual::Base visualHandle;
+ Property::Map transformMap = Property::Map();
- RegisteredVisualContainer::Iterator iter;
- for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
+ Vector2 newSize( 0.f, 0.f );
+ newSize.width = size.width + ( controlImpl.mPadding.start + controlImpl.mPadding.end );
+ newSize.height = size.height + ( controlImpl.mPadding.top + controlImpl.mPadding.bottom );
+
+ if( ( controlImpl.mMargin.start != 0 ) ||
+ ( controlImpl.mMargin.end != 0 ) ||
+ ( controlImpl.mMargin.top != 0 ) ||
+ ( controlImpl.mMargin.bottom != 0 ) )
{
- Toolkit::Visual::Base visual = (*iter)->visual;
- if( visual && visual.GetName() == visualName )
- {
- visualHandle = visual;
- break;
- }
+ transformMap.Add( Toolkit::Visual::Transform::Property::SIZE, newSize )
+ .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+ .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( controlImpl.mMargin.start, controlImpl.mMargin.top ) )
+ .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+ .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
}
- return visualHandle;
+ else if( ( controlImpl.mPadding.start != 0 ) ||
+ ( controlImpl.mPadding.end != 0 ) ||
+ ( controlImpl.mPadding.top != 0 ) ||
+ ( controlImpl.mPadding.bottom != 0 ) )
+ {
+ transformMap.Add( Toolkit::Visual::Transform::Property::SIZE, newSize )
+ .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+ .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
+ }
+
+ visual.SetTransformAndSize( transformMap, newSize ); // Send an empty map as we do not want to modify the visual's set transform
}
} // unnamed namespace
-
Toolkit::Control Control::New()
{
// Create the implementation, temporarily owned on stack
{
mImpl->mBackgroundColor = color;
Property::Map map;
- map[ Toolkit::DevelVisual::Property::TYPE ] = Toolkit::Visual::COLOR;
+ map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::COLOR;
map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
SetBackground( map );
void Control::SetBackground( const Property::Map& map )
{
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
+ visual.SetName("background");
if( visual )
{
- RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
- visual.SetDepthIndex( DepthIndex::BACKGROUND );
+ mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
// Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
RelayoutRequest();
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
if( visual )
{
- RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
- visual.SetDepthIndex( DepthIndex::BACKGROUND );
+ mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
}
}
void Control::ClearBackground()
{
- UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
+ mImpl->UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
mImpl->mBackgroundColor = Color::TRANSPARENT;
// Trigger a size negotiation request that may be needed when unregistering a visual.
OnKeyboardEnter();
}
-void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
-{
- RegisterVisual( index, visual, true );
-}
-
-void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
-{
- bool visualReplaced ( false );
- Actor self = Self();
-
- if( !mImpl->mVisuals.Empty() )
- {
- RegisteredVisualContainer::Iterator iter;
- // Check if visual (index) is already registered. Replace if so.
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
- {
- if( (*iter)->visual && self.OnStage() )
- {
- Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
- }
-
- mImpl->StopObservingVisual( (*iter)->visual );
- mImpl->StartObservingVisual( visual );
-
- (*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
- {
- mImpl->mVisuals.PushBack( new RegisteredVisual( index, visual, enabled ) );
-
- // monitor when the visuals resources are ready
- mImpl->StartObservingVisual( visual );
-
- }
-
- if( visual && self.OnStage() && 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 )
-{
- RegisteredVisualContainer::Iterator iter;
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
- {
- // stop observing visual
- mImpl->StopObservingVisual( (*iter)->visual );
-
- Actor self( Self() );
- Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
- (*iter)->visual.Reset();
- mImpl->mVisuals.Erase( iter );
- }
-}
-
-Toolkit::Visual::Base Control::GetVisual( Property::Index index ) const
-{
- RegisteredVisualContainer::Iterator iter;
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
- {
- return (*iter)->visual;
- }
-
- return Toolkit::Visual::Base();
-}
-
-void Control::EnableVisual( Property::Index index, bool enable )
-{
- RegisteredVisualContainer::Iterator iter;
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
- {
- if ( (*iter)->enabled == enable )
- {
- DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
- return;
- }
-
- (*iter)->enabled = enable;
- Actor parentActor = Self();
- if ( Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
- {
- if ( enable )
- {
- 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 %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.
- }
- }
- }
-}
-
-bool Control::IsVisualEnabled( Property::Index index ) const
-{
- RegisteredVisualContainer::Iterator iter;
- if ( FindVisual( index, mImpl->mVisuals, iter ) )
- {
- return (*iter)->enabled;
- }
- return false;
-}
-
-Dali::Animation Control::CreateTransition( const Toolkit::TransitionData& handle )
-{
- Dali::Animation transition;
- const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
-
- if( transitionData.Count() > 0 )
- {
- // Setup a Transition from TransitionData.
- TransitionData::Iterator end = transitionData.End();
- for( TransitionData::Iterator iter = transitionData.Begin() ;
- iter != end; ++iter )
- {
- TransitionData::Animator* animator = (*iter);
-
- Toolkit::Visual::Base visual = GetVisualByName( mImpl->mVisuals, animator->objectName );
-
- if( visual )
- {
- Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
- visualImpl.AnimateProperty( transition, *animator );
- }
- else
- {
- // Otherwise, try any actor children of control (Including the control)
- Actor child = Self().FindChildByName( animator->objectName );
- if( child )
- {
- Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
- if( propertyIndex != Property::INVALID_INDEX )
- {
- 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 ) );
- }
- }
- }
- }
- }
- }
-
- return transition;
-}
-
bool Control::OnAccessibilityActivated()
{
return false; // Accessibility activation is not handled by default
}
}
- 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 );
- }
- }
- }
+ // The clipping renderer is only created if required.
+ CreateClippingRenderer( *this );
}
void Control::OnStageDisconnection()
{
- for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
- {
- // Check whether the visual is empty
- if( (*iter)->visual )
- {
- DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageDisconnection Setting visual(%d) off stage\n", (*iter)->index );
- Actor self( Self() );
- Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
- }
- }
+ mImpl->OnStageDisconnection();
}
void Control::OnKeyInputFocusGained()
void Control::OnPropertySet( Property::Index index, Property::Value propertyValue )
{
- Actor self( Self() );
- if( index == Actor::Property::CLIPPING_MODE )
+ // If the clipping mode has been set, we may need to create a renderer.
+ // Only do this if we are already on-stage as the OnStageConnection will handle the off-stage clipping controls.
+ if( ( index == Actor::Property::CLIPPING_MODE ) && Self().OnStage() )
{
- // 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 );
- }
- }
- }
+ // Note: This method will handle whether creation of the renderer is required.
+ CreateClippingRenderer( *this );
}
}
void Control::OnSizeSet(const Vector3& targetSize)
{
- Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
+ Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
if( visual )
{
Vector2 size( targetSize );
- visual.SetTransformAndSize( Property::Map(), size ); // Send an empty map as we do not want to modify the visual's set transform
+ SetBackgroundVisual( *mImpl, visual, size );
+
}
}
{
for( unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i )
{
- container.Add( Self().GetChildAt( i ), size );
+ Actor child = Self().GetChildAt( i );
+ Vector2 newChildSize( size );
+
+ // When set the padding or margin on the control, child should be resized and repositioned.
+ if( ( mImpl->mPadding.start != 0 ) || ( mImpl->mPadding.end != 0 ) || ( mImpl->mPadding.top != 0 ) || ( mImpl->mPadding.bottom != 0 ) ||
+ ( mImpl->mMargin.start != 0 ) || ( mImpl->mMargin.end != 0 ) || ( mImpl->mMargin.top != 0 ) || ( mImpl->mMargin.bottom != 0 ) )
+ {
+ Extents padding = mImpl->mPadding;
+
+ Dali::CustomActor ownerActor(GetOwner());
+ Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( ownerActor.GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
+
+ if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
+ {
+ std::swap( padding.start, padding.end );
+ }
+
+ newChildSize.width = size.width - ( padding.start + padding.end );
+ newChildSize.height = size.height - ( padding.top + padding.bottom );
+
+ // Cannot use childs Position property as it can already have padding and margin applied on it,
+ // so we end up cumulatively applying them over and over again.
+ Vector2 childOffset( 0.f, 0.f );
+ childOffset.x += ( mImpl->mMargin.start + padding.start );
+ childOffset.y += ( mImpl->mMargin.top + padding.top );
+
+ child.SetPosition( childOffset.x, childOffset.y );
+ }
+
+ container.Add( child, newChildSize );
}
- Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
+ Toolkit::Visual::Base visual = mImpl->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
+ SetBackgroundVisual( *mImpl, visual, size );
}
}
Vector3 Control::GetNaturalSize()
{
- Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
+ Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
if( visual )
{
Vector2 naturalSize;
visual.GetNaturalSize( naturalSize );
+ naturalSize.width += ( mImpl->mPadding.start + mImpl->mPadding.end );
+ naturalSize.height += ( mImpl->mPadding.top + mImpl->mPadding.bottom );
return Vector3( naturalSize );
}
return Vector3::ZERO;