2 * Copyright(c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 using System.ComponentModel;
20 using Tizen.NUI.BaseComponents;
22 namespace Tizen.NUI.UIComponents
26 /// The PushButton changes its appearance when it is pressed, and returns to its original when it is released.
28 /// <since_tizen> 3 </since_tizen>
29 public class PushButton : Button
31 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
33 internal PushButton(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.PushButton_SWIGUpcast(cPtr), cMemoryOwn)
35 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
38 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PushButton obj)
40 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
44 /// To dispose the PushButton instance.
46 /// <since_tizen> 3 </since_tizen>
47 protected override void Dispose(DisposeTypes type)
54 if(type == DisposeTypes.Explicit)
57 //Release your own managed resources here.
58 //You should release all of your own disposable objects here.
61 //Release your own unmanaged resources here.
62 //You should not access any managed member here except static instance.
63 //because the execution order of Finalizes is non-deterministic.
65 if (swigCPtr.Handle != global::System.IntPtr.Zero)
70 NDalicPINVOKE.delete_PushButton(swigCPtr);
72 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
79 internal new class Property
81 internal static readonly int UNSELECTED_ICON = NDalicPINVOKE.PushButton_Property_UNSELECTED_ICON_get();
82 internal static readonly int SELECTED_ICON = NDalicPINVOKE.PushButton_Property_SELECTED_ICON_get();
83 internal static readonly int ICON_ALIGNMENT = NDalicPINVOKE.PushButton_Property_ICON_ALIGNMENT_get();
84 internal static readonly int LABEL_PADDING = NDalicPINVOKE.PushButton_Property_LABEL_PADDING_get();
85 internal static readonly int ICON_PADDING = NDalicPINVOKE.PushButton_Property_ICON_PADDING_get();
89 /// Creates the PushButton.
91 /// <since_tizen> 3 </since_tizen>
92 public PushButton() : this(NDalicPINVOKE.PushButton_New(), true)
94 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
99 /// Downcasts a handle to pushButton handle.
101 /// <since_tizen> 3 </since_tizen>
102 /// Please do not use! this will be deprecated!
103 /// Instead please use as keyword.
104 [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
105 [EditorBrowsable(EditorBrowsableState.Never)]
106 public new static PushButton DownCast(BaseHandle handle)
108 PushButton ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as PushButton;
109 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
116 /// <since_tizen> 3 </since_tizen>
117 /// Please do not use! this will be deprecated!
118 /// Instead please use UnselectedVisual.
119 [Obsolete("Please do not use! This will be deprecated! Please use UnselectedVisual instead!")]
120 [EditorBrowsable(EditorBrowsableState.Never)]
121 public string UnselectedIcon
125 SetProperty(PushButton.Property.UNSELECTED_ICON, new Tizen.NUI.PropertyValue(value));
132 /// <since_tizen> 3 </since_tizen>
133 /// Please do not use! this will be deprecated!
134 /// Instead please use SelectedVisual.
135 [Obsolete("Please do not use! This will be deprecated! Please use SelectedVisual instead!")]
136 [EditorBrowsable(EditorBrowsableState.Never)]
137 public string SelectedIcon
141 SetProperty(PushButton.Property.SELECTED_ICON, new Tizen.NUI.PropertyValue(value));
146 /// Please do not use! this will be deprecated
148 /// <since_tizen> 3 </since_tizen>
149 [Obsolete("Please do not use! This will be deprecated! Please use LabelRelativeAlignment instead!")]
150 [EditorBrowsable(EditorBrowsableState.Never)]
151 public IconAlignmentType IconAlignment
156 if (GetProperty(PushButton.Property.ICON_ALIGNMENT).Get(out temp) == false)
158 NUILog.Error("IconAlignment get error!");
163 return IconAlignmentType.Left;
165 return IconAlignmentType.Right;
167 return IconAlignmentType.Top;
169 return IconAlignmentType.Bottom;
171 return IconAlignmentType.Default;
176 string valueToString = "";
179 case IconAlignmentType.Left:
181 valueToString = "LEFT";
184 case IconAlignmentType.Right:
186 valueToString = "RIGHT";
189 case IconAlignmentType.Top:
191 valueToString = "TOP";
194 case IconAlignmentType.Bottom:
196 valueToString = "BOTTOM";
201 valueToString = "DEFAULT";
205 SetProperty(PushButton.Property.ICON_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
210 /// Please do not use! this will be deprecated
212 /// <since_tizen> 3 </since_tizen>
214 [Obsolete("Please do not use! This will be deprecated! Please use Button.LabelPadding instead!")]
215 [EditorBrowsable(EditorBrowsableState.Never)]
216 public new Vector4 LabelPadding
220 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
221 GetProperty(PushButton.Property.LABEL_PADDING).Get(temp);
226 SetProperty(PushButton.Property.LABEL_PADDING, new Tizen.NUI.PropertyValue(value));
231 /// Please do not use! this will be deprecated
233 /// <since_tizen> 3 </since_tizen>
235 [Obsolete("Please do not use! This will be deprecated! Please use ForegroundVisualPadding instead!")]
236 [EditorBrowsable(EditorBrowsableState.Never)]
237 public Vector4 IconPadding
241 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
242 GetProperty(PushButton.Property.ICON_PADDING).Get(temp);
247 SetProperty(PushButton.Property.ICON_PADDING, new Tizen.NUI.PropertyValue(value));
252 /// Please do not use! this will be deprecated
254 /// <since_tizen> 3 </since_tizen>
256 [Obsolete("Please do not use! This will be deprecated! Please use Button.Align instead!")]
257 [EditorBrowsable(EditorBrowsableState.Never)]
258 public enum IconAlignmentType
261 /// The icon located to the left of text.
265 /// The icon located to the right of text.
269 /// The icon located to the top of text.
273 /// The icon located to the bottom of text.
277 /// The icon located to the right of text by default.