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=5ef44322f47aff0140e63aa3c38bb19e28bb44c0;hp=5b3540784bd34103b3f1296f56c3de6340a5854f;hb=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;hpb=e979409480340033e0154a43bb1cbeeeb8d1c6a3 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 5b35407..5ef4432 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -31,9 +31,20 @@ namespace Internal DALI_INTERNAL { class TextField; } +/** + * @addtogroup dali-toolkit-controls-text-controls + * @{ + */ /** * @brief A control which provides a single-line editable text field. + * + * * Signals + * | %Signal Name | Method | + * |------------------------|-----------------------------------------------------| + * | text-changed | @ref TextChangedSignal() | + * | max-length-reached | @ref MaxLengthReachedSignal() | + * */ class DALI_IMPORT_API TextField : public Control { @@ -55,21 +66,40 @@ 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 - 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 - CURSOR_IMAGE, ///< name "cursor-image", The image to display for cursors, type STRING - PRIMARY_CURSOR_COLOR, ///< name "primary-cursor-color", The color to apply to the primary cursor, type VECTOR4 - SECONDARY_CURSOR_COLOR, ///< name "secondary-cursor-color", The color to apply to the secondary cursor, type VECTOR4 - ENABLE_CURSOR_BLINK, ///< name "enable-cursor-blink", Whether the cursor should blink or not, type BOOLEAN - CURSOR_BLINK_INTERVAL, ///< name "cursor-blink-interval", The time interval between cursor on/off states, type FLOAT - CURSOR_BLINK_DURATION, ///< name "cursor-blink-duration", The cursor will stop blinking after this duration (if non-zero), type FLOAT - GRAB_HANDLE_IMAGE, ///< name "grab-handle-image", The image to display for grab handle, type STRING - DECORATION_BOUNDING_BOX ///< name "decoration-bounding-box", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE + RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend", The type or rendering e.g. bitmap-based, type INT + 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 + 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 + SECONDARY_CURSOR_COLOR, ///< name "secondary-cursor-color", The color to apply to the secondary cursor, type VECTOR4 + ENABLE_CURSOR_BLINK, ///< name "enable-cursor-blink", Whether the cursor should blink or not, type BOOLEAN + CURSOR_BLINK_INTERVAL, ///< name "cursor-blink-interval", The time interval in seconds between cursor on/off states, type FLOAT + CURSOR_BLINK_DURATION, ///< name "cursor-blink-duration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT + CURSOR_WIDTH, ///< name "cursor-width", The cursor width, type INTEGER + GRAB_HANDLE_IMAGE, ///< name "grab-handle-image", The image to display for the grab handle, type STRING + GRAB_HANDLE_PRESSED_IMAGE, ///< name "grab-handle-pressed-image", The image to display when the grab handle is pressed, type STRING + SCROLL_THRESHOLD, ///< name "scroll-threshold" Scrolling will occur if the cursor is this close to the control border, type FLOAT + SCROLL_SPEED, ///< name "scroll-speed" The scroll speed in pixels per second, type FLOAT + SELECTION_HANDLE_IMAGE_LEFT, ///< name "selection-handle-image-left", The image to display for the left selection handle, type MAP + SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selection-handle-image-right", The image to display for the right selection handle, type MAP + SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selection-handle-pressed-image-left" The image to display when the left selection handle is pressed, type MAP + SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selection-handle-pressed-image-right" The image to display when the right selection handle is pressed, type MAP + SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selection-handle-marker-image-left", The image to display for the left selection handle marker, type MAP + SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selection-handle-marker-image-right", The image to display for the right selection handle marker, type MAP + 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 + INPUT_METHOD_SETTINGS ///< name "input-method-settings" The settings to relating to the System's Input Method, Key and Value type MAP }; }; @@ -84,6 +114,12 @@ 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 TextChangedSignalType; + typedef Signal MaxLengthReachedSignalType; + /** * Create the TextField control. * @return A handle to the TextField control. @@ -128,6 +164,30 @@ public: */ static TextField DownCast( BaseHandle handle ); + // Signals + + /** + * @brief This signal is emitted when the text changes. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName( TextField textField ); + * @endcode + * @return The signal to connect to. + */ + TextChangedSignalType& TextChangedSignal(); + + /** + * @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 /** @@ -145,6 +205,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali