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.
17 namespace Tizen.NUI.UIComponents
21 using System.Runtime.InteropServices;
22 using Tizen.NUI.BaseComponents;
25 /// Slider is a control to enable sliding an indicator between two values.
27 public class Slider : View
29 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
31 internal Slider(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.Slider_SWIGUpcast(cPtr), cMemoryOwn)
33 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
36 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Slider obj)
38 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
44 protected override void Dispose(DisposeTypes type)
51 if (type == DisposeTypes.Explicit)
54 //Release your own managed resources here.
55 //You should release all of your own disposable objects here.
59 //Release your own unmanaged resources here.
60 //You should not access any managed member here except static instance.
61 //because the execution order of Finalizes is non-deterministic.
63 if (swigCPtr.Handle != global::System.IntPtr.Zero)
69 //Unreference this instance from Registry.
70 Registry.Unregister(this);
72 NDalicPINVOKE.delete_Slider(swigCPtr);
74 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
81 /// Value changed event arguments.
83 public class ValueChangedEventArgs : EventArgs
85 private Slider _slider;
86 private float _slideValue;
106 public float SlideValue
120 /// Sliding finished event arguments.
122 public class SlidingFinishedEventArgs : EventArgs
124 private Slider _slider;
125 private float _slideValue;
145 public float SlideValue
159 /// Mark reached event arguments.
161 public class MarkReachedEventArgs : EventArgs
163 private Slider _slider;
164 private int _slideValue;
184 public int SlideValue
198 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
199 private delegate bool ValueChangedCallbackDelegate(IntPtr slider, float slideValue);
200 private EventHandlerWithReturnType<object, ValueChangedEventArgs, bool> _sliderValueChangedEventHandler;
201 private ValueChangedCallbackDelegate _sliderValueChangedCallbackDelegate;
203 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
204 private delegate bool SlidingFinishedCallbackDelegate(IntPtr slider, float slideValue);
205 private EventHandlerWithReturnType<object, SlidingFinishedEventArgs, bool> _sliderSlidingFinishedEventHandler;
206 private SlidingFinishedCallbackDelegate _sliderSlidingFinishedCallbackDelegate;
208 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
209 private delegate bool MarkReachedCallbackDelegate(IntPtr slider, int slideValue);
210 private EventHandlerWithReturnType<object, MarkReachedEventArgs, bool> _sliderMarkReachedEventHandler;
211 private MarkReachedCallbackDelegate _sliderMarkReachedCallbackDelegate;
214 /// Event emitted when the slider value changes.
216 public event EventHandlerWithReturnType<object, ValueChangedEventArgs, bool> ValueChanged
220 if (_sliderValueChangedEventHandler == null)
222 _sliderValueChangedCallbackDelegate = (OnValueChanged);
223 ValueChangedSignal().Connect(_sliderValueChangedCallbackDelegate);
225 _sliderValueChangedEventHandler += value;
229 _sliderValueChangedEventHandler -= value;
230 if (_sliderValueChangedEventHandler == null && ValueChangedSignal().Empty() == false)
232 ValueChangedSignal().Disconnect(_sliderValueChangedCallbackDelegate);
237 // Callback for Slider ValueChanged signal
238 private bool OnValueChanged(IntPtr slider, float slideValue)
240 ValueChangedEventArgs e = new ValueChangedEventArgs();
242 // Populate all members of "e" (ValueChangedEventArgs) with real page
243 e.Slider = Slider.GetSliderFromPtr(slider);
244 e.SlideValue = slideValue;
246 if (_sliderValueChangedEventHandler != null)
248 //here we send all page to user event handlers
249 return _sliderValueChangedEventHandler(this, e);
255 /// Event emitted when the sliding is finished.
257 public event EventHandlerWithReturnType<object, SlidingFinishedEventArgs, bool> SlidingFinished
261 if (_sliderSlidingFinishedEventHandler == null)
263 _sliderSlidingFinishedCallbackDelegate = (OnSlidingFinished);
264 SlidingFinishedSignal().Connect(_sliderSlidingFinishedCallbackDelegate);
266 _sliderSlidingFinishedEventHandler += value;
270 _sliderSlidingFinishedEventHandler -= value;
271 if (_sliderSlidingFinishedEventHandler == null && SlidingFinishedSignal().Empty() == false)
273 SlidingFinishedSignal().Disconnect(_sliderSlidingFinishedCallbackDelegate);
278 // Callback for Slider SlidingFinished signal
279 private bool OnSlidingFinished(IntPtr slider, float slideValue)
281 SlidingFinishedEventArgs e = new SlidingFinishedEventArgs();
283 // Populate all members of "e" (SlidingFinishedEventArgs) with real page
284 e.Slider = Slider.GetSliderFromPtr(slider);
285 e.SlideValue = slideValue;
287 if (_sliderSlidingFinishedEventHandler != null)
289 //here we send all page to user event handlers
290 return _sliderSlidingFinishedEventHandler(this, e);
296 /// Event emitted when the slider handle reaches a mark.
298 public event EventHandlerWithReturnType<object, MarkReachedEventArgs, bool> MarkReached
302 if (_sliderMarkReachedEventHandler == null)
304 _sliderMarkReachedCallbackDelegate = (OnMarkReached);
305 MarkReachedSignal().Connect(_sliderMarkReachedCallbackDelegate);
307 _sliderMarkReachedEventHandler += value;
311 _sliderMarkReachedEventHandler -= value;
312 if (_sliderMarkReachedEventHandler == null && MarkReachedSignal().Empty() == false)
314 MarkReachedSignal().Disconnect(_sliderMarkReachedCallbackDelegate);
319 // Callback for Slider MarkReached signal
320 private bool OnMarkReached(IntPtr slider, int slideValue)
322 MarkReachedEventArgs e = new MarkReachedEventArgs();
324 // Populate all members of "e" (MarkReachedEventArgs) with real page
325 e.Slider = Slider.GetSliderFromPtr(slider);
326 e.SlideValue = slideValue;
328 if (_sliderMarkReachedEventHandler != null)
330 //here we send all page to user event handlers
331 return _sliderMarkReachedEventHandler(this, e);
337 /// Get Slider from the pointer.
339 /// <param name="cPtr">The pointer of Slider</param>
340 /// <returns>Object of Slider type</returns>
341 internal static Slider GetSliderFromPtr(global::System.IntPtr cPtr)
343 Slider ret = new Slider(cPtr, false);
344 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
348 internal class Property : global::System.IDisposable
350 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
351 protected bool swigCMemOwn;
353 internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
355 swigCMemOwn = cMemoryOwn;
356 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
359 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Property obj)
361 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
364 //A Flag to check who called Dispose(). (By User or DisposeQueue)
365 private bool isDisposeQueued = false;
366 //A Flat to check if it is already disposed.
367 protected bool disposed = false;
371 if (!isDisposeQueued)
373 isDisposeQueued = true;
374 DisposeQueue.Instance.Add(this);
378 public void Dispose()
380 //Throw excpetion if Dispose() is called in separate thread.
381 if (!Window.IsInstalled())
383 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
388 Dispose(DisposeTypes.Implicit);
392 Dispose(DisposeTypes.Explicit);
393 System.GC.SuppressFinalize(this);
397 protected virtual void Dispose(DisposeTypes type)
404 if (type == DisposeTypes.Explicit)
407 //Release your own managed resources here.
408 //You should release all of your own disposable objects here.
412 //Release your own unmanaged resources here.
413 //You should not access any managed member here except static instance.
414 //because the execution order of Finalizes is non-deterministic.
416 if (swigCPtr.Handle != global::System.IntPtr.Zero)
421 NDalicPINVOKE.delete_Slider_Property(swigCPtr);
423 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
429 internal Property() : this(NDalicPINVOKE.new_Slider_Property(), true)
431 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
434 internal static readonly int LOWER_BOUND = NDalicPINVOKE.Slider_Property_LOWER_BOUND_get();
435 internal static readonly int UPPER_BOUND = NDalicPINVOKE.Slider_Property_UPPER_BOUND_get();
436 internal static readonly int VALUE = NDalicPINVOKE.Slider_Property_VALUE_get();
437 internal static readonly int TRACK_VISUAL = NDalicPINVOKE.Slider_Property_TRACK_VISUAL_get();
438 internal static readonly int HANDLE_VISUAL = NDalicPINVOKE.Slider_Property_HANDLE_VISUAL_get();
439 internal static readonly int PROGRESS_VISUAL = NDalicPINVOKE.Slider_Property_PROGRESS_VISUAL_get();
440 internal static readonly int POPUP_VISUAL = NDalicPINVOKE.Slider_Property_POPUP_VISUAL_get();
441 internal static readonly int POPUP_ARROW_VISUAL = NDalicPINVOKE.Slider_Property_POPUP_ARROW_VISUAL_get();
442 internal static readonly int DISABLED_COLOR = NDalicPINVOKE.Slider_Property_DISABLED_COLOR_get();
443 internal static readonly int VALUE_PRECISION = NDalicPINVOKE.Slider_Property_VALUE_PRECISION_get();
444 internal static readonly int SHOW_POPUP = NDalicPINVOKE.Slider_Property_SHOW_POPUP_get();
445 internal static readonly int SHOW_VALUE = NDalicPINVOKE.Slider_Property_SHOW_VALUE_get();
446 internal static readonly int MARKS = NDalicPINVOKE.Slider_Property_MARKS_get();
447 internal static readonly int SNAP_TO_MARKS = NDalicPINVOKE.Slider_Property_SNAP_TO_MARKS_get();
448 internal static readonly int MARK_TOLERANCE = NDalicPINVOKE.Slider_Property_MARK_TOLERANCE_get();
453 /// Creates the Slider control.
455 public Slider() : this(NDalicPINVOKE.Slider_New(), true)
457 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
460 internal Slider(Slider handle) : this(NDalicPINVOKE.new_Slider__SWIG_1(Slider.getCPtr(handle)), true)
462 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
465 internal Slider Assign(Slider handle)
467 Slider ret = new Slider(NDalicPINVOKE.Slider_Assign(swigCPtr, Slider.getCPtr(handle)), false);
468 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
473 /// Downcasts an Object handle to Slider.<br>
474 /// If handle points to a Slider, the downcast produces valid handle.<br>
475 /// If not, the returned handle is left uninitialized.<br>
477 /// <param name="handle">Handle to an object</param>
478 /// <returns>Handle to a Slider or an uninitialized handle</returns>
479 public new static Slider DownCast(BaseHandle handle)
481 Slider ret = new Slider(NDalicPINVOKE.Slider_DownCast(BaseHandle.getCPtr(handle)), true);
482 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
486 internal SliderValueChangedSignal ValueChangedSignal()
488 SliderValueChangedSignal ret = new SliderValueChangedSignal(NDalicPINVOKE.Slider_ValueChangedSignal(swigCPtr), false);
489 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
493 internal SliderValueChangedSignal SlidingFinishedSignal()
495 SliderValueChangedSignal ret = new SliderValueChangedSignal(NDalicPINVOKE.Slider_SlidingFinishedSignal(swigCPtr), false);
496 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
500 internal SliderMarkReachedSignal MarkReachedSignal()
502 SliderMarkReachedSignal ret = new SliderMarkReachedSignal(NDalicPINVOKE.Slider_MarkReachedSignal(swigCPtr), false);
503 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
508 /// Lower bound property
510 public float LowerBound
515 GetProperty(Slider.Property.LOWER_BOUND).Get(out temp);
520 SetProperty(Slider.Property.LOWER_BOUND, new Tizen.NUI.PropertyValue(value));
525 /// Upper bound property
527 public float UpperBound
532 GetProperty(Slider.Property.UPPER_BOUND).Get(out temp);
537 SetProperty(Slider.Property.UPPER_BOUND, new Tizen.NUI.PropertyValue(value));
549 GetProperty(Slider.Property.VALUE).Get(out temp);
554 SetProperty(Slider.Property.VALUE, new Tizen.NUI.PropertyValue(value));
559 /// Track visual property
561 public PropertyMap TrackVisual
565 PropertyMap temp = new PropertyMap();
566 GetProperty(Slider.Property.TRACK_VISUAL).Get(temp);
571 SetProperty(Slider.Property.TRACK_VISUAL, new Tizen.NUI.PropertyValue(value));
576 /// Handle visual property
578 public PropertyMap HandleVisual
582 PropertyMap temp = new PropertyMap();
583 GetProperty(Slider.Property.HANDLE_VISUAL).Get(temp);
588 SetProperty(Slider.Property.HANDLE_VISUAL, new Tizen.NUI.PropertyValue(value));
593 /// Progress visual property
595 public PropertyMap ProgressVisual
599 PropertyMap temp = new PropertyMap();
600 GetProperty(Slider.Property.PROGRESS_VISUAL).Get(temp);
605 SetProperty(Slider.Property.PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value));
610 /// Popup visual property
612 public PropertyMap PopupVisual
616 PropertyMap temp = new PropertyMap();
617 GetProperty(Slider.Property.POPUP_VISUAL).Get(temp);
622 SetProperty(Slider.Property.POPUP_VISUAL, new Tizen.NUI.PropertyValue(value));
627 /// Popup arrow visual property
629 public PropertyMap PopupArrowVisual
633 PropertyMap temp = new PropertyMap();
634 GetProperty(Slider.Property.POPUP_ARROW_VISUAL).Get(temp);
639 SetProperty(Slider.Property.POPUP_ARROW_VISUAL, new Tizen.NUI.PropertyValue(value));
644 /// Disable color property
646 public Vector4 DisabledColor
650 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
651 GetProperty(Slider.Property.DISABLED_COLOR).Get(temp);
656 SetProperty(Slider.Property.DISABLED_COLOR, new Tizen.NUI.PropertyValue(value));
661 /// Value presicion property
663 public int ValuePrecision
668 GetProperty(Slider.Property.VALUE_PRECISION).Get(out temp);
673 SetProperty(Slider.Property.VALUE_PRECISION, new Tizen.NUI.PropertyValue(value));
678 /// Show popup property
680 public bool ShowPopup
685 GetProperty(Slider.Property.SHOW_POPUP).Get(out temp);
690 SetProperty(Slider.Property.SHOW_POPUP, new Tizen.NUI.PropertyValue(value));
695 /// Show value property
697 public bool ShowValue
702 GetProperty(Slider.Property.SHOW_VALUE).Get(out temp);
707 SetProperty(Slider.Property.SHOW_VALUE, new Tizen.NUI.PropertyValue(value));
714 public Tizen.NUI.PropertyArray Marks
718 Tizen.NUI.PropertyArray temp = new Tizen.NUI.PropertyArray();
719 GetProperty(Slider.Property.MARKS).Get(temp);
724 SetProperty(Slider.Property.MARKS, new Tizen.NUI.PropertyValue(value));
729 /// Snap to marks property
731 public bool SnapToMarks
736 GetProperty(Slider.Property.SNAP_TO_MARKS).Get(out temp);
741 SetProperty(Slider.Property.SNAP_TO_MARKS, new Tizen.NUI.PropertyValue(value));
746 /// Mark tolerance property
748 public float MarkTolerance
753 GetProperty(Slider.Property.MARK_TOLERANCE).Get(out temp);
758 SetProperty(Slider.Property.MARK_TOLERANCE, new Tizen.NUI.PropertyValue(value));