1 // Copyright (c) 2017 Samsung Electronics Co., Ltd.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
16 // This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
17 // Some have been manually changed
19 namespace Tizen.NUI.UIComponents
23 using System.Runtime.InteropServices;
24 using Tizen.NUI.BaseComponents;
27 /// Button is a base class for different kinds of buttons.<br>
28 /// This class provides the disabled property and the clicked signal.<br>
29 /// A Clicked event handler is emitted when the button is touched and the touch point doesn't leave the boundary of the button.<br>
30 /// When the disabled property is set to true, no signal is emitted.<br>
31 /// 'Visual' describes not just traditional images like png, bmp but refers to whatever is used to show the button, it could be a color, gradient or some other kind of renderer.<br>
32 /// The button's appearance can be modified by setting properties for the various visuals/images.<br>
33 /// It is not mandatory to set all visuals. A button could be defined only by setting its background visual or by setting its background and selected visuals.<br>
34 /// The button visual is shown over the background visual.<br>
35 /// When pressed the unselected visuals are replaced by the selected visual.<br>
36 /// The text label is always placed on the top of all images.<br>
37 /// When the button is disabled, background, button and selected visuals are replaced by their disabled visuals.<br>
39 public class Button : View
41 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
43 internal Button(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.Button_SWIGUpcast(cPtr), cMemoryOwn)
45 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
48 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Button obj)
50 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
54 /// To make Button instance be disposed.
56 protected override void Dispose(DisposeTypes type)
63 if (type == DisposeTypes.Explicit)
66 //Release your own managed resources here.
67 //You should release all of your own disposable objects here.
71 //Release your own unmanaged resources here.
72 //You should not access any managed member here except static instance.
73 //because the execution order of Finalizes is non-deterministic.
75 if (swigCPtr.Handle != global::System.IntPtr.Zero)
80 NDalicPINVOKE.delete_Button(swigCPtr);
82 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
89 private EventHandlerWithReturnType<object, EventArgs, bool> _clickedEventHandler;
90 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
91 private delegate bool ClickedCallbackType(global::System.IntPtr data);
92 private ClickedCallbackType _clickedCallback;
95 /// Clicked will be triggered when the button is touched and the touch point doesn't leave the boundary of the button.
97 public event EventHandlerWithReturnType<object, EventArgs, bool> Clicked
101 if (_clickedEventHandler == null)
103 _clickedCallback = OnClicked;
104 ClickedSignal().Connect(_clickedCallback);
107 _clickedEventHandler += value;
112 _clickedEventHandler -= value;
114 if (_clickedEventHandler == null && ClickedSignal().Empty() == false)
116 ClickedSignal().Disconnect(_clickedCallback);
122 private bool OnClicked(IntPtr data)
124 if (_clickedEventHandler != null)
126 return _clickedEventHandler(this, null);
133 private EventHandlerWithReturnType<object, EventArgs, bool> _pressedEventHandler;
134 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
135 private delegate bool PressedCallbackType(global::System.IntPtr data);
136 private PressedCallbackType _pressedCallback;
139 /// Pressed will be triggered when the button is touched.
141 public event EventHandlerWithReturnType<object, EventArgs, bool> Pressed
145 if (_pressedEventHandler == null)
147 _pressedCallback = OnPressed;
148 PressedSignal().Connect(_pressedCallback);
151 _pressedEventHandler += value;
156 _pressedEventHandler -= value;
158 if (_pressedEventHandler == null && PressedSignal().Empty() == false)
160 this.PressedSignal().Disconnect(_pressedCallback);
165 private bool OnPressed(IntPtr data)
167 if (_pressedEventHandler != null)
169 return _pressedEventHandler(this, null);
176 private EventHandlerWithReturnType<object, EventArgs, bool> _releasedEventHandler;
177 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
178 private delegate bool ReleasedCallbackType(global::System.IntPtr data);
179 private ReleasedCallbackType _releasedCallback;
182 /// Released will be triggered when the button is touched and the touch point leaves the boundary of the button.
184 public event EventHandlerWithReturnType<object, EventArgs, bool> Released
188 if (_releasedEventHandler == null)
190 _releasedCallback = OnReleased;
191 ReleasedSignal().Connect(_releasedCallback);
193 _releasedEventHandler += value;
198 _releasedEventHandler -= value;
200 if (_releasedEventHandler == null && ReleasedSignal().Empty() == false)
202 ReleasedSignal().Disconnect(_releasedCallback);
208 private bool OnReleased(IntPtr data)
210 if (_releasedEventHandler != null)
212 return _releasedEventHandler(this, null);
218 private EventHandlerWithReturnType<object, EventArgs, bool> _stateChangedEventHandler;
219 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
220 private delegate bool StateChangedCallback(global::System.IntPtr data);
221 private StateChangedCallback _stateChangedCallback;
224 /// StateChanged will be triggered when the button's state is changed.
226 public event EventHandlerWithReturnType<object, EventArgs, bool> StateChanged
230 if (_stateChangedEventHandler == null)
232 _stateChangedCallback = OnStateChanged;
233 StateChangedSignal().Connect(_stateChangedCallback);
236 _stateChangedEventHandler += value;
241 _stateChangedEventHandler -= value;
243 if (_stateChangedEventHandler == null && StateChangedSignal().Empty() == false)
245 StateChangedSignal().Disconnect(_stateChangedCallback);
250 private bool OnStateChanged(IntPtr data)
252 if (_stateChangedEventHandler != null)
254 return _stateChangedEventHandler(this, null);
261 /// Gets/Sets the unselected button foreground/icon visual
263 public Tizen.NUI.PropertyMap UnselectedVisual
267 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
268 GetProperty(Button.Property.UNSELECTED_VISUAL).Get(temp);
273 SetProperty(Button.Property.UNSELECTED_VISUAL, new Tizen.NUI.PropertyValue(value));
278 /// Gets/Sets the selected button foreground/icon visual
280 public Tizen.NUI.PropertyMap SelectedVisual
284 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
285 GetProperty(Button.Property.SELECTED_VISUAL).Get(temp);
290 SetProperty(Button.Property.SELECTED_VISUAL, new Tizen.NUI.PropertyValue(value));
295 /// Gets/Sets the disabled selected state foreground/icon button visual
297 public Tizen.NUI.PropertyMap DisabledSelectedVisual
301 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
302 GetProperty(Button.Property.DISABLED_SELECTED_VISUAL).Get(temp);
307 SetProperty(Button.Property.DISABLED_SELECTED_VISUAL, new Tizen.NUI.PropertyValue(value));
312 /// Gets/Sets the disabled unselected state foreground/icon visual
314 public Tizen.NUI.PropertyMap DisabledUnselectedVisual
318 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
319 GetProperty(Button.Property.DISABLED_UNSELECTED_VISUAL).Get(temp);
324 SetProperty(Button.Property.DISABLED_UNSELECTED_VISUAL, new Tizen.NUI.PropertyValue(value));
329 /// Gets/Sets the disabled in the unselected state background, button visual
331 public Tizen.NUI.PropertyMap UnselectedBackgroundVisual
335 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
336 GetProperty(Button.Property.UNSELECTED_BACKGROUND_VISUAL).Get(temp);
341 SetProperty(Button.Property.UNSELECTED_BACKGROUND_VISUAL, new Tizen.NUI.PropertyValue(value));
346 /// Gets/Sets the selected background button visual
348 public Tizen.NUI.PropertyMap SelectedBackgroundVisual
352 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
353 GetProperty(Button.Property.SELECTED_BACKGROUND_VISUAL).Get(temp);
358 SetProperty(Button.Property.SELECTED_BACKGROUND_VISUAL, new Tizen.NUI.PropertyValue(value));
363 /// Gets/Sets the disabled while unselected background button visual
365 public Tizen.NUI.PropertyMap DisabledUnselectedBackgroundVisual
369 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
370 GetProperty(Button.Property.DISABLED_UNSELECTED_BACKGROUND_VISUAL).Get(temp);
375 SetProperty(Button.Property.DISABLED_UNSELECTED_BACKGROUND_VISUAL, new Tizen.NUI.PropertyValue(value));
380 /// Gets/Sets the disabled while selected background button visual
382 public Tizen.NUI.PropertyMap DisabledSelectedBackgroundVisual
386 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
387 GetProperty(Button.Property.DISABLED_SELECTED_BACKGROUND_VISUAL).Get(temp);
392 SetProperty(Button.Property.DISABLED_SELECTED_BACKGROUND_VISUAL, new Tizen.NUI.PropertyValue(value));
397 /// Gets/Sets the position of the the label in relation to the foreground/icon if both present
399 public Align LabelRelativeAlignment
404 if (GetProperty(Button.Property.LABEL_RELATIVE_ALIGNMENT).Get(out temp) == false)
406 NUILog.Error("LabelRelativeAlignment get error!");
424 string valueToString = "";
429 valueToString = "BEGIN";
434 valueToString = "END";
439 valueToString = "TOP";
444 valueToString = "BOTTOM";
449 valueToString = "END";
453 SetProperty(Button.Property.LABEL_RELATIVE_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
458 /// Gets/Sets the padding around the text
460 public Vector4 LabelPadding
464 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
465 GetProperty(Button.Property.LABEL_PADDING).Get(temp);
470 SetProperty(Button.Property.LABEL_PADDING, new Tizen.NUI.PropertyValue(value));
475 /// Gets/Sets the padding around the foreground visual
477 public Vector4 ForegroundVisualPadding
481 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
482 GetProperty(Button.Property.FOREGROUND_VISUAL_PADDING).Get(temp);
487 SetProperty(Button.Property.FOREGROUND_VISUAL_PADDING, new Tizen.NUI.PropertyValue(value));
491 internal class Property
493 internal static readonly int UNSELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_UNSELECTED_VISUAL_get();
494 internal static readonly int SELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_SELECTED_VISUAL_get();
495 internal static readonly int DISABLED_SELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_DISABLED_SELECTED_VISUAL_get();
496 internal static readonly int DISABLED_UNSELECTED_VISUAL = NDalicManualPINVOKE.Button_Property_DISABLED_UNSELECTED_VISUAL_get();
497 internal static readonly int UNSELECTED_BACKGROUND_VISUAL = NDalicManualPINVOKE.Button_Property_UNSELECTED_BACKGROUND_VISUAL_get();
498 internal static readonly int SELECTED_BACKGROUND_VISUAL = NDalicManualPINVOKE.Button_Property_SELECTED_BACKGROUND_VISUAL_get();
499 internal static readonly int DISABLED_UNSELECTED_BACKGROUND_VISUAL = NDalicManualPINVOKE.Button_Property_DISABLED_UNSELECTED_BACKGROUND_VISUAL_get();
500 internal static readonly int DISABLED_SELECTED_BACKGROUND_VISUAL = NDalicManualPINVOKE.Button_Property_DISABLED_SELECTED_BACKGROUND_VISUAL_get();
501 internal static readonly int LABEL_RELATIVE_ALIGNMENT = NDalicManualPINVOKE.Button_Property_LABEL_RELATIVE_ALIGNMENT_get();
502 internal static readonly int LABEL_PADDING = NDalicManualPINVOKE.Button_Property_LABEL_PADDING_get();
503 internal static readonly int FOREGROUND_VISUAL_PADDING = NDalicManualPINVOKE.Button_Property_VISUAL_PADDING_get();
504 internal static readonly int AUTO_REPEATING = NDalicPINVOKE.Button_Property_AUTO_REPEATING_get();
505 internal static readonly int INITIAL_AUTO_REPEATING_DELAY = NDalicPINVOKE.Button_Property_INITIAL_AUTO_REPEATING_DELAY_get();
506 internal static readonly int NEXT_AUTO_REPEATING_DELAY = NDalicPINVOKE.Button_Property_NEXT_AUTO_REPEATING_DELAY_get();
507 internal static readonly int TOGGLABLE = NDalicPINVOKE.Button_Property_TOGGLABLE_get();
508 internal static readonly int SELECTED = NDalicPINVOKE.Button_Property_SELECTED_get();
509 internal static readonly int UNSELECTED_COLOR = NDalicPINVOKE.Button_Property_UNSELECTED_COLOR_get();
510 internal static readonly int SELECTED_COLOR = NDalicPINVOKE.Button_Property_SELECTED_COLOR_get();
511 internal static readonly int LABEL = NDalicPINVOKE.Button_Property_LABEL_get();
515 /// Creates an uninitialized Button.<br>
516 /// Only derived versions can be instantiated.<br>
518 public Button() : this(NDalicPINVOKE.new_Button__SWIG_0(), true)
520 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
523 internal ButtonSignal PressedSignal()
525 ButtonSignal ret = new ButtonSignal(NDalicPINVOKE.Button_PressedSignal(swigCPtr), false);
526 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
530 internal ButtonSignal ReleasedSignal()
532 ButtonSignal ret = new ButtonSignal(NDalicPINVOKE.Button_ReleasedSignal(swigCPtr), false);
533 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
537 internal ButtonSignal ClickedSignal()
539 ButtonSignal ret = new ButtonSignal(NDalicPINVOKE.Button_ClickedSignal(swigCPtr), false);
540 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
544 internal ButtonSignal StateChangedSignal()
546 ButtonSignal ret = new ButtonSignal(NDalicPINVOKE.Button_StateChangedSignal(swigCPtr), false);
547 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
552 /// If the autorepeating property is set to true then the togglable property is set to false.
554 public bool AutoRepeating
559 GetProperty(Button.Property.AUTO_REPEATING).Get(out temp);
564 SetProperty(Button.Property.AUTO_REPEATING, new Tizen.NUI.PropertyValue(value));
569 /// By default this value is set to 0.15 seconds.
571 public float InitialAutoRepeatingDelay
576 GetProperty(Button.Property.INITIAL_AUTO_REPEATING_DELAY).Get(out temp);
581 SetProperty(Button.Property.INITIAL_AUTO_REPEATING_DELAY, new Tizen.NUI.PropertyValue(value));
586 /// default this value is set to 0.05 seconds.
588 public float NextAutoRepeatingDelay
593 GetProperty(Button.Property.NEXT_AUTO_REPEATING_DELAY).Get(out temp);
598 SetProperty(Button.Property.NEXT_AUTO_REPEATING_DELAY, new Tizen.NUI.PropertyValue(value));
603 /// If the togglable property is set to true, then the autorepeating property is set to false.
605 public bool Togglable
610 GetProperty(Button.Property.TOGGLABLE).Get(out temp);
615 SetProperty(Button.Property.TOGGLABLE, new Tizen.NUI.PropertyValue(value));
620 /// /Gets/Sets the togglable button as either selected or unselected, togglable property must be set to true.
627 GetProperty(Button.Property.SELECTED).Get(out temp);
632 SetProperty(Button.Property.SELECTED, new Tizen.NUI.PropertyValue(value));
637 /// Gets/Sets unselected color.
639 public Color UnselectedColor
643 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
644 GetProperty(Button.Property.UNSELECTED_COLOR).Get(temp);
649 SetProperty(Button.Property.UNSELECTED_COLOR, new Tizen.NUI.PropertyValue(value));
654 /// Gets/Sets selected color.
656 public Color SelectedColor
660 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
661 GetProperty(Button.Property.SELECTED_COLOR).Get(temp);
666 SetProperty(Button.Property.SELECTED_COLOR, new Tizen.NUI.PropertyValue(value));
673 public Tizen.NUI.PropertyMap Label
677 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
678 GetProperty(Button.Property.LABEL).Get(temp);
683 SetProperty(Button.Property.LABEL, new Tizen.NUI.PropertyValue(value));
688 /// Gets/Sets text of label.
690 public string LabelText
694 Tizen.NUI.PropertyMap map = new Tizen.NUI.PropertyMap();
695 GetProperty( Button.Property.LABEL).Get(map);
696 Tizen.NUI.PropertyValue value = map.Find( TextVisualProperty.Text, "Text");
703 SetProperty( Button.Property.LABEL, new Tizen.NUI.PropertyValue( value ) );
708 /// Enumeration for describing the position the text label can be in relation to the control(and foreground/icon).
713 /// At the start of the control before the foreground/icon
717 /// At the end of the control after the foreground/icon
721 /// At the top of the control above the foreground/icon
725 /// At the bottom of the control below the foreground/icon