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=1f6df9b04905b62539233bf14ff90083a8f3df31;hb=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;hpb=65b846c8241507cb808b9bad685f7893f15eeec7 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 1f6df9b..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,6 +31,10 @@ namespace Internal DALI_INTERNAL { class TextField; } +/** + * @addtogroup dali-toolkit-controls-text-controls + * @{ + */ /** * @brief A control which provides a single-line editable text field. @@ -38,6 +42,7 @@ class TextField; * * Signals * | %Signal Name | Method | * |------------------------|-----------------------------------------------------| + * | text-changed | @ref TextChangedSignal() | * | max-length-reached | @ref MaxLengthReachedSignal() | * */ @@ -81,14 +86,17 @@ public: 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 STRING - SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selection-handle-image-right", The image to display for the right selection handle, type STRING - 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_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 @@ -109,6 +117,7 @@ public: // Type Defs /// @brief Max Characters Exceed signal type; + typedef Signal TextChangedSignalType; typedef Signal MaxLengthReachedSignalType; /** @@ -158,6 +167,17 @@ public: // 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: @@ -185,6 +205,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali