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,
78 UPDATE_LINES = 0x0400,
82 ALL_OPERATIONS = 0xFFFF
88 * @brief Create a new instance of a Controller.
90 * @param[in] controlInterface An interface used to request a text relayout.
91 * @return A pointer to a new Controller.
93 static ControllerPtr New( ControlInterface& controlInterface );
96 * @brief Replaces any text previously set.
98 * @note This will be converted into UTF-32 when stored in the text model.
99 * @param[in] text A string of UTF-8 characters.
101 void SetText( const std::string& text );
104 * @brief Retrieve any text previously set.
106 * @return A string of UTF-8 characters.
108 void GetText( std::string& text ) const;
111 * @brief Replaces any placeholder text previously set.
113 * @param[in] text A string of UTF-8 characters.
115 void SetPlaceholderText( const std::string& text );
118 * @brief Retrieve any placeholder text previously set.
120 * @return A string of UTF-8 characters.
122 void GetPlaceholderText( std::string& text ) const;
125 * @brief Set the default font family.
127 * @param[in] defaultFontFamily The default font family.
129 void SetDefaultFontFamily( const std::string& defaultFontFamily );
132 * @brief Retrieve the default font family.
134 * @return The default font family.
136 const std::string& GetDefaultFontFamily() const;
139 * @brief Set the default font style.
141 * @param[in] defaultFontStyle The default font style.
143 void SetDefaultFontStyle( const std::string& defaultFontStyle );
146 * @brief Retrieve the default font style.
148 * @return The default font style.
150 const std::string& GetDefaultFontStyle() const;
153 * @brief Set the default point size.
155 * @param[in] defaultFontStyle The default point size.
157 void SetDefaultPointSize( float pointSize );
160 * @brief Retrieve the default point size.
162 * @return The default point size.
164 float GetDefaultPointSize() const;
167 * @brief Called to enable text input.
169 * @note Only selectable or editable controls should calls this.
170 * @param[in] decorator Used to create cursor, selection handle decorations etc.
172 void EnableTextInput( DecoratorPtr decorator );
175 * @brief Triggers a relayout which updates View (if necessary).
177 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
178 * @param[in] size A the size of a bounding box to layout text within.
179 * @return True if the text model or decorations were updated.
181 bool Relayout( const Vector2& size );
184 * @brief Lays-out the text.
186 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
188 * @param[in] size A the size of a bounding box to layout text within.
189 * @param[in] operations The layout operations which need to be done.
190 * @param[out] layoutSize The size of the laid-out text.
192 bool DoRelayout( const Vector2& size,
193 OperationsMask operations,
197 * @copydoc Control::GetNaturalSize()
199 Vector3 GetNaturalSize();
202 * @copydoc Control::GetHeightForWidth()
204 float GetHeightForWidth( float width );
207 * @brief Return the layout engine.
209 * @return A reference to the layout engine.
211 LayoutEngine& GetLayoutEngine();
214 * @brief Return a view of the text.
216 * @return A reference to the view.
221 * @brief Caller by editable UI controls when keyboard focus is gained.
223 void KeyboardFocusGainEvent();
226 * @brief Caller by editable UI controls when focus is lost.
228 void KeyboardFocusLostEvent();
231 * @brief Caller by editable UI controls when key events are received.
233 * @param[in] event The key event.
235 bool KeyEvent( const Dali::KeyEvent& event );
238 * @brief Caller by editable UI controls when a tap gesture occurs.
239 * @param[in] tapCount The number of taps.
240 * @param[in] x The x position relative to the top-left of the parent control.
241 * @param[in] y The y position relative to the top-left of the parent control.
243 void TapEvent( unsigned int tapCount, float x, float y );
246 * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent()
248 virtual void GrabHandleEvent( GrabHandleState state, float x, float y );
253 * @brief A reference counted object may only be deleted by calling Unreference().
255 virtual ~Controller();
260 * @brief Request a relayout using the ControlInterface.
262 void RequestRelayout();
265 * @brief Private constructor.
267 Controller( ControlInterface& controlInterface );
270 Controller( const Controller& handle );
273 Controller& operator=( const Controller& handle );
280 // Avoid allocating this when the user does not specify a font
283 // Avoid allocating this for non-editable controls
289 } // namespace Toolkit
293 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__