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.
18 using System.Runtime.InteropServices;
19 using System.ComponentModel;
21 namespace Tizen.NUI.BaseComponents
25 /// ImageView is a class for displaying an image resource.<br />
26 /// An instance of ImageView can be created using a URL or an image instance.<br />
28 /// <since_tizen> 3 </since_tizen>
29 public class ImageView : View
31 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
33 internal ImageView(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.ImageView_SWIGUpcast(cPtr), cMemoryOwn)
35 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
38 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImageView obj)
40 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
45 /// Event arguments of resource ready.
47 /// <since_tizen> 3 </since_tizen>
48 public class ResourceReadyEventArgs : EventArgs
53 /// The view whose resource is ready.
55 /// <since_tizen> 3 </since_tizen>
69 private EventHandler<ResourceReadyEventArgs> _resourceReadyEventHandler;
70 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
71 private delegate void ResourceReadyEventCallbackType(IntPtr data);
72 private ResourceReadyEventCallbackType _resourceReadyEventCallback;
75 /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br />
76 /// This signal is emitted after all resources required by a control are loaded and ready.<br />
77 /// Most resources are only loaded when the control is placed on the stage.<br />
79 /// <since_tizen> 3 </since_tizen>
80 public event EventHandler<ResourceReadyEventArgs> ResourceReady
84 if (_resourceReadyEventHandler == null)
86 _resourceReadyEventCallback = OnResourceReady;
87 ResourceReadySignal(this).Connect(_resourceReadyEventCallback);
90 _resourceReadyEventHandler += value;
95 _resourceReadyEventHandler -= value;
97 if (_resourceReadyEventHandler == null && ResourceReadySignal(this).Empty() == false)
99 ResourceReadySignal(this).Disconnect(_resourceReadyEventCallback);
104 // Callback for View ResourceReady signal
105 private void OnResourceReady(IntPtr data)
107 ResourceReadyEventArgs e = new ResourceReadyEventArgs();
110 e.View = Registry.GetManagedBaseHandleFromNativePtr(data) as View;
113 if (_resourceReadyEventHandler != null)
115 _resourceReadyEventHandler(this, e);
120 /// you can override it to clean-up your own resources.
122 /// <param name="type">DisposeTypes</param>
123 /// <since_tizen> 3 </since_tizen>
124 protected override void Dispose(DisposeTypes type)
131 if (type == DisposeTypes.Explicit)
134 //Release your own managed resources here.
135 //You should release all of your own disposable objects here.
138 _nPatchMap?.Dispose();
142 //Release your own unmanaged resources here.
143 //You should not access any managed member here except static instance.
144 //because the execution order of Finalizes is non-deterministic.
146 if (swigCPtr.Handle != global::System.IntPtr.Zero)
151 NDalicPINVOKE.delete_ImageView(swigCPtr);
153 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
159 internal new class Property
161 internal static readonly int RESOURCE_URL = NDalicPINVOKE.ImageView_Property_RESOURCE_URL_get();
162 internal static readonly int IMAGE = NDalicPINVOKE.ImageView_Property_IMAGE_get();
163 internal static readonly int PRE_MULTIPLIED_ALPHA = NDalicPINVOKE.ImageView_Property_PRE_MULTIPLIED_ALPHA_get();
164 internal static readonly int PIXEL_AREA = NDalicPINVOKE.ImageView_Property_PIXEL_AREA_get();
168 /// Creates an initialized ImageView.
170 /// <since_tizen> 3 </since_tizen>
171 public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
173 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
177 /// Creates an initialized ImageView from a URL to an image resource.<br />
178 /// If the string is empty, ImageView will not display anything.<br />
180 /// <param name="url">The URL of the image resource to display.</param>
181 /// <since_tizen> 3 </since_tizen>
182 public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
185 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
188 internal ImageView(string url, Uint16Pair size) : this(NDalicPINVOKE.ImageView_New__SWIG_3(url, Uint16Pair.getCPtr(size)), true)
191 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
196 /// Sets this ImageView from the given URL.<br />
197 /// If the URL is empty, ImageView will not display anything.<br />
199 /// <param name="url">The URL to the image resource to display.</param>
200 /// <since_tizen> 3 </since_tizen>
201 public void SetImage(string url)
204 NDalicPINVOKE.ImageView_SetImage__SWIG_1(swigCPtr, url);
205 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
207 internal void SetImage(string url, Uint16Pair size)
210 NDalicPINVOKE.ImageView_SetImage__SWIG_2(swigCPtr, url, Uint16Pair.getCPtr(size));
211 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
214 internal ViewResourceReadySignal ResourceReadySignal(View view)
216 ViewResourceReadySignal ret = new ViewResourceReadySignal(NDalicPINVOKE.ResourceReadySignal(View.getCPtr(view)), false);
217 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
222 /// Queries if all resources required by a control are loaded and ready.<br />
223 /// Most resources are only loaded when the control is placed on the stage.<br />
224 /// True if the resources are loaded and ready, false otherwise.<br />
226 /// <since_tizen> 3 </since_tizen>
227 public new bool IsResourceReady()
229 bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
230 if (NDalicPINVOKE.SWIGPendingException.Pending)
231 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
236 /// ImageView ResourceUrl, type string.
238 /// <since_tizen> 3 </since_tizen>
239 public string ResourceUrl
243 GetProperty(ImageView.Property.IMAGE).Get(out _url);
248 _url = (value == null? "" : value);
254 /// This will be deprecated, please use Image instead. <br />
255 /// ImageView ImageMap, type PropertyMap: string if it is a URL, map otherwise.
257 /// <since_tizen> 3 </since_tizen>
258 [Obsolete("Please do not use! This will be deprecated! Please use Image property instead!")]
259 [EditorBrowsable(EditorBrowsableState.Never)]
260 public PropertyMap ImageMap
266 PropertyMap temp = new PropertyMap();
267 GetProperty(ImageView.Property.IMAGE).Get(temp);
279 if (_url != null) { value.Add("url", new PropertyValue(_url)); }
280 SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
286 /// ImageView Image, type PropertyMap
288 /// <since_tizen> 4 </since_tizen>
289 public PropertyMap Image
295 PropertyMap temp = new PropertyMap();
296 GetProperty(ImageView.Property.IMAGE).Get(temp);
308 if(_url != null) { value.Add("url", new PropertyValue(_url)); }
309 SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
315 /// ImageView PreMultipliedAlpha, type Boolean.<br />
316 /// Image must be initialized.<br />
318 /// <since_tizen> 3 </since_tizen>
319 public bool PreMultipliedAlpha
324 GetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA).Get(out temp);
329 SetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value));
334 /// ImageView PixelArea, type Vector4 (Animatable property).<br />
335 /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br />
337 /// <since_tizen> 3 </since_tizen>
338 public RelativeVector4 PixelArea
342 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
343 GetProperty(ImageView.Property.PIXEL_AREA).Get(temp);
348 SetProperty(ImageView.Property.PIXEL_AREA, new Tizen.NUI.PropertyValue(value));
353 /// The border of the image in the order: left, right, bottom, top.<br />
354 /// If set, ImageMap will be ignored.<br />
355 /// For N-Patch images only.<br />
358 /// <since_tizen> 3 </since_tizen>
359 public Rectangle Border
373 /// Gets or sets whether to draw the borders only (if true).<br />
374 /// If not specified, the default is false.<br />
375 /// For N-Patch images only.<br />
378 /// <since_tizen> 3 </since_tizen>
379 public bool BorderOnly
383 return _borderOnly ?? false;
393 /// Gets or sets whether to synchronos loading the resourceurl of image.<br />
395 /// <since_tizen> 3 </since_tizen>
396 public bool SynchronosLoading
400 return _synchronousLoading ?? false;
404 _synchronousLoading = value;
410 /// Gets or sets whether to correct orientation of image automatically.<br />
412 /// <since_tizen> 5 </since_tizen>
413 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
414 [EditorBrowsable(EditorBrowsableState.Never)]
415 public bool OrientationCorrection
419 return _orientationCorrection ?? false;
423 _orientationCorrection = value;
430 /// Get the loading state of the visual resource.
432 /// <since_tizen> 5 </since_tizen>
433 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
434 [EditorBrowsable(EditorBrowsableState.Never)]
435 public ImageView.LoadingStatusType LoadingStatus
439 return (ImageView.LoadingStatusType)NDalicManualPINVOKE.View_GetVisualResourceStatus(swigCPtr, (int)Property.IMAGE);
444 /// Enumeration for LoadingStatus of image.
446 /// <since_tizen> 5 </since_tizen>
447 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
448 [EditorBrowsable(EditorBrowsableState.Never)]
449 public enum LoadingStatusType
452 /// Loading preparing status.
454 /// <since_tizen> 5 </since_tizen>
455 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
456 [EditorBrowsable(EditorBrowsableState.Never)]
459 /// Loading ready status.
461 /// <since_tizen> 5 </since_tizen>
462 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
463 [EditorBrowsable(EditorBrowsableState.Never)]
466 /// Loading failed status.
468 /// <since_tizen> 5 </since_tizen>
469 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
470 [EditorBrowsable(EditorBrowsableState.Never)]
475 private void UpdateImage()
480 { // for nine-patch image
481 _nPatchMap = new PropertyMap();
482 _nPatchMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.NPatch));
483 _nPatchMap.Add(NpatchImageVisualProperty.URL, new PropertyValue(_url));
484 _nPatchMap.Add(NpatchImageVisualProperty.Border, new PropertyValue(_border));
485 if (_borderOnly != null) { _nPatchMap.Add(NpatchImageVisualProperty.BorderOnly, new PropertyValue((bool)_borderOnly)); }
486 if (_synchronousLoading != null) { _nPatchMap.Add(NpatchImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
487 if (_orientationCorrection != null) { _nPatchMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
488 SetProperty(ImageView.Property.IMAGE, new PropertyValue(_nPatchMap));
490 else if (_synchronousLoading != null || _orientationCorrection != null)
491 { // for normal image, with synchronous loading property
492 PropertyMap imageMap = new PropertyMap();
493 imageMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.Image));
494 imageMap.Add(ImageVisualProperty.URL, new PropertyValue(_url));
495 if (_synchronousLoading != null) { imageMap.Add(ImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
496 if (_orientationCorrection != null) { imageMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
497 SetProperty(ImageView.Property.IMAGE, new PropertyValue(imageMap));
500 { // just for normal image
501 SetProperty(ImageView.Property.IMAGE, new PropertyValue(_url));
506 private Rectangle _border = null;
507 private PropertyMap _nPatchMap = null;
508 private bool? _synchronousLoading = null;
509 private bool? _borderOnly = null;
510 private string _url = null;
511 private bool? _orientationCorrection = null;