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>
47 typedef IntrusivePtr<Decorator> DecoratorPtr;
49 // Used to set the cursor positions etc.
52 PRIMARY_CURSOR, ///< The primary cursor for bidirectional text (or the regular cursor for single-direction text)
53 SECONDARY_CURSOR, ///< The secondary cursor for bidirectional text
57 // Determines which of the cursors are active (if any).
60 ACTIVE_CURSOR_NONE, ///< Neither primary nor secondary cursor are active
61 ACTIVE_CURSOR_PRIMARY, ///< Primary cursor is active (only)
62 ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active
65 // The state information for handle events.
75 // Used to set different handle images
79 HANDLE_IMAGE_RELEASED,
80 HANDLE_IMAGE_TYPE_COUNT
87 LEFT_SELECTION_HANDLE,
88 RIGHT_SELECTION_HANDLE,
93 * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
95 * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
97 * The Popup decoration will be positioned either above the Grab handle or above the selection handles but if doing so
98 * would cause the Popup to exceed the Decoration Bounding Box ( see SetBoundingBox API ) the the Popup will be repositioned below the handle(s).
100 * Selection handles will be flipped around to ensure they do not exceed the Decoration Bounding Box. ( Stay visible ).
102 * Decorator components forward input events to a controller class through an interface.
103 * The controller is responsible for selecting which components are active.
105 class Decorator : public RefObject
109 class ControllerInterface
114 * @brief Constructor.
116 ControllerInterface() {};
119 * @brief Virtual destructor.
121 virtual ~ControllerInterface() {};
124 * @brief An input event from one of the handles.
126 * @param[out] targetSize The Size of the UI control the decorator is adding it's decorations to.
128 virtual void GetTargetSize( Vector2& targetSize ) = 0;
131 * @brief Add a decoration to the parent UI control.
133 * @param[in] decoration The actor displaying a decoration.
135 virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
138 * @brief An input event from one of the handles.
140 * @param[in] handleType The handle's type.
141 * @param[in] state The handle's state.
142 * @param[in] x The x position relative to the top-left of the parent control.
143 * @param[in] y The y position relative to the top-left of the parent control.
145 virtual void DecorationEvent( HandleType handleType, HandleState state, float x, float y ) = 0;
149 * @brief Create a new instance of a Decorator.
151 * @param[in] controller The controller which receives input events from Decorator components.
152 * @return A pointer to a new Decorator.
154 static DecoratorPtr New( ControllerInterface& controller );
157 * @brief Set the bounding box which handles, popup and similar decorations will not exceed.
159 * The default value is the width and height of the stage from the top left origin.
160 * If a title bar for example is on the top of the screen then the y should be the title's height and
161 * the boundary height the stage height minus the title's height.
162 * Restrictions - The boundary box should be set up with a fixed z position for the text-input and the default camera.
164 * ------------------------------------------
166 * |o---------------------------------------|
168 * || Bounding Box || boundary height
170 * |----------------------------------------|
171 * ------------------------------------------
174 * @param[in] boundingBox Vector( x coordinate, y coordinate, width, height )
176 void SetBoundingBox( const Rect<int>& boundingBox );
179 * @brief Retrieve the bounding box origin and dimensions.
181 * default is set once control is added to stage, before this the return vector will be Vector4:ZERO
182 * @return Rect<int> the bounding box origin, width and height
184 const Rect<int>& GetBoundingBox() const;
187 * @brief The decorator waits until a relayout before creating actors etc.
189 * @param[in] size The size of the parent control after size-negotiation.
191 void Relayout( const Dali::Vector2& size );
194 * @brief Updates the decorator's actor positions after scrolling.
196 * @param[in] scrollOffset The scroll offset.
198 void UpdatePositions( const Vector2& scrollOffset );
201 * @brief Sets which of the cursors are active.
203 * @note Cursor will only be visible if within the parent area.
204 * @param[in] activeCursor Which of the cursors should be active (if any).
206 void SetActiveCursor( ActiveCursor activeCursor );
209 * @brief Query which of the cursors are active.
211 * @return Which of the cursors are active (if any).
213 unsigned int GetActiveCursor() const;
216 * @brief Sets the position of a cursor.
218 * @param[in] cursor The cursor to set.
219 * @param[in] x The x position relative to the top-left of the parent control.
220 * @param[in] y The y position relative to the top-left of the parent control.
221 * @param[in] cursorHeight The logical height of the cursor.
222 * @param[in] lineHeight The logical height of the line.
224 void SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight );
227 * @brief Retrieves the position, height and lineHeight of a cursor.
229 * @param[in] cursor The cursor to get.
230 * @param[out] x The x position relative to the top-left of the parent control.
231 * @param[out] y The y position relative to the top-left of the parent control.
232 * @param[out] cursorHeight The logical height of the cursor.
233 * @param[out] lineHeight The logical height of the line.
235 void GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const;
238 * @brief Retrieves the position of a cursor.
240 * @param[in] cursor The cursor to get.
242 * @return The position.
244 const Vector2& GetPosition( Cursor cursor ) const;
247 * @brief Sets the color for a cursor.
249 * @param[in] cursor Whether this color is for the primary or secondary cursor.
250 * @param[in] color The color to use.
252 void SetColor( Cursor cursor, const Dali::Vector4& color );
255 * @brief Retrieves the color for a cursor.
257 * @param[in] cursor Whether this color is for the primary or secondary cursor.
258 * @return The cursor color.
260 const Dali::Vector4& GetColor( Cursor cursor ) const;
263 * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
265 void StartCursorBlink();
268 * @brief Stop blinking the cursor.
270 void StopCursorBlink();
273 * @brief Set the interval between cursor blinks.
275 * @param[in] seconds The interval in seconds.
277 void SetCursorBlinkInterval( float seconds );
280 * @brief Retrieves the blink-interval for a cursor.
282 * @return The cursor blink-interval.
284 float GetCursorBlinkInterval() const;
287 * @brief The cursor will stop blinking after this duration.
289 * @param[in] seconds The duration in seconds.
291 void SetCursorBlinkDuration( float seconds );
294 * @brief Retrieves the blink-duration for a cursor.
296 * @return The cursor blink-duration.
298 float GetCursorBlinkDuration() const;
301 * @brief Sets whether a handle is active.
303 * @param[in] handleType One of the handles.
304 * @param[in] active True if the handle should be active.
306 void SetHandleActive( HandleType handleType,
310 * @brief Query whether a handle is active.
312 * @param[in] handleType One of the handles.
314 * @return True if the handle is active.
316 bool IsHandleActive( HandleType handleType ) const;
319 * @brief Sets the image for one of the handles.
321 * @param[in] handleType One of the handles.
322 * @param[in] handleImageType A different image can be set for the pressed/released states.
323 * @param[in] image The image to use.
325 void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
328 * @brief Retrieves the image for one of the handles.
330 * @param[in] handleType One of the handles.
331 * @param[in] handleImageType A different image can be set for the pressed/released states.
333 * @return The grab handle image.
335 Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
338 * @brief Sets the position of a selection handle.
340 * @param[in] handleType The handle to set.
341 * @param[in] x The x position relative to the top-left of the parent control.
342 * @param[in] y The y position relative to the top-left of the parent control.
343 * @param[in] lineHeight The logical line height at this position.
345 void SetPosition( HandleType handleType, float x, float y, float lineHeight );
348 * @brief Retrieves the position of a selection handle.
350 * @param[in] handleType The handle to get.
351 * @param[out] x The x position relative to the top-left of the parent control.
352 * @param[out] y The y position relative to the top-left of the parent control.
353 * @param[out] lineHeight The logical line height at this position.
355 void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
358 * @brief Retrieves the position of a selection handle.
360 * @param[in] handleType The handle to get.
362 * @return The position of the selection handle relative to the top-left of the parent control.
364 const Vector2& GetPosition( HandleType handleType ) const;
367 * @brief Swaps the selection handle's images.
369 * This method is called by the text controller to swap the handles
370 * when the start index is bigger than the end one.
372 void SwapSelectionHandlesEnabled( bool enable );
375 * @brief Adds a quad to the existing selection highlights.
377 * @param[in] x1 The top-left x position.
378 * @param[in] y1 The top-left y position.
379 * @param[in] x2 The bottom-right x position.
380 * @param[in] y3 The bottom-right y position.
382 void AddHighlight( float x1, float y1, float x2, float y2 );
385 * @brief Removes all of the previously added highlights.
387 void ClearHighlights();
390 * @brief Sets the selection highlight color.
392 * @param[in] image The image to use.
394 void SetHighlightColor( const Vector4& color );
397 * @brief Retrieves the selection highlight color.
401 const Vector4& GetHighlightColor() const;
404 * @brief Set the Selection Popup to show or hide via the active flaf
405 * @param[in] active true to show, false to hide
407 void SetPopupActive( bool active );
410 * @brief Query whether the Selection Popup is active.
412 * @return True if the Selection Popup should be active.
414 bool IsPopupActive() const;
417 * @brief Sets the scroll threshold.
419 * It defines a square area inside the control, close to the edge.
420 * When the cursor enters this area, the decorator starts to send scroll events.
422 * @param[in] threshold The scroll threshold.
424 void SetScrollThreshold( float threshold );
427 * @brief Retrieves the scroll threshold.
429 * @retunr The scroll threshold.
431 float GetScrollThreshold() const;
434 * @brief Sets the scroll speed.
436 * Is the distance the text is going to be scrolled during a scroll interval.
438 * @param[in] speed The scroll speed.
440 void SetScrollSpeed( float speed );
443 * @brief Retrieves the scroll speed.
445 * @return The scroll speed.
447 float GetScrollSpeed() const;
450 * @brief Sets the scroll interval.
452 * @param[in] seconds The scroll interval in seconds.
454 void SetScrollTickInterval( float seconds );
457 * @brief Retrieves the scroll interval.
459 * @return The scroll interval.
461 float GetScrollTickInterval() const;
466 * @brief A reference counted object may only be deleted by calling Unreference().
468 virtual ~Decorator();
473 * @brief Private constructor.
474 * @param[in] controller The controller which receives input events from Decorator components.
476 Decorator( ControllerInterface& controller );
479 Decorator( const Decorator& handle );
482 Decorator& operator=( const Decorator& handle );
491 } // namespace Toolkit
495 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__