1 #ifndef __DALI_TOOLKIT_TEXT_INPUT_H__
2 #define __DALI_TOOLKIT_TEXT_INPUT_H__
5 * Copyright (c) 2014 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 * @addtogroup CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE
27 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
29 namespace Dali DALI_IMPORT_API
35 namespace Internal DALI_INTERNAL
41 * @brief TextInput Actor takes input one character at a time and displays it as a string within an input box.
42 * Characters can be removed from the end of the string until it is empty. A maximum length of displayed string
45 class TextInput : public Control
52 static const Property::Index HIGHLIGHT_COLOR_PROPERTY; // Property, name "highlight-color", type VECTOR4
53 static const Property::Index CUT_AND_PASTE_COLOR_PROPERTY; // Property, name "cut-and-paste-bg-color", type VECTOR4
54 static const Property::Index CUT_AND_PASTE_PRESSED_COLOR_PROPERTY; // Property, name "cut-and-paste-pressed-color", type VECTOR4
55 static const Property::Index CUT_AND_PASTE_BORDER_COLOR_PROPERTY; // Property, name "cut-and-paste-border-color", type VECTOR4
56 static const Property::Index CUT_AND_PASTE_ICON_COLOR_PROPERTY; // Property, name "cut-and-paste-icon-color", type VECTOR4
57 static const Property::Index CUT_AND_PASTE_ICON_PRESSED_COLOR_PROPERTY; // Property, name "cut-and-paste-icon-pressed-color", type VECTOR4
58 static const Property::Index CUT_AND_PASTE_TEXT_COLOR_PROPERTY; // Property, name "cut-and-paste-text-color", type VECTOR4
59 static const Property::Index CUT_AND_PASTE_TEXT_PRESSED_COLOR_PROPERTY; // Property, name "cut-and-paste-text-pressed-color", type VECTOR4
60 static const Property::Index CUT_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "cut-button-position-priority", type unsigned int
61 static const Property::Index COPY_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "copy-button-position-priority", type unsigned int
62 static const Property::Index PASTE_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "paste-button-position-priority", type unsigned int
63 static const Property::Index SELECT_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "select-button-position-priority", type unsigned int
64 static const Property::Index SELECT_ALL_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "select-all-button-position-priority", type unsigned int
65 static const Property::Index CLIPBOARD_BUTTON_POSITION_PRIORITY_PROPERTY; // Property, name "clipboard-button-position-priority", type unsigned int
66 static const Property::Index POP_UP_OFFSET_FROM_TEXT_PROPERTY; // Property, name "popup-offset-from-text", type VECTOR4
67 static const Property::Index CURSOR_COLOR_PROPERTY; // Property, name "cursor-color", type VECTOR4
73 static const char* const SIGNAL_START_INPUT; ///< name "start-input"
74 static const char* const SIGNAL_END_INPUT; ///< name "end-input"
75 static const char* const SIGNAL_STYLE_CHANGED; ///< name "style-changed"
76 static const char* const SIGNAL_MAX_INPUT_CHARACTERS_REACHED; ///< name "max-input-characters-reached"
77 static const char* const SIGNAL_TOOLBAR_DISPLAYED; ///< name "toolbar-displayed"
78 static const char* const SIGNAL_TEXT_EXCEED_BOUNDARIES; ///< name "text-exceed-boundaries"
84 * @brief Create an uninitialized TextInput; this can be initialized with TextView::New().
86 * Calling member functions with an uninitialized Dali::Object is not allowed.
91 * @brief Copy constructor.
93 * @param handle to be copied
95 TextInput( const TextInput& handle );
98 * @brief Assignment operator.
100 * @param handle to object we want to point to
101 * @return handle to the TextInput
103 TextInput& operator=( const TextInput& handle );
106 * @brief Create an initialised TextInput.
108 * @return A handle to a newly allocated Dali resource.
110 static TextInput New();
113 * @brief Downcast an Object handle to TextInput.
115 * If handle points to a TextInput the downcast produces valid
116 * handle. If not the returned handle is left uninitialized.
118 * @param[in] handle Handle to an object
119 * @return handle to a TextInput or an uninitialized handle
121 static TextInput DownCast( BaseHandle handle );
126 * This is non-virtual since derived Handle types must not contain data or virtual methods.
131 * @brief Get the inputed text currently being displayed.
133 * @return string, the currently displayed string.
135 std::string GetText() const;
138 * @brief Get the inputed text currently being displayed together with mark-up tags.
140 * @return string, the currently displayed string with mark-up.
142 std::string GetMarkupText() const;
145 * @brief Set the maximum number of characters for the Text Input.
147 * @param [in] maxChars the max number of characters
149 void SetMaxCharacterLength(std::size_t maxChars);
152 * @brief Limits the number of lines of text Text Input will display.
154 * @param [in] maxLines the max number of lines to display, must be greater than 0.
155 * Currently the only valid limit is 1. Which turns TextInput into Single line mode. Any number higher than 1 results in no limit.
157 void SetNumberOfLinesLimit(std::size_t maxLines);
160 * @brief Returns the limit of lines Text Input is allowed to display.
162 * @return max line number limit
164 std::size_t GetNumberOfLinesLimit() const;
167 * @brief Returns the number of characters TextInput is displaying.
169 * @return number of characters
171 std::size_t GetNumberOfCharacters() const;
174 * @brief Sets a place holder text to be displayed when the text-input is empty.
176 * If not set or set to an empty string then no place holder will be shown.
177 * @param [in] placeHolderText text to be used as place holder.
179 void SetPlaceholderText( const std::string& placeHolderText );
182 * @return the current set place holder text, empty string returned if not set.
184 std::string GetPlaceholderText();
187 * @brief set initial text to be displayed in text-input.
189 * Can be used to edit a pre-existing string.
190 * @param [in] initialText text to be initially displayed
192 void SetInitialText(const std::string& initialText);
195 * @brief Manual method to set the focus on the TextInput so it starts or stops edit state.
197 * @pre The text input actor has been initialised.
198 * @param[in] editMode true or false to indicate editMode on or off
200 void SetEditable(bool editMode);
203 * @see SetEditable(bool editMode).
205 * It sets the cursor in the closest character to the given touch point.
207 * @param[in] editMode true or false to indicate editMode on or off
208 * @param[in] touchPoint A position in actor coordinates within the text-input.
210 void SetEditable(bool editMode, const Vector2& touchPoint);
213 * @brief Check if TextInput is in edit state.
215 * @pre The text input actor has been initialised.
216 * @return True or False to indicate editMode on or off
218 bool IsEditable() const;
221 * @brief Method to enable or disable edit on touch/tap.
223 * If not enabled (set to false) then SetEditable(true) will be used to start edit mode.
224 * @pre The text input actor has been initialised.
225 * @param[in] editOnTouch true or false to indicate if editing should start on touch
226 * default is for editing to start on touching textinput
228 void SetEditOnTouch(bool editOnTouch = true);
231 * @brief Check if TextInput starts edit mode on touch.
233 * @pre The text input actor has been initialised.
234 * @return True or False to indicate editOnTouch on or off
236 bool IsEditOnTouch() const;
239 * @brief Check if Text Selection is enabled so required text can be highlighted.
241 * @pre The text input actor has been initialised.
242 * @param[in] textSelectable true or false to indicate if text can be selected or not
243 * default is for text to be select-able when in edit mode
245 void SetTextSelectable(bool textSelectable = true);
248 * @brief Check if Text can be selected.
250 * @pre The text input actor has been initialised.
251 * @return True or False to indicate if text can be selected or not
253 bool IsTextSelectable() const;
256 * @brief Check if any text is currently selected, can be used to determine if ApplyStyle or SetActiveStyle should be used.
258 * @pre The text input actor has been initialised.
259 * @return True if text selected else False
261 bool IsTextSelected() const;
264 * @brief Selects text between the given positions.
266 * @pre TextInput should be in edit mode.
267 * @param start position to start selection
268 * @param end position to end selection, inclusive of this character.
269 * Providing 0 and result from GetNumberOfCharacters() will select all text.
271 void SelectText(std::size_t start, std::size_t end);
274 * @brief If any text is selected then de-select it and hide highlight.
276 * @pre The text input actor has been initialised.
281 * @brief Set the image to be used as the cursor grab hander.
283 * @pre The text input actor has been initialised.
284 * @param[in] image The image to be used.
286 void SetGrabHandleImage( Image image );
290 * @brief Set the image to be used for the regular left to right cursor.
292 * @pre The text input actor has been initialised.
293 * @param[in] image The image to be used.
294 * @param[in] border The nine patch border for the image.
296 void SetCursorImage(Dali::Image image, const Vector4& border );
299 * @brief Retrieve the selection handle size.
301 * Both handles have same size.
302 * @return Vector3 the selection handle size.
304 Vector3 GetSelectionHandleSize();
307 * @brief Set the image to be used for the Right to Left cursor.
309 * @pre The text input actor has been initialised.
310 * @param[in] image The image to be used.
311 * @param[in] border The nine patch border for the image.
313 void SetRTLCursorImage(Dali::Image image, const Vector4& border );
316 * @brief Toggle to enable the grab handle, used to position cursor when magnifier not being used.
318 * Default behaviour is to use the magnifier to position the cursor, enabling this prevents the magnifier from being shown.
319 * @param[in] toggle true to enable, false to disable grab handle
321 void EnableGrabHandle(bool toggle);
324 * @brief Method to check if grab handle is enabled, if false then the magnifier will be used to position cursor.
326 * @return bool returns true is grab handle enabled.
328 bool IsGrabHandleEnabled();
331 * @brief Set the bounding rectangle which handles, popup and similar decorations will not exceed.
333 * The default value is the width and height of the stage from the top left origin.
334 * If a title bar for example is on the top of the screen then the y should be the title's height and
335 * the boundary height the stage height minus the title's height.
336 * Restrictions - The boundary box should be set up with a fixed z position for the text-input and the default camera.
337 * @param[in] boundingOriginAndSize Rect( x coordinate, y coordinate, width, height )
338 * ------------------------------------------
340 * |o---------------------------------------|
342 * || Bounding Box || boundary height
344 * |----------------------------------------|
345 * ------------------------------------------
348 void SetBoundingRectangle( const Rect<float>& boundingOriginAndSize );
351 * @brief Retrieve the bounding box origin and dimensions.
353 * default is set once control is added to stage, before this the return vector will be Vector4:ZERO
354 * @return Rect the bounding rectangle
356 const Rect<float> GetBoundingRectangle() const;
359 * @brief Sets the style for new text being typed.
361 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
362 * @pre The text input actor has been initialised.
363 * @param[in] style The style for the new text.
364 * @param[in] mask The bit mask.
366 void SetActiveStyle( const TextStyle& style, const TextStyle::Mask mask = TextStyle::ALL );
369 * @brief Applies the given style to the selected text.
371 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
372 * Introduced text after this call uses the new style.
373 * @param[in] style The given style.
374 * @param[in] mask The bit mask.
376 void ApplyStyle( const TextStyle& style, const TextStyle::Mask mask = TextStyle::ALL );
379 * @brief Applies the given style to all text, selected or not selected.
381 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
382 * @param[in] style The given style.
383 * @param[in] mask The bit mask.
385 void ApplyStyleToAll( const TextStyle& style, const TextStyle::Mask mask = TextStyle::ALL );
388 * @brief Get the style of the Text character before the cursor.
390 * If no character before then return the InputStyle.
391 * @return TextStyle, the style of the character before the cursor
393 TextStyle GetStyleAtCursor() const;
396 * @brief Set the current text alignment (overrides default setting).
398 * The default alignment is dependent on the current text in the text field.
399 * If the text begins using LTR characters (e.g. European text) then the
400 * alignment is HorizontalLeft. If the text begins using RTL characters
401 * (e.g. Hebrew/Arabic text) then the alignment is HorizontalRight.
402 * If there is no text, then the alignment defaults to:
403 * (HorizontalLeft | VerticalCenter)
404 * @param[in] align The new alignment option.
406 void SetTextAlignment( Toolkit::Alignment::Type align );
409 * @brief Set the current line justification. (overrides default setting).
411 * The default justification is dependent on the current text in the text field.
412 * If the text begins using LTR characters (e.g. European text) then the
413 * justification is HorizontalLeft. If the text begins using RTL characters
414 * (e.g. Hebrew/Arabic text) then the justification is HorizontalRight.
415 * If there is no text, then the justification defaults to:
416 * (HorizontalLeft | VerticalCenter)
417 * @param[in] justification The new line justification.
419 void SetTextLineJustification( Toolkit::TextView::LineJustification justification );
422 * @brief Sets a fade boundary.
424 * @see TextView::FadeBoundary.
426 * @param[in] fadeBoundary The given fade boundary.
428 void SetFadeBoundary( const Toolkit::TextView::FadeBoundary& fadeBoundary );
431 * @brief Retrieves the fade boundary.
433 * @see TextView::FadeBoundary.
435 * @return The fade boundary.
437 const Toolkit::TextView::FadeBoundary& GetFadeBoundary() const;
440 * @brief Get the current text alignment combined into a single value.
442 * The values can be tested by using the & operator
443 * and the desired flag. e.g. if (GetTextAlignment() & HorizontalCentre) ...
444 * @return The combined text alignment
446 Toolkit::Alignment::Type GetTextAlignment() const;
449 * @brief Sets how to split the text in lines policy.
451 * @param policy The multi-line policy.
453 void SetMultilinePolicy( Toolkit::TextView::MultilinePolicy policy );
456 * @brief Gets the split in lines policy.
458 * @return The multi-line policy.
460 Toolkit::TextView::MultilinePolicy GetMultilinePolicy() const;
463 * @brief Sets how to display the text inside the TextView when it exceeds the text-view's width.
465 * @param policy The exceed policy.
467 void SetWidthExceedPolicy( Toolkit::TextView::ExceedPolicy policy );
470 * @brief Gets the width exceed policy.
472 * @return The exceed policy.
474 TextView::ExceedPolicy GetWidthExceedPolicy() const;
477 * @brief Sets how to display the text inside the TextView when it exceeds the text-view's height.
479 * @param policy The exceed policy.
481 void SetHeightExceedPolicy( Toolkit::TextView::ExceedPolicy policy );
484 * @brief Gets the height exceed policy.
486 * @return The exceed policy.
488 TextView::ExceedPolicy GetHeightExceedPolicy() const;
491 * @brief Sets if the inputed text can exceed the text-input boundary.
493 * By default is enabled.
495 * @param[in] enable Whether the inputed text can exceed its boundary.
497 void SetExceedEnabled( bool enable );
500 * @brief Retrieves whether inputed text can exceed the text-input boundary.
502 * @return \e true if text inputed can exceed the boundary, otherwise \e false.
504 bool GetExceedEnabled() const;
507 * @brief Allows modification of text-actor's position in the depth sort algorithm.
509 * @see Dali::RenderableActor::SetSortModifier()
510 * @param [in] depthOffset the offset to be given to the internal text-actors. Positive values pushing it further back.
512 void SetSortModifier( float depthOffset );
515 * @brief Sets whether text-view renders text using a previously generated snapshot.
517 * @see TextView::SetSnapshotModeEnabled()
519 * @param[in] enable Whether text-view is using or not a snapshot to render text.
521 void SetSnapshotModeEnabled( bool enable );
524 * @brief Retrieves whether text-view is using a snapshot to render text.
526 * @see TextView::IsSnapshotModeEnabled()
528 * @return \e true if text-view is using a snapshot to render text, otherwhise it returns \e false.
530 bool IsSnapshotModeEnabled() const;
533 * @copydoc TextView::SetScrollEnabled()
535 void SetScrollEnabled( bool enable );
538 * @copydoc TextView::IsScrollEnabled()
540 bool IsScrollEnabled() const;
543 * @copydoc TextView::SetScrollPosition()
545 void SetScrollPosition( const Vector2& position );
548 * @copydoc TextView::GetScrollPosition()
550 Vector2 GetScrollPosition() const;
553 * @brief Sets whether markup processing should be carried out.
555 * @param[in] enable whether markup processing is carried out or not.
557 void SetMarkupProcessingEnabled( bool enable );
560 * @brief Returns whether markup processing is enabled or not
562 * @return true is markup processing is enabled
564 bool IsMarkupProcessingEnabled() const;
567 public: /* Signals */
569 /// @brief Input Signal.
570 typedef SignalV2< void ( TextInput textInput ) > InputSignalV2;
572 /// @brief Input style changed signal.
573 typedef SignalV2< void ( TextInput textInput, const TextStyle& style ) > StyleChangedSignalV2;
575 /// @brief Text modified signal.
576 typedef SignalV2< void ( TextInput textInput ) > TextModifiedSignalType;
578 /// @brief Max input characters reached signal.
579 typedef SignalV2< void ( TextInput textInput ) > MaxInputCharactersReachedSignalV2;
581 /// @brief Input text exceeds boundaries signal.
582 typedef SignalV2< void ( TextInput textInput ) > InputTextExceedBoundariesSignalV2;
585 * @brief Signal emitted when the Text-Input starts receiving input.
587 InputSignalV2& InputStartedSignal();
590 * @brief Signal emitted when the Text-Input is finished receiving input.
592 * TextInput::GetText() can be called to get current text string.
593 * @return The signal to connect to
595 InputSignalV2& InputFinishedSignal();
598 * @brief Signal emitted when the cut and paste toolbar is displayed.
600 * @return The signal to connect to
602 InputSignalV2& CutAndPasteToolBarDisplayedSignal();
605 * @brief Signal emitted when style changes.
607 * @return The signal to connect to
609 StyleChangedSignalV2& StyleChangedSignal();
612 * @brief Signal emitted when text changes.
614 * @return The signal to connect to.
616 TextModifiedSignalType& TextModifiedSignal();
619 * @brief Signal emitted when max input characters are reached during text input.
621 * @return The signal to connect to
623 MaxInputCharactersReachedSignalV2& MaxInputCharactersReachedSignal();
626 * @brief Signal emitted when input text exceeds the boundaries of the text-input.
628 * @return The signal to connect to
630 InputTextExceedBoundariesSignalV2& InputTextExceedBoundariesSignal();
632 public: // Not intended for application developers
635 * @brief Creates a handle using the Toolkit::Internal implementation.
637 * @param[in] implementation The Control implementation.
639 TextInput(Internal::TextInput& implementation);
642 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
644 * @param[in] internal A pointer to the internal CustomActor.
646 TextInput(Dali::Internal::CustomActor* internal );
649 } // namespace Toolkit
656 #endif // __DALI_TOOLKIT_TEXT_INPUT_H__