#define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
/*
- * 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.
*/
// EXTERNAL INCLUDES
-#include <dali/public-api/common/intrusive-ptr.h>
+#include <dali/public-api/object/base-object.h>
// INTERNAL INCLUDES
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
-#include <dali-toolkit/internal/text/rendering/text-renderer.h>
+#include <dali-toolkit/internal/text/rendering/text-typesetter.h>
#include <dali-toolkit/internal/text/text-controller.h>
-#include <dali-toolkit/internal/text/text-scroller.h>
namespace Dali
{
* | underline | STRING |
* | shadow | STRING |
* | outline | STRING |
- * | batchingEnabled | BOOLEAN |
*
*/
class TextVisual : public Visual::Base
* @brief Create a new text visual.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] properties A Property::Map containing settings for this visual
* @return A smart-pointer to the newly allocated visual.
*/
- static TextVisualPtr New( VisualFactoryCache& factoryCache );
+ static TextVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
/**
- * @brief Sets the text control interface which is needed to communicate with a control.
- * @param[in] controlInterface Pointer to the control-interface.
+ * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
+ * @param[in,out] propertyMap containing string keys or a mix of strings and indexes. Will be changed to index keys.
*/
- void SetTextControlInterface( Text::ControlInterface* controlInterface );
+ static void ConvertStringKeysToIndexKeys( Property::Map& propertyMap );
-public: // from Visual::Base
+ /**
+ * @brief Retrieve the text's controller.
+ * @param[in] visual The text visual.
+ * @return The text controller
+ */
+ static Text::ControllerPtr GetController( Toolkit::Visual::Base visual )
+ {
+ return GetVisualObject( visual ).mController;
+ };
/**
- * @copydoc Visual::Base::GetHeightForWidth()
+ * @brief Set the index of the animatable text color property.
+ * @param[in] visual The text visual.
+ * @param[in] animatablePropertyIndex The index of the animatable property
*/
- float GetHeightForWidth( float width ) const;
+ static void SetAnimatableTextColorProperty( Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex )
+ {
+ GetVisualObject( visual ).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
+ };
/**
- * @copydoc Visual::Base::GetNaturalSize()
+ * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
+ * @param[in] visual The text visual.
+ */
+ static void EnableRendererUpdate( Toolkit::Visual::Base visual )
+ {
+ GetVisualObject( visual ).mRendererUpdateNeeded = true;
+ };
+
+public: // from Visual::Base
+
+ /**
+ * @copydoc Visual::Base::GetHeightForWidth()
*/
- virtual void SetSize( const Vector2& size );
+ virtual float GetHeightForWidth( float width );
/**
* @copydoc Visual::Base::GetNaturalSize()
*/
- virtual void GetNaturalSize( Vector2& naturalSize ) const;
+ virtual void GetNaturalSize( Vector2& naturalSize );
/**
* @copydoc Visual::Base::CreatePropertyMap()
*/
virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ /**
+ * @copydoc Visual::Base::CreateInstancePropertyMap
+ */
+ virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
+
protected:
/**
// from Visual::Base
/**
- * @copydoc Visual::Base::DoInitialize()
+ * @copydoc Visual::Base::DoSetProperties()
*/
- virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+ virtual void DoSetProperties( const Property::Map& propertyMap );
/**
* @copydoc Visual::Base::DoSetOnStage()
virtual void DoSetOffStage( Actor& actor );
/**
- *@copydoc Visual::Base::DoSetProperty
+ * @copydoc Visual::Base::OnSetTransform
*/
- virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+ virtual void OnSetTransform();
+private:
/**
- * @copydoc Visual::Base::DoGetProperty
+ * @brief Set the individual property to the given value.
+ *
+ * @param[in] index The index key used to reference this value within the initial property map.
+ *
+ * @param[in] propertyValue The value to set.
*/
- virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
-
-private:
+ void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
/**
- * @brief Render view, create and attach actor(s) to this TextView.
- * @todo In a next patch a new text render back-end won't add extra actors.
+ * @brief Updates the text's renderer.
*/
- void RenderText();
+ void UpdateRenderer();
/**
- * @brief Stops the text auto scroll.
+ * @brief Removes the texture set from the renderer.
*/
- void StopTextAutoScrolling();
+ void RemoveTextureSet();
/**
- * @brief Set up Autoscrolling.
+ * @brief Retrieve the text's controller.
+ * @param[in] visual The text visual.
+ * @return The text controller
*/
- void SetUpAutoScrolling();
+ static TextVisual& GetVisualObject( Toolkit::Visual::Base visual )
+ {
+ return static_cast<TextVisual&>( visual.GetBaseObject() );
+ };
private:
- Text::ControllerPtr mController; ///< The text's controller.
- Actor mSelf;
-
- Text::RendererPtr mRenderer;
- Text::TextScrollerPtr mTextScroller;
- Actor mRenderableActor;
-
- int mRenderingBackend;
- bool mHasBeenStaged : 1;
+ Text::ControllerPtr mController; ///< The text's controller.
+ Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
+ WeakHandle<Actor> mControl; ///< The control where the renderer is added.
+ Property::Index mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
+ bool mRendererUpdateNeeded:1; ///< The flag to indicate whether the renderer needs to be updated.
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff