X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-editor.h;h=a52b13e88a589fc0c3e3508b28a275ef7a1e60d3;hb=5c827a7125b3c0420ba39766cbbcb0ee3eb8fccf;hp=1de373027bc64b01f0ac943478ccde99adb58a38;hpb=479693b4fd773eb8888ae401d02b49188293e231;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/text-controls/text-editor.h b/dali-toolkit/public-api/controls/text-controls/text-editor.h index 1de3730..a52b13e 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-editor.h +++ b/dali-toolkit/public-api/controls/text-controls/text-editor.h @@ -39,10 +39,11 @@ class TextEditor; /** * @brief A control which provides a multi-line editable text editor. * - * * Signals - * | %Signal Name | Method | - * |----------------------|-----------------------------------------------------| - * | textChanged | @ref TextChangedSignal() | + * Signals + * | %Signal Name | Method | | + * |----------------------|--------------------------------|--------------------| + * | textChanged | @ref TextChangedSignal() | @SINCE_1_1.37 | + * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 | * */ class DALI_IMPORT_API TextEditor : public Control @@ -50,7 +51,8 @@ class DALI_IMPORT_API TextEditor : public Control public: /** - * @brief The start and end property ranges for this control. + * @brief Enumeration for the start and end property ranges for this control. + * @SINCE_1_1.37 */ enum PropertyRange { @@ -59,18 +61,23 @@ public: }; /** - * @brief An enumeration of properties belonging to the TextEditor class. + * @brief Enumeration for the instance of properties belonging to the TextEditor class. + * @SINCE_1_1.37 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the TextEditor class. + * @SINCE_1_1.37 + */ enum { RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_1.37 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_1.37 TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_1.37 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_1.37 - FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_1.37 - POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_1.37 + FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING or MAP @SINCE_1_2.13 + POINT_SIZE, ///< name "pointSize", The size of font in points (Conversion from Pixel size to Point size : Point size = Pixel size * 72 / DPI), type FLOAT @SINCE_1_1.37 HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The text horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_1.37 SCROLL_THRESHOLD, ///< name "scrollThreshold" Vertical scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_1.37 SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT @SINCE_1_1.37 @@ -93,49 +100,90 @@ public: ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_1.37 INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_1.37 INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_1.37 - INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_1.37 + INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING or MAP @SINCE_1_2.13 INPUT_POINT_SIZE, ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT @SINCE_1_1.37 LINE_SPACING, ///< name "lineSpacing", The default extra space between lines in points, type FLOAT @SINCE_1_1.37 INPUT_LINE_SPACING, ///< name "inputLineSpacing" The extra space between lines in points. It affects the whole paragraph where the new input text is inserted, type FLOAT @SINCE_1_1.37 - UNDERLINE, ///< name "underline" The default underline parameters, type STRING @SINCE_1_1.37 - INPUT_UNDERLINE, ///< name "inputUnderline" The underline parameters of the new input text, type STRING @SINCE_1_1.37 - SHADOW, ///< name "shadow" The default shadow parameters, type STRING @SINCE_1_1.37 - INPUT_SHADOW, ///< name "inputShadow" The shadow parameters of the new input text, type STRING @SINCE_1_1.37 - EMBOSS, ///< name "emboss" The default emboss parameters, type STRING @SINCE_1_1.37 - INPUT_EMBOSS, ///< name "inputEmboss" The emboss parameters of the new input text, type STRING @SINCE_1_1.37 - OUTLINE, ///< name "outline" The default outline parameters, type STRING @SINCE_1_1.37 - INPUT_OUTLINE, ///< name "inputOutline" The outline parameters of the new input text, type STRING @SINCE_1_1.37 + UNDERLINE, ///< name "underline" The default underline parameters, type STRING or MAP @SINCE_1_2.13 + INPUT_UNDERLINE, ///< name "inputUnderline" The underline parameters of the new input text, type STRING or MAP @SINCE_1_2.13 + SHADOW, ///< name "shadow" The default shadow parameters, type STRING or MAP @SINCE_1_2.13 + INPUT_SHADOW, ///< name "inputShadow" The shadow parameters of the new input text, type STRING or MAP @SINCE_1_2.13 + EMBOSS, ///< name "emboss" The default emboss parameters, type STRING or MAP @SINCE_1_2.13 + INPUT_EMBOSS, ///< name "inputEmboss" The emboss parameters of the new input text, type STRING or MAP @SINCE_1_2.13 + OUTLINE, ///< name "outline" The default outline parameters, type STRING or MAP @SINCE_1_2.13 + INPUT_OUTLINE, ///< name "inputOutline" The outline parameters of the new input text, type STRING or MAP @SINCE_1_2.13 + }; + }; + + /** + * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed. + * + * @SINCE_1_2_2 + */ + struct InputStyle + { + /** + * @brief Enumeration for mask used by the signal InputStyleChangedSignal(). + * @SINCE_1_2_2 + */ + enum Mask + { + NONE = 0x0000, ///< @SINCE_1_2_2 + COLOR = 0x0001, ///< @SINCE_1_2_2 + FONT_FAMILY = 0x0002, ///< @SINCE_1_2_2 + POINT_SIZE = 0x0004, ///< @SINCE_1_2_2 + FONT_STYLE = 0x0008, ///< @SINCE_1_2_2 + LINE_SPACING = 0x0010, ///< @SINCE_1_2_2 + UNDERLINE = 0x0020, ///< @SINCE_1_2_2 + SHADOW = 0x0040, ///< @SINCE_1_2_2 + EMBOSS = 0x0080, ///< @SINCE_1_2_2 + OUTLINE = 0x0100 ///< @SINCE_1_2_2 }; }; // Type Defs - /// @brief Text changed signal type. + /** + * @brief Text changed signal type. + * @SINCE_1_1.37 + */ typedef Signal TextChangedSignalType; /** - * @brief Create the TextEditor control. - * @return A handle to the TextEditor control. + * @brief Input Style changed signal type. + * @SINCE_1_2_2 + */ + typedef Signal InputStyleChangedSignalType; + + /** + * @brief Creates the TextEditor control. + * + * @SINCE_1_1.37 + * @return A handle to the TextEditor control */ static TextEditor New(); /** * @brief Creates an empty handle. + * + * @SINCE_1_1.37 */ TextEditor(); /** * @brief Copy constructor. * - * @param[in] handle The handle to copy from. + * @SINCE_1_1.37 + * @param[in] handle The handle to copy from */ TextEditor( const TextEditor& handle ); /** * @brief Assignment operator. * - * @param[in] handle The handle to copy from. - * @return A reference to this. + * @SINCE_1_1.37 + * @param[in] handle The handle to copy from + * @return A reference to this */ TextEditor& operator=( const TextEditor& handle ); @@ -143,17 +191,19 @@ public: * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_1.37 */ ~TextEditor(); /** - * @brief Downcast a handle to TextEditor. + * @brief Downcasts a handle to TextEditor. * - * If the BaseHandle points is a TextEditor the downcast returns a valid handle. - * If not the returned handle is left empty. + * If the BaseHandle points is a TextEditor, the downcast returns a valid handle. + * If not, the returned handle is left empty. * - * @param[in] handle Handle to an object. - * @return handle to a TextEditor or an empty handle. + * @SINCE_1_1.37 + * @param[in] handle Handle to an object + * @return Handle to a TextEditor or an empty handle */ static TextEditor DownCast( BaseHandle handle ); @@ -166,25 +216,45 @@ public: * @code * void YourCallbackName( TextEditor textEditor ); * @endcode - * @return The signal to connect to. + * + * @SINCE_1_1.37 + * @return The signal to connect to */ TextChangedSignalType& TextChangedSignal(); + /** + * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position. + * i.e. The signal is not emitted when the input style is updated through the property system. + * + * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed. + * @code + * void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask ); + * @endcode + * + * @SINCE_1_2_2 + * @return The signal to connect to + */ + InputStyleChangedSignalType& InputStyleChangedSignal(); + public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * - * @param[in] implementation The Control implementation. + * @SINCE_1_1.37 + * @param[in] implementation The Control implementation */ DALI_INTERNAL TextEditor( Internal::TextEditor& implementation ); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * - * @param[in] internal A pointer to the internal CustomActor. + * @SINCE_1_1.37 + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**