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 //------------------------------------------------------------------------------
20 // This file was automatically generated by SWIG (http://www.swig.org).
23 // Do not make changes to this file unless you know what you are doing--modify
24 // the SWIG interface file instead.
25 //------------------------------------------------------------------------------
27 namespace Tizen.NUI.BaseComponents
30 using System.Runtime.InteropServices;
33 /// ImageView is a class for displaying an image resource.<br>
34 /// An instance of ImageView can be created using a URL or an Image instance.<br>
36 public class ImageView : View
38 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
40 internal ImageView(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.ImageView_SWIGUpcast(cPtr), cMemoryOwn)
42 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
45 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(ImageView obj)
47 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
52 /// Event arguments of resource ready.
54 public class ResourceReadyEventArgs : EventArgs
59 /// The view whose resource is ready.
74 private EventHandler<ResourceReadyEventArgs> _resourceReadyEventHandler;
75 [UnmanagedFunctionPointer(CallingConvention.StdCall)]
76 private delegate void ResourceReadyEventCallbackType(IntPtr data);
77 private ResourceReadyEventCallbackType _resourceReadyEventCallback;
80 /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
81 /// This signal is emitted after all resources required by a control are loaded and ready.<br>
82 /// Most resources are only loaded when the control is placed on stage.<br>
84 public event EventHandler<ResourceReadyEventArgs> ResourceReady
88 if (_resourceReadyEventHandler == null)
90 _resourceReadyEventCallback = OnResourceReady;
91 ResourceReadySignal(this).Connect(_resourceReadyEventCallback);
94 _resourceReadyEventHandler += value;
99 _resourceReadyEventHandler -= value;
101 if (_resourceReadyEventHandler == null && ResourceReadySignal(this).Empty() == false)
103 ResourceReadySignal(this).Disconnect(_resourceReadyEventCallback);
108 // Callback for View ResourceReady signal
109 private void OnResourceReady(IntPtr data)
111 ResourceReadyEventArgs e = new ResourceReadyEventArgs();
114 e.View = Registry.GetManagedBaseHandleFromNativePtr(data) as View;
117 if (_resourceReadyEventHandler != null)
119 _resourceReadyEventHandler(this, e);
123 //you can override it to clean-up your own resources.
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 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 public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
172 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
176 /// Creates an initialized ImageView from an URL to an image resource.<br>
177 /// If the string is empty, ImageView will not display anything.<br>
179 /// <param name="url">The url of the image resource to display</param>
180 public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
182 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
185 internal ImageView(string url, Uint16Pair size) : this(NDalicPINVOKE.ImageView_New__SWIG_3(url, Uint16Pair.getCPtr(size)), true)
187 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
192 /// Sets this ImageView from the given URL.<br>
193 /// If the URL is empty, ImageView will not display anything.<br>
195 /// <param name="url">The URL to the image resource to display</param>
196 public void SetImage(string url)
198 NDalicPINVOKE.ImageView_SetImage__SWIG_1(swigCPtr, url);
199 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
201 internal void SetImage(string url, Uint16Pair size)
203 NDalicPINVOKE.ImageView_SetImage__SWIG_2(swigCPtr, url, Uint16Pair.getCPtr(size));
204 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
207 internal ViewResourceReadySignal ResourceReadySignal(View view) {
208 ViewResourceReadySignal ret = new ViewResourceReadySignal(NDalicPINVOKE.ResourceReadySignal(View.getCPtr(view)), false);
209 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
214 /// Query if all resources required by a control are loaded and ready.<br>
215 /// Most resources are only loaded when the control is placed on stage.<br>
216 /// true if the resources are loaded and ready, false otherwise.<br>
218 public bool IsResourceReady()
220 bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
221 if (NDalicPINVOKE.SWIGPendingException.Pending)
222 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
227 /// ImageView ResourceUrl, type string
229 public string ResourceUrl
233 GetProperty(ImageView.Property.RESOURCE_URL).Get(out _url);
244 /// ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise
246 public PropertyMap ImageMap
252 PropertyMap temp = new PropertyMap();
253 GetProperty(ImageView.Property.IMAGE).Get(temp);
265 SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
271 /// ImageView PreMultipliedAlpha, type Boolean.<br>
272 /// Image must be initialized.<br>
274 public bool PreMultipliedAlpha
279 GetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA).Get(out temp);
284 SetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value));
289 /// ImageView PixelArea, type Vector4 (Animatable property).<br>
290 /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br>
292 public RelativeVector4 PixelArea
296 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
297 GetProperty(ImageView.Property.PIXEL_AREA).Get(temp);
302 SetProperty(ImageView.Property.PIXEL_AREA, new Tizen.NUI.PropertyValue(value));
307 /// The border of the image in the order: left, right, bottom, top.<br>
308 /// If set, ImageMap will be ignored.<br>
309 /// For N-Patch images only.<br>
312 public Rectangle Border
326 /// Get or set whether to draws the borders only(If true).<br>
327 /// If not specified, the default is false.<br>
328 /// For N-Patch images only.<br>
331 public bool BorderOnly
335 return _borderOnly ?? false;
344 public bool SynchronosLoading
348 return _synchronousLoading ?? false;
352 _synchronousLoading = value;
357 private void UpdateImage()
362 { // for nine-patch image
363 _nPatchMap = new PropertyMap();
364 _nPatchMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.NPatch));
365 _nPatchMap.Add(NpatchImageVisualProperty.URL, new PropertyValue(_url));
366 _nPatchMap.Add(NpatchImageVisualProperty.Border, new PropertyValue(_border));
367 if (_borderOnly != null) { _nPatchMap.Add(NpatchImageVisualProperty.BorderOnly, new PropertyValue((bool)_borderOnly)); }
368 if (_synchronousLoading != null) _nPatchMap.Add(NpatchImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading));
369 SetProperty(ImageView.Property.IMAGE, new PropertyValue(_nPatchMap));
371 else if(_synchronousLoading != null)
372 { // for normal image, with synchronous loading property
373 PropertyMap imageMap = new PropertyMap();
374 imageMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.Image));
375 imageMap.Add(ImageVisualProperty.URL, new PropertyValue(_url));
376 imageMap.Add(ImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading));
377 SetProperty(ImageView.Property.IMAGE, new PropertyValue(imageMap));
380 { // just for normal image
381 SetProperty(ImageView.Property.RESOURCE_URL, new PropertyValue(_url));
386 private Rectangle _border = null;
387 private PropertyMap _nPatchMap = null;
388 private bool? _synchronousLoading = null;
389 private bool? _borderOnly = null;
390 private string _url = null;