Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / BaseComponents / ImageView.cs
index a5c6202..30bcac2 100755 (executable)
@@ -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.
+ *
+ */
 
 namespace Tizen.NUI.BaseComponents
 {
@@ -20,8 +21,8 @@ namespace Tizen.NUI.BaseComponents
     using System.Runtime.InteropServices;
 
     /// <summary>
-    /// ImageView is a class for displaying an image resource.<br>
-    /// An instance of ImageView can be created using a URL or an image instance.<br>
+    /// ImageView is a class for displaying an image resource.<br />
+    /// An instance of ImageView can be created using a URL or an image instance.<br />
     /// </summary>
     public class ImageView : View
     {
@@ -48,6 +49,7 @@ namespace Tizen.NUI.BaseComponents
             /// <summary>
             /// The view whose resource is ready.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public View View
             {
                 get
@@ -67,10 +69,11 @@ namespace Tizen.NUI.BaseComponents
         private ResourceReadyEventCallbackType _resourceReadyEventCallback;
 
         /// <summary>
-        /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
-        /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on the stage.<br>
+        /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br />
+        /// This signal is emitted after all resources required by a control are loaded and ready.<br />
+        /// Most resources are only loaded when the control is placed on the stage.<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandler<ResourceReadyEventArgs> ResourceReady
         {
             add
@@ -110,7 +113,11 @@ namespace Tizen.NUI.BaseComponents
             }
         }
 
-        //you can override it to clean-up your own resources.
+        /// <summary>
+        /// you can override it to clean-up your own resources.
+        /// </summary>
+        /// <param name="type">DisposeTypes</param>
+        /// <since_tizen> 3 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -157,16 +164,18 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Creates an initialized ImageView.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 
         }
         /// <summary>
-        /// Creates an initialized ImageView from a URL to an image resource.<br>
-        /// If the string is empty, ImageView will not display anything.<br>
+        /// Creates an initialized ImageView from a URL to an image resource.<br />
+        /// If the string is empty, ImageView will not display anything.<br />
         /// </summary>
         /// <param name="url">The URL of the image resource to display.</param>
+        /// <since_tizen> 3 </since_tizen>
         public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
         {
             _url = url;
@@ -180,6 +189,9 @@ namespace Tizen.NUI.BaseComponents
 
         }
 
+        /// <summary>
+        /// [Obsolete("Please do not use! this will be deprecated")]
+        /// </summary>
         [Obsolete("Please do not use! this will be deprecated")]
         public new static ImageView DownCast(BaseHandle handle)
         {
@@ -188,10 +200,11 @@ namespace Tizen.NUI.BaseComponents
             return ret;
         }
         /// <summary>
-        /// Sets this ImageView from the given URL.<br>
-        /// If the URL is empty, ImageView will not display anything.<br>
+        /// Sets this ImageView from the given URL.<br />
+        /// If the URL is empty, ImageView will not display anything.<br />
         /// </summary>
         /// <param name="url">The URL to the image resource to display.</param>
+        /// <since_tizen> 3 </since_tizen>
         public void SetImage(string url)
         {
             _url = url;
@@ -212,10 +225,11 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Queries if all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on the stage.<br>
-        /// True if the resources are loaded and ready, false otherwise.<br>
+        /// Queries if all resources required by a control are loaded and ready.<br />
+        /// Most resources are only loaded when the control is placed on the stage.<br />
+        /// True if the resources are loaded and ready, false otherwise.<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public new  bool IsResourceReady()
         {
             bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
@@ -227,6 +241,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// ImageView ResourceUrl, type string.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string ResourceUrl
         {
             get
@@ -244,6 +259,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// ImageView ImageMap, type PropertyMap: string if it is a URL, map otherwise
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap ImageMap
         {
             get
@@ -269,9 +285,10 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// ImageView PreMultipliedAlpha, type Boolean.<br>
-        /// Image must be initialized.<br>
+        /// ImageView PreMultipliedAlpha, type Boolean.<br />
+        /// Image must be initialized.<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool PreMultipliedAlpha
         {
             get
@@ -287,9 +304,10 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// ImageView PixelArea, type Vector4 (Animatable property).<br>
-        /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br>
+        /// ImageView PixelArea, type Vector4 (Animatable property).<br />
+        /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br />
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public RelativeVector4 PixelArea
         {
             get
@@ -305,11 +323,12 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// The border of the image in the order: left, right, bottom, top.<br>
-        /// If set, ImageMap will be ignored.<br>
-        /// For N-Patch images only.<br>
+        /// The border of the image in the order: left, right, bottom, top.<br />
+        /// If set, ImageMap will be ignored.<br />
+        /// For N-Patch images only.<br />
         /// Optional.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Rectangle Border
         {
             get
@@ -324,11 +343,12 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Gets or sets whether to draw the borders only (if true).<br>
-        /// If not specified, the default is false.<br>
-        /// For N-Patch images only.<br>
+        /// Gets or sets whether to draw the borders only (if true).<br />
+        /// If not specified, the default is false.<br />
+        /// For N-Patch images only.<br />
         /// Optional.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool BorderOnly
         {
             get
@@ -342,6 +362,10 @@ namespace Tizen.NUI.BaseComponents
             }
         }
 
+        /// <summary>
+        /// Gets or sets whether to synchronos loading the resourceurl of image.<br />
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool SynchronosLoading
         {
             get
@@ -392,4 +416,4 @@ namespace Tizen.NUI.BaseComponents
 
     }
 
-}
+}
\ No newline at end of file