1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
2 #define __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
39 * @brief A control which renders a short text string.
41 class TextField : public Control, public Text::ControlInterface
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
53 * @copydoc Dali::Toollkit::TextField::New()
55 static Toolkit::TextField New();
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.
65 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
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.
73 static Property::Value GetProperty( BaseObject* object, Property::Index index );
75 private: // From Control
78 * @copydoc Control::OnInitialize()
80 virtual void OnInitialize();
83 * @copydoc Control::GetNaturalSize()
85 virtual Vector3 GetNaturalSize();
88 * @copydoc Control::GetHeightForWidth()
90 virtual float GetHeightForWidth( float width );
93 * @copydoc Control::OnInitialize()
95 virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container );
98 * Received for single & double taps
100 void OnTap( Actor actor, const TapGesture& tap );
103 * @copydoc Text::ControlInterface::RequestTextRelayout()
105 virtual void RequestTextRelayout();
107 private: // Implementation
110 * Construct a new TextField.
115 * A reference counted object may only be deleted by calling Unreference()
117 virtual ~TextField();
121 // Undefined copy constructor and assignment operators
122 TextField(const TextField&);
123 TextField& operator=(const TextField& rhs);
127 Text::ControllerPtr mController;
128 Text::RendererPtr mRenderer;
129 Text::DecoratorPtr mDecorator;
131 TapGestureDetector mDoubleTapDetector;
133 unsigned int mRenderingBackend;
136 } // namespace Internal
138 // Helpers for public-api forwarding methods
140 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
142 DALI_ASSERT_ALWAYS(textField);
144 Dali::RefObject& handle = textField.GetImplementation();
146 return static_cast<Toolkit::Internal::TextField&>(handle);
149 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
151 DALI_ASSERT_ALWAYS(textField);
153 const Dali::RefObject& handle = textField.GetImplementation();
155 return static_cast<const Toolkit::Internal::TextField&>(handle);
158 } // namespace Toolkit
162 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__