dali/public-api/actors/text-actor.h

   1 #ifndef __DALI_TEXT_ACTOR_H__
   2 #define __DALI_TEXT_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21
  22 // EXTERNAL INCLUDES
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/actors/renderable-actor.h>
  27 #include <dali/public-api/common/loading-state.h>
  28 #include <dali/public-api/common/constants.h>
  29 #include <dali/public-api/math/vector2.h>
  30 #include <dali/public-api/text/text-style.h>
  31 #include <dali/public-api/text/text.h>
  32
  33 namespace Dali DALI_IMPORT_API
  34 {
  35
  36 struct TextActorParameters;
  37 class Font;
  38
  39 namespace Internal DALI_INTERNAL
  40 {
  41 class TextActor;
  42 }
  43
  44 /**
  45  * @brief TextActor is a basic actor for displaying a text label
  46  *
  47  * By default the text actor always uses the natural size of the text when SetText is called,
  48  * unless SetSize is called to override the size or size is animated to some other size.
  49  * Natural size for TextActor is the same as the size returned by Font::MeasureText( string )
  50  * using the font that the TextActor is using.
  51  *
  52  * By default CullFaceMode is set to CullNone to enable the TextActor to be viewed from all angles.
  53  */
  54 class DALI_IMPORT_API TextActor : public RenderableActor
  55 {
  56 public:
  57
  58   typedef SignalV2< void (TextActor) > TextSignalV2;     ///< Text available signal type
  59
  60   //Signal Names
  61   static const char* const SIGNAL_TEXT_LOADING_FINISHED; ///< name "text-loading-finished"
  62
  63   // Default Properties; additional to RenderableActor properties
  64   static const Property::Index TEXT;                              ///< name "text"                     type STRING
  65   static const Property::Index FONT;                              ///< name "font"                     type STRING
  66   static const Property::Index FONT_STYLE;                        ///< name "font-style"               type STRING
  67   static const Property::Index OUTLINE_ENABLE;                    ///< name "outline-enable"           type BOOLEAN
  68   static const Property::Index OUTLINE_COLOR;                     ///< name "outline-color"            type VECTOR4
  69   static const Property::Index OUTLINE_THICKNESS_WIDTH;           ///< name "outline-thickness-width"  type VECTOR2
  70   static const Property::Index SMOOTH_EDGE;                       ///< name "smooth-edge"              type FLOAT
  71   static const Property::Index GLOW_ENABLE;                       ///< name "glow-enable"              type BOOLEAN
  72   static const Property::Index GLOW_COLOR;                        ///< name "glow-color"               type VECTOR4
  73   static const Property::Index GLOW_INTENSITY;                    ///< name "glow-intensity"           type FLOAT
  74   static const Property::Index SHADOW_ENABLE;                     ///< name "shadow-enable"            type BOOLEAN
  75   static const Property::Index SHADOW_COLOR;                      ///< name "shadow-color"             type VECTOR4
  76   static const Property::Index SHADOW_OFFSET;                     ///< name "shadow-offset"            type VECTOR2
  77   static const Property::Index ITALICS_ANGLE;                     ///< name "italics-angle"            type FLOAT
  78   static const Property::Index UNDERLINE;                         ///< name "underline"                type BOOLEAN
  79   static const Property::Index WEIGHT;                            ///< name "weight"                   type INTEGER
  80   static const Property::Index FONT_DETECTION_AUTOMATIC;          ///< name "font-detection-automatic" type BOOLEAN
  81   static const Property::Index GRADIENT_COLOR;                    ///< name "gradient-color"           type VECTOR4
  82   static const Property::Index GRADIENT_START_POINT;              ///< name "gradient-start-point"     type VECTOR2
  83   static const Property::Index GRADIENT_END_POINT;                ///< name "gradient-end-point"       type VECTOR2
  84   static const Property::Index SHADOW_SIZE;                       ///< name "shadow-size"              type FLOAT
  85   static const Property::Index TEXT_COLOR;                        ///< name "text-color"               type VECTOR4
  86
  87   /**
  88    * @brief Create an uninitialized TextActor handle.
  89    *
  90    * This can be initialised with TextActor::New().
  91    * Calling member functions with an uninitialized handle is not allowed.
  92    */
  93   TextActor();
  94
  95   /**
  96    * @brief Create a TextActor object with no text.
  97    *
  98    * @return A handle to a newly allocated Dali resource.
  99    */
 100   static TextActor New();
 101
 102   /**
 103    * @brief Create a TextActor object with text, a default style and font detection.
 104    *
 105    * @param[in] text The text which will be displayed
 106    */
 107   static TextActor New( const Text& text );
 108
 109   /**
 110    * @brief Create a TextActor object with text.
 111    *
 112    * The style and whether to automatically detect the font could be set in the parameters.
 113    *
 114    * @param[in] text The text which will be displayed
 115    * @param[in] parameters Text parameters.
 116    */
 117   static TextActor New( const Text& text, const TextActorParameters& parameters );
 118
 119   /**
 120    * @brief Downcast an Object handle to TextActor.
 121    *
 122    * If handle points to a TextActor the downcast produces valid
 123    * handle. If not the returned handle is left uninitialized.
 124    * @param[in] handle to An object
 125    * @return handle to a TextActor or an uninitialized handle
 126    */
 127   static TextActor DownCast( BaseHandle handle );
 128
 129   /**
 130    * @brief Destructor
 131    *
 132    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 133    */
 134   ~TextActor();
 135
 136   /**
 137    * @copydoc Dali::BaseHandle::operator=
 138    */
 139   using BaseHandle::operator=;
 140
 141   /**
 142    * @brief Get the text label displayed by the actor.
 143    *
 144    * @pre The text actor has been initialized.
 145    * @return The text label
 146    */
 147   std::string GetText() const;
 148
 149   /**
 150    * @brief Set the text label displayed by the actor.
 151    *
 152    * @pre The text actor has been initialized.
 153    * @param [in] text The new text label
 154    */
 155   void SetText(const Text& text);
 156
 157   /**
 158    * @brief Set text to the natural size of the text string.
 159    *
 160    * After this method the text actor always uses the natural size of the text
 161    * when SetText is called unless SetSize is called to override the size.
 162    */
 163   void SetToNaturalSize();
 164
 165   /**
 166    * @brief Get the font used to display the text label displayed by the actor.
 167    *
 168    * @pre The text actor has been initialized.
 169    * @return The font currently in use
 170    */
 171   Font GetFont() const;
 172
 173   /**
 174    * @brief Set the font used to display the text label displayed by the actor.
 175    *
 176    * @pre The text actor has been initialized.
 177    * @param [in] font The new font
 178    */
 179   void SetFont(Font& font);
 180
 181   // styling and effects
 182
 183   /**
 184    * @brief Set the gradient color.
 185    *
 186    * This is the color associated with the gradient end point.
 187    * @param[in] color The gradient color (end-point color)
 188    */
 189   void SetGradientColor( const Vector4& color );
 190
 191   /**
 192    * @brief Get the gradient color.
 193    *
 194    * This is the color associated with the gradient end point.
 195    * @return The gradient color (end-point color)
 196    */
 197   Vector4 GetGradientColor() const;
 198
 199   /**
 200    * @brief Set the gradient start point.
 201    *
 202    * This is a 2D position between the coordinate range:
 203    * 0.0,0.0 (Left,Top) to 1.0,1.0 (Right,Bottom) within
 204    * the outputted Text. Actor::COLOR will represent this point
 205    * in the gradient.
 206    * @param[in] position The relative position of the gradient start point.
 207    */
 208   void SetGradientStartPoint( const Vector2& position );
 209
 210   /**
 211    * @brief Get the gradient start point.
 212    *
 213    * @return The relative position of the gradient start point.
 214    */
 215   Vector2 GetGradientStartPoint() const;
 216
 217   /**
 218    * @brief Set the gradient end point.
 219    *
 220    * This is a 2D position between the coordinate range:
 221    * 0.0,0.0 (Left,Top) to 1.0,1.0 (Right,Bottom) within
 222    * the outputted Text. TextActor::GRADIENT_COLOR will represent
 223    * this point in the gradient.
 224    * @param[in] position The relative position of the gradient end point.
 225    */
 226   void SetGradientEndPoint( const Vector2& position );
 227
 228   /**
 229    * @brief Get the gradient end point.
 230    *
 231    * @return The relative position of the gradient end point.
 232    */
 233   Vector2 GetGradientEndPoint() const;
 234
 235   /**
 236    * @brief Sets text style.
 237    *
 238    * @param[in] style The text style.
 239    */
 240   void SetTextStyle( const TextStyle& style );
 241
 242   /**
 243    * @brief Retrieves a copy of the text style.
 244    *
 245    * @return The text style.
 246    */
 247   TextStyle GetTextStyle() const;
 248
 249   /**
 250    * @brief Set the text color.
 251    *
 252    * This is blended with the Actor color
 253    * @param[in] color The text color (Default: WHITE)
 254    */
 255   void SetTextColor( const Vector4& color );
 256
 257   /**
 258    * @brief Get the text color.
 259    *
 260    * @return The text color.
 261    */
 262   Vector4 GetTextColor() const;
 263
 264   /**
 265    * @brief Set soft edge smoothing.
 266    *
 267    * @param[in] smoothEdge Specify the distance field value for the center of the text edge.
 268    *                   0 <= smoothEdge <= 1
 269    */
 270   void SetSmoothEdge( float smoothEdge = TextStyle::DEFAULT_SMOOTH_EDGE_DISTANCE_FIELD );
 271
 272   /**
 273    * @brief Set text outlining.
 274    *
 275    * @param[in] enable  Set to true to enable text outlining.
 276    * @param[in] color   Outline color.
 277    * @param[in] thickness Thickness of outline. The outline thickness is determined by two parameters.
 278    *                      thickness[0] Specifies the distance field value for the center of the outline.
 279    *                      thickness[1] Specifies the softness/width/anti-aliasing of the outlines inner edge.
 280    *                      SetSmoothEdge() specifies the smoothness/anti-aliasing of the text outer edge.
 281    *                      0 <= smoothEdge[0] <= 1.
 282    *                      0 <= smoothEdge[1] <= 1.
 283    */
 284   void SetOutline( bool enable, const Vector4& color, const Vector2& thickness = TextStyle::DEFAULT_OUTLINE_THICKNESS );
 285
 286   /**
 287    * @brief Set text glow.
 288    *
 289    * @param[in] enable  Set to true to enable text outer glow.
 290    * @param[in] color   Glow color.
 291    * @param[in] intensity Determines the amount of glow around text.
 292    *                      The edge of the text is at the value set with SetSmoothEdge().
 293    *                      SetSmoothEdge() The distance field value at which the glow becomes fully transparent.
 294    */
 295   void SetGlow( bool enable, const Vector4& color, float intensity = TextStyle::DEFAULT_GLOW_INTENSITY );
 296
 297   /**
 298    * @brief Set text shadow.
 299    *
 300    * @param[in] enable  Set to true to enable text drop shadow.
 301    * @param[in] color   Shadow color
 302    * @param[in] offset  Offset in pixels. To avoid cropping of the drop shadow limit the offset to PointSize / 3.5
 303    * @param[in] size    Size of shadow in pixels. 0 means the shadow is the same size as the text.
 304    */
 305   void SetShadow( bool enable, const Vector4& color, const Vector2& offset = TextStyle::DEFAULT_SHADOW_OFFSET,
 306                   float size = TextStyle::DEFAULT_SHADOW_SIZE );
 307
 308   /**
 309    * @brief Enable italics on the text actor, the text will be sheared by the given angle.
 310    *
 311    * @param[in] enabled True will enable italics, false disable it.
 312    * @param[in] angle Italics angle in degrees.
 313    */
 314   void SetItalics( bool enabled, Degree angle = TextStyle::DEFAULT_ITALICS_ANGLE );
 315
 316   /**
 317    * @brief Enable italics on the text actor, the text will be sheared by the given angle.
 318    *
 319    * @param[in] enabled True will enable italics, false disable it.
 320    * @param[in] angle Italics angle in radians.
 321    */
 322   void SetItalics( bool enabled, Radian angle );
 323
 324   /**
 325    * @brief Get text italics for the actor.
 326    *
 327    * @returns True if italics is enabled.
 328    */
 329   bool GetItalics() const;
 330
 331   /**
 332    * @brief Get text italics angle.
 333    *
 334    * @returns Angle as a Radian.
 335    */
 336   Radian GetItalicsAngle() const;
 337
 338   /**
 339    * @brief Set text underline.
 340    *
 341    * @param[in] enable Boolean indicating if the text should be underlined or not.
 342    */
 343   void SetUnderline( bool enable );
 344
 345   /**
 346    * @brief Get text underline.
 347    *
 348    * @return  Boolean indicating if the text should be underlined or not.
 349    */
 350   bool GetUnderline() const;
 351
 352   /**
 353    * @brief Set text weight.
 354    *
 355    * @param weight Text weight.
 356    */
 357   void SetWeight( TextStyle::Weight weight );
 358
 359   /**
 360    * @brief Get text weight.
 361    *
 362    * @return Text weight.
 363    */
 364   TextStyle::Weight GetWeight() const;
 365
 366   /**
 367    * @brief Try to detect font in case text is not supported with current one.
 368    *
 369    * @param [in] value true or false
 370    */
 371   void SetFontDetectionAutomatic(bool value);
 372
 373   /**
 374    * @brief Query whether TextActor is using automatic font detection.
 375    *
 376    * @return true or false
 377    */
 378   bool IsFontDetectionAutomatic() const;
 379
 380   /**
 381    * @brief Query whether the font has been loaded and built.
 382    *
 383    * Should be used by the application to determine whether the font
 384    * is ready to be queried for metrics
 385    * @return The loading state, either Loading, Success or Failed.
 386    */
 387   LoadingState GetLoadingState() const;
 388
 389   /**
 390    * @brief Emitted when text loads successfully and is available for displaying, or when the loading fails.
 391    *
 392    * @return A signal object to Connect() with.
 393    */
 394   TextSignalV2& TextAvailableSignal();
 395
 396 public: // Not intended for use by Application developers
 397
 398   /**
 399    * @brief This constructor is used by Dali New() methods
 400    * e
 401    * @param [in] actor A pointer to a newly allocated Dali resource
 402    */
 403   explicit DALI_INTERNAL TextActor(Internal::TextActor* actor);
 404 };
 405
 406 } // namespace Dali
 407
 408 #endif // __DALI_TEXT_ACTOR_H__