src/Tizen.NUI/src/public/VisualFactory.cs

   1 /*
   2  * Copyright(c) 2017 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 using System;
  19 using System.ComponentModel;
  20
  21 namespace Tizen.NUI
  22 {
  23
  24     /// <summary>
  25     /// The VisualFactory is a singleton object that provides and shares visuals between views.
  26     /// </summary>
  27     /// <since_tizen> 3 </since_tizen>
  28     public class VisualFactory : BaseHandle
  29     {
  30         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  31
  32         internal VisualFactory(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.VisualFactory_SWIGUpcast(cPtr), cMemoryOwn)
  33         {
  34             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  35         }
  36
  37         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(VisualFactory obj)
  38         {
  39             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  40         }
  41
  42         /// <summary>
  43         /// Dispose.
  44         /// </summary>
  45         /// <param name="type">The dispose type</param>
  46         /// <since_tizen> 3 </since_tizen>
  47         /// Please DO NOT use! This will be deprecated!
  48         /// Dispose() method in Singletone classes (ex: FocusManager, StyleManager, VisualFactory, IMFManager, TtsPlayer, Window) is not required.
  49         /// Because it is Sigletone, so it is alive for one thread until the NUI is terminated, so it never be disposed.
  50         [Obsolete("Please do not use! This will be deprecated!")]
  51         [EditorBrowsable(EditorBrowsableState.Never)]
  52         protected override void Dispose(DisposeTypes type)
  53         {
  54             if (disposed)
  55             {
  56                 return;
  57             }
  58
  59             if (type == DisposeTypes.Explicit)
  60             {
  61                 //Called by User
  62                 //Release your own managed resources here.
  63                 //You should release all of your own disposable objects here.
  64             }
  65
  66             //Release your own unmanaged resources here.
  67             //You should not access any managed member here except static instance.
  68             //because the execution order of Finalizes is non-deterministic.
  69
  70             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  71             {
  72                 if (swigCMemOwn)
  73                 {
  74                     swigCMemOwn = false;
  75                     NDalicPINVOKE.delete_VisualFactory(swigCPtr);
  76                 }
  77                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  78             }
  79
  80             base.Dispose(type);
  81         }
  82
  83         /// <summary>
  84         /// Please do not use! this will be deprecated, please use VisualFactory.Instance instead.
  85         /// </summary>
  86         /// <since_tizen> 3 </since_tizen>
  87         [Obsolete("Please do not use! This will be deprecated! Please use VisualFactory.Instance instead! " +
  88             "Like: " +
  89             "VisualFactory visualFactory = VisualFactory.Instance; " +
  90             "visualFactory.CreateVisual(visualMap);")]
  91         [EditorBrowsable(EditorBrowsableState.Never)]
  92         public static VisualFactory Get()
  93         {
  94             VisualFactory ret = new VisualFactory(NDalicPINVOKE.VisualFactory_Get(), true);
  95             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  96             return ret;
  97         }
  98
  99         internal VisualFactory() : this(NDalicPINVOKE.new_VisualFactory__SWIG_0(), true)
 100         {
 101             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 102         }
 103
 104
 105         /// <summary>
 106         /// Request the visual.
 107         /// </summary>
 108         /// <param name="propertyMap">The map contains the properties required by the visual. The content of the map determines the type of visual that will be returned.</param>
 109         /// <returns>The handle to the created visual.</returns>
 110         /// <since_tizen> 3 </since_tizen>
 111         public VisualBase CreateVisual(PropertyMap propertyMap)
 112         {
 113             VisualBase ret = new VisualBase(NDalicPINVOKE.VisualFactory_CreateVisual__SWIG_0(swigCPtr, PropertyMap.getCPtr(propertyMap)), true);
 114             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 115             return ret;
 116         }
 117
 118         internal VisualBase CreateVisual(Image image)
 119         {
 120             VisualBase ret = new VisualBase(NDalicPINVOKE.VisualFactory_CreateVisual__SWIG_1(swigCPtr, Image.getCPtr(image)), true);
 121             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 122             return ret;
 123         }
 124
 125         private static readonly VisualFactory instance = VisualFactory.Get();
 126
 127         /// <summary>
 128         /// Retrieves the VisualFactory singleton.
 129         /// </summary>
 130         /// <since_tizen> 3 </since_tizen>
 131         public static VisualFactory Instance
 132         {
 133             get
 134             {
 135                 return instance;
 136             }
 137         }
 138
 139     }
 140
 141 }