projects / platform / core / csapi / tizenfx.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / BaseComponents / TextEditor.cs
diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
index 17185e7..66b5eda 100755 (executable)
--- a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
+++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
@@ -1,18 +1,19 @@
-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 extern alias TizenSystemSettings;
 using TizenSystemSettings.Tizen.System;
@@ -92,6 +93,7 @@ namespace Tizen.NUI.BaseComponents
             /// <summary>
             /// TextEditor - is the texteditor control which has the text contents changed.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public TextEditor TextEditor
             {
                 get
@@ -112,8 +114,9 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// An event for the TextChanged signal which can be used to subscribe or unsubscribe the event handler
-        /// provided by the user. The TextChanged signal is emitted when the text changes.<br>
+        /// provided by the user. The TextChanged signal is emitted when the text changes.<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandler<TextChangedEventArgs> TextChanged
         {
             add
@@ -161,6 +164,7 @@ namespace Tizen.NUI.BaseComponents
             /// <summary>
             /// TextEditor - is the texteditor control which has the scroll state changed.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public TextEditor TextEditor
             {
                 get
@@ -176,6 +180,7 @@ namespace Tizen.NUI.BaseComponents
             /// <summary>
             /// ScrollState - is the texteditor control scroll state.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public ScrollState ScrollState
             {
                 get
@@ -196,8 +201,9 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Event for the ScrollStateChanged signal which can be used to subscribe or unsubscribe the event handler
-        /// provided by the user. The ScrollStateChanged signal is emitted when the scroll state changes.<br>
+        /// provided by the user. The ScrollStateChanged signal is emitted when the scroll state changes.<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandler<ScrollStateChangedEventArgs> ScrollStateChanged
         {
             add
@@ -313,6 +319,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Creates the TextEditor control.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public TextEditor() : this(NDalicPINVOKE.TextEditor_New(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -323,6 +330,12 @@ namespace Tizen.NUI.BaseComponents
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
+        /// <summary>
+        /// [Obsolete("Please do not use! this will be deprecated")]
+        /// </summary>
+        /// <param name="handle"></param>
+        /// <returns></returns>
+        /// <since_tizen> 3 </since_tizen>
         [Obsolete("Please do not use! this will be deprecated")]
         public new static TextEditor DownCast(BaseHandle handle)
         {
@@ -353,12 +366,13 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// The TranslatableText property.<br>
-        /// The text can set the SID value.<br>
+        /// The TranslatableText property.<br />
+        /// The text can set the SID value.<br />
         /// </summary>
         /// <exception cref='ArgumentNullException'>
         /// ResourceManager about multilingual is null.
         /// </exception>
+        /// <since_tizen> 4 </since_tizen>
         public string TranslatableText
         {
             get
@@ -376,12 +390,13 @@ namespace Tizen.NUI.BaseComponents
             }
         }
         /// <summary>
-        /// The TranslatablePlaceholderText property.<br>
-        /// The text can set the SID value.<br>
+        /// The TranslatablePlaceholderText property.<br />
+        /// The text can set the SID value.<br />
         /// </summary>
         /// <exception cref='ArgumentNullException'>
         /// ResourceManager about multilingual is null.
         /// </exception>
+        /// <since_tizen> 4 </since_tizen>
         public string TranslatablePlaceholderText
         {
             get
@@ -428,8 +443,10 @@ namespace Tizen.NUI.BaseComponents
                 PlaceholderText = NUIApplication.MultilingualResourceManager?.GetString(textEditorPlaceHolderTextSid, new CultureInfo(e.Value.Replace("_", "-")));
             }
         }
+        /// <summary>
         /// The Text property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Text
         {
             get
@@ -447,6 +464,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The TextColor property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 TextColor
         {
             get
@@ -464,6 +482,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The FontFamily property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string FontFamily
         {
             get
@@ -481,6 +500,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The FontStyle property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap FontStyle
         {
             get
@@ -498,6 +518,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The PointSize property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float PointSize
         {
             get
@@ -515,6 +536,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The HorizontalAlignment property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public HorizontalAlignment HorizontalAlignment
         {
             get
@@ -570,6 +592,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The ScrollThreshold property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float ScrollThreshold
         {
             get
@@ -587,6 +610,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The ScrollSpeed property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float ScrollSpeed
         {
             get
@@ -604,6 +628,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The PrimaryCursorColor property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 PrimaryCursorColor
         {
             get
@@ -621,6 +646,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SecondaryCursorColor property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 SecondaryCursorColor
         {
             get
@@ -638,6 +664,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The EnableCursorBlink property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool EnableCursorBlink
         {
             get
@@ -655,6 +682,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The CursorBlinkInterval property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float CursorBlinkInterval
         {
             get
@@ -672,6 +700,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The CursorBlinkDuration property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float CursorBlinkDuration
         {
             get
@@ -689,6 +718,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The CursorWidth property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int CursorWidth
         {
             get
@@ -706,6 +736,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The GrabHandleImage property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string GrabHandleImage
         {
             get
@@ -723,6 +754,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The GrabHandlePressedImage property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string GrabHandlePressedImage
         {
             get
@@ -740,6 +772,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandleImageLeft property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandleImageLeft
         {
             get
@@ -757,6 +790,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandleImageRight property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandleImageRight
         {
             get
@@ -774,6 +808,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandlePressedImageLeft property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandlePressedImageLeft
         {
             get
@@ -791,6 +826,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandlePressedImageRight property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandlePressedImageRight
         {
             get
@@ -808,6 +844,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandleMarkerImageLeft property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandleMarkerImageLeft
         {
             get
@@ -825,6 +862,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHandleMarkerImageRight property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap SelectionHandleMarkerImageRight
         {
             get
@@ -842,6 +880,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SelectionHighlightColor property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 SelectionHighlightColor
         {
             get
@@ -859,6 +898,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The DecorationBoundingBox property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Rectangle DecorationBoundingBox
         {
             get
@@ -876,6 +916,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The EnableMarkup property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool EnableMarkup
         {
             get
@@ -893,6 +934,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputColor property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 InputColor
         {
             get
@@ -910,6 +952,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputFontFamily property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string InputFontFamily
         {
             get
@@ -927,6 +970,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputFontStyle property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap InputFontStyle
         {
             get
@@ -944,6 +988,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputPointSize property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float InputPointSize
         {
             get
@@ -961,6 +1006,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The LineSpacing property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float LineSpacing
         {
             get
@@ -978,6 +1024,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputLineSpacing property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float InputLineSpacing
         {
             get
@@ -995,6 +1042,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The Underline property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap Underline
         {
             get
@@ -1012,6 +1060,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputUnderline property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string InputUnderline
         {
             get
@@ -1029,6 +1078,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The Shadow property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap Shadow
         {
             get
@@ -1046,6 +1096,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputShadow property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string InputShadow
         {
             get
@@ -1063,6 +1114,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The Emboss property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Emboss
         {
             get
@@ -1080,6 +1132,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputEmboss property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string InputEmboss
         {
             get
@@ -1097,6 +1150,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The Outline property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Outline
         {
             get
@@ -1114,6 +1168,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The InputOutline property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string InputOutline
         {
             get
@@ -1131,6 +1186,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SmoothScroll property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool SmoothScroll
         {
             get
@@ -1148,6 +1204,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The SmoothScrollDuration property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float SmoothScrollDuration
         {
             get
@@ -1165,6 +1222,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The EnableScrollBar property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool EnableScrollBar
         {
             get
@@ -1182,6 +1240,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The ScrollBarShowDuration property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float ScrollBarShowDuration
         {
             get
@@ -1199,6 +1258,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The ScrollBarFadeDuration property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float ScrollBarFadeDuration
         {
             get
@@ -1216,6 +1276,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The PixelSize property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float PixelSize
         {
             get
@@ -1233,6 +1294,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The line count of the text.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int LineCount
         {
             get
@@ -1246,6 +1308,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The text to display when the TextEditor is empty and inactive.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string PlaceholderText
         {
             get
@@ -1263,6 +1326,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The Placeholder text color.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Color PlaceholderTextColor
         {
             get
@@ -1280,6 +1344,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The EnableSelection property.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public bool EnableSelection
         {
             get
@@ -1318,6 +1383,7 @@ namespace Tizen.NUI.BaseComponents
         /// editor.Placeholder = propertyMap;
         /// </code>
         /// </example>
+        /// <since_tizen> 4 </since_tizen>
         public Tizen.NUI.PropertyMap Placeholder
         {
             get
@@ -1333,9 +1399,10 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// The LineWrapMode property.<br>
-        /// The line wrap mode when the text lines over the layout width.<br>
+        /// The LineWrapMode property.<br />
+        /// The line wrap mode when the text lines over the layout width.<br />
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public LineWrapMode LineWrapMode
         {
             get
@@ -1377,4 +1444,4 @@ namespace Tizen.NUI.BaseComponents
 
     }
 
-}
+}
\ No newline at end of file
Domain: Dotnet / Frameworks;