GHZDaPing/Assets/Vuplex/WebView/Core/Scripts/IWithPointerDownAndUp.cs

// Copyright (c) 2024 Vuplex Inc. All rights reserved.
//
// Licensed under the Vuplex Commercial Software Library License, you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
//     https://vuplex.com/commercial-library-license
//
// 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 UnityEngine;

namespace Vuplex.WebView {

    /// <summary>
    /// An interface implemented by a webview if it supports PointerDown()
    /// and PointerUp(), which can be used to implement functionality like
    /// drag interactions, double-clicks, and right-clicks.
    /// </summary>
    /// <remarks>
    /// For details on the limitations of drag interactions on iOS and UWP, please see
    /// https://support.vuplex.com/articles/hover-and-drag-limitations.
    /// </remarks>
    /// <example>
    /// <code>
    /// var webViewWithPointerDownAndUp = webViewPrefab.WebView as IWithPointerDownAndUp;
    /// if (webViewWithPointerDownAndUp != null) {
    ///     // Double right click at (250px, 100px) in the web page.
    ///     var normalizedPoint = webViewPrefab.WebView.PointToNormalized(250, 100);
    ///     var pointerOptions = new PointerOptions {
    ///         Button = MouseButton.Right,
    ///         ClickCount = 2
    ///     };
    ///     webViewWithPointerDownAndUp.PointerDown(normalizedPoint, pointerOptions);
    ///     webViewWithPointerDownAndUp.PointerUp(normalizedPoint, pointerOptions);
    /// }
    /// </code>
    /// </example>
    public interface IWithPointerDownAndUp {

        /// <summary>
        /// Dispatches a pointerdown / mousedown click event at the given normalized point.
        /// This can be used in conjunction with IWithMovablePointer.MovePointer() and
        /// PointerUp() to implement drag interactions.
        /// </summary>
        /// <seealso cref="IWebView.Click"/>
        void PointerDown(Vector2 normalizedPoint);

        /// <summary>
        /// Like PointerDown(Vector2), except it also accepts a
        /// PointerOptions parameter to modify the behavior
        /// (e.g. to trigger a right click or a double click).
        /// </summary>
        void PointerDown(Vector2 normalizedPoint, PointerOptions options);

        /// <summary>
        /// Dispatches a pointerup / mouseup click event at the given normalized point.
        /// This can be used in conjunction with PointerDown() and
        /// IWithMovablePointer.MovePointer() and to implement drag interactions.
        /// </summary>
        /// <seealso cref="IWebView.Click"/>
        void PointerUp(Vector2 normalizedPoint);

        /// <summary>
        /// Like PointerUp(Vector2), except it also accepts a
        /// PointerOptions parameter to modify the behavior
        /// (e.g. to trigger a right click or a double click).
        /// </summary>
        void PointerUp(Vector2 normalizedPoint, PointerOptions options);
    }
}