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