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