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>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/math/vector2.h>
46 typedef IntrusivePtr<Decorator> DecoratorPtr;
48 // Used to set the cursor positions etc.
51 PRIMARY_CURSOR, ///< The primary cursor for bidirectional text (or the regular cursor for single-direction text)
52 SECONDARY_CURSOR, ///< The secondary cursor for bidirectional text
56 // Determines which of the cursors are active (if any).
59 ACTIVE_CURSOR_NONE, ///< Neither primary nor secondary cursor are active
60 ACTIVE_CURSOR_PRIMARY, ///< Primary cursor is active (only)
61 ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active
64 // The state information for handle events.
74 // Used to set different handle images
78 HANDLE_IMAGE_RELEASED,
79 HANDLE_IMAGE_TYPE_COUNT
86 LEFT_SELECTION_HANDLE,
87 RIGHT_SELECTION_HANDLE,
92 * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
94 * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
96 * The Popup decoration will be positioned either above the Grab handle or above the selection handles but if doing so
97 * would cause the Popup to exceed the Decoration Bounding Box ( see SetBoundingBox API ) the the Popup will be repositioned below the handle(s).
99 * Selection handles will be flipped around to ensure they do not exceed the Decoration Bounding Box. ( Stay visible ).
101 * Decorator components forward input events to a controller class through an observer interface.
102 * The controller is responsible for selecting which components are active.
104 class Decorator : public RefObject
113 * @brief Constructor.
118 * @brief Virtual destructor.
120 virtual ~Observer() {};
123 * @brief An input event from one of the handles.
125 * @param[in] handleType The handle's type.
126 * @param[in] state The handle's state.
127 * @param[in] x The x position relative to the top-left of the parent control.
128 * @param[in] y The y position relative to the top-left of the parent control.
130 virtual void HandleEvent( HandleType handleType, HandleState state, float x, float y ) = 0;
134 * @brief Create a new instance of a Decorator.
136 * @param[in] parent Decorations will be added to this parent control.
137 * @param[in] observer A class which receives input events from Decorator components.
138 * @return A pointer to a new Decorator.
140 static DecoratorPtr New( Dali::Toolkit::Internal::Control& parent, Observer& observer );
143 * @brief Set the bounding box which handles, popup and similar decorations will not exceed.
145 * The default value is the width and height of the stage from the top left origin.
146 * If a title bar for example is on the top of the screen then the y should be the title's height and
147 * the boundary height the stage height minus the title's height.
148 * Restrictions - The boundary box should be set up with a fixed z position for the text-input and the default camera.
150 * ------------------------------------------
152 * |o---------------------------------------|
154 * || Bounding Box || boundary height
156 * |----------------------------------------|
157 * ------------------------------------------
160 * @param[in] boundingBox Vector( x coordinate, y coordinate, width, height )
162 void SetBoundingBox( const Rect<int>& boundingBox );
165 * @brief Retrieve the bounding box origin and dimensions.
167 * default is set once control is added to stage, before this the return vector will be Vector4:ZERO
168 * @return Rect<int> the bounding box origin, width and height
170 const Rect<int>& GetBoundingBox() const;
173 * @brief The decorator waits until a relayout before creating actors etc.
175 * @param[in] size The size of the parent control after size-negotiation.
177 void Relayout( const Dali::Vector2& size );
180 * @brief Updates the decorator's actor positions after scrolling.
182 * @param[in] scrollOffset The scroll offset.
184 void UpdatePositions( const Vector2& scrollOffset );
187 * @brief Sets which of the cursors are active.
189 * @note Cursor will only be visible if within the parent area.
190 * @param[in] activeCursor Which of the cursors should be active (if any).
192 void SetActiveCursor( ActiveCursor activeCursor );
195 * @brief Query which of the cursors are active.
197 * @return Which of the cursors are active (if any).
199 unsigned int GetActiveCursor() const;
202 * @brief Sets the position of a cursor.
204 * @param[in] cursor The cursor to set.
205 * @param[in] x The x position relative to the top-left of the parent control.
206 * @param[in] y The y position relative to the top-left of the parent control.
207 * @param[in] cursorHeight The logical height of the cursor.
208 * @param[in] lineHeight The logical height of the line.
210 void SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight );
213 * @brief Retrieves the position, height and lineHeight of a cursor.
215 * @param[in] cursor The cursor to get.
216 * @param[out] x The x position relative to the top-left of the parent control.
217 * @param[out] y The y position relative to the top-left of the parent control.
218 * @param[out] cursorHeight The logical height of the cursor.
219 * @param[out] lineHeight The logical height of the line.
221 void GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const;
224 * @brief Retrieves the position of a cursor.
226 * @param[in] cursor The cursor to get.
228 * @return The position.
230 const Vector2& GetPosition( Cursor cursor ) const;
233 * @brief Sets the color for a cursor.
235 * @param[in] cursor Whether this color is for the primary or secondary cursor.
236 * @param[in] color The color to use.
238 void SetColor( Cursor cursor, const Dali::Vector4& color );
241 * @brief Retrieves the color for a cursor.
243 * @param[in] cursor Whether this color is for the primary or secondary cursor.
244 * @return The cursor color.
246 const Dali::Vector4& GetColor( Cursor cursor ) const;
249 * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
251 void StartCursorBlink();
254 * @brief Stop blinking the cursor.
256 void StopCursorBlink();
259 * @brief Set the interval between cursor blinks.
261 * @param[in] seconds The interval in seconds.
263 void SetCursorBlinkInterval( float seconds );
266 * @brief Retrieves the blink-interval for a cursor.
268 * @return The cursor blink-interval.
270 float GetCursorBlinkInterval() const;
273 * @brief The cursor will stop blinking after this duration.
275 * @param[in] seconds The duration in seconds.
277 void SetCursorBlinkDuration( float seconds );
280 * @brief Retrieves the blink-duration for a cursor.
282 * @return The cursor blink-duration.
284 float GetCursorBlinkDuration() const;
287 * @brief Sets whether a handle is active.
289 * @param[in] handleType One of the handles.
290 * @param[in] active True if the handle should be active.
292 void SetHandleActive( HandleType handleType,
296 * @brief Query whether a handle is active.
298 * @param[in] handleType One of the handles.
300 * @return True if the handle is active.
302 bool IsHandleActive( HandleType handleType ) const;
305 * @brief Sets the image for one of the handles.
307 * @param[in] handleType One of the handles.
308 * @param[in] handleImageType A different image can be set for the pressed/released states.
309 * @param[in] image The image to use.
311 void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
314 * @brief Retrieves the image for one of the handles.
316 * @param[in] handleType One of the handles.
317 * @param[in] handleImageType A different image can be set for the pressed/released states.
319 * @return The grab handle image.
321 Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
324 * @brief Sets the position of a selection handle.
326 * @param[in] handleType The handle to set.
327 * @param[in] x The x position relative to the top-left of the parent control.
328 * @param[in] y The y position relative to the top-left of the parent control.
329 * @param[in] lineHeight The logical line height at this position.
331 void SetPosition( HandleType handleType, float x, float y, float lineHeight );
334 * @brief Retrieves the position of a selection handle.
336 * @param[in] handleType The handle to get.
337 * @param[out] x The x position relative to the top-left of the parent control.
338 * @param[out] y The y position relative to the top-left of the parent control.
339 * @param[out] lineHeight The logical line height at this position.
341 void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
344 * @brief Adds a quad to the existing selection highlights.
346 * @param[in] x1 The top-left x position.
347 * @param[in] y1 The top-left y position.
348 * @param[in] x2 The bottom-right x position.
349 * @param[in] y3 The bottom-right y position.
351 void AddHighlight( float x1, float y1, float x2, float y2 );
354 * @brief Removes all of the previously added highlights.
356 void ClearHighlights();
359 * @brief Sets the selection highlight color.
361 * @param[in] image The image to use.
363 void SetHighlightColor( const Vector4& color );
366 * @brief Retrieves the selection highlight color.
370 const Vector4& GetHighlightColor() const;
373 * @brief Set the Selection Popup to show or hide via the active flaf
374 * @param[in] active true to show, false to hide
376 void SetPopupActive( bool active );
379 * @brief Query whether the Selection Popup is active.
381 * @return True if the Selection Popup should be active.
383 bool IsPopupActive() const;
386 * @brief Sets the scroll threshold.
388 * It defines a square area inside the control, close to the edge.
389 * When the cursor enters this area, the decorator starts to send scroll events.
391 * @param[in] threshold The scroll threshold.
393 void SetScrollThreshold( float threshold );
396 * @brief Retrieves the scroll threshold.
398 * @retunr The scroll threshold.
400 float GetScrollThreshold() const;
403 * @brief Sets the scroll speed.
405 * Is the distance the text is going to be scrolled during a scroll interval.
407 * @param[in] speed The scroll speed.
409 void SetScrollSpeed( float speed );
412 * @brief Retrieves the scroll speed.
414 * @return The scroll speed.
416 float GetScrollSpeed() const;
419 * @brief Sets the scroll interval.
421 * @param[in] seconds The scroll interval in seconds.
423 void SetScrollTickInterval( float seconds );
426 * @brief Retrieves the scroll interval.
428 * @return The scroll interval.
430 float GetScrollTickInterval() const;
435 * @brief A reference counted object may only be deleted by calling Unreference().
437 virtual ~Decorator();
442 * @brief Private constructor.
443 * @param[in] parent Decorations will be added to this parent control.
444 * @param[in] observer A class which receives input events from Decorator components.
446 Decorator(Dali::Toolkit::Internal::Control& parent, Observer& observer );
449 Decorator( const Decorator& handle );
452 Decorator& operator=( const Decorator& handle );
461 } // namespace Toolkit
465 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__