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 /// ProgressBar is a control to give the user an indication of the progress of an operation.
27 public class ProgressBar : View
29 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
31 internal ProgressBar(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.ProgressBar_SWIGUpcast(cPtr), cMemoryOwn)
33 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
36 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ProgressBar obj)
38 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
42 /// To make ProgressBar instance be disposed.
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 (_progressBarValueChangedCallbackDelegate != null)
65 ValueChangedSignal().Disconnect(_progressBarValueChangedCallbackDelegate);
68 if (swigCPtr.Handle != global::System.IntPtr.Zero)
73 NDalicPINVOKE.delete_ProgressBar(swigCPtr);
75 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
83 /// Event arguments that passed via ValueChangedEventArgs
85 public class ValueChangedEventArgs : EventArgs
87 private ProgressBar _progressBar;
88 private float _progressValue;
89 private float _secondaryProgressValue;
91 public ProgressBar ProgressBar
103 public float ProgressValue
107 return _progressValue;
111 _progressValue = value;
115 public float SecondaryProgressValue
119 return _secondaryProgressValue;
123 _secondaryProgressValue = value;
129 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
130 private delegate void ValueChangedCallbackDelegate(IntPtr progressBar, float progressValue, float secondaryProgressValue);
131 private EventHandler<ValueChangedEventArgs> _progressBarValueChangedEventHandler;
132 private ValueChangedCallbackDelegate _progressBarValueChangedCallbackDelegate;
135 /// Event is sent when the ProgressBar value changes.
137 public event EventHandler<ValueChangedEventArgs> ValueChanged
141 if (_progressBarValueChangedEventHandler == null)
143 _progressBarValueChangedCallbackDelegate = (OnValueChanged);
144 ValueChangedSignal().Connect(_progressBarValueChangedCallbackDelegate);
146 _progressBarValueChangedEventHandler += value;
150 _progressBarValueChangedEventHandler -= value;
151 if (_progressBarValueChangedEventHandler == null && ValueChangedSignal().Empty() == false)
153 ValueChangedSignal().Disconnect(_progressBarValueChangedCallbackDelegate);
158 // Callback for ProgressBar ValueChanged signal
159 private void OnValueChanged(IntPtr progressBar, float progressValue, float secondaryProgressValue)
161 ValueChangedEventArgs e = new ValueChangedEventArgs();
163 // Populate all members of "e" (ValueChangedEventArgs) with real page
164 e.ProgressBar = Registry.GetManagedBaseHandleFromNativePtr(progressBar) as ProgressBar;
165 e.ProgressValue = progressValue;
166 e.SecondaryProgressValue = secondaryProgressValue;
168 if (_progressBarValueChangedEventHandler != null)
170 _progressBarValueChangedEventHandler(this, e);
174 internal class Property
176 internal static readonly int PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_PROGRESS_VALUE_get();
177 internal static readonly int SECONDARY_PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_SECONDARY_PROGRESS_VALUE_get();
178 internal static readonly int INDETERMINATE = NDalicPINVOKE.ProgressBar_Property_INDETERMINATE_get();
179 internal static readonly int TRACK_VISUAL = NDalicPINVOKE.ProgressBar_Property_TRACK_VISUAL_get();
180 internal static readonly int PROGRESS_VISUAL = NDalicPINVOKE.ProgressBar_Property_PROGRESS_VISUAL_get();
181 internal static readonly int SECONDARY_PROGRESS_VISUAL = NDalicPINVOKE.ProgressBar_Property_SECONDARY_PROGRESS_VISUAL_get();
182 internal static readonly int INDETERMINATE_VISUAL = NDalicPINVOKE.ProgressBar_Property_INDETERMINATE_VISUAL_get();
183 internal static readonly int INDETERMINATE_VISUAL_ANIMATION = NDalicPINVOKE.ProgressBar_Property_INDETERMINATE_VISUAL_ANIMATION_get();
184 internal static readonly int LABEL_VISUAL = NDalicPINVOKE.ProgressBar_Property_LABEL_VISUAL_get();
188 /// Creates the ProgressBar.
190 public ProgressBar() : this(NDalicPINVOKE.ProgressBar_New(), true)
192 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
196 internal ProgressBarValueChangedSignal ValueChangedSignal()
198 ProgressBarValueChangedSignal ret = new ProgressBarValueChangedSignal(NDalicPINVOKE.ProgressBar_ValueChangedSignal(swigCPtr), false);
199 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
204 /// The progress value of progress bar, progress runs form 0 to 1.<br>
205 /// If Value is set to 0, progress bar will be set to beginning.<br>
206 /// If Value is set to 1, progress bar will be set to end.<br>
207 /// Any Value outside of the range is ignored.<br>
209 public float ProgressValue
214 GetProperty(ProgressBar.Property.PROGRESS_VALUE).Get(out temp);
219 SetProperty(ProgressBar.Property.PROGRESS_VALUE, new Tizen.NUI.PropertyValue(value));
223 /// The secondary progress value of progress bar, secondary progress runs form 0 to 1.<br>
224 /// Optional. If not supplied, the default is 0.<br>
225 /// If Value is set to 0, progress bar will be set secondary progress to beginning.<br>
226 /// If Value is set to 1, progress bar will be set secondary progress to end.<br>
227 /// Any Value outside of the range is ignored.<br>
229 public float SecondaryProgressValue
234 GetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VALUE).Get(out temp);
239 SetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VALUE, new Tizen.NUI.PropertyValue(value));
243 /// Sets the progress-bar as \e indeterminate state.
245 public bool Indeterminate
250 GetProperty(ProgressBar.Property.INDETERMINATE).Get(out temp);
255 SetProperty(ProgressBar.Property.INDETERMINATE, new Tizen.NUI.PropertyValue(value));
259 /// The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.<br>
260 /// Optional. If not supplied, the default track visual will be shown.<br>
262 public Tizen.NUI.PropertyMap TrackVisual
266 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
267 GetProperty(ProgressBar.Property.TRACK_VISUAL).Get(temp);
272 SetProperty(ProgressBar.Property.TRACK_VISUAL, new Tizen.NUI.PropertyValue(value));
276 /// The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.<br>
277 /// Optional. If not supplied, the default progress visual will be shown.<br>
279 public Tizen.NUI.PropertyMap ProgressVisual
283 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
284 GetProperty(ProgressBar.Property.PROGRESS_VISUAL).Get(temp);
289 SetProperty(ProgressBar.Property.PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value));
293 /// The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.<br>
294 /// Optional. If not supplied, the secondary progress visual will not be shown.<br>
296 public Tizen.NUI.PropertyMap SecondaryProgressVisual
300 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
301 GetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VISUAL).Get(temp);
306 SetProperty(ProgressBar.Property.SECONDARY_PROGRESS_VISUAL, new Tizen.NUI.PropertyValue(value));
310 /// The indeterminate visual of progress bar.<br>
311 /// Optional. If not supplied, the default inditerminate visual will be shown.<br>
313 public Tizen.NUI.PropertyMap IndeterminateVisual
317 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
318 GetProperty(ProgressBar.Property.INDETERMINATE_VISUAL).Get(temp);
323 SetProperty(ProgressBar.Property.INDETERMINATE_VISUAL, new Tizen.NUI.PropertyValue(value));
327 /// The transition data for indeterminate visual animation.<br>
328 /// Optional. If not supplied, default animation will be played.<br>
330 public Tizen.NUI.PropertyArray IndeterminateVisualAnimation
334 Tizen.NUI.PropertyArray temp = new Tizen.NUI.PropertyArray();
335 GetProperty(ProgressBar.Property.INDETERMINATE_VISUAL_ANIMATION).Get(temp);
340 SetProperty(ProgressBar.Property.INDETERMINATE_VISUAL_ANIMATION, new Tizen.NUI.PropertyValue(value));
344 /// The Label visual of progress bar.
346 public Tizen.NUI.PropertyMap LabelVisual
350 Tizen.NUI.PropertyMap temp = new Tizen.NUI.PropertyMap();
351 GetProperty(ProgressBar.Property.LABEL_VISUAL).Get(temp);
356 SetProperty(ProgressBar.Property.LABEL_VISUAL, new Tizen.NUI.PropertyValue(value));