/*
* Copyright(c) 2019 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 Tizen.NUI.BaseComponents;
using System.ComponentModel;
namespace Tizen.NUI
{
///
/// This class emits a signal when a tap gesture occurs that meets the requirements set by the application.
/// A TapGesture is a discrete gesture, which means it does not have any state information attached.
///
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public class TapGestureDetector : GestureDetector
{
///
/// Creates an initialized TapGestureDetector.
///
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public TapGestureDetector() : this(Interop.TapGestureDetector.New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// Creates an initialized TapGestureDetector with the specified parameters.
///
/// The minimum and maximum number of taps required
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public TapGestureDetector(uint tapsRequired) : this(Interop.TapGestureDetector.New(tapsRequired), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
internal TapGestureDetector(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
{
}
private DaliEventHandler _detectedEventHandler;
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
private delegate void DetectedCallbackType(IntPtr actor, IntPtr TapGesture);
private DetectedCallbackType _detectedCallback;
///
/// This signal is emitted when the specified tap is detected on the attached view.
///
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public event DaliEventHandler Detected
{
add
{
if (_detectedEventHandler == null)
{
_detectedCallback = OnTapGestureDetected;
DetectedSignal().Connect(_detectedCallback);
}
_detectedEventHandler += value;
}
remove
{
_detectedEventHandler -= value;
if (_detectedEventHandler == null && DetectedSignal().Empty() == false)
{
DetectedSignal().Disconnect(_detectedCallback);
}
}
}
///
/// The copy constructor.
///
/// A reference to the copied handle
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public TapGestureDetector(TapGestureDetector handle) : this(Interop.TapGestureDetector.NewTapGestureDetector(TapGestureDetector.getCPtr(handle)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// Sets the minimum number of taps required. The tap count is the number of times a user should "tap" the screen.
/// The default is 1.
///
/// The minimum taps required
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetMinimumTapsRequired(uint minimumTaps)
{
Interop.TapGestureDetector.SetMinimumTapsRequired(SwigCPtr, minimumTaps);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// Sets the maximum number of taps required. The tap count is the number of times a user should "tap" the screen.
/// The default is 1.
///
/// The maximum taps required
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetMaximumTapsRequired(uint maximumTaps)
{
Interop.TapGestureDetector.SetMaximumTapsRequired(SwigCPtr, maximumTaps);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// Retrieves the minimum number of taps required.
///
/// The minimum taps required
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetMinimumTapsRequired()
{
uint ret = Interop.TapGestureDetector.GetMinimumTapsRequired(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Retrieves the maximum number of taps required.
///
/// The maximum taps required
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetMaximumTapsRequired()
{
uint ret = Interop.TapGestureDetector.GetMaximumTapsRequired(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal new static TapGestureDetector DownCast(BaseHandle handle)
{
TapGestureDetector ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TapGestureDetector;
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal static TapGestureDetector GetTapGestureDetectorFromPtr(global::System.IntPtr cPtr)
{
TapGestureDetector ret = new TapGestureDetector(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal TapGestureDetectedSignal DetectedSignal()
{
TapGestureDetectedSignal ret = new TapGestureDetectedSignal(Interop.TapGestureDetector.DetectedSignal(SwigCPtr), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal TapGestureDetector Assign(TapGestureDetector rhs)
{
TapGestureDetector ret = new TapGestureDetector(Interop.TapGestureDetector.Assign(SwigCPtr, TapGestureDetector.getCPtr(rhs)), false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// override it to clean-up your own resources.
///
///
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void Dispose(DisposeTypes type)
{
if (disposed)
{
return;
}
if (type == DisposeTypes.Explicit)
{
//Called by User
//Release your own managed resources here.
//You should release all of your own disposable objects here.
}
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
//because the execution order of Finalizes is non-deterministic.
if (HasBody())
{
if (_detectedCallback != null)
{
using TapGestureDetectedSignal signal = new TapGestureDetectedSignal(Interop.TapGestureDetector.DetectedSignal(GetBaseHandleCPtrHandleRef), false);
signal?.Disconnect(_detectedCallback);
_detectedCallback = null;
}
}
base.Dispose(type);
}
/// This will not be public opened.
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
{
Interop.TapGestureDetector.DeleteTapGestureDetector(swigCPtr);
}
private void OnTapGestureDetected(IntPtr actor, IntPtr tapGesture)
{
DetectedEventArgs e = new DetectedEventArgs();
// Populate all members of "e" (DetectedEventArgs) with real data
e.View = Registry.GetManagedBaseHandleFromNativePtr(actor) as View;
if (null == e.View)
{
e.View = Registry.GetManagedBaseHandleFromRefObject(actor) as View;
}
// If DispatchGestureEvents is false, no gesture events are dispatched.
if (e.View != null && e.View.DispatchGestureEvents == false)
{
return;
}
e.TapGesture = Tizen.NUI.TapGesture.GetTapGestureFromPtr(tapGesture);
if (_detectedEventHandler != null)
{
e.Handled = true;
//here we send all data to user event handlers
_detectedEventHandler(this, e);
}
}
///
/// Event arguments that are passed via the TapGestureEvent signal.
///
/// 5
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public class DetectedEventArgs : EventArgs
{
private View _view;
private TapGesture _tapGesture;
private bool handled = true;
///
/// The attached view.
///
/// 5
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public View View
{
get
{
return _view;
}
set
{
_view = value;
}
}
///
/// The TapGesture.
///
/// 5
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public TapGesture TapGesture
{
get
{
return _tapGesture;
}
set
{
_tapGesture = value;
}
}
///
/// Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing.
///
[EditorBrowsable(EditorBrowsableState.Never)]
public bool Handled
{
get => handled;
set
{
handled = value;
Interop.Actor.SetNeedGesturePropagation(View.getCPtr(_view), !value);
if (NDalicPINVOKE.SWIGPendingException.Pending)
throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
}
}
}
}