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 #include <dali-toolkit/public-api/text/rendering/text-renderer.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 class TextLabel;
  34 }
  35
  36 /**
  37  * @brief A control which renders a short text string.
  38  *
  39  * Text labels are lightweight, non-editable and do not respond to user input.
  40  */
  41 class DALI_IMPORT_API TextLabel : public Control
  42 {
  43 public:
  44
  45   // Property indices
  46   static const Property::Index PROPERTY_TEXT;       ///< name "text", type STRING
  47   static const Property::Index PROPERTY_MULTI_LINE; ///< name "multi-line", type BOOLEAN
  48
  49   // Property names
  50   static const std::string TEXT_PROPERTY_NAME;       ///< Property, name "text", type STRING
  51   static const std::string MULTI_LINE_PROPERTY_NAME; ///< Property, name "multi-line", type BOOLEAN
  52
  53   /**
  54    * Create the TextLabel control.
  55    * @return A handle to the TextLabel control.
  56    */
  57   static TextLabel New();
  58
  59   /**
  60    * @brief Creates an empty handle.
  61    */
  62   TextLabel();
  63
  64   /**
  65    * @brief Copy constructor.
  66    *
  67    * @param[in] handle The handle to copy from.
  68    */
  69   TextLabel( const TextLabel& handle );
  70
  71   /**
  72    * @brief Assignment operator.
  73    *
  74    * @param[in] handle The handle to copy from.
  75    * @return A reference to this.
  76    */
  77   TextLabel& operator=( const TextLabel& handle );
  78
  79   /**
  80    * @brief Destructor
  81    *
  82    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  83    */
  84   ~TextLabel();
  85
  86   /**
  87    * @brief Downcast a handle to TextLabel.
  88    *
  89    * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
  90    * If not the returned handle is left empty.
  91    *
  92    * @param[in] handle Handle to an object
  93    * @return handle to a TextLabel or an empty handle
  94    */
  95   static TextLabel DownCast( BaseHandle handle );
  96
  97   /**
  98    * @brief Set the rendering back-end used by the TextLabel.
  99    *
 100    * @param[in] renderer The text renderer to use.
 101    */
 102   void SetRenderer( Text::RendererPtr renderer );
 103
 104 public: // Not intended for application developers
 105
 106   /**
 107    * @brief Creates a handle using the Toolkit::Internal implementation.
 108    *
 109    * @param[in] implementation The Control implementation.
 110    */
 111   DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
 112
 113   /**
 114    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 115    *
 116    * @param[in]  internal  A pointer to the internal CustomActor.
 117    */
 118   explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
 119 };
 120
 121 } // namespace Toolkit
 122
 123 } // namespace Dali
 124
 125 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__