X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-field.h;h=1dd97cfe715a7eb11d0f865e4029370efab85851;hp=ddfa4af669848697aac12242f65b390c160b53dc;hb=a3b69d118ee5f918a827b23ea76813a7aefad845;hpb=a303f9aeedf6c41514ab474e0cb7f52cd692deec diff --git a/dali-toolkit/public-api/controls/text-controls/text-field.h b/dali-toolkit/public-api/controls/text-controls/text-field.h index ddfa4af..1dd97cf 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -39,7 +39,7 @@ class TextField; /** * @brief A control which provides a single-line editable text field. * - * * Signals + * Signals * | %Signal Name | Method | | * |----------------------|--------------------------------|--------------------| * | textChanged | @ref TextChangedSignal() | @SINCE_1_0.0 | @@ -61,11 +61,15 @@ public: }; /** - * @brief An enumeration of properties belonging to the TextField class. + * @brief Enumeration for the instance of properties belonging to the TextField class. * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the TextField class. + * @SINCE_1_0.0 + */ enum { RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0 @@ -73,7 +77,7 @@ public: PLACEHOLDER_TEXT, ///< name "placeholderText", The text to display when the TextField is empty and inactive, type STRING @SINCE_1_0.0 PLACEHOLDER_TEXT_FOCUSED, ///< name "placeholderTextFocused", The text to display when the TextField is empty with key-input focus, type STRING @SINCE_1_0.0 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0 - FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0 + 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, type FLOAT @SINCE_1_0.0 MAX_LENGTH, ///< name "maxLength" The maximum number of characters that can be inserted, type INTEGER @SINCE_1_0.0 EXCEED_POLICY, ///< name "exceedPolicy" Specifies how the text is truncated when it does not fit, type INTEGER @SINCE_1_0.0 @@ -105,21 +109,21 @@ public: INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_0.0 ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0 INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_0.0 - INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_0.0 + 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_0.0 - 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 Specifies how the text is truncated when it does not fit + * @brief Enumeration for specifying how the text is truncated when it does not fit. * * The default value is \e EXCEED_POLICY_CLIP. * @SINCE_1_0.0 @@ -137,6 +141,11 @@ public: */ struct InputStyle { + /** + * @brief Mask used by the signal InputStyleChangedSignal(). + * + * @SINCE_1_2_2 + */ enum Mask { NONE = 0x0000, ///< @SINCE_1_2_2 @@ -172,9 +181,9 @@ public: typedef Signal InputStyleChangedSignalType; /** - * @brief Create the TextField control. + * @brief Creates the TextField control. * @SINCE_1_0.0 - * @return A handle to the TextField control. + * @return A handle to the TextField control */ static TextField New(); @@ -188,7 +197,7 @@ public: * @brief Copy constructor. * * @SINCE_1_0.0 - * @param[in] handle The handle to copy from. + * @param[in] handle The handle to copy from */ TextField( const TextField& handle ); @@ -196,8 +205,8 @@ public: * @brief Assignment operator. * * @SINCE_1_0.0 - * @param[in] handle The handle to copy from. - * @return A reference to this. + * @param[in] handle The handle to copy from + * @return A reference to this */ TextField& operator=( const TextField& handle ); @@ -210,14 +219,14 @@ public: ~TextField(); /** - * @brief Downcast a handle to TextField. + * @brief Downcasts a handle to TextField. * - * If the BaseHandle points is a TextField the downcast returns a valid handle. - * If not the returned handle is left empty. + * If the BaseHandle points is a TextField, the downcast returns a valid handle. + * If not, the returned handle is left empty. * * @SINCE_1_0.0 - * @param[in] handle Handle to an object. - * @return handle to a TextField or an empty handle. + * @param[in] handle Handle to an object + * @return Handle to a TextField or an empty handle */ static TextField DownCast( BaseHandle handle ); @@ -243,7 +252,7 @@ public: * void YourCallbackName( TextField textField ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ MaxLengthReachedSignalType& MaxLengthReachedSignal(); @@ -257,7 +266,7 @@ public: * @endcode * * @SINCE_1_2_2 - * @return The signal to connect to. + * @return The signal to connect to */ InputStyleChangedSignalType& InputStyleChangedSignal(); @@ -267,7 +276,7 @@ public: // Not intended for application developers * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 - * @param[in] implementation The Control implementation. + * @param[in] implementation The Control implementation */ DALI_INTERNAL TextField( Internal::TextField& implementation ); @@ -275,7 +284,7 @@ public: // Not intended for application developers * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 - * @param[in] internal A pointer to the internal CustomActor. + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal ); };