ORPA-pyOpenRPA/Wiki/RUS_Guide/markdown/Robot/06_mouse.md

# 6. Функции Mouse

## Общее

## Описание функций

Описание каждой функции начинается с обозначения L+,W+, что означает, что функция поддерживается в ОС Linux (L) и Windows (W)

**Functions:**

| `Click`([inXInt, inYInt, inClickCountInt, …])

 | L+,W+: Нажатие (вниз) кнопки мыши и затем немедленно выпуск (вверх) её.

 |
| `ClickDouble`([inXInt, inYInt, …])

                  | L+,W+: Двойное нажатие левой клавиши мыши.

                                                                                                                                                                     |
| `Down`([inXInt, inYInt, inButtonStr, …])

            | L+,W+: Переместить указатель по координатам inXInt, inYInt, после чего нажать (вниз) клавишу мыши и не отпускать до выполнения соответсвующей команды (см.

                                                     |
| `MoveTo`([inXInt, inYInt, …])

                       | L+,W+: Переместить указатель мыши на позицию inXInt, inYInt за время inMoveDurationSecFloat.

                                                                                                                   |
| `ScrollHorizontal`(inScrollClickCountInt[, …])

      | L+,W-: Переместить указатель мыши на позицию inXInt, inYInt и выполнить горизонтальную прокрутку (скроллинг) виртуальным колесом мыши на количество щелчков inScrollClickCountInt.

                             |
| `ScrollVertical`(inScrollClickCountInt[, …])

        | L+,W+: Переместить указатель мыши на позицию inXInt, inYInt и выполнить вертикальную прокрутку (скроллинг) колесом мыши на количество щелчков inScrollClickCountInt.

                                           |
| `Up`([inXInt, inYInt, inButtonStr, …])

              | L+,W+: Отпустить (вверх) клавишу мыши.

                                                                                                                                                                         |

### pyOpenRPA.Robot.Mouse.Click(inXInt: Optional[int] = None, inYInt: Optional[int] = None, inClickCountInt: int = 1, inIntervalSecFloat: float = 0.0, inButtonStr: str = 'left', inMoveDurationSecFloat: float = 0.0, inWaitAfterSecFloat: float = 0.4)
L+,W+: Нажатие (вниз) кнопки мыши и затем немедленно выпуск (вверх) её. Допускается следующая параметризация. Если не указаны inXInt и inYInt - клик производится по месту нахождения указателя мыши.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.Click(100,150) #Выполнить нажатие левой клавиши мыши на экране по координатам: X(гор) 100px, Y(вер) 150px.
```


* **Параметры**

    
    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inClickCountInt** (*int**, **опциональный*) – Количество нажатий (вниз и вверх) кнопкой мыши, По умолчанию 1


    * **inIntervalSecFloat** (*float**, **опциональный*) – Интервал ожидания в секундах между нажатиями, По умолчанию 0.0


    * **inButtonStr** (*str**, **опциональный*) – Номер кнопки, которую требуется нажать. Возможные варианты: „left“, „middle“, „right“ или 1, 2, 3. В остальных случаях инициирует исключение ValueError. По умолчанию „left“


    * **inMoveDurationSecFloat** (*float**, **опциональный*) – Время перемещения указателя мыши, По умолчанию 0.0 (моментальное перемещение)


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.ClickDouble(inXInt: Optional[int] = None, inYInt: Optional[int] = None, inWaitAfterSecFloat: float = 0.4)
L+,W+: Двойное нажатие левой клавиши мыши. Данное действие аналогично вызову функции (см. ниже).

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.ClickDouble(100,150) #Выполнить двойное нажатие левой клавиши мыши на экране по координатам: X(гор) 100px, Y(вер) 150px.
```


* **Параметры**

    
    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.Down(inXInt: Optional[int] = None, inYInt: Optional[int] = None, inButtonStr: str = 'left', inWaitAfterSecFloat: float = 0.4)
L+,W+: Переместить указатель по координатам inXInt, inYInt, после чего нажать (вниз) клавишу мыши и не отпускать до выполнения соответсвующей команды (см. Up). Если координаты inXInt, inYInt не переданы - нажатие происходит на тех координатах X/Y, на которых указатель мыши находится.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.Down() #Опустить левую клавишу мыши
```


* **Параметры**

    
    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inButtonStr** (*str**, **опциональный*) – Номер кнопки, которую требуется нажать. Возможные варианты: „left“, „middle“, „right“ или 1, 2, 3. В остальных случаях инициирует исключение ValueError. По умолчанию „left“


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.MoveTo(inXInt=None, inYInt=None, inMoveDurationSecFloat: float = 0.0, inWaitAfterSecFloat: float = 0.4)
L+,W+: Переместить указатель мыши на позицию inXInt, inYInt за время inMoveDurationSecFloat.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.MoveTo(inXInt=100, inYInt=200) #Переместить указатель мыши по координатам: X(гор) 100, Y(вер) 200
```


* **Параметры**

    
    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inMoveDurationSecFloat** (*float**, **опциональный*) – Время перемещения указателя мыши, По умолчанию 0.0 (моментальное перемещение)


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.ScrollHorizontal(inScrollClickCountInt, inXInt=None, inYInt=None, inWaitAfterSecFloat: float = 0.4)
L+,W-: Переместить указатель мыши на позицию inXInt, inYInt и выполнить горизонтальную прокрутку (скроллинг) виртуальным колесом мыши на количество щелчков inScrollClickCountInt.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.ScrollHorizontal(100, inXInt=100, inYInt=200) #Крутить колесо мыши вниз на 100 кликов по координатам: X(гор) 100, Y(вер) 200
Mouse.ScrollHorizontal(-100) #Крутить колесо мыши вверх на 100 кликов по текущим координатам указателя мыши.
```


* **Параметры**

    
    * **inScrollClickCountInt** (*int**, **обязательный*) – Количество щелчок колеса мыши, которое требуется !горизонтально! прокрутить. Аргумент может принимать как положительное (прокрутка вправо), так и отрицательное (прокрутка влево) значения


    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.ScrollVertical(inScrollClickCountInt, inXInt=None, inYInt=None, inWaitAfterSecFloat: float = 0.4)
L+,W+: Переместить указатель мыши на позицию inXInt, inYInt и выполнить вертикальную прокрутку (скроллинг) колесом мыши на количество щелчков inScrollClickCountInt.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области (экрана).

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.ScrollVertical(100, inXInt=100, inYInt=200) #Крутить колесо мыши вниз на 100 кликов по координатам: X(гор) 100, Y(вер) 200
Mouse.ScrollVertical(-100) #Крутить колесо мыши вверх на 100 кликов по текущим координатам указателя мыши.
```


* **Параметры**

    
    * **inScrollClickCountInt** (*int**, **обязательный*) – Количество щелчок колеса мыши, которое требуется !вертикально! прокрутить. Аргумент может принимать как положительное (прокрутка вниз), так и отрицательное (прокрутка вверх) значения


    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)



### pyOpenRPA.Robot.Mouse.Up(inXInt: Optional[int] = None, inYInt: Optional[int] = None, inButtonStr: str = 'left', inWaitAfterSecFloat: float = 0.4)
L+,W+: Отпустить (вверх) клавишу мыши. Если координаты inXInt, inYInt не переданы - нажатие происходит на тех координатах X/Y, на которых указатель мыши находится.

!ВНИМАНИЕ! Отсчет координат inXInt, inYInt начинается с левого верхнего края рабочей области.

```
# Mouse: Взаимодействие с мышью
from pyOpenRPA.Robot import Mouse
Mouse.Up(inButtonStr:str='right') #Поднять правую клавишу мыши
```


* **Параметры**

    
    * **inXInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси X (горизонтальная ось).


    * **inYInt** (*int**, **опциональный*) – Целевая позиция указателя мыши по оси Y (вертикальная ось).


    * **inButtonStr** (*str**, **опциональный*) – Номер кнопки, которую требуется поднять. Возможные варианты: „left“, „middle“, „right“ или 1, 2, 3. В остальных случаях инициирует исключение ValueError. По умолчанию „left“


    * **inWaitAfterSecFloat** (*float**, **опциональный*) – Количество секунд, которые ожидать после выполнения операции. По умолчанию установлено в настройках модуля Mouse (базовое значение 0.4)


## Быстрая навигация


* [Сообщество pyOpenRPA (telegram)](https://t.me/pyOpenRPA)


* [Сообщество pyOpenRPA (tenchat)](https://tenchat.ru/iMaslov?utm_source=19f2a84f-3268-437f-950c-d987ae42af24)


* [Сообщество pyOpenRPA (вконтакте)](https://vk.com/pyopenrpa)


* [Презентация pyOpenRPA](https://pyopenrpa.ru/Index/pyOpenRPA_product_service.pdf)


* [Портал pyOpenRPA](https://pyopenrpa.ru)


* [Репозиторий pyOpenRPA](https://gitlab.com/UnicodeLabs/OpenRPA)

		.. v1.2.14 replace:: v1.2.14