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=356036310f176cf113dd4226886aeaa5e47ce573;hp=d8425590cce34bb62744feb1ea7e2de9ebf6720e;hb=24d391fe222bd0fd5910e3b3481124fa23b796be;hpb=867aa572372bf901975516db0fa77630754a8c27 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 d842559..3560363 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 @@ -78,21 +78,131 @@ namespace Property /** * @brief name "smoothScroll", type bool * @details Enable or disable the smooth scroll animation + * @note This property is currently being used for some applications, so it can't be changed. */ SMOOTH_SCROLL = INPUT_OUTLINE + 1, /** * @brief name "smoothScrollDuration", type float * @details Sets the duration of smooth scroll animation + * @note This property is currently being used for some applications, so it can't be changed. */ - SMOOTH_SCROLL_DURATION + SMOOTH_SCROLL_DURATION, + + /** + * @brief name "enableScrollBar", type bool + * @details Enable or disable the scroll bar + * @note This property is currently being used for some applications, so it can't be changed. + */ + ENABLE_SCROLL_BAR, + + /** + * @brief name "scrollBarShowDuration", type float + * @details Sets the duration of scroll bar to show + * @note This property is currently being used for some applications, so it can't be changed. + */ + SCROLL_BAR_SHOW_DURATION, + + /** + * @brief name "scrollBarFadeDuration", type float + * @details Sets the duration of scroll bar to fade out + * @note This property is currently being used for some applications, so it can't be changed. + */ + 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 }; } // namespace Property -} // namespace DevelText +namespace Scroll +{ + enum Type + { + STARTED, ///< Scrolling is started. + FINISHED ///< Scrolling is finished. + }; +} // namespace Scroll + +typedef Signal< void ( TextEditor, Scroll::Type ) > ScrollStateChangedSignalType; + +/** + * @brief This signal is emitted when TextEditor scrolling is started or finished. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName( ScrollState::Type type ); + * @endcode + * type: Whether the scrolling is started or finished. + * @return The signal to connect to + */ +DALI_IMPORT_API ScrollStateChangedSignalType& ScrollStateChangedSignal( TextEditor textEditor ); + +} // namespace DevelTextEditor } // namespace Toolkit } // namespace Dali -#endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H \ No newline at end of file +#endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H