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 /// <seealso cref="BindableObject.PropertyChanged"/>
119 [Obsolete("Deprecated in API9, Will be removed in API11, Please use BindableObject.PropertyChanged instead!")]
120 public event PropertyChangedEventHandler PropertySet;
122 internal global::System.Runtime.InteropServices.HandleRef GetBaseHandleCPtrHandleRef
131 /// Returns the bool value true to indicate that an operand is true and returns false otherwise.
133 /// <since_tizen> 3 </since_tizen>
134 public static bool operator true(BaseHandle handle)
136 // if the C# object is null, return false
137 if (BaseHandle.ReferenceEquals(handle, null))
141 // returns true if the handle has a body, false otherwise
142 return handle.HasBody();
146 /// Returns the bool false to indicate that an operand is false and returns true otherwise.
148 /// <since_tizen> 3 </since_tizen>
149 public static bool operator false(BaseHandle handle)
151 // if the C# object is null, return true
152 if (BaseHandle.ReferenceEquals(handle, null))
156 return !handle.HasBody();
160 /// Explicit conversion from Handle to bool.
162 /// <since_tizen> 3 </since_tizen>
163 public static explicit operator bool(BaseHandle handle)
165 // if the C# object is null, return false
166 if (BaseHandle.ReferenceEquals(handle, null))
170 // returns true if the handle has a body, false otherwise
171 return handle.HasBody();
175 /// Equality operator
177 /// <since_tizen> 3 </since_tizen>
178 public static bool operator ==(BaseHandle x, BaseHandle y)
180 // if the C# objects are the same return true
181 if (BaseHandle.ReferenceEquals(x, y))
185 if (!BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
187 // drop into native code to see if both handles point to the same body
191 if (BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
193 if (y.HasBody()) return false;
196 if (!BaseHandle.ReferenceEquals(x, null) && BaseHandle.ReferenceEquals(y, null))
198 if (x.HasBody()) return false;
206 /// Inequality operator. Returns Null if either operand is Null
208 /// <since_tizen> 3 </since_tizen>
209 public static bool operator !=(BaseHandle x, BaseHandle y)
215 /// Logical AND operator.<br />
216 /// It's possible when doing a operator this function (opBitwiseAnd) is never called due to short circuiting.<br />
218 /// <since_tizen> 3 </since_tizen>
219 public static BaseHandle operator &(BaseHandle x, BaseHandle y)
229 /// Logical OR operator for ||.<br />
230 /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br />
232 /// <since_tizen> 3 </since_tizen>
233 public static BaseHandle operator |(BaseHandle x, BaseHandle y)
235 if (!BaseHandle.ReferenceEquals(x, null) || !BaseHandle.ReferenceEquals(y, null))
237 if (x != null && x.HasBody())
241 if (y != null && y.HasBody())
251 /// Logical ! operator
253 /// <since_tizen> 3 </since_tizen>
254 public static bool operator !(BaseHandle x)
256 // if the C# object is null, return true
257 if (BaseHandle.ReferenceEquals(x, null))
271 /// <param name="o">The object should be compared.</param>
272 /// <returns>True if equal.</returns>
273 /// <since_tizen> 5 </since_tizen>
274 public override bool Equals(object o)
276 return base.Equals(o);
280 /// Gets the hash code of this baseHandle.
282 /// <returns>The hash code.</returns>
283 /// <since_tizen> 5 </since_tizen>
284 public override int GetHashCode()
286 return base.GetHashCode();
292 /// <since_tizen> 3 </since_tizen>
293 public void Dispose()
297 Dispose(DisposeTypes.Implicit);
303 GC.SuppressFinalize(this);
307 /// Hidden API (Inhouse API).
311 /// Following the guide of https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose.
312 /// This will replace "protected virtual void Dispose(DisposeTypes type)" which is exactly same in functionality.
314 /// <param name="disposing">true in order to free managed objects</param>
315 // Protected implementation of Dispose pattern.
316 [EditorBrowsable(EditorBrowsableState.Never)]
317 protected virtual void Dispose(bool disposing)
326 // TODO: dispose managed state (managed objects).
327 // Explicit call. user calls Dispose()
329 //Throw exception if Dispose() is called in separate thread.
330 if (!Window.IsInstalled())
332 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
337 Dispose(DisposeTypes.Implicit);
341 Dispose(DisposeTypes.Explicit);
346 // Implicit call. user doesn't call Dispose(), so this object is added into DisposeQueue to be disposed automatically.
347 if (!isDisposeQueued)
349 isDisposeQueued = true;
350 DisposeQueue.Instance.Add(this);
354 // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
355 // TODO: set large fields to null.
360 /// Performs an action on this object with the given action name and attributes.
362 /// <param name="actionName">The command for the action.</param>
363 /// <param name="attributes">The list of attributes for the action.</param>
364 /// <returns>The action is performed by the object or not.</returns>
365 /// <since_tizen> 3 </since_tizen>
366 public bool DoAction(string actionName, PropertyMap attributes)
368 bool ret = Interop.BaseHandle.DoAction(swigCPtrCopy, actionName, PropertyMap.getCPtr(attributes));
369 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
374 /// Returns the type name for the Handle.<br />
375 /// Will return an empty string if the typename does not exist. This will happen for types that
376 /// have not registered with type-registry.
378 /// <returns>The type name. Empty string if the typename does not exist.</returns>
379 /// <since_tizen> 3 </since_tizen>
380 public string GetTypeName()
382 string ret = Interop.BaseHandle.GetTypeName(swigCPtrCopy);
383 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
388 /// Returns the type info for the Handle.<br />
390 /// <param name="info">The type information.</param>
391 /// <returns>True If get the type info.</returns>
392 /// <since_tizen> 3 </since_tizen>
393 public bool GetTypeInfo(Tizen.NUI.TypeInfo info)
395 bool ret = Interop.BaseHandle.GetTypeInfo(swigCPtrCopy, Tizen.NUI.TypeInfo.getCPtr(info));
396 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
401 /// Resets the handle.
403 /// <since_tizen> 3 </since_tizen>
406 Interop.BaseHandle.Reset(swigCPtrCopy);
407 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
411 /// To check the BaseHandle instance is equal or not.
413 /// <param name="rhs">The baseHandle instance.</param>
414 /// <returns>True If equal.</returns>
415 /// <since_tizen> 3 </since_tizen>
416 public bool EqualTo(BaseHandle rhs)
418 bool ret = Interop.BaseHandle.EqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
419 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
424 /// To check the BaseHandle instance is equal or not.
426 /// <param name="rhs">The baseHandle instance.</param>
427 /// <returns>True If not equal.</returns>
428 /// <since_tizen> 3 </since_tizen>
429 public bool NotEqualTo(BaseHandle rhs)
431 bool ret = Interop.BaseHandle.NotEqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
432 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
437 /// To check the BaseHandle instance has body or not.
439 /// <returns>True If the baseHandle instance has body.</returns>
440 /// <since_tizen> 3 </since_tizen>
441 public bool HasBody()
443 if (swigCPtrCopy.Handle == IntPtr.Zero)
448 if (disposed == true)
452 bool ret = Interop.BaseHandle.HasBody(swigCPtrCopy);
453 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
458 /// To check the BaseHandle instance is equal or not.
460 /// <param name="rhs">The baseHandle instance.</param>
461 /// <returns>True If equal.</returns>
462 /// <since_tizen> 3 </since_tizen>
463 public bool IsEqual(BaseHandle rhs)
465 if (disposed == true)
470 bool ret = Interop.BaseHandle.IsEqual(swigCPtrCopy, BaseHandle.getCPtr(rhs));
471 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
475 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(BaseHandle obj)
477 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtrCopy;
480 internal void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
482 PropertySet?.Invoke(this, new PropertyChangedEventArgs(propertyName));
488 /// <since_tizen> 3 </since_tizen>
489 protected virtual void Dispose(DisposeTypes type)
496 if (type == DisposeTypes.Explicit)
499 //Release your own managed resources here.
500 //You should release all of your own disposable objects here.
504 //Release your own unmanaged resources here.
505 //You should not access any managed member here except static instance.
506 //because the execution order of Finalizes is non-deterministic.
508 //Unreference this instance from Registry.
511 Registry.Unregister(this);
514 if (SwigCPtr.Handle != IntPtr.Zero)
519 ReleaseSwigCPtr(SwigCPtr);
521 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
523 if (swigCPtrCopy.Handle != global::System.IntPtr.Zero)
526 Interop.BaseHandle.DeleteBaseHandle(swigCPtrCopy);
527 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
532 if (null != Application.Current)
534 Application.Current.XamlResourceChanged -= OnResourcesChanged;
539 /// Release swigCPtr.
541 /// <since_tizen> 6 </since_tizen>
542 /// This will not be public opened.
543 [EditorBrowsable(EditorBrowsableState.Never)]
544 protected virtual void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
549 /// Contains event arguments for the FocusChangeRequested event.
551 [Obsolete("Deprecated in API9; Will be removed in API11.")]
552 public class FocusRequestArgs : EventArgs
556 /// Gets or sets a value that indicates the starting focus state of the element for which a focus change is requested.
558 public bool Focus { get; set; }
561 /// Gets or sets a value that indicates the ending focus state of the element for which a focus change is requested.
563 public bool Result { get; set; }
566 internal global::System.Runtime.InteropServices.HandleRef SwigCPtr
578 [EditorBrowsable(EditorBrowsableState.Never)]
579 protected internal bool SwigCMemOwn => swigCMemOwn;
582 /// A flag to check if it is already disposed.
584 [EditorBrowsable(EditorBrowsableState.Never)]
585 protected internal bool Disposed => disposed;