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=619f91a1eff34f7eceeea7f7e29b64be0bd58c6c;hb=f7e6a8dfa8b498ba261cb66b9842d50d9d2c0e2f;hpb=98d143f42bcbff983cadb5caf0de67e8cc7528a4 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 619f91a..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) 2020 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. @@ -84,41 +84,41 @@ enum Type 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. - */ + * @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. - */ + * @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. - */ + * @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. - */ + * @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 - */ + * @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. - */ + * @brief The type or rendering e.g. bitmap-based. + * @details Name "renderingBackend", type Property::INTEGER. + */ RENDERING_BACKEND, /** @@ -140,10 +140,86 @@ enum Type 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 "editable", type Property::BOOL. + * @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 @@ -173,6 +249,49 @@ using MaxLengthReachedSignalType = Signal; */ 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 } // namespace Toolkit