/**
* @brief A control which provides a single-line editable text field.
*
- * * Signals
+ * Signals
* | %Signal Name | Method | |
* |----------------------|--------------------------------|--------------------|
* | textChanged | @ref TextChangedSignal() | @SINCE_1_0.0 |
};
/**
- * @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
};
/**
- * @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
*/
struct InputStyle
{
+ /**
+ * @brief Mask used by the signal InputStyleChangedSignal().
+ *
+ * @SINCE_1_2_2
+ */
enum Mask
{
NONE = 0x0000, ///< @SINCE_1_2_2
typedef Signal<void ( TextField, InputStyle::Mask ) > 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();
* @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 );
* @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 );
~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 );
* void YourCallbackName( TextField textField );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
MaxLengthReachedSignalType& MaxLengthReachedSignal();
* @endcode
*
* @SINCE_1_2_2
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
InputStyleChangedSignalType& InputStyleChangedSignal();
* @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 );
* @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 );
};