-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+using System;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Tizen.NUI.BaseComponents
{
- using System;
- using System.Runtime.InteropServices;
/// <summary>
- /// ImageView is a class for displaying an image resource.<br>
- /// An instance of ImageView can be created using a URL or an Image instance.<br>
+ /// ImageView is a class for displaying an image resource.<br />
+ /// An instance of ImageView can be created using a URL or an image instance.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ImageView : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
/// <summary>
/// Event arguments of resource ready.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ResourceReadyEventArgs : EventArgs
{
private View _view;
/// <summary>
/// The view whose resource is ready.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public View View
{
get
private ResourceReadyEventCallbackType _resourceReadyEventCallback;
/// <summary>
- /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
- /// This signal is emitted after all resources required by a control are loaded and ready.<br>
- /// Most resources are only loaded when the control is placed on stage.<br>
+ /// An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br />
+ /// This signal is emitted after all resources required by a control are loaded and ready.<br />
+ /// Most resources are only loaded when the control is placed on the stage.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ResourceReadyEventArgs> ResourceReady
{
add
private void OnResourceReady(IntPtr data)
{
ResourceReadyEventArgs e = new ResourceReadyEventArgs();
- if(data != null)
+ if (data != null)
{
e.View = Registry.GetManagedBaseHandleFromNativePtr(data) as View;
}
}
}
- //you can override it to clean-up your own resources.
+ /// <summary>
+ /// you can override it to clean-up your own resources.
+ /// </summary>
+ /// <param name="type">DisposeTypes</param>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
return;
}
- if(type == DisposeTypes.Explicit)
+ if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
base.Dispose(type);
}
- internal class Property
+ internal new class Property
{
internal static readonly int RESOURCE_URL = NDalicPINVOKE.ImageView_Property_RESOURCE_URL_get();
internal static readonly int IMAGE = NDalicPINVOKE.ImageView_Property_IMAGE_get();
/// <summary>
/// Creates an initialized ImageView.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Creates an initialized ImageView from an URL to an image resource.<br>
- /// If the string is empty, ImageView will not display anything.<br>
+ /// Creates an initialized ImageView from a URL to an image resource.<br />
+ /// If the string is empty, ImageView will not display anything.<br />
/// </summary>
- /// <param name="url">The url of the image resource to display</param>
+ /// <param name="url">The URL of the image resource to display.</param>
+ /// <since_tizen> 3 </since_tizen>
public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
{
_url = url;
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Downcasts a handle to imageView handle.
+ /// </summary>
+ /// Please do not use! this will be deprecated!
+ /// Instead please use as keyword.
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
+ "Like: " +
+ "BaseHandle handle = new ImageView(imagePath); " +
+ "ImageView image = handle as ImageView")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public new static ImageView DownCast(BaseHandle handle)
{
- ImageView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ImageView;
+ ImageView ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ImageView;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+
/// <summary>
- /// Sets this ImageView from the given URL.<br>
- /// If the URL is empty, ImageView will not display anything.<br>
+ /// Sets this ImageView from the given URL.<br />
+ /// If the URL is empty, ImageView will not display anything.<br />
/// </summary>
- /// <param name="url">The URL to the image resource to display</param>
+ /// <param name="url">The URL to the image resource to display.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetImage(string url)
{
_url = url;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- internal ViewResourceReadySignal ResourceReadySignal(View view) {
+ internal ViewResourceReadySignal ResourceReadySignal(View view)
+ {
ViewResourceReadySignal ret = new ViewResourceReadySignal(NDalicPINVOKE.ResourceReadySignal(View.getCPtr(view)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// <summary>
- /// Query if all resources required by a control are loaded and ready.<br>
- /// Most resources are only loaded when the control is placed on stage.<br>
- /// true if the resources are loaded and ready, false otherwise.<br>
+ /// Queries if all resources required by a control are loaded and ready.<br />
+ /// Most resources are only loaded when the control is placed on the stage.<br />
+ /// True if the resources are loaded and ready, false otherwise.<br />
/// </summary>
- public bool IsResourceReady()
+ /// <since_tizen> 3 </since_tizen>
+ public new bool IsResourceReady()
{
bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending)
}
/// <summary>
- /// ImageView ResourceUrl, type string
+ /// ImageView ResourceUrl, type string.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string ResourceUrl
{
get
{
- GetProperty(ImageView.Property.RESOURCE_URL).Get(out _url);
+ GetProperty(ImageView.Property.IMAGE).Get(out _url);
return _url;
}
set
{
- _url = value;
+ _url = (value == null? "" : value);
UpdateImage();
}
}
/// <summary>
- /// ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise
+ /// This will be deprecated, please use Image instead. <br />
+ /// ImageView ImageMap, type PropertyMap: string if it is a URL, map otherwise.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [Obsolete("Please do not use! This will be deprecated! Please use Image property instead!")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
public PropertyMap ImageMap
{
get
{
if (_border == null)
{
+ if (_url != null) { value.Add("url", new PropertyValue(_url)); }
+ SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
+ }
+ }
+ }
+
+ /// <summary>
+ /// ImageView Image, type PropertyMap
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
+ public PropertyMap Image
+ {
+ get
+ {
+ if (_border == null)
+ {
+ PropertyMap temp = new PropertyMap();
+ GetProperty(ImageView.Property.IMAGE).Get(temp);
+ return temp;
+ }
+ else
+ {
+ return null;
+ }
+ }
+ set
+ {
+ if (_border == null)
+ {
+ if(_url != null) { value.Add("url", new PropertyValue(_url)); }
SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
}
}
}
/// <summary>
- /// ImageView PreMultipliedAlpha, type Boolean.<br>
- /// Image must be initialized.<br>
+ /// ImageView PreMultipliedAlpha, type Boolean.<br />
+ /// Image must be initialized.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool PreMultipliedAlpha
{
get
}
/// <summary>
- /// ImageView PixelArea, type Vector4 (Animatable property).<br>
- /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br>
+ /// ImageView PixelArea, type Vector4 (Animatable property).<br />
+ /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RelativeVector4 PixelArea
{
get
}
/// <summary>
- /// The border of the image in the order: left, right, bottom, top.<br>
- /// If set, ImageMap will be ignored.<br>
- /// For N-Patch images only.<br>
+ /// The border of the image in the order: left, right, bottom, top.<br />
+ /// If set, ImageMap will be ignored.<br />
+ /// For N-Patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle Border
{
get
}
/// <summary>
- /// Get or set whether to draws the borders only(If true).<br>
- /// If not specified, the default is false.<br>
- /// For N-Patch images only.<br>
+ /// Gets or sets whether to draw the borders only (if true).<br />
+ /// If not specified, the default is false.<br />
+ /// For N-Patch images only.<br />
/// Optional.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool BorderOnly
{
get
}
}
+ /// <summary>
+ /// Gets or sets whether to synchronos loading the resourceurl of image.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SynchronosLoading
{
get
}
}
+ /// <summary>
+ /// Gets or sets whether to correct orientation of image automatically.<br />
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ public bool OrientationCorrection
+ {
+ get
+ {
+ return _orientationCorrection ?? false;
+ }
+ set
+ {
+ _orientationCorrection = value;
+ UpdateImage();
+ }
+ }
+
+
+ /// <summary>
+ /// Get the loading state of the visual resource.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ public ImageView.LoadingStatusType LoadingStatus
+ {
+ get
+ {
+ return (ImageView.LoadingStatusType)NDalicManualPINVOKE.View_GetVisualResourceStatus(swigCPtr, (int)Property.IMAGE);
+ }
+ }
+
+ /// <summary>
+ /// Enumeration for LoadingStatus of image.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ public enum LoadingStatusType
+ {
+ /// <summary>
+ /// Loading preparing status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ Preparing,
+ /// <summary>
+ /// Loading ready status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ Ready,
+ /// <summary>
+ /// Loading failed status.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ Failed
+ }
+
+
private void UpdateImage()
{
if (_url != null)
_nPatchMap.Add(NpatchImageVisualProperty.URL, new PropertyValue(_url));
_nPatchMap.Add(NpatchImageVisualProperty.Border, new PropertyValue(_border));
if (_borderOnly != null) { _nPatchMap.Add(NpatchImageVisualProperty.BorderOnly, new PropertyValue((bool)_borderOnly)); }
- if (_synchronousLoading != null) _nPatchMap.Add(NpatchImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading));
+ if (_synchronousLoading != null) { _nPatchMap.Add(NpatchImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
+ if (_orientationCorrection != null) { _nPatchMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
SetProperty(ImageView.Property.IMAGE, new PropertyValue(_nPatchMap));
}
- else if(_synchronousLoading != null)
+ else if (_synchronousLoading != null || _orientationCorrection != null)
{ // for normal image, with synchronous loading property
PropertyMap imageMap = new PropertyMap();
imageMap.Add(Visual.Property.Type, new PropertyValue((int)Visual.Type.Image));
imageMap.Add(ImageVisualProperty.URL, new PropertyValue(_url));
- imageMap.Add(ImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading));
+ if (_synchronousLoading != null) { imageMap.Add(ImageVisualProperty.SynchronousLoading, new PropertyValue((bool)_synchronousLoading)); }
+ if (_orientationCorrection != null) { imageMap.Add(ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); }
SetProperty(ImageView.Property.IMAGE, new PropertyValue(imageMap));
}
else
{ // just for normal image
- SetProperty(ImageView.Property.RESOURCE_URL, new PropertyValue(_url));
+ SetProperty(ImageView.Property.IMAGE, new PropertyValue(_url));
}
}
}
private bool? _synchronousLoading = null;
private bool? _borderOnly = null;
private string _url = null;
-
+ private bool? _orientationCorrection = null;
}
}
projects / platform / core / csapi / tizenfx.git / blobdiff