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>
28 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h>
41 class TextSelectionPopupCallbackInterface;
52 typedef IntrusivePtr<Decorator> DecoratorPtr;
54 // Used to set the cursor positions etc.
57 PRIMARY_CURSOR, ///< The primary cursor for bidirectional text (or the regular cursor for single-direction text)
58 SECONDARY_CURSOR, ///< The secondary cursor for bidirectional text
62 // Determines which of the cursors are active (if any).
65 ACTIVE_CURSOR_NONE, ///< Neither primary nor secondary cursor are active
66 ACTIVE_CURSOR_PRIMARY, ///< Primary cursor is active (only)
67 ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active
70 // The state information for handle events.
80 // Used to set different handle images
84 HANDLE_IMAGE_RELEASED,
85 HANDLE_IMAGE_TYPE_COUNT
92 LEFT_SELECTION_HANDLE,
93 RIGHT_SELECTION_HANDLE,
98 * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
100 * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
102 * The Popup decoration will be positioned either above the Grab handle or above the selection handles but if doing so
103 * would cause the Popup to exceed the Decoration Bounding Box ( see SetBoundingBox API ) the the Popup will be repositioned below the handle(s).
105 * Selection handles will be flipped around to ensure they do not exceed the Decoration Bounding Box. ( Stay visible ).
107 * Decorator components forward input events to a controller class through an interface.
108 * The controller is responsible for selecting which components are active.
110 class Decorator : public RefObject
114 class ControllerInterface
119 * @brief Constructor.
121 ControllerInterface() {};
124 * @brief Virtual destructor.
126 virtual ~ControllerInterface() {};
129 * @brief An input event from one of the handles.
131 * @param[out] targetSize The Size of the UI control the decorator is adding it's decorations to.
133 virtual void GetTargetSize( Vector2& targetSize ) = 0;
136 * @brief Add a decoration to the parent UI control.
138 * @param[in] decoration The actor displaying a decoration.
140 virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
143 * @brief An input event from one of the handles.
145 * @param[in] handleType The handle's type.
146 * @param[in] state The handle's state.
147 * @param[in] x The x position relative to the top-left of the parent control.
148 * @param[in] y The y position relative to the top-left of the parent control.
150 virtual void DecorationEvent( HandleType handleType, HandleState state, float x, float y ) = 0;
154 * @brief Create a new instance of a Decorator.
156 * @param[in] controller The controller which receives input events from Decorator components.
157 * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
159 * @return A pointer to a new Decorator.
161 static DecoratorPtr New( ControllerInterface& controller,
162 TextSelectionPopupCallbackInterface& callbackInterface );
165 * @brief Set the bounding box which handles, popup and similar decorations will not exceed.
167 * The default value is the width and height of the stage from the top left origin.
168 * If a title bar for example is on the top of the screen then the y should be the title's height and
169 * the boundary height the stage height minus the title's height.
170 * Restrictions - The boundary box should be set up with a fixed z position for the text-input and the default camera.
172 * ------------------------------------------
174 * |o---------------------------------------|
176 * || Bounding Box || boundary height
178 * |----------------------------------------|
179 * ------------------------------------------
182 * @param[in] boundingBox Vector( x coordinate, y coordinate, width, height )
184 void SetBoundingBox( const Rect<int>& boundingBox );
187 * @brief Retrieve the bounding box origin and dimensions.
189 * default is set once control is added to stage, before this the return vector will be Vector4:ZERO
190 * @return Rect<int> the bounding box origin, width and height
192 const Rect<int>& GetBoundingBox() const;
195 * @brief The decorator waits until a relayout before creating actors etc.
197 * @param[in] size The size of the parent control after size-negotiation.
199 void Relayout( const Dali::Vector2& size );
202 * @brief Updates the decorator's actor positions after scrolling.
204 * @param[in] scrollOffset The scroll offset.
206 void UpdatePositions( const Vector2& scrollOffset );
209 * @brief Sets which of the cursors are active.
211 * @note Cursor will only be visible if within the parent area.
212 * @param[in] activeCursor Which of the cursors should be active (if any).
214 void SetActiveCursor( ActiveCursor activeCursor );
217 * @brief Query which of the cursors are active.
219 * @return Which of the cursors are active (if any).
221 unsigned int GetActiveCursor() const;
224 * @brief Sets the position of a cursor.
226 * @param[in] cursor The cursor to set.
227 * @param[in] x The x position relative to the top-left of the parent control.
228 * @param[in] y The y position relative to the top-left of the parent control.
229 * @param[in] cursorHeight The logical height of the cursor.
230 * @param[in] lineHeight The logical height of the line.
232 void SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight );
235 * @brief Retrieves the position, height and lineHeight of a cursor.
237 * @param[in] cursor The cursor to get.
238 * @param[out] x The x position relative to the top-left of the parent control.
239 * @param[out] y The y position relative to the top-left of the parent control.
240 * @param[out] cursorHeight The logical height of the cursor.
241 * @param[out] lineHeight The logical height of the line.
243 void GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const;
246 * @brief Retrieves the position of a cursor.
248 * @param[in] cursor The cursor to get.
250 * @return The position.
252 const Vector2& GetPosition( Cursor cursor ) const;
255 * @brief Sets the color for a cursor.
257 * @param[in] cursor Whether this color is for the primary or secondary cursor.
258 * @param[in] color The color to use.
260 void SetColor( Cursor cursor, const Dali::Vector4& color );
263 * @brief Retrieves the color for a cursor.
265 * @param[in] cursor Whether this color is for the primary or secondary cursor.
266 * @return The cursor color.
268 const Dali::Vector4& GetColor( Cursor cursor ) const;
271 * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
273 void StartCursorBlink();
276 * @brief Stop blinking the cursor.
278 void StopCursorBlink();
281 * @brief Set the interval between cursor blinks.
283 * @param[in] seconds The interval in seconds.
285 void SetCursorBlinkInterval( float seconds );
288 * @brief Retrieves the blink-interval for a cursor.
290 * @return The cursor blink-interval.
292 float GetCursorBlinkInterval() const;
295 * @brief The cursor will stop blinking after this duration.
297 * @param[in] seconds The duration in seconds.
299 void SetCursorBlinkDuration( float seconds );
302 * @brief Retrieves the blink-duration for a cursor.
304 * @return The cursor blink-duration.
306 float GetCursorBlinkDuration() const;
309 * @brief Sets whether a handle is active.
311 * @param[in] handleType One of the handles.
312 * @param[in] active True if the handle should be active.
314 void SetHandleActive( HandleType handleType,
318 * @brief Query whether a handle is active.
320 * @param[in] handleType One of the handles.
322 * @return True if the handle is active.
324 bool IsHandleActive( HandleType handleType ) const;
327 * @brief Sets the image for one of the handles.
329 * @param[in] handleType One of the handles.
330 * @param[in] handleImageType A different image can be set for the pressed/released states.
331 * @param[in] image The image to use.
333 void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
336 * @brief Retrieves the image for one of the handles.
338 * @param[in] handleType One of the handles.
339 * @param[in] handleImageType A different image can be set for the pressed/released states.
341 * @return The grab handle image.
343 Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
346 * @brief Sets the position of a selection handle.
348 * @param[in] handleType The handle to set.
349 * @param[in] x The x position relative to the top-left of the parent control.
350 * @param[in] y The y position relative to the top-left of the parent control.
351 * @param[in] lineHeight The logical line height at this position.
353 void SetPosition( HandleType handleType, float x, float y, float lineHeight );
356 * @brief Retrieves the position of a selection handle.
358 * @param[in] handleType The handle to get.
359 * @param[out] x The x position relative to the top-left of the parent control.
360 * @param[out] y The y position relative to the top-left of the parent control.
361 * @param[out] lineHeight The logical line height at this position.
363 void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
366 * @brief Retrieves the position of a selection handle.
368 * @param[in] handleType The handle to get.
370 * @return The position of the selection handle relative to the top-left of the parent control.
372 const Vector2& GetPosition( HandleType handleType ) const;
375 * @brief Swaps the selection handle's images.
377 * This method is called by the text controller to swap the handles
378 * when the start index is bigger than the end one.
380 void SwapSelectionHandlesEnabled( bool enable );
383 * @brief Adds a quad to the existing selection highlights.
385 * @param[in] x1 The top-left x position.
386 * @param[in] y1 The top-left y position.
387 * @param[in] x2 The bottom-right x position.
388 * @param[in] y3 The bottom-right y position.
390 void AddHighlight( float x1, float y1, float x2, float y2 );
393 * @brief Removes all of the previously added highlights.
395 void ClearHighlights();
398 * @brief Sets the selection highlight color.
400 * @param[in] image The image to use.
402 void SetHighlightColor( const Vector4& color );
405 * @brief Retrieves the selection highlight color.
409 const Vector4& GetHighlightColor() const;
412 * @brief Set the Selection Popup to show or hide via the active flaf
413 * @param[in] active true to show, false to hide
415 void SetPopupActive( bool active );
418 * @brief Query whether the Selection Popup is active.
420 * @return True if the Selection Popup should be active.
422 bool IsPopupActive() const;
425 * @brief Set a bit mask of the buttons to be shown by Popup
426 * @param[in] enabledButtonsBitMask from TextSelectionPopup::Buttons enum
428 void SetEnabledPopupButtons( TextSelectionPopup::Buttons& enabledButtonsBitMask );
431 * @brief Get the current bit mask of buttons to be shown by Popup
432 * @return bitmask of TextSelectionPopup::Buttons
434 TextSelectionPopup::Buttons& GetEnabledPopupButtons();
437 * @brief Sets the scroll threshold.
439 * It defines a square area inside the control, close to the edge.
440 * When the cursor enters this area, the decorator starts to send scroll events.
442 * @param[in] threshold The scroll threshold.
444 void SetScrollThreshold( float threshold );
447 * @brief Retrieves the scroll threshold.
449 * @retunr The scroll threshold.
451 float GetScrollThreshold() const;
454 * @brief Sets the scroll speed.
456 * Is the distance the text is going to be scrolled during a scroll interval.
458 * @param[in] speed The scroll speed.
460 void SetScrollSpeed( float speed );
463 * @brief Retrieves the scroll speed.
465 * @return The scroll speed.
467 float GetScrollSpeed() const;
470 * @brief Sets the scroll interval.
472 * @param[in] seconds The scroll interval in seconds.
474 void SetScrollTickInterval( float seconds );
477 * @brief Retrieves the scroll interval.
479 * @return The scroll interval.
481 float GetScrollTickInterval() const;
486 * @brief A reference counted object may only be deleted by calling Unreference().
488 virtual ~Decorator();
493 * @brief Private constructor.
494 * @param[in] controller The controller which receives input events from Decorator components.
495 * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
497 Decorator( ControllerInterface& controller,
498 TextSelectionPopupCallbackInterface& callbackInterface );
501 Decorator( const Decorator& handle );
504 Decorator& operator=( const Decorator& handle );
513 } // namespace Toolkit
517 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__