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/public-api/common/intrusive-ptr.h>
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali-toolkit/public-api/text/text-view.h>
41 typedef IntrusivePtr<Controller> ControllerPtr;
44 * @brief A Text Controller is used by UI Controls which display text.
46 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
47 * It provides a view of the text that can be used by rendering back-ends.
49 class Controller : public RefObject
54 * @brief Create a new instance of a Controller.
56 * @return A pointer to a new Controller.
58 static ControllerPtr New();
61 * @brief Replaces any text previously set.
63 * @note This will be converted into UTF-32 when stored in the text model.
64 * @param[in] text A string of UTF-8 characters.
66 void SetText( const std::string& text );
69 * @brief Triggers a relayout which updates View (if necessary).
71 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
72 * @param[in] size A the size of a bounding box to layout text within.
73 * @return True if the View was updated.
75 bool Relayout( const Vector2& size );
78 * @brief Return the layout engine.
80 * @return A reference to the layout engine.
82 LayoutEngine& GetLayoutEngine();
85 * @brief Return a view of the text.
87 * @return A reference to the view.
94 * @brief A reference counted object may only be deleted by calling Unreference().
96 virtual ~Controller();
101 * @brief Private constructor.
106 * @brief Populates the visual model.
108 void UpdateVisualModel();
111 Controller( const Controller& handle );
114 Controller& operator=( const Controller& handle );
123 } // namespace Toolkit
127 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__