Add ItemView stopScrolling action

[platform/core/uifw/dali-toolkit.git] / docs / content / shared-javascript-and-cpp-documentation / text-field.md

diff --git a/docs/content/shared-javascript-and-cpp-documentation/text-field.md b/docs/content/shared-javascript-and-cpp-documentation/text-field.md
index 79e20ed..f6c8ecc 100644 (file)
--- a/docs/content/shared-javascript-and-cpp-documentation/text-field.md
+++ b/docs/content/shared-javascript-and-cpp-documentation/text-field.md
@@ -11,7 +11,9 @@ The Dali::Toolkit::TextField is a control which provides a single-line editable
 
 Before any text has been entered, the TextField can display some placeholder text.
 An alternative placeholder can be displayed when the TextField has keyboard focus.
 
 Before any text has been entered, the TextField can display some placeholder text.
 An alternative placeholder can be displayed when the TextField has keyboard focus.

-For example a TextField used to enter a username could initially show "Unknown Name", and then show "Enter Name." when the cursor is shown. 
+For example a TextField used to enter a username could initially show "Unknown Name", and then show "Enter Name." when the cursor is shown.
+
+Note *CR+LF* new line characters are replaced by a *LF* one.

 
 ~~~{.cpp}
 // C++
 
 ~~~{.cpp}
 // C++


@@ -51,22 +53,15 @@ console.log( field.text );
 
 ### Font Selection
 
 
 ### Font Selection
 

-TextField will automatically select a suitable fonts, in the same was as TextLabel.
-The preferred font can also be selected from a JSON stylesheet:
-
-~~~{.json}
-{
-  "styles":
-  {
-    "textfield":
-    {
-      "font-family":"Arial",
-      "font-style":"Regular",
-      "point-size":8
-    }
-  }
-}
-~~~
+By default TextField will automatically select a suitable font from the platform. However, a different font could be selected. See the [Font Selection](@ref font-selection) section for more details.
+
+### Mark-up Style
+
+Mark-up tags can be used to change the style of the text. See the [Mark-up Style](@ref markup-style) section for more details.
+
+### Input Style
+
+The input style can be changed through the control properties. See the [Input Style](@ref input-style) section for more details.

 
 ### Text Alignment
 
 
 ### Text Alignment
 


@@ -85,6 +80,10 @@ field.SetProperty( TextField::Property::HORIZONTAL_ALIGNMENT, "BEGIN" ); // "CEN
 field.HorizontalAlignment = "BEGIN"; // "CENTER" or "END"
 ~~~
 
 field.HorizontalAlignment = "BEGIN"; // "CENTER" or "END"
 ~~~
 

+### Copy and Paste  (Selection)
+
+Text can be selected by a long press or double tapping it. See the [Copy and Paste](@ref copy-n-paste) section for more details.
+

 ### TextField Decorations
 
 #### Color
 ### TextField Decorations
 
 #### Color


@@ -122,6 +121,7 @@ field.placeholderTextColor = dali.COLOR_BLACK;
  horizontalAlignment               | HORIZONTAL_ALIGNMENT                 |  STRING      | O            | X
  verticalAlignment                 | VERTICAL_ALIGNMENT                   |  STRING      | O            | X
  textColor                         | TEXT_COLOR                           |  VECTOR4     | O            | X
  horizontalAlignment               | HORIZONTAL_ALIGNMENT                 |  STRING      | O            | X
  verticalAlignment                 | VERTICAL_ALIGNMENT                   |  STRING      | O            | X
  textColor                         | TEXT_COLOR                           |  VECTOR4     | O            | X

+ placeholderTextColor              | PLACEHOLDER_TEXT_COLOR               |  VECTOR4     | O            | X

  shadowOffset                      | SHADOW_OFFSET                        |  VECTOR2     | O            | X
  shadowColor                       | SHADOW_COLOR                         |  VECTOR4     | O            | X
  primaryCursorColor                | PRIMARY_CURSOR_COLOR                 |  VECTOR4     | O            | X
  shadowOffset                      | SHADOW_OFFSET                        |  VECTOR2     | O            | X
  shadowColor                       | SHADOW_COLOR                         |  VECTOR4     | O            | X
  primaryCursorColor                | PRIMARY_CURSOR_COLOR                 |  VECTOR4     | O            | X


@@ -129,17 +129,25 @@ field.placeholderTextColor = dali.COLOR_BLACK;
  enableCursorBlink                 | ENABLE_CURSOR_BLINK                  |  BOOLEAN     | O            | X
  cursorBlinkInterval               | CURSOR_BLINK_INTERVAL                |  FLOAT       | O            | X
  cursorBlinkDuration               | CURSOR_BLINK_DURATION                |  FLOAT       | O            | X
  enableCursorBlink                 | ENABLE_CURSOR_BLINK                  |  BOOLEAN     | O            | X
  cursorBlinkInterval               | CURSOR_BLINK_INTERVAL                |  FLOAT       | O            | X
  cursorBlinkDuration               | CURSOR_BLINK_DURATION                |  FLOAT       | O            | X

+ cursorWidth                       | CURSOR_WIDTH                         |  INTEGER     | O            | X

  grabHandleImage                   | GRAB_HANDLE_IMAGE                    |  STRING      | O            | X
  grabHandlePressedImage            | GRAB_HANDLE_PRESSED_IMAGE            |  STRING      | O            | X
  scrollThreshold                   | SCROLL_THRESHOLD                     |  FLOAT       | O            | X
  grabHandleImage                   | GRAB_HANDLE_IMAGE                    |  STRING      | O            | X
  grabHandlePressedImage            | GRAB_HANDLE_PRESSED_IMAGE            |  STRING      | O            | X
  scrollThreshold                   | SCROLL_THRESHOLD                     |  FLOAT       | O            | X

- scrollSpreed                      | SCROLL_SPEED                         |  FLOAT       | O            | X
+ scrollSpeed                       | SCROLL_SPEED                         |  FLOAT       | O            | X

  selectionHandleImageLeft          | SELECTION_HANDLE_IMAGE_LEFT          |  STRING      | O            | X
  selectionHandleImageRight         | SELECTION_HANDLE_IMAGE_RIGHT         |  STRING      | O            | X
  selectionHandlePressedImageLeft   | SELECTION_HANDLE_PRESSED_IMAGE_LEFT  |  STRING      | O            | X
  selectionHandlePressedImageRight  | SELECTION_HANDLE_PRESSED_IMAGE_RIGHT |  STRING      | O            | X
  selectionHandleImageLeft          | SELECTION_HANDLE_IMAGE_LEFT          |  STRING      | O            | X
  selectionHandleImageRight         | SELECTION_HANDLE_IMAGE_RIGHT         |  STRING      | O            | X
  selectionHandlePressedImageLeft   | SELECTION_HANDLE_PRESSED_IMAGE_LEFT  |  STRING      | O            | X
  selectionHandlePressedImageRight  | SELECTION_HANDLE_PRESSED_IMAGE_RIGHT |  STRING      | O            | X

+ selectionHandleMarkerImageLeft    | SELECTION_HANDLE_MARKER_IMAGE_LEFT   |  MAP         | O            | X
+ selectionHandleMarkerImageRight   | SELECTION_HANDLE_MARKER_IMAGE_RIGHT  |  MAP         | O            | X

  selectionHighlightColor           | SELECTION_HIGHLIGHT_COLOR            |  VECTOR4     | O            | X
  decorationBoundingBox             | DECORATION_BOUNDING_BOX              |  RECTANGLE   | O            | X
  inputMethodSettings               | INPUT_METHOD_SETTINGS                |  MAP         | O            | X
  selectionHighlightColor           | SELECTION_HIGHLIGHT_COLOR            |  VECTOR4     | O            | X
  decorationBoundingBox             | DECORATION_BOUNDING_BOX              |  RECTANGLE   | O            | X
  inputMethodSettings               | INPUT_METHOD_SETTINGS                |  MAP         | O            | X

+ inputColor                        | INPUT_COLOR                          |  VECTOR4     | O            | X
+ enableMarkup                      | ENABLE_MARKUP                        |  BOOLEAN     | O            | X
+ inputFontFamily                   | INPUT_FONT_FAMILY                    |  STRING      | O            | X
+ inputFontStyle                    | INPUT_FONT_STYLE                     |  STRING      | O            | X
+ inputPointSize                    | INPUT_POINT_SIZE                     |  FLOAT       | O            | X

 
 @class TextField
 
 
 @class TextField