xref: /template/strap/vendor/php-webdriver/webdriver/lib/WebDriverMouse.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php

namespace Facebook\WebDriver;

use Facebook\WebDriver\Interactions\Internal\WebDriverCoordinates;

/**
 * Interface representing basic mouse operations.
 */
interface WebDriverMouse
{
    /**
     * @param WebDriverCoordinates $where
     * @return WebDriverMouse
     */
    public function click(WebDriverCoordinates $where);

    /**
     * @param WebDriverCoordinates $where
     * @return WebDriverMouse
     */
    public function contextClick(WebDriverCoordinates $where);

    /**
     * @param WebDriverCoordinates $where
     * @return WebDriverMouse
     */
    public function doubleClick(WebDriverCoordinates $where);

    /**
     * @param WebDriverCoordinates $where
     * @return WebDriverMouse
     */
    public function mouseDown(WebDriverCoordinates $where);

    /**
     * @param WebDriverCoordinates $where
     * @param int $x_offset
     * @param int $y_offset
     * @return WebDriverMouse
     */
    public function mouseMove(
        WebDriverCoordinates $where,
        $x_offset = null,
        $y_offset = null
    );

    /**
     * @param WebDriverCoordinates $where
     * @return WebDriverMouse
     */
    public function mouseUp(WebDriverCoordinates $where);
}