dali-toolkit/public-api/controls/text-controls/text-label.h

   1 #ifndef __DALI_TOOLKIT_TEXT_LABEL_H__
   2 #define __DALI_TOOLKIT_TEXT_LABEL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextLabel;
  33 }
  34 /**
  35  * @addtogroup dali-toolkit-controls-text-controls
  36  * @{
  37  */
  38
  39 /**
  40  * @brief A control which renders a short text string.
  41  *
  42  * Text labels are lightweight, non-editable and do not respond to user input.
  43  */
  44 class DALI_IMPORT_API TextLabel : public Control
  45 {
  46 public:
  47
  48   /**
  49    * @brief The start and end property ranges for this control.
  50    */
  51   enum PropertyRange
  52   {
  53     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  54     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  55   };
  56
  57   /**
  58    * @brief An enumeration of properties belonging to the TextLabel class.
  59    */
  60   struct Property
  61   {
  62     enum
  63     {
  64       RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend",    The type or rendering e.g. bitmap-based,          type INT
  65       TEXT,                                     ///< name "text",                 The text to display in UTF-8 format,              type STRING
  66       FONT_FAMILY,                              ///< name "font-family",          The requested font family,                        type STRING
  67       FONT_STYLE,                               ///< name "font-style",           The requested font style e.g. Regular/Italic,     type STRING
  68       POINT_SIZE,                               ///< name "point-size",           The size of font in points,                       type FLOAT
  69       MULTI_LINE,                               ///< name "multi-line",           The single-line or multi-line layout option,      type BOOLEAN
  70       HORIZONTAL_ALIGNMENT,                     ///< name "horizontal-alignment", The line horizontal alignment,                    type STRING,  values "BEGIN", "CENTER", "END"
  71       VERTICAL_ALIGNMENT,                       ///< name "vertical-alignment",   The line vertical alignment,                      type STRING,  values   "TOP",   "CENTER",   "BOTTOM"
  72       TEXT_COLOR,                               ///< name "text-color",           The text color,                                   type VECTOR4
  73       SHADOW_OFFSET,                            ///< name "shadow-offset",        The drop shadow offset 0 indicates no shadow,     type VECTOR2
  74       SHADOW_COLOR,                             ///< name "shadow-color",         The color of a drop shadow,                       type VECTOR4
  75       UNDERLINE_ENABLED,                        ///< name "underline-enabled",    The underline enabled flag,                       type BOOLEAN
  76       UNDERLINE_COLOR,                          ///< name "underline-color",      The color of the underline,                       type VECTOR4
  77       UNDERLINE_HEIGHT                          ///< name "underline-height",     Overrides the underline height from font metrics, type FLOAT
  78     };
  79   };
  80
  81   /**
  82    * @brief Create the TextLabel control.
  83    *
  84    * @return A handle to the TextLabel control.
  85    */
  86   static TextLabel New();
  87
  88   /**
  89    * @brief Create the TextLabel control.
  90    *
  91    * @param[in] text The text to display.
  92    * @return A handle to the TextLabel control.
  93    */
  94   static TextLabel New( const std::string& text );
  95
  96   /**
  97    * @brief Creates an empty handle.
  98    */
  99   TextLabel();
 100
 101   /**
 102    * @brief Copy constructor.
 103    *
 104    * @param[in] handle The handle to copy from.
 105    */
 106   TextLabel( const TextLabel& handle );
 107
 108   /**
 109    * @brief Assignment operator.
 110    *
 111    * @param[in] handle The handle to copy from.
 112    * @return A reference to this.
 113    */
 114   TextLabel& operator=( const TextLabel& handle );
 115
 116   /**
 117    * @brief Destructor
 118    *
 119    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 120    */
 121   ~TextLabel();
 122
 123   /**
 124    * @brief Downcast a handle to TextLabel.
 125    *
 126    * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
 127    * If not the returned handle is left empty.
 128    *
 129    * @param[in] handle Handle to an object
 130    * @return handle to a TextLabel or an empty handle
 131    */
 132   static TextLabel DownCast( BaseHandle handle );
 133
 134 public: // Not intended for application developers
 135
 136   /**
 137    * @brief Creates a handle using the Toolkit::Internal implementation.
 138    *
 139    * @param[in] implementation The Control implementation.
 140    */
 141   DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
 142
 143   /**
 144    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 145    *
 146    * @param[in]  internal  A pointer to the internal CustomActor.
 147    */
 148   explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
 149 };
 150
 151 /**
 152  * @}
 153  */
 154 } // namespace Toolkit
 155
 156 } // namespace Dali
 157
 158 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__