2 * Copyright(c) 2021 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.ComponentModel;
19 using System.Runtime.CompilerServices;
20 using Tizen.NUI.Binding;
25 /// BaseHandle is a handle to an internal Dali resource.
27 /// <since_tizen> 3 </since_tizen>
28 public class BaseHandle : Element, global::System.IDisposable
33 /// <since_tizen> 3 </since_tizen>
34 [Obsolete("Deprecated in API9, Will be removed in API11, Please use SwigCMemOwn")]
35 [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
36 protected bool swigCMemOwn;
39 /// A flag to check if it is already disposed.
41 /// <since_tizen> 3 </since_tizen>
42 [Obsolete("Deprecated in API9, Will be removed in API11, Please use Disposed")]
43 [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
44 protected bool disposed = false;
46 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
47 private global::System.Runtime.InteropServices.HandleRef swigCPtrCopy;
48 private bool registerMe;
50 //A Flag to check who called Dispose(). (By User or DisposeQueue)
51 private bool isDisposeQueued = false;
54 /// Create an instance of BaseHandle.
56 /// <since_tizen> 3 </since_tizen>
57 public BaseHandle() : this(Interop.BaseHandle.NewBaseHandle())
59 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
63 /// Create an instance of BaseHandle.
65 /// <param name="handle">The BaseHandle instance.</param>
66 /// <since_tizen> 3 </since_tizen>
67 public BaseHandle(BaseHandle handle) : this(Interop.BaseHandle.NewBaseHandle(BaseHandle.getCPtr(handle)))
69 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
72 internal BaseHandle(global::System.IntPtr cPtr, bool cMemoryOwn)
74 //to catch derived classes dali native exceptions
75 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
77 registerMe = swigCMemOwn = cMemoryOwn;
78 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
79 // using copy constructor to create another native handle so Registry.Unregister works fine.
80 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(this, Interop.BaseHandle.NewBaseHandle(swigCPtr));
81 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
86 // Register this instance of BaseHandle in the registry.
87 Registry.Register(this);
91 internal BaseHandle(global::System.IntPtr cPtr)
93 registerMe = swigCMemOwn = true;
95 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
97 // using copy constructor to create another native handle so Registry.Unregister works fine.
98 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(this, Interop.BaseHandle.NewBaseHandle(SwigCPtr));
99 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
103 // Register this instance of BaseHandle in the registry.
104 Registry.Register(this);
111 /// <since_tizen> 3 </since_tizen>
112 ~BaseHandle() => Dispose(false);
115 /// Event when a property is set.
117 /// <since_tizen> 5 </since_tizen>
118 public event PropertyChangedEventHandler PropertySet;
120 internal global::System.Runtime.InteropServices.HandleRef GetBaseHandleCPtrHandleRef
129 /// Returns the bool value true to indicate that an operand is true and returns false otherwise.
131 /// <since_tizen> 3 </since_tizen>
132 public static bool operator true(BaseHandle handle)
134 // if the C# object is null, return false
135 if (BaseHandle.ReferenceEquals(handle, null))
139 // returns true if the handle has a body, false otherwise
140 return handle.HasBody();
144 /// Returns the bool false to indicate that an operand is false and returns true otherwise.
146 /// <since_tizen> 3 </since_tizen>
147 public static bool operator false(BaseHandle handle)
149 // if the C# object is null, return true
150 if (BaseHandle.ReferenceEquals(handle, null))
154 return !handle.HasBody();
158 /// Explicit conversion from Handle to bool.
160 /// <since_tizen> 3 </since_tizen>
161 public static explicit operator bool(BaseHandle handle)
163 // if the C# object is null, return false
164 if (BaseHandle.ReferenceEquals(handle, null))
168 // returns true if the handle has a body, false otherwise
169 return handle.HasBody();
173 /// Equality operator
175 /// <since_tizen> 3 </since_tizen>
176 public static bool operator ==(BaseHandle x, BaseHandle y)
178 // if the C# objects are the same return true
179 if (BaseHandle.ReferenceEquals(x, y))
183 if (!BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
185 // drop into native code to see if both handles point to the same body
189 if (BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
191 if (y.HasBody()) return false;
194 if (!BaseHandle.ReferenceEquals(x, null) && BaseHandle.ReferenceEquals(y, null))
196 if (x.HasBody()) return false;
204 /// Inequality operator. Returns Null if either operand is Null
206 /// <since_tizen> 3 </since_tizen>
207 public static bool operator !=(BaseHandle x, BaseHandle y)
213 /// Logical AND operator.<br />
214 /// It's possible when doing a operator this function (opBitwiseAnd) is never called due to short circuiting.<br />
216 /// <since_tizen> 3 </since_tizen>
217 public static BaseHandle operator &(BaseHandle x, BaseHandle y)
227 /// Logical OR operator for ||.<br />
228 /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br />
230 /// <since_tizen> 3 </since_tizen>
231 public static BaseHandle operator |(BaseHandle x, BaseHandle y)
233 if (!BaseHandle.ReferenceEquals(x, null) || !BaseHandle.ReferenceEquals(y, null))
235 if (x != null && x.HasBody())
239 if (y != null && y.HasBody())
249 /// Logical ! operator
251 /// <since_tizen> 3 </since_tizen>
252 public static bool operator !(BaseHandle x)
254 // if the C# object is null, return true
255 if (BaseHandle.ReferenceEquals(x, null))
269 /// <param name="o">The object should be compared.</param>
270 /// <returns>True if equal.</returns>
271 /// <since_tizen> 5 </since_tizen>
272 public override bool Equals(object o)
274 return base.Equals(o);
278 /// Gets the the hash code of this baseHandle.
280 /// <returns>The hash code.</returns>
281 /// <since_tizen> 5 </since_tizen>
282 public override int GetHashCode()
284 return base.GetHashCode();
290 /// <since_tizen> 3 </since_tizen>
291 public void Dispose()
294 System.GC.SuppressFinalize(this);
298 /// Hidden API (Inhouse API).
302 /// Following the guide of https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose.
303 /// This will replace "protected virtual void Dispose(DisposeTypes type)" which is exactly same in functionality.
305 /// <param name="disposing">true in order to free managed objects</param>
306 // Protected implementation of Dispose pattern.
307 [EditorBrowsable(EditorBrowsableState.Never)]
308 protected virtual void Dispose(bool disposing)
317 // TODO: dispose managed state (managed objects).
318 // Explicit call. user calls Dispose()
320 //Throw excpetion if Dispose() is called in separate thread.
321 if (!Window.IsInstalled())
323 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
328 Dispose(DisposeTypes.Implicit);
332 Dispose(DisposeTypes.Explicit);
337 // Implicit call. user doesn't call Dispose(), so this object is added into DisposeQueue to be disposed automatically.
338 if (!isDisposeQueued)
340 isDisposeQueued = true;
341 DisposeQueue.Instance.Add(this);
345 // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
346 // TODO: set large fields to null.
351 /// Performs an action on this object with the given action name and attributes.
353 /// <param name="actionName">The command for the action.</param>
354 /// <param name="attributes">The list of attributes for the action.</param>
355 /// <returns>The action is performed by the object or not.</returns>
356 /// <since_tizen> 3 </since_tizen>
357 public bool DoAction(string actionName, PropertyMap attributes)
359 bool ret = Interop.BaseHandle.DoAction(swigCPtrCopy, actionName, PropertyMap.getCPtr(attributes));
360 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
365 /// Returns the type name for the Handle.<br />
366 /// Will return an empty string if the typename does not exist. This will happen for types that
367 /// have not registered with type-registry.
369 /// <returns>The type name. Empty string if the typename does not exist.</returns>
370 /// <since_tizen> 3 </since_tizen>
371 public string GetTypeName()
373 string ret = Interop.BaseHandle.GetTypeName(swigCPtrCopy);
374 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
379 /// Returns the type info for the Handle.<br />
381 /// <param name="info">The type information.</param>
382 /// <returns>True If get the type info.</returns>
383 /// <since_tizen> 3 </since_tizen>
384 public bool GetTypeInfo(Tizen.NUI.TypeInfo info)
386 bool ret = Interop.BaseHandle.GetTypeInfo(swigCPtrCopy, Tizen.NUI.TypeInfo.getCPtr(info));
387 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
392 /// Resets the handle.
394 /// <since_tizen> 3 </since_tizen>
397 Interop.BaseHandle.Reset(swigCPtrCopy);
398 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
402 /// To check the BaseHandle instance is equal or not.
404 /// <param name="rhs">The baseHandle instance.</param>
405 /// <returns>True If equal.</returns>
406 /// <since_tizen> 3 </since_tizen>
407 public bool EqualTo(BaseHandle rhs)
409 bool ret = Interop.BaseHandle.EqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
410 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
415 /// To check the BaseHandle instance is equal or not.
417 /// <param name="rhs">The baseHandle instance.</param>
418 /// <returns>True If not equal.</returns>
419 /// <since_tizen> 3 </since_tizen>
420 public bool NotEqualTo(BaseHandle rhs)
422 bool ret = Interop.BaseHandle.NotEqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
423 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
428 /// To check the BaseHandle instance has body or not.
430 /// <returns>True If the baseHandle instance has body.</returns>
431 /// <since_tizen> 3 </since_tizen>
432 public bool HasBody()
434 if (swigCPtrCopy.Handle == IntPtr.Zero)
439 if (disposed == true)
443 bool ret = Interop.BaseHandle.HasBody(swigCPtrCopy);
444 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
449 /// To check the BaseHandle instance is equal or not.
451 /// <param name="rhs">The baseHandle instance.</param>
452 /// <returns>True If equal.</returns>
453 /// <since_tizen> 3 </since_tizen>
454 public bool IsEqual(BaseHandle rhs)
456 if (disposed == true)
461 bool ret = Interop.BaseHandle.IsEqual(swigCPtrCopy, BaseHandle.getCPtr(rhs));
462 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
466 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(BaseHandle obj)
468 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtrCopy;
471 internal void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
473 PropertySet?.Invoke(this, new PropertyChangedEventArgs(propertyName));
479 /// <since_tizen> 3 </since_tizen>
480 protected virtual void Dispose(DisposeTypes type)
487 if (type == DisposeTypes.Explicit)
490 //Release your own managed resources here.
491 //You should release all of your own disposable objects here.
495 //Release your own unmanaged resources here.
496 //You should not access any managed member here except static instance.
497 //because the execution order of Finalizes is non-deterministic.
499 //Unreference this instance from Registry.
502 Registry.Unregister(this);
505 if (SwigCPtr.Handle != IntPtr.Zero)
510 ReleaseSwigCPtr(SwigCPtr);
512 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
514 if (swigCPtrCopy.Handle != global::System.IntPtr.Zero)
517 Interop.BaseHandle.DeleteBaseHandle(swigCPtrCopy);
518 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
525 /// Release swigCPtr.
527 /// <since_tizen> 6 </since_tizen>
528 /// This will not be public opened.
529 [EditorBrowsable(EditorBrowsableState.Never)]
530 protected virtual void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
535 /// Contains event arguments for the FocusChangeRequested event.
537 [Obsolete("Deprecated in API9; Will be removed in API11.")]
538 public class FocusRequestArgs : EventArgs
542 /// Gets or sets a value that indicates the starting focus state of the element for which a focus change is requested.
544 public bool Focus { get; set; }
547 /// Gets or sets a value that indicates the ending focus state of the element for which a focus change is requested.
549 public bool Result { get; set; }
552 internal global::System.Runtime.InteropServices.HandleRef SwigCPtr
564 [EditorBrowsable(EditorBrowsableState.Never)]
565 protected internal bool SwigCMemOwn => swigCMemOwn;
568 /// A flag to check if it is already disposed.
570 [EditorBrowsable(EditorBrowsableState.Never)]
571 protected internal bool Disposed => disposed;