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=133b2c72a2602c591ada553dba6ac782ce25d72b;hp=0875753962cd682ffe61deff56d731bd083da56f;hb=b694e7e2ae624e206e1548b1a863c554eb9cd4d7;hpb=821556eb9d7060137f06814b9dbfd9320d6c1b12 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 0875753..133b2c7 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_FIELD_H__ -#define __DALI_TOOLKIT_TEXT_FIELD_H__ +#ifndef DALI_TOOLKIT_TEXT_FIELD_H +#define DALI_TOOLKIT_TEXT_FIELD_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -46,7 +46,7 @@ class TextField; * | maxLengthReached | @ref MaxLengthReachedSignal() | @SINCE_1_0.0 | * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 | */ -class DALI_IMPORT_API TextField : public Control +class DALI_TOOLKIT_API TextField : public Control { public: @@ -169,20 +169,14 @@ public: PLACEHOLDER_TEXT_COLOR, /** - * @DEPRECATED_1_1.37 Use SHADOW instead. - * @brief The drop shadow offset 0 indicates no shadow. - * @details Name "shadowOffset", type Property::VECTOR2. - * @SINCE_1_0.0 + * @brief This property is removed because it's deprecated. */ - SHADOW_OFFSET, + RESERVED_PROPERTY_01, /** - * @DEPRECATED_1_1.37 Use SHADOW instead. - * @brief The color of a drop shadow. - * @details Name "shadowColor", type Property::VECTOR4. - * @SINCE_1_0.0 + * @brief This property is removed because it's deprecated. */ - SHADOW_COLOR, + RESERVED_PROPERTY_02, /** * @brief The color to apply to the primary cursor. @@ -313,6 +307,26 @@ public: /** * @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; + * + * field.SetProperty( TextField::Property::INPUT_METHOD_SETTINGS, propertyMap ); + * @endcode * @SINCE_1_0.0 */ INPUT_METHOD_SETTINGS, @@ -353,9 +367,7 @@ public: INPUT_POINT_SIZE, /** - * @brief The default underline parameters. - * @details Name "underline", type Property::MAP. - * @SINCE_1_2.13 + * @copydoc Dali::Toolkit::TextLabel::Property::UNDERLINE */ UNDERLINE, @@ -367,9 +379,7 @@ public: INPUT_UNDERLINE, /** - * @brief The default shadow parameters. - * @details Name "shadow", type Property::MAP. - * @SINCE_1_2.13 + * @copydoc Dali::Toolkit::TextLabel::Property::SHADOW */ SHADOW, @@ -395,9 +405,7 @@ public: INPUT_EMBOSS, /** - * @brief The default outline parameters. - * @details Name "outline", type Property::MAP. - * @SINCE_1_2.13 + * @copydoc Dali::Toolkit::TextLabel::Property::OUTLINE */ OUTLINE, @@ -642,4 +650,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_FIELD_H__ +#endif // DALI_TOOLKIT_TEXT_FIELD_H