[NUI] remove deprecated APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / UIComponents / PushButton.cs
index 4c8ee8e..7598d7c 100755 (executable)
@@ -1,27 +1,29 @@
-/** 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.
+ *
+ */
 
 using System;
+using System.ComponentModel;
 using Tizen.NUI.BaseComponents;
 
 namespace Tizen.NUI.UIComponents
 {
 
     /// <summary>
-    /// A PushButton changes its appearance when is pressed and returns to its original when is released.
+    /// The PushButton changes its appearance when it is pressed, and returns to its original when it is released.
     /// </summary>
     public class PushButton : Button
     {
@@ -38,7 +40,7 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// To make PushButton instance be disposed.
+        /// To dispose the PushButton instance.
         /// </summary>
         protected override void Dispose(DisposeTypes type)
         {
@@ -72,7 +74,7 @@ namespace Tizen.NUI.UIComponents
         }
 
 
-        internal class Property
+        internal new class Property
         {
             internal static readonly int UNSELECTED_ICON = NDalicPINVOKE.PushButton_Property_UNSELECTED_ICON_get();
             internal static readonly int SELECTED_ICON = NDalicPINVOKE.PushButton_Property_SELECTED_ICON_get();
@@ -84,13 +86,21 @@ namespace Tizen.NUI.UIComponents
         /// <summary>
         /// Creates the PushButton.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PushButton() : this(NDalicPINVOKE.PushButton_New(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 
         }
 
-        [Obsolete("Please do not use! this will be deprecated")]
+        /// <summary>
+        /// Downcasts a handle to pushButton handle.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// Please do not use! this will be deprecated!
+        /// Instead please use as keyword.
+        [Obsolete("Please DO NOT use! This will be deprecated, instead please USE as keyword.")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public new static PushButton DownCast(BaseHandle handle)
         {
             PushButton ret =  Registry.GetManagedBaseHandleFromNativePtr(handle) as PushButton;
@@ -98,7 +108,14 @@ namespace Tizen.NUI.UIComponents
             return ret;
         }
 
-        [Obsolete("Please do not use! this will be deprecated")]
+        /// <summary>
+        /// UnselectedIcon.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// Please do not use! this will be deprecated!
+        /// Instead please use UnselectedVisual.
+        [Obsolete("Please DO NOT use! This will be Deprecated!. Please implement by using Visual instead!")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public string UnselectedIcon
         {
             set
@@ -106,7 +123,15 @@ namespace Tizen.NUI.UIComponents
                 SetProperty(PushButton.Property.UNSELECTED_ICON, new Tizen.NUI.PropertyValue(value));
             }
         }
-        [Obsolete("Please do not use! this will be deprecated")]
+
+        /// <summary>
+        /// SelectedIcon.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// Please do not use! this will be deprecated!
+        /// Instead please use SelectedVisual.
+        [Obsolete("Please do not use! this will be deprecated, instead please use SelectedVisual.")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public string SelectedIcon
         {
             set
@@ -114,7 +139,12 @@ namespace Tizen.NUI.UIComponents
                 SetProperty(PushButton.Property.SELECTED_ICON, new Tizen.NUI.PropertyValue(value));
             }
         }
-        [Obsolete("Please do not use! this will be deprecated")]
+        /// <summary>
+        /// Please do not use! this will be deprecated
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Please DO NOT use! This will be deprecated, please implement by using Visual instead!")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public IconAlignmentType IconAlignment
         {
             get
@@ -172,8 +202,14 @@ namespace Tizen.NUI.UIComponents
                 SetProperty(PushButton.Property.ICON_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
             }
         }
-        [Obsolete("Please do not use! this will be deprecated")]
-        public Vector4 LabelPadding
+        /// <summary>
+        /// Please do not use! this will be deprecated
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// no use
+        [Obsolete("Please DO NOT use! This will be deprecated")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public new Vector4 LabelPadding
         {
             get
             {
@@ -187,7 +223,13 @@ namespace Tizen.NUI.UIComponents
             }
         }
 
-        [Obsolete("Please do not use! this will be deprecated")]
+        /// <summary>
+        /// Please do not use! this will be deprecated
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// no use
+        [Obsolete("Please DO NOT use! This will be deprecated")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public Vector4 IconPadding
         {
             get
@@ -202,30 +244,36 @@ namespace Tizen.NUI.UIComponents
             }
         }
 
-        [Obsolete("Please do not use! this will be deprecated")]
+        /// <summary>
+        /// Please do not use! this will be deprecated
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// no use
+        [Obsolete("Please DO NOT use! This will be deprecated!")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public enum IconAlignmentType
         {
             /// <summary>
-            /// Icon located to the left of text.
+            /// The icon located to the left of text.
             /// </summary>
             Left,
             /// <summary>
-            /// Icon located to the right of text.
+            /// The icon located to the right of text.
             /// </summary>
             Right,
             /// <summary>
-            /// Icon located to the top of text.
+            /// The icon located to the top of text.
             /// </summary>
             Top,
             /// <summary>
-            /// Icon located to the bottom of text.
+            /// The icon located to the bottom of text.
             /// </summary>
             Bottom,
             /// <summary>
-            /// Icon located to the right of text by default.
+            /// The icon located to the right of text by default.
             /// </summary>
             Default = Right
         }
 
     }
-}
+}
\ No newline at end of file