1 #ifndef __DALI_TOOLKIT_TEXT_DECORATOR_H__
2 #define __DALI_TOOLKIT_TEXT_DECORATOR_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>
44 typedef IntrusivePtr<Decorator> DecoratorPtr;
46 // Used to set the cursor positions etc.
49 PRIMARY_CURSOR, ///< The primary cursor for bidirectional text (or the regular cursor for single-direction text)
50 SECONDARY_CURSOR, ///< The secondary cursor for bidirectional text
54 // Determines which of the cursors are active (if any).
57 ACTIVE_CURSOR_NONE, ///< Neither primary nor secondary cursor are active
58 ACTIVE_CURSOR_PRIMARY, ///< Primary cursor is active (only)
59 ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active
62 // The state information for grab handle events
70 // The set the selection-handle positions etc.
73 PRIMARY_SELECTION_HANDLE,
74 SECONDARY_SELECTION_HANDLE,
75 SELECTION_HANDLE_COUNT
78 enum SelectionHandleState
80 SELECTION_HANDLE_PRESSED,
81 SELECTION_HANDLE_RELEASED
85 * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
87 * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
88 * In some cases the decorations will be moved or flipped around, to maintain visibility on-screen.
90 * Decorator components forward input events to a controller class through an observer interface.
91 * The controller is responsible for selecting which components are active.
93 class Decorator : public RefObject
102 * @brief Constructor.
107 * @brief Virtual destructor.
109 virtual ~Observer() {};
112 * @brief An input event from the grab handle.
114 * @param[in] state The grab handle state.
115 * @param[in] x The x position relative to the top-left of the parent control.
117 virtual void GrabHandleEvent( GrabHandleState state, float x ) = 0;
121 * @brief Create a new instance of a Decorator.
123 * @param[in] parent Decorations will be added to this parent control.
124 * @param[in] observer A class which receives input events from Decorator components.
125 * @return A pointer to a new Decorator.
127 static DecoratorPtr New( Dali::Toolkit::Internal::Control& parent, Observer& observer );
130 * @brief The decorator waits until a relayout before creating actors etc.
132 * @param[in] size The size of the parent control after size-negotiation.
134 void Relayout( const Dali::Vector2& size );
137 * @brief Sets which of the cursors are active.
139 * @note Cursor will only be visible if within the parent area.
140 * @param[in] activeCursor Which of the cursors should be active (if any).
142 void SetActiveCursor( ActiveCursor activeCursor );
145 * @brief Query which of the cursors are active.
147 * @return Which of the cursors are active (if any).
149 unsigned int GetActiveCursor() const;
152 * @brief Sets the position of a cursor.
154 * @param[in] cursor The cursor to set.
155 * @param[in] x The x position relative to the top-left of the parent control.
156 * @param[in] y The y position relative to the top-left of the parent control.
157 * @param[in] height The logical height of the cursor.
159 void SetPosition( Cursor cursor, float x, float y, float height );
162 * @brief Retrieves the position of a cursor.
164 * @param[in] cursor The cursor to get.
165 * @param[out] x The x position relative to the top-left of the parent control.
166 * @param[out] y The y position relative to the top-left of the parent control.
167 * @param[out] height The logical height of the cursor.
169 void GetPosition( Cursor cursor, float& x, float& y, float& height ) const;
172 * @brief Sets the image for a cursor.
174 * @param[in] image The image to use.
176 void SetCursorImage( Dali::Image image );
179 * @brief Retrieves the image for a cursor.
181 * @return The cursor image.
183 Dali::Image GetCursorImage() const;
186 * @brief Sets the color for a cursor.
188 * @param[in] cursor Whether this color is for the primary or secondary cursor.
189 * @param[in] color The color to use.
191 void SetColor( Cursor cursor, const Dali::Vector4& color );
194 * @brief Retrieves the color for a cursor.
196 * @param[in] cursor Whether this color is for the primary or secondary cursor.
197 * @return The cursor color.
199 const Dali::Vector4& GetColor( Cursor cursor ) const;
202 * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
204 void StartCursorBlink();
207 * @brief Stop blinking the cursor.
209 void StopCursorBlink();
212 * @brief Set the interval between cursor blinks.
214 * @param[in] seconds The interval in seconds.
216 void SetCursorBlinkInterval( float seconds );
219 * @brief Retrieves the blink-interval for a cursor.
221 * @return The cursor blink-interval.
223 float GetCursorBlinkInterval() const;
226 * @brief The cursor will stop blinking after this duration.
228 * @param[in] seconds The duration in seconds.
230 void SetCursorBlinkDuration( float seconds );
233 * @brief Retrieves the blink-duration for a cursor.
235 * @return The cursor blink-duration.
237 float GetCursorBlinkDuration() const;
240 * @brief Sets whether the grab handle is active.
242 * @note The grab handle follows the cursor position set with SetPosition(Cursor, ...)
243 * @param[in] active True if the grab handle should be active.
245 void SetGrabHandleActive( bool active );
248 * @brief Query whether the grab handle is active.
250 * @return True if the grab handle should be active.
252 bool IsGrabHandleActive() const;
255 * @brief Sets the image for the grab handle.
257 * @param[in] image The image to use.
259 void SetGrabHandleImage( Dali::Image image );
262 * @brief Retrieves the image for the grab handle.
264 * @return The grab handle image.
266 Dali::Image GetGrabHandleImage() const;
269 * @brief Sets whether the selection handles and highlight are active.
271 * @param[in] active True if the selection handles and highlight are active.
273 void SetSelectionActive( bool active );
276 * @brief Query whether the selection handles and highlight are active.
278 * @return True if the selection handles and highlight are active.
280 bool IsSelectionActive() const;
283 * @brief Sets the position of a selection handle.
285 * @param[in] handle The handle to set.
286 * @param[in] x The x position relative to the top-left of the parent control.
287 * @param[in] y The y position relative to the top-left of the parent control.
288 * @param[in] cursorHeight The logical cursor height at this position.
290 void SetPosition( SelectionHandle handle, float x, float y, float cursorHeight );
293 * @brief Retrieves the position of a selection handle.
295 * @param[in] handle The handle to get.
296 * @param[out] x The x position relative to the top-left of the parent control.
297 * @param[out] y The y position relative to the top-left of the parent control.
298 * @param[out] cursorHeight The logical cursor height at this position.
300 void GetPosition( SelectionHandle handle, float& x, float& y, float& cursorHeight ) const;
303 * @brief Sets the image for one of the selection handles.
305 * @param[in] handle The selection handle.
306 * @param[in] state A different image can be set for the pressed/released states.
307 * @param[in] image The image to use.
309 void SetImage( SelectionHandle handle, SelectionHandleState state, Dali::Image image );
312 * @brief Retrieves the image for a selection handle.
314 * @param[in] handle The selection handle.
315 * @param[in] state A different image can be set for the pressed/released states.
318 Dali::Image GetImage( SelectionHandle handle, SelectionHandleState state ) const;
323 * @brief A reference counted object may only be deleted by calling Unreference().
325 virtual ~Decorator();
330 * @brief Private constructor.
331 * @param[in] parent Decorations will be added to this parent control.
332 * @param[in] observer A class which receives input events from Decorator components.
334 Decorator(Dali::Toolkit::Internal::Control& parent, Observer& observer );
337 Decorator( const Decorator& handle );
340 Decorator& operator=( const Decorator& handle );
349 } // namespace Toolkit
353 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__