/**
* @brief A control which provides a multi-line editable text editor.
*
- * * Signals
+ * Signals
* | %Signal Name | Method | |
* |----------------------|--------------------------------|--------------------|
* | textChanged | @ref TextChangedSignal() | @SINCE_1_1.37 |
- * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2.2 |
+ * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 |
*
*/
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
};
/**
- * @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
/**
* @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 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
+ 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
};
};
/**
* @brief Input Style changed signal type.
- * @SINCE_1_2.2
+ * @SINCE_1_2_2
*/
typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
/**
- * @brief Create the TextEditor control.
+ * @brief Creates the TextEditor control.
*
* @SINCE_1_1.37
- * @return A handle to the TextEditor control.
+ * @return A handle to the TextEditor control
*/
static TextEditor New();
* @brief Copy constructor.
*
* @SINCE_1_1.37
- * @param[in] handle The handle to copy from.
+ * @param[in] handle The handle to copy from
*/
TextEditor( const TextEditor& handle );
* @brief Assignment operator.
*
* @SINCE_1_1.37
- * @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
*/
TextEditor& operator=( const TextEditor& handle );
~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.
*
* @SINCE_1_1.37
- * @param[in] handle Handle to an object.
- * @return handle to a TextEditor or an empty handle.
+ * @param[in] handle Handle to an object
+ * @return Handle to a TextEditor or an empty handle
*/
static TextEditor DownCast( BaseHandle handle );
* @endcode
*
* @SINCE_1_1.37
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
TextChangedSignalType& TextChangedSignal();
* void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
* @endcode
*
- * @SINCE_1_2.2
- * @return The signal to connect to.
+ * @SINCE_1_2_2
+ * @return The signal to connect to
*/
InputStyleChangedSignalType& InputStyleChangedSignal();
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_1.37
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
* @SINCE_1_1.37
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
};