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