.. _module.robot.screen:

####################################
7. Функции Screen
####################################

************************
Общее
************************
!ВНИМАНИЕ! ДЛЯ РАБОТЫ В LINUX ТРЕБУЕТСЯ НАЛИЧИЕ КОМПОНЕНТА SCROT (sudo apt-get scrot)

Документация к модулю будет опубликована в Июле 2022. По всем вопросам роботизации WEB приложений обращайтесь в центр поддержки клиентов pyOpenRPA.

Дорогие коллеги!

Мы знаем, что с pyOpenRPA вы сможете существенно улучшить качество вашего бизнеса. Платформа роботизации pyOpenRPA - это разработка, которая дает возможность делать виртуальных сотрудников (программных роботов RPA) выгодными, начиная от эффекта всего в **10 тыс. руб.** И управлять ими будете только Вы! 

Если у вас останутся вопросы, то вы всегда можете обратиться в центр поддержки клиентов pyOpenRPA. Контакты: :ref:`3.-Copyrights-&-Contacts`

pyOpenRPA - роботы помогут!

************************
Класс Box
************************
Экземпляр класса pyscreeze.Box, который характеризует прямоугольную область на экране.

top - координата левой верхней точки в пикселях по оси X (горизонталь)
left - координата левой верхней точки в пикселях по оси Y (вертикаль)
height - расстояние вниз от левой верхней точки в пикселях
width - расстояние вправо от левой верхней точки в пикселях


************************
Класс Point
************************
Экземпляр класса pyscreeze.Point, который характеризует точку на экране.

x - координата точки в пикселях по оси X (горизонталь)
y - координата точки в пикселях по оси Y (вертикаль)

************************************************
Символьное указание точки (inPointRuleStr)
************************************************

LU|CU|RU
--------
LC|CC|RC  
--------
LD|CD|RD 

Символьное указание точки - точка относительно которой выполнить изменение прямоугольной области. 

 "CC", 

Формат образования кода: XY, где 

- X обозначает положение по горизонтали (допустимые значения: "L", "C", "R")
- Y обозначает положение по вертикали (допустимые значения: "U", "C", "D")

Допустимые значения:

- "CC" - центр по горизонтали, центр по вертикали
- "LU" - левый край по горизонтали, верхний край по вертикали
- "LD" - левый край по горизонтали, нижний край по вертикали
- "RD" - правый край по горизонтали, нижний край по вертикали
- "RU" - правый край по горизонтали, верхний край по вертикали

X-10 - корректировка координаты по оси X на 10 пикселей влево
Y+20 - корректировка координаты по оси Y на 20 пикселей вниз


************************************************
Символьное указание области (inAnchorRuleStr)
************************************************

LU|CU|RU
--------
LC|CC|RC 
--------
LD|CD|RD 

Символьное указание области поиска - область относительно которой выполнить поиск другой прямоугольной области. 

 "CC", 

Формат образования кода: XY, где 

- X обозначает область по горизонтали (допустимые значения: "L", "C", "R")
- Y обозначает область по вертикали (допустимые значения: "U", "C", "D")


Допустимые значения:

- "CC" - выбранная прямоугольная область
- "LU" - слева и сверху от выбранной прямоугольной области
- "LD" - слева и снизу от выбранной прямоугольной области
- "LС" - слева от выбранной прямоугольной области
- "RC" - справа от выбранной прямоугольной области
- "СU" - сверху от выбранной прямоугольной области
- "CD" - сверху от выбранной прямоугольной области
- "RD" - справа и снизу от выбранной прямоугольной области
- "RU" - справа и сверху от выбранной прямоугольной области

Опция "S" (strict) - искомый объект должен всеми своими координатами находиться в обозначенной прямоугольной области

Формат допускает комбинации нескольких областей в одной строке.
Пример:
"CC,LU,LD,S"
"CC|LU|LD|S"
"CCLULDS"

Графическая интерпретация:
+|-|-
-----
-|+|- 
-----
+|-|- 

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

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

.. automodule:: pyOpenRPA.Robot.Screen
    :members:
    :autosummary:

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

- `Сообщество 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>`_