X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-field.h;h=57828f270dd6548704c3d34a3a643f6a308e757c;hb=caf7677175a0e8b9c690d4f2ab73adc295f22c0e;hp=f33483cd5a883ececeec9cb4c218529ccecd2609;hpb=260c832bfaa0294e74a4f96d321f149adf09a3ce;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git 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 f33483c..57828f2 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -44,7 +44,7 @@ class TextField; * |----------------------|--------------------------------|--------------------| * | textChanged | @ref TextChangedSignal() | @SINCE_1_0.0 | * | maxLengthReached | @ref MaxLengthReachedSignal() | @SINCE_1_0.0 | - * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2.2 | + * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 | */ class DALI_IMPORT_API TextField : public Control { @@ -66,6 +66,10 @@ public: */ struct Property { + /** + * @brief An enumeration 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,16 +109,16 @@ 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 }; }; @@ -133,21 +137,26 @@ public: /** * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed. * - * @SINCE_1_2.2 + * @SINCE_1_2_2 */ struct InputStyle { + /** + * @brief 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 - UNDERLINE = 0x0010, ///< @SINCE_1_2.2 - SHADOW = 0x0020, ///< @SINCE_1_2.2 - EMBOSS = 0x0040, ///< @SINCE_1_2.2 - OUTLINE = 0x0080 ///< @SINCE_1_2.2 + 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 + UNDERLINE = 0x0010, ///< @SINCE_1_2_2 + SHADOW = 0x0020, ///< @SINCE_1_2_2 + EMBOSS = 0x0040, ///< @SINCE_1_2_2 + OUTLINE = 0x0080 ///< @SINCE_1_2_2 }; }; @@ -167,7 +176,7 @@ public: /** * @brief Input Style changed signal type. - * @SINCE_1_2.2 + * @SINCE_1_2_2 */ typedef Signal InputStyleChangedSignalType; @@ -256,7 +265,7 @@ public: * void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask ); * @endcode * - * @SINCE_1_2.2 + * @SINCE_1_2_2 * @return The signal to connect to. */ InputStyleChangedSignalType& InputStyleChangedSignal();