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=ac2bc6dde48c9d2aa572c407ea1cc53477997ff2;hp=3c4f28710849ae1fd3acc866c23898fb1b6b65f7;hb=60d99d04d7677a1b91d4f2fdd9e74bc5e1b5e7bf;hpb=6658c69d9cb50e204f4eb7e41365785060170d26 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 3c4f287..ac2bc6d 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) 2020 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,146 +17,155 @@ * 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 +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. */ - SMOOTH_SCROLL = INPUT_OUTLINE + 1, + PLACEHOLDER_TEXT, - /** - * @brief name "smoothScrollDuration", type float - * @details Sets the duration of smooth scroll animation + /** + * @brief The placeholder-text color. + * @details Name "placeholderTextColor", type Property::VECTOR4. */ - SMOOTH_SCROLL_DURATION, + PLACEHOLDER_TEXT_COLOR, - /** - * @brief name "enableScrollBar", type bool - * @details Enable or disable the scroll bar + /** + * @brief Enables Text selection using Shift key. + * @details Name "enableShiftSelection", type Property::BOOLEAN. */ - ENABLE_SCROLL_BAR, + ENABLE_SHIFT_SELECTION, - /** - * @brief name "scrollBarShowDuration", type float - * @details Sets the duration of scroll bar to show + /** + * @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. */ - SCROLL_BAR_SHOW_DURATION, + ENABLE_GRAB_HANDLE, - /** - * @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 + /** + * @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 */ - PIXEL_SIZE, + MATCH_SYSTEM_LANGUAGE_DIRECTION, - /** - * @brief The line count of text. - * @details name "lineCount", type int - * @note this property is read-only. + /** + * @brief The type or rendering e.g. bitmap-based. + * @details Name "renderingBackend", type Property::INTEGER. */ - LINE_COUNT, + 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 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 - }; } // 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); } // namespace DevelTextEditor