* | %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
*/
struct Property
{
+ /**
+ * @brief An enumeration 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
TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_1.37
TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_1.37
FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_1.37
- FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_1.37
+ 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_1.37
HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The text horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_1.37
SCROLL_THRESHOLD, ///< name "scrollThreshold" Vertical scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_1.37
ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_1.37
INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_1.37
INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_1.37
- INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_1.37
+ 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_1.37
LINE_SPACING, ///< name "lineSpacing", The default extra space between lines in points, type FLOAT @SINCE_1_1.37
INPUT_LINE_SPACING, ///< name "inputLineSpacing" The extra space between lines in points. It affects the whole paragraph where the new input text is inserted, type FLOAT @SINCE_1_1.37
- 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 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
- 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;
* void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
* @endcode
*
- * @SINCE_1_2.2
+ * @SINCE_1_2_2
* @return The signal to connect to.
*/
InputStyleChangedSignalType& InputStyleChangedSignal();