1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_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/internal/text/decorator/text-decorator.h>
23 #include <dali-toolkit/internal/text/text-control-interface.h>
24 #include <dali-toolkit/internal/text/text-view.h>
27 #include <dali/public-api/common/intrusive-ptr.h>
28 #include <dali/public-api/events/key-event.h>
29 #include <dali/public-api/math/vector3.h>
30 #include <dali/public-api/math/vector2.h>
31 #include <dali/public-api/object/ref-object.h>
46 typedef IntrusivePtr<Controller> ControllerPtr;
47 typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
50 * @brief A Text Controller is used by UI Controls which display text.
52 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
53 * It provides a view of the text that can be used by rendering back-ends.
55 * For selectable/editable UI controls, the controller handles input events from the UI control
56 * and decorations (grab handles etc) via an observer interface.
58 class Controller : public RefObject, public Decorator::Observer
63 * @brief Text related operations to be done in the relayout process.
67 NO_OPERATION = 0x0000,
68 CONVERT_TO_UTF32 = 0x0001,
70 VALIDATE_FONTS = 0x0004,
71 GET_LINE_BREAKS = 0x0008,
72 GET_WORD_BREAKS = 0x0010,
74 GET_GLYPH_METRICS = 0x0040,
76 UPDATE_ACTUAL_SIZE = 0x0100,
77 UPDATE_POSITIONS = 0x0200,
81 ALL_OPERATIONS = 0xFFFF
87 * @brief Create a new instance of a Controller.
89 * @param[in] controlInterface An interface used to request a text relayout.
90 * @return A pointer to a new Controller.
92 static ControllerPtr New( ControlInterface& controlInterface );
95 * @brief Replaces any text previously set.
97 * @note This will be converted into UTF-32 when stored in the text model.
98 * @param[in] text A string of UTF-8 characters.
100 void SetText( const std::string& text );
103 * @brief Retrieve any text previously set.
105 * @return A string of UTF-8 characters.
107 void GetText( std::string& text ) const;
110 * @brief Replaces any placeholder text previously set.
112 * @param[in] text A string of UTF-8 characters.
114 void SetPlaceholderText( const std::string& text );
117 * @brief Retrieve any placeholder text previously set.
119 * @return A string of UTF-8 characters.
121 void GetPlaceholderText( std::string& text ) const;
124 * @brief Set the default font family.
126 * @param[in] defaultFontFamily The default font family.
128 void SetDefaultFontFamily( const std::string& defaultFontFamily );
131 * @brief Retrieve the default font family.
133 * @return The default font family.
135 const std::string& GetDefaultFontFamily() const;
138 * @brief Set the default font style.
140 * @param[in] defaultFontStyle The default font style.
142 void SetDefaultFontStyle( const std::string& defaultFontStyle );
145 * @brief Retrieve the default font style.
147 * @return The default font style.
149 const std::string& GetDefaultFontStyle() const;
152 * @brief Set the default point size.
154 * @param[in] defaultFontStyle The default point size.
156 void SetDefaultPointSize( float pointSize );
159 * @brief Retrieve the default point size.
161 * @return The default point size.
163 float GetDefaultPointSize() const;
166 * @brief Called to enable text input.
168 * @note Only selectable or editable controls should calls this.
169 * @param[in] decorator Used to create cursor, selection handle decorations etc.
171 void EnableTextInput( DecoratorPtr decorator );
174 * @brief Triggers a relayout which updates View (if necessary).
176 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
177 * @param[in] size A the size of a bounding box to layout text within.
178 * @return True if the text model or decorations were updated.
180 bool Relayout( const Vector2& size );
183 * @brief Lays-out the text.
185 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
187 * @param[in] size A the size of a bounding box to layout text within.
188 * @param[in] operations The layout operations which need to be done.
190 bool DoRelayout( const Vector2& size, OperationsMask operations );
193 * @copydoc Control::GetNaturalSize()
195 Vector3 GetNaturalSize();
198 * @copydoc Control::GetHeightForWidth()
200 float GetHeightForWidth( float width );
203 * @brief Return the layout engine.
205 * @return A reference to the layout engine.
207 LayoutEngine& GetLayoutEngine();
210 * @brief Return a view of the text.
212 * @return A reference to the view.
217 * @brief Caller by editable UI controls when keyboard focus is gained.
219 void KeyboardFocusGainEvent();
222 * @brief Caller by editable UI controls when focus is lost.
224 void KeyboardFocusLostEvent();
227 * @brief Caller by editable UI controls when key events are received.
229 * @param[in] event The key event.
231 bool KeyEvent( const Dali::KeyEvent& event );
234 * @brief Caller by editable UI controls when a tap gesture occurs.
235 * @param[in] tapCount The number of taps.
236 * @param[in] x The x position relative to the top-left of the parent control.
237 * @param[in] y The y position relative to the top-left of the parent control.
239 void TapEvent( unsigned int tapCount, float x, float y );
242 * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent()
244 virtual void GrabHandleEvent( GrabHandleState state, float x, float y );
249 * @brief A reference counted object may only be deleted by calling Unreference().
251 virtual ~Controller();
256 * @brief Request a relayout using the ControlInterface.
258 void RequestRelayout();
261 * @brief Private constructor.
263 Controller( ControlInterface& controlInterface );
266 Controller( const Controller& handle );
269 Controller& operator=( const Controller& handle );
276 // Avoid allocating this when the user does not specify a font
279 // Avoid allocating this for non-editable controls
285 } // namespace Toolkit
289 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__