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=1f6df9b04905b62539233bf14ff90083a8f3df31;hp=8eac8f7052af5015bed265056d4b0f1c4d2c45ef;hb=8f7943250250b3c39196bbda662012afe74b0260;hpb=66c5b1e0a29cc284f7acbe3f1e0e6bd8ee43316e 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 8eac8f7..1f6df9b 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -34,6 +34,12 @@ class TextField; /** * @brief A control which provides a single-line editable text field. + * + * * Signals + * | %Signal Name | Method | + * |------------------------|-----------------------------------------------------| + * | max-length-reached | @ref MaxLengthReachedSignal() | + * */ class DALI_IMPORT_API TextField : public Control { @@ -56,15 +62,18 @@ public: enum { RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend", The type or rendering e.g. bitmap-based, type INT - PLACEHOLDER_TEXT, ///< name "placeholder-text", The text to display when the TextField is empty, type STRING TEXT, ///< name "text", The text to display in UTF-8 format, type STRING + PLACEHOLDER_TEXT, ///< name "placeholder-text", The text to display when the TextField is empty and inactive, type STRING + PLACEHOLDER_TEXT_FOCUSED, ///< name "placeholder-text-focused", The text to display when the TextField is empty with key-input focus, type STRING FONT_FAMILY, ///< name "font-family", The requested font family, type STRING FONT_STYLE, ///< name "font-style", The requested font style e.g. Regular/Italic, type STRING POINT_SIZE, ///< name "point-size", The size of font in points, type FLOAT - EXCEED_POLICY, ///< name "exceed-policy" Specifies how the text is truncated when it does not fit, type INT + MAX_LENGTH, ///< name "max-length" The maximum number of characters that can be inserted, type INTEGER + EXCEED_POLICY, ///< name "exceed-policy" Specifies how the text is truncated when it does not fit, type INTEGER HORIZONTAL_ALIGNMENT, ///< name "horizontal-alignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" VERTICAL_ALIGNMENT, ///< name "vertical-alignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" TEXT_COLOR, ///< name "text-color", The text color, type VECTOR4 + PLACEHOLDER_TEXT_COLOR, ///< name "placeholder-text-color", The placeholder-text color, type VECTOR4 SHADOW_OFFSET, ///< name "shadow-offset", The drop shadow offset 0 indicates no shadow, type VECTOR2 SHADOW_COLOR, ///< name "shadow-color", The color of a drop shadow, type VECTOR4 PRIMARY_CURSOR_COLOR, ///< name "primary-cursor-color", The color to apply to the primary cursor, type VECTOR4 @@ -81,7 +90,8 @@ public: SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selection-handle-pressed-image-left" The image to display when the left selection handle is pressed, type STRING SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selection-handle-pressed-image-right" The image to display when the right selection handle is pressed, type STRING SELECTION_HIGHLIGHT_COLOR, ///< name "selection-highlight-color" The color of the selection highlight, type VECTOR4 - DECORATION_BOUNDING_BOX ///< name "decoration-bounding-box", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE + DECORATION_BOUNDING_BOX, ///< name "decoration-bounding-box" The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE + INPUT_METHOD_SETTINGS ///< name "input-method-settings" The settings to relating to the System's Input Method, Key and Value type MAP }; }; @@ -96,6 +106,11 @@ public: EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField. }; + // Type Defs + + /// @brief Max Characters Exceed signal type; + typedef Signal MaxLengthReachedSignalType; + /** * Create the TextField control. * @return A handle to the TextField control. @@ -140,6 +155,19 @@ public: */ static TextField DownCast( BaseHandle handle ); + // Signals + + /** + * @brief This signal is emitted when inserted text exceeds the maximum character limit. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName( TextField textField ); + * @endcode + * @return The signal to connect to. + */ + MaxLengthReachedSignalType& MaxLengthReachedSignal(); + public: // Not intended for application developers /**