X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Ftext-controls%2Ftext-editor-devel.h;h=665af7a1452ccb98ec5b609919b9e2564343995f;hp=50f6af51312bd19f1084e03c5405993e1ce4f43d;hb=f7e6a8dfa8b498ba261cb66b9842d50d9d2c0e2f;hpb=ab5c560f8956e7b795b7cc2072d06a61aef103b7 diff --git a/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h index 50f6af5..665af7a 100644 --- a/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h +++ b/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,182 +17,280 @@ * limitations under the License. * */ +// EXTERNAL INCLUDES +#include // INTERNAL INCLUDES #include namespace Dali { - namespace Toolkit { - namespace DevelTextEditor { - namespace Property { - enum Type - { - RENDERING_BACKEND = Dali::Toolkit::TextEditor::Property::RENDERING_BACKEND, - TEXT = Dali::Toolkit::TextEditor::Property::TEXT, - TEXT_COLOR = Dali::Toolkit::TextEditor::Property::TEXT_COLOR, - FONT_FAMILY = Dali::Toolkit::TextEditor::Property::FONT_FAMILY, - FONT_STYLE = Dali::Toolkit::TextEditor::Property::FONT_STYLE, - POINT_SIZE = Dali::Toolkit::TextEditor::Property::POINT_SIZE, - HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextEditor::Property::HORIZONTAL_ALIGNMENT, - SCROLL_THRESHOLD = Dali::Toolkit::TextEditor::Property::SCROLL_THRESHOLD, - SCROLL_SPEED = Dali::Toolkit::TextEditor::Property::SCROLL_SPEED, - PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::PRIMARY_CURSOR_COLOR, - SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::SECONDARY_CURSOR_COLOR, - ENABLE_CURSOR_BLINK = Dali::Toolkit::TextEditor::Property::ENABLE_CURSOR_BLINK, - CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_INTERVAL, - CURSOR_BLINK_DURATION = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_DURATION, - CURSOR_WIDTH = Dali::Toolkit::TextEditor::Property::CURSOR_WIDTH, - GRAB_HANDLE_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_IMAGE, - GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_PRESSED_IMAGE, - SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_LEFT, - SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_RIGHT, - SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT, - SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, - SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT, - SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT, - SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextEditor::Property::SELECTION_HIGHLIGHT_COLOR, - DECORATION_BOUNDING_BOX = Dali::Toolkit::TextEditor::Property::DECORATION_BOUNDING_BOX, - ENABLE_MARKUP = Dali::Toolkit::TextEditor::Property::ENABLE_MARKUP, - INPUT_COLOR = Dali::Toolkit::TextEditor::Property::INPUT_COLOR, - INPUT_FONT_FAMILY = Dali::Toolkit::TextEditor::Property::INPUT_FONT_FAMILY, - INPUT_FONT_STYLE = Dali::Toolkit::TextEditor::Property::INPUT_FONT_STYLE, - INPUT_POINT_SIZE = Dali::Toolkit::TextEditor::Property::INPUT_POINT_SIZE, - LINE_SPACING = Dali::Toolkit::TextEditor::Property::LINE_SPACING, - INPUT_LINE_SPACING = Dali::Toolkit::TextEditor::Property::INPUT_LINE_SPACING, - UNDERLINE = Dali::Toolkit::TextEditor::Property::UNDERLINE, - INPUT_UNDERLINE = Dali::Toolkit::TextEditor::Property::INPUT_UNDERLINE, - SHADOW = Dali::Toolkit::TextEditor::Property::SHADOW, - INPUT_SHADOW = Dali::Toolkit::TextEditor::Property::INPUT_SHADOW, - EMBOSS = Dali::Toolkit::TextEditor::Property::EMBOSS, - INPUT_EMBOSS = Dali::Toolkit::TextEditor::Property::INPUT_EMBOSS, - OUTLINE = Dali::Toolkit::TextEditor::Property::OUTLINE, - INPUT_OUTLINE = Dali::Toolkit::TextEditor::Property::INPUT_OUTLINE, - - /** - * @brief name "smoothScroll", type bool - * @details Enable or disable the smooth scroll animation - */ - SMOOTH_SCROLL = INPUT_OUTLINE + 1, - - /** - * @brief name "smoothScrollDuration", type float - * @details Sets the duration of smooth scroll animation - */ - SMOOTH_SCROLL_DURATION, - - /** - * @brief name "enableScrollBar", type bool - * @details Enable or disable the scroll bar - */ - ENABLE_SCROLL_BAR, - - /** - * @brief name "scrollBarShowDuration", type float - * @details Sets the duration of scroll bar to show - */ - SCROLL_BAR_SHOW_DURATION, - - /** - * @brief name "scrollBarFadeDuration", type float - * @details Sets the duration of scroll bar to fade out - */ - SCROLL_BAR_FADE_DURATION, - - /** - * @brief The size of font in pixels. - * - * Conversion from Point size to Pixel size : - * Pixel size = Point size * DPI / 72 - * @details name "pixelSize", type float - */ - PIXEL_SIZE, - - /** - * @brief The line count of text. - * @details name "lineCount", type int - * @note this property is read-only. - */ - LINE_COUNT, - - /** - * @brief The text to display when the TextEditor is empty and inactive. - * @details name "placeholderText", type string - */ - PLACEHOLDER_TEXT, - - /** - * @brief The placeholder-text color. - * @details name "placeholderTextColor", type vector4 - */ - PLACEHOLDER_TEXT_COLOR, - - /** - * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color. - * @details name "enableSelection", type bool - */ - ENABLE_SELECTION, - - /** - * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size. - * - * @code - * Property::Map propertyMap; - * propertyMap["placeholderText"] = "Setting Placeholder Text"; - * propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused"; - * propertyMap["placeholderColor"] = Color::RED; - * propertyMap["placeholderFontFamily"] = "Arial"; - * propertyMap["placeholderPointSize"] = 12.0f; - * - * Property::Map fontStyleMap; - * fontStyleMap.Insert( "weight", "bold" ); - * fontStyleMap.Insert( "width", "condensed" ); - * fontStyleMap.Insert( "slant", "italic" ); - * propertyMap["placeholderFontStyle"] = fontStyleMap; - * - * editor.SetProperty( DevelTextEditor::Property::PLACEHOLDER, propertyMap ); - * @endcode - * - * @details name "placeholder", type MAP - */ - PLACEHOLDER, - - /** - * @brief line wrap mode when the text lines over layout width. - * @details name "lineWrapMode", type string. - */ - LINE_WRAP_MODE - }; +enum Type +{ + TEXT = Dali::Toolkit::TextEditor::Property::TEXT, + TEXT_COLOR = Dali::Toolkit::TextEditor::Property::TEXT_COLOR, + FONT_FAMILY = Dali::Toolkit::TextEditor::Property::FONT_FAMILY, + FONT_STYLE = Dali::Toolkit::TextEditor::Property::FONT_STYLE, + POINT_SIZE = Dali::Toolkit::TextEditor::Property::POINT_SIZE, + HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextEditor::Property::HORIZONTAL_ALIGNMENT, + SCROLL_THRESHOLD = Dali::Toolkit::TextEditor::Property::SCROLL_THRESHOLD, + SCROLL_SPEED = Dali::Toolkit::TextEditor::Property::SCROLL_SPEED, + PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::PRIMARY_CURSOR_COLOR, + SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::SECONDARY_CURSOR_COLOR, + ENABLE_CURSOR_BLINK = Dali::Toolkit::TextEditor::Property::ENABLE_CURSOR_BLINK, + CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_INTERVAL, + CURSOR_BLINK_DURATION = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_DURATION, + CURSOR_WIDTH = Dali::Toolkit::TextEditor::Property::CURSOR_WIDTH, + GRAB_HANDLE_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_IMAGE, + GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_PRESSED_IMAGE, + SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_LEFT, + SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_RIGHT, + SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT, + SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, + SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT, + SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT, + SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextEditor::Property::SELECTION_HIGHLIGHT_COLOR, + DECORATION_BOUNDING_BOX = Dali::Toolkit::TextEditor::Property::DECORATION_BOUNDING_BOX, + ENABLE_MARKUP = Dali::Toolkit::TextEditor::Property::ENABLE_MARKUP, + INPUT_COLOR = Dali::Toolkit::TextEditor::Property::INPUT_COLOR, + INPUT_FONT_FAMILY = Dali::Toolkit::TextEditor::Property::INPUT_FONT_FAMILY, + INPUT_FONT_STYLE = Dali::Toolkit::TextEditor::Property::INPUT_FONT_STYLE, + INPUT_POINT_SIZE = Dali::Toolkit::TextEditor::Property::INPUT_POINT_SIZE, + LINE_SPACING = Dali::Toolkit::TextEditor::Property::LINE_SPACING, + INPUT_LINE_SPACING = Dali::Toolkit::TextEditor::Property::INPUT_LINE_SPACING, + UNDERLINE = Dali::Toolkit::TextEditor::Property::UNDERLINE, + INPUT_UNDERLINE = Dali::Toolkit::TextEditor::Property::INPUT_UNDERLINE, + SHADOW = Dali::Toolkit::TextEditor::Property::SHADOW, + INPUT_SHADOW = Dali::Toolkit::TextEditor::Property::INPUT_SHADOW, + EMBOSS = Dali::Toolkit::TextEditor::Property::EMBOSS, + INPUT_EMBOSS = Dali::Toolkit::TextEditor::Property::INPUT_EMBOSS, + OUTLINE = Dali::Toolkit::TextEditor::Property::OUTLINE, + INPUT_OUTLINE = Dali::Toolkit::TextEditor::Property::INPUT_OUTLINE, + SMOOTH_SCROLL = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL, + SMOOTH_SCROLL_DURATION = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL_DURATION, + ENABLE_SCROLL_BAR = Dali::Toolkit::TextEditor::Property::ENABLE_SCROLL_BAR, + SCROLL_BAR_SHOW_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_SHOW_DURATION, + SCROLL_BAR_FADE_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_FADE_DURATION, + PIXEL_SIZE = Dali::Toolkit::TextEditor::Property::PIXEL_SIZE, + LINE_COUNT = Dali::Toolkit::TextEditor::Property::LINE_COUNT, + ENABLE_SELECTION = Dali::Toolkit::TextEditor::Property::ENABLE_SELECTION, + PLACEHOLDER = Dali::Toolkit::TextEditor::Property::PLACEHOLDER, + LINE_WRAP_MODE = Dali::Toolkit::TextEditor::Property::LINE_WRAP_MODE, + + /** + * @brief The text to display when the TextEditor is empty and inactive. + * @details Name "placeholderText", type Property::STRING. + */ + PLACEHOLDER_TEXT, + + /** + * @brief The placeholder-text color. + * @details Name "placeholderTextColor", type Property::VECTOR4. + */ + PLACEHOLDER_TEXT_COLOR, + + /** + * @brief Enables Text selection using Shift key. + * @details Name "enableShiftSelection", type Property::BOOLEAN. + */ + ENABLE_SHIFT_SELECTION, + + /** + * @brief Enables the grab handles for text selection. + * @details Name "enableGrabHandle", type Property::BOOLEAN. + * @note The default value is true, which means the grab handles are enabled by default. + */ + ENABLE_GRAB_HANDLE, + + /** + * @brief Modifies the default text alignment to match the direction of the system language. + * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write + * @note The default value is false + */ + MATCH_SYSTEM_LANGUAGE_DIRECTION, + + /** + * @brief The type or rendering e.g. bitmap-based. + * @details Name "renderingBackend", type Property::INTEGER. + */ + RENDERING_BACKEND, + + /** + * @brief The maximum number of characters that can be inserted. + * @details Name "maxLength", type Property::INTEGER. + */ + MAX_LENGTH, + + /** + * @brief The selected text start position. + * @details Name "selectedTextStart", type Property::INTEGER. + */ + SELECTED_TEXT_START, + + /** + * @brief The selected text range end position. + * @details Name "selectedTextEnd", type Property::INTEGER. + */ + SELECTED_TEXT_END, + + /** + * @brief The horizontal scroll position in pixels. + * @details Name "horizontalScrollPosition", type Property::FLOAT. + */ + HORIZONTAL_SCROLL_POSITION, + + /** + * @brief The vertical scroll position in pixels. + * @details Name "verticalScrollPosition", type Property::FLOAT. + */ + VERTICAL_SCROLL_POSITION, + + /** + * @brief The Editable state of control. + * @details Name "enableEditing", type Property::BOOLEAN. + */ + ENABLE_EDITING, + + /** + * @brief The selected text in UTF-8 format. + * @details Name "selectedText", type Property::STRING. + * @note This property is read-only. + */ + SELECTED_TEXT, + + /** + * @brief The font size scale. + * @details name "fontSizeScale", type Property::FLOAT. + * @note The default value is 1.0 which does nothing. + * The given font size scale value is used for multiplying the specified font size before querying fonts. + * + * e.g. The rendering results of both cases are same. + * - fontSize: 15pt, fontSizeScale: 1.0 + * - fontSize: 10pt, fontSizeScale: 1.5 + */ + FONT_SIZE_SCALE, + + /** + * @brief The position for primary cursor. + * @details Name "primaryCursorPosition", type Property::INTEGER. + */ + PRIMARY_CURSOR_POSITION, + + /** + * @brief The color of the grab color. + * @details Name "grabHandleColor", type Property::VECTOR4. + */ + GRAB_HANDLE_COLOR, + + /** + * @brief Enables the grab handle popup for text selection. + * @details Name "enableGrabHandlePopup", type Property::BOOLEAN. + * @note The default value is true, which means the grab handle popup is enabled by default. + */ + ENABLE_GRAB_HANDLE_POPUP, + + /** + * @brief The settings to relating to the System's Input Method, Key and Value. + * @details Name "inputMethodSettings", type Property::MAP. + * + * @note VARIATION key can be changed depending on PANEL_LAYOUT. + * For example, when PANEL_LAYOUT key is InputMethod::PanelLayout::NORMAL, + * then VARIATION would be among NORMAL, WITH_FILENAME, and WITH_PERSON_NAME in Dali::InputMethod::NormalLayout. + * For more information, see Dali::InputMethod::Category. + * + * Example Usage: + * @code + * Property::Map propertyMap; + * InputMethod::PanelLayout::Type panelLayout = InputMethod::PanelLayout::NUMBER; + * InputMethod::AutoCapital::Type autoCapital = InputMethod::AutoCapital::WORD; + * InputMethod::ButtonAction::Type buttonAction = InputMethod::ButtonAction::GO; + * int inputVariation = 1; + * propertyMap["PANEL_LAYOUT"] = panelLayout; + * propertyMap["AUTO_CAPITALIZE"] = autoCapital; + * propertyMap["BUTTON_ACTION"] = buttonAction; + * propertyMap["VARIATION"] = inputVariation; + * + * editor.SetProperty(DevelTextEditor::Property::INPUT_METHOD_SETTINGS, propertyMap); + * @endcode + */ + INPUT_METHOD_SETTINGS, +}; + } // namespace Property -namespace Scroll -{ - enum Type - { - STARTED, ///< Scrolling is started. - FINISHED ///< Scrolling is finished. - }; -} // namespace Scroll +/** + * @brief Return the input method context of TextEditor. + * + * @param[in] textEditor The instance of TextEditor. + * @return InputMethodContext instance. + */ +DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextEditor textEditor); -typedef Signal< void ( TextEditor, Scroll::Type ) > ScrollStateChangedSignalType; +/** + * @brief Max Characters Exceed signal type. + */ +using MaxLengthReachedSignalType = Signal; /** - * @brief This signal is emitted when TextEditor scrolling is started or finished. + * @brief This signal is emitted when inserted text exceeds the maximum character limit. * * A callback of the following type may be connected: * @code - * void YourCallbackName( ScrollState::Type type ); + * void YourCallbackName( TextEditor textEditor ); * @endcode - * type: Whether the scrolling is started or finished. + * @param[in] textEditor The instance of TextEditor. * @return The signal to connect to */ -DALI_IMPORT_API ScrollStateChangedSignalType& ScrollStateChangedSignal( TextEditor textEditor ); +DALI_TOOLKIT_API MaxLengthReachedSignalType& MaxLengthReachedSignal(TextEditor textEditor); + +/** + * @brief Anchor clicked signal type. + * + * @note Signal + * - const char* : href of clicked anchor. + * - uint32_t : length of href. + */ +using AnchorClickedSignalType = Signal; + +/** + * @brief This signal is emitted when the anchor is clicked. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName(TextEditor textEditor, const char* href, uint32_t hrefLength); + * @endcode + * @param[in] textEditor The instance of TextEditor. + * @return The signal to connect to. + */ +DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextEditor textEditor); + +/** + * @brief Select the whole text of TextEditor. + * + * @param[in] textEditor The instance of TextEditor. + */ +DALI_TOOLKIT_API void SelectWholeText(TextEditor textEditor); + +/** + * @brief Unselect the whole text of TextEditor. + * + * @param[in] textEditor The instance of TextEditor. + */ +DALI_TOOLKIT_API void SelectNone(TextEditor textEditor); + +/** + * @brief Scroll the TextEditor by specific amount. + * + * @param[in] textEditor The instance of TextEditor. + * @param[in] scroll amount (in pixels) of scrolling in horizontal & vectical directions. + */ +DALI_TOOLKIT_API void ScrollBy(TextEditor textEditor, Vector2 scroll); } // namespace DevelTextEditor