dali-toolkit/internal/controls/text-controls/text-field-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
   2 #define __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_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-impl.h>
  23 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  24 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  25 #include <dali-toolkit/internal/text/text-control-interface.h>
  26 #include <dali-toolkit/internal/text/text-controller.h>
  27 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal
  36 {
  37
  38 /**
  39  * @brief A control which renders a short text string.
  40  */
  41 class TextField : public Control, public Text::ControlInterface
  42 {
  43 public:
  44
  45   // Properties
  46   enum
  47   {
  48     TEXTFIELD_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  49     TEXTFIELD_PROPERTY_END_INDEX = TEXTFIELD_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
  50   };
  51
  52   /**
  53    * @copydoc Dali::Toollkit::TextField::New()
  54    */
  55   static Toolkit::TextField New();
  56
  57   // Properties
  58
  59   /**
  60    * Called when a property of an object of this type is set.
  61    * @param[in] object The object whose property is set.
  62    * @param[in] index The property index.
  63    * @param[in] value The new property value.
  64    */
  65   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  66
  67   /**
  68    * Called to retrieve a property of an object of this type.
  69    * @param[in] object The object whose property is to be retrieved.
  70    * @param[in] index The property index.
  71    * @return The current value of the property.
  72    */
  73   static Property::Value GetProperty( BaseObject* object, Property::Index index );
  74
  75 private: // From Control
  76
  77   /**
  78    * @copydoc Control::OnInitialize()
  79    */
  80   virtual void OnInitialize();
  81
  82   /**
  83    * @copydoc Control::GetNaturalSize()
  84    */
  85   virtual Vector3 GetNaturalSize();
  86
  87   /**
  88    * @copydoc Control::GetHeightForWidth()
  89    */
  90   virtual float GetHeightForWidth( float width );
  91
  92   /**
  93    * @copydoc Control::OnInitialize()
  94    */
  95   virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container );
  96
  97   /**
  98    * Received for single & double taps
  99    */
 100   void OnTap( Actor actor, const TapGesture& tap );
 101
 102   /**
 103    * @copydoc Text::ControlInterface::RequestTextRelayout()
 104    */
 105   virtual void RequestTextRelayout();
 106
 107 private: // Implementation
 108
 109   /**
 110    * Construct a new TextField.
 111    */
 112   TextField();
 113
 114   /**
 115    * A reference counted object may only be deleted by calling Unreference()
 116    */
 117   virtual ~TextField();
 118
 119 private:
 120
 121   // Undefined copy constructor and assignment operators
 122   TextField(const TextField&);
 123   TextField& operator=(const TextField& rhs);
 124
 125 private: // Data
 126
 127   Text::ControllerPtr mController;
 128   Text::RendererPtr mRenderer;
 129   Text::DecoratorPtr mDecorator;
 130
 131   TapGestureDetector mDoubleTapDetector;
 132
 133   unsigned int mRenderingBackend;
 134 };
 135
 136 } // namespace Internal
 137
 138 // Helpers for public-api forwarding methods
 139
 140 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
 141 {
 142   DALI_ASSERT_ALWAYS(textField);
 143
 144   Dali::RefObject& handle = textField.GetImplementation();
 145
 146   return static_cast<Toolkit::Internal::TextField&>(handle);
 147 }
 148
 149 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
 150 {
 151   DALI_ASSERT_ALWAYS(textField);
 152
 153   const Dali::RefObject& handle = textField.GetImplementation();
 154
 155   return static_cast<const Toolkit::Internal::TextField&>(handle);
 156 }
 157
 158 } // namespace Toolkit
 159
 160 } // namespace Dali
 161
 162 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__