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 * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
72 * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
73 * In some cases the decorations will be moved or flipped around, to maintain visibility on-screen.
75 * Decorator components forward input events to a controller class through an observer interface.
76 * The controller is responsible for selecting which components are active.
78 class Decorator : public RefObject
92 * @brief Virtual destructor.
94 virtual ~Observer() {};
97 * @brief An input event from the grab handle.
99 * @param[in] state The grab handle state.
100 * @param[in] x The x position relative to the top-left of the parent control.
102 virtual void GrabHandleEvent( GrabHandleState state, float x ) = 0;
106 * @brief Create a new instance of a Decorator.
108 * @param[in] parent Decorations will be added to this parent control.
109 * @param[in] observer A class which receives input events from Decorator components.
110 * @return A pointer to a new Decorator.
112 static DecoratorPtr New( Dali::Toolkit::Internal::Control& parent, Observer& observer );
115 * @brief The decorator waits until a relayout before creating actors etc.
117 * @param[in] size The size of the parent control after size-negotiation.
119 void Relayout( const Dali::Vector2& size );
122 * @brief Sets which of the cursors are active.
124 * @note Cursor will only be visible if within the parent area.
125 * @param[in] activeCursor Which of the cursors should be active (if any).
127 void SetActiveCursor( ActiveCursor activeCursor );
130 * @brief Query which of the cursors are active.
132 * @return Which of the cursors are active (if any).
134 unsigned int GetActiveCursor() const;
137 * @brief Sets the position of a cursor.
139 * @param[in] cursor The cursor to set.
140 * @param[in] x The x position relative to the top-left of the parent control.
141 * @param[in] y The y position relative to the top-left of the parent control.
142 * @param[in] height The logical height of the cursor.
144 void SetPosition( Cursor cursor, float x, float y, float height );
147 * @brief Retrieves the position of a cursor.
149 * @param[in] cursor The cursor to get.
150 * @param[out] x The x position relative to the top-left of the parent control.
151 * @param[out] y The y position relative to the top-left of the parent control.
152 * @param[out] height The logical height of the cursor.
154 void GetPosition( Cursor cursor, float& x, float& y, float& height ) const;
157 * @brief Sets the image for a cursor.
159 * @param[in] image The image to use.
161 void SetCursorImage( Dali::Image image );
164 * @brief Retrieves the image for a cursor.
166 * @return The cursor image.
168 Dali::Image GetCursorImage() const;
171 * @brief Sets the color for a cursor.
173 * @param[in] cursor Whether this color is for the primary or secondary cursor.
174 * @param[in] color The color to use.
176 void SetColor( Cursor cursor, const Dali::Vector4& color );
179 * @brief Retrieves the color for a cursor.
181 * @param[in] cursor Whether this color is for the primary or secondary cursor.
182 * @return The cursor color.
184 const Dali::Vector4& GetColor( Cursor cursor ) const;
187 * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
189 void StartCursorBlink();
192 * @brief Stop blinking the cursor.
194 void StopCursorBlink();
197 * @brief Set the interval between cursor blinks.
199 * @param[in] seconds The interval in seconds.
201 void SetCursorBlinkInterval( float seconds );
204 * @brief Retrieves the blink-interval for a cursor.
206 * @return The cursor blink-interval.
208 float GetCursorBlinkInterval() const;
211 * @brief The cursor will stop blinking after this duration.
213 * @param[in] seconds The duration in seconds.
215 void SetCursorBlinkDuration( float seconds );
218 * @brief Retrieves the blink-duration for a cursor.
220 * @return The cursor blink-duration.
222 float GetCursorBlinkDuration() const;
225 * @brief Sets whether the grab handle is active.
227 * @note The grab handle follows the cursor position set with SetPosition(Cursor, ...)
228 * @param[in] active True if the grab handle should be active.
230 void SetGrabHandleActive( bool active );
233 * @brief Query whether the grab handle is active.
235 * @return True if the grab handle should be active.
237 bool IsGrabHandleActive() const;
240 * @brief Sets the image for the grab handle.
242 * @param[in] image The image to use.
244 void SetGrabHandleImage( Dali::Image image );
247 * @brief Retrieves the image for the grab handle.
249 * @return The grab handle image.
251 Dali::Image GetGrabHandleImage() const;
256 * @brief A reference counted object may only be deleted by calling Unreference().
258 virtual ~Decorator();
263 * @brief Private constructor.
264 * @param[in] parent Decorations will be added to this parent control.
265 * @param[in] observer A class which receives input events from Decorator components.
267 Decorator(Dali::Toolkit::Internal::Control& parent, Observer& observer );
270 Decorator( const Decorator& handle );
273 Decorator& operator=( const Decorator& handle );
282 } // namespace Toolkit
286 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__