[NUI] Add Obsolete attributes for EditorBrowsable apis
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / internal / SignalObserver.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 using System;
18 using System.Runtime.InteropServices;
19 using System.ComponentModel;
20
21
22 namespace Tizen.NUI
23 {
24     /// <summary>
25     /// Please do not use! this will be deprecated
26     /// </summary>
27     /// <since_tizen> 4 </since_tizen>
28     [Obsolete("Please do not use! This will be deprecated!")]
29     [EditorBrowsable(EditorBrowsableState.Never)]
30     public class SignalObserver : global::System.IDisposable
31     {
32         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
33         /// <summary>
34         /// swigCMemOwn
35         /// </summary>
36         /// <since_tizen> 4 </since_tizen>
37         protected bool swigCMemOwn;
38
39         internal SignalObserver(global::System.IntPtr cPtr, bool cMemoryOwn)
40         {
41             swigCMemOwn = cMemoryOwn;
42             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
43         }
44
45         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(SignalObserver obj)
46         {
47             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
48         }
49
50         //A Flag to check who called Dispose(). (By User or DisposeQueue)
51         private bool isDisposeQueued = false;
52         /// <summary>
53         /// A Flat to check if it is already disposed.
54         /// </summary>
55         /// <since_tizen> 4 </since_tizen>
56         protected bool disposed = false;
57
58         /// <summary>
59         /// Dispose
60         /// </summary>
61         /// <since_tizen> 3 </since_tizen>
62         ~SignalObserver()
63         {
64             if (!isDisposeQueued)
65             {
66                 isDisposeQueued = true;
67                 DisposeQueue.Instance.Add(this);
68             }
69         }
70
71         /// <summary>
72         /// Dispose
73         /// </summary>
74         /// <since_tizen> 4 </since_tizen>
75         public void Dispose()
76         {
77             //Throw excpetion if Dispose() is called in separate thread.
78             if (!Window.IsInstalled())
79             {
80                 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
81             }
82
83             if (isDisposeQueued)
84             {
85                 Dispose(DisposeTypes.Implicit);
86             }
87             else
88             {
89                 Dispose(DisposeTypes.Explicit);
90                 System.GC.SuppressFinalize(this);
91             }
92         }
93
94         /// <summary>
95         /// Dispose
96         /// </summary>
97         /// <since_tizen> 4 </since_tizen>
98         protected virtual void Dispose(DisposeTypes type)
99         {
100             if (disposed)
101             {
102                 return;
103             }
104
105             if (type == DisposeTypes.Explicit)
106             {
107                 //Called by User
108                 //Release your own managed resources here.
109                 //You should release all of your own disposable objects here.
110
111             }
112
113             //Release your own unmanaged resources here.
114             //You should not access any managed member here except static instance.
115             //because the execution order of Finalizes is non-deterministic.
116
117             if (swigCPtr.Handle != global::System.IntPtr.Zero)
118             {
119                 if (swigCMemOwn)
120                 {
121                     swigCMemOwn = false;
122                     NDalicPINVOKE.delete_SignalObserver(swigCPtr);
123                 }
124                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
125             }
126
127             disposed = true;
128         }
129
130         /// <summary>
131         /// This method is called when the signal is disconnecting.
132         /// </summary>
133         /// <param name="slotObserver">The signal that has disconnected</param>
134         /// <param name="callback">The callback attached to the signal disconnected</param>
135         /// <since_tizen> 4 </since_tizen>
136         public virtual void SignalDisconnected(SlotObserver slotObserver, SWIGTYPE_p_Dali__CallbackBase callback)
137         {
138             NDalicPINVOKE.SignalObserver_SignalDisconnected(swigCPtr, SlotObserver.getCPtr(slotObserver), SWIGTYPE_p_Dali__CallbackBase.getCPtr(callback));
139             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
140         }
141
142     }
143
144 }