ORPA-pyOpenRPA/Sources/GuideSphinx/Robot/02_Defs.rst

####################################
2. Defs
####################################

****************************************************************************************************
Desktop app UI access (win32 and UI automation dlls)
****************************************************************************************************

Definitions
############################################

- **UIO** - UI Object (class of pywinauto UI object) [pywinauto.base_wrapper]
- **UIOSelector** - List of dict (key attributes)
- **PWA** - PyWinAuto
- **PWASpecification** - List of dict (key attributes in pywinauto.find_window notation)
- **UIOTree** - Recursive Dict of Dict ... (UI Parent -> Child hierarchy)
- **UIOInfo** - Dict of UIO attributes
- **UIOActivity** - Activity of the UIO (UI object) from the Pywinauto module
- **UIOEI** - UI Object info object


What is UIO?
############################################
UIO is a User Interface Object (pyOpenRPA terminology). For maximum compatibility, this instance is inherited from the object model developed in the [pywinauto library (click to get a list of available class functions)](https://pywinauto.readthedocs.io/en/latest/code/pywinauto.base_wrapper.html).

This approach allows us to implement useful functionality that has already been successfully developed in other libraries, and Supplement it with the missing functionality. In our case, the missing functionality is the ability to dynamically access UIO objects using UIO selectors.


UIOSelector structure & example
############################################
<a name="UIOSelector_Structure_Examples"></a>
UIOSelector is the list of condition items for the UIO in GUI. Each item has condition attributes for detect applicable UIO. Here is the description of the available condition attributes in item.

**Desciption**<br>
 ```
[
    {
        "depth_start" :: [int, start from 1] :: the depth index, where to start check the condition list (default 1),
        "depth_end" :: [int, start from 1] :: the depth index, where to stop check the condition list (default 1),
        "ctrl_index" || "index" :: [int, starts from 0] :: the index of the UIO in parent UIO child list,
        "title" :: [str] :: the condition for the UIO attribute *title*,
        "title_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *title*,
        "rich_text" :: [str] :: the condition for the UIO attribute *rich_text*,
        "rich_text_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *rich_text*,
        "class_name" :: [str] :: the condition for the UIO attribute *class_name*,
        "class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *class_name*,
        "friendly_class_name" :: [str] :: the condition for the UIO attribute *friendly_class_name*,
        "friendly_class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *friendly_class_name*,
        "control_type" :: [str] :: the condition for the UIO attribute *control_type*,
        "control_type_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *control_type*,
        "is_enabled" :: [bool] :: the condition for the UIO attribute *is_enabled*. If UI object is enabled on GUI,
        "is_visible" :: [bool] :: the condition for the UIO attribute *is_visible*. If UI object is visible on GUI,
        "backend" :: [str, "win32" || "uia"] :: the method of UIO extraction (default "win32"). ATTENTION! Current option can be only for the first item of the UIO selector. For the next items this option will be implemented from the first item.
    },
    { ... specification next level UIO }
]
 ```
**The UIO selector example**
 ```
[
    {"class_name":"CalcFrame", "backend":"win32"}, # 1-st level UIO specification
    {"title":"Hex", "depth_start":3, "depth_end": 3} # 3-rd level specification (because of attribute depth_start|depth_stop)
]
 ```
The UIDesktop module (OpenRPA/Robot/UIDesktop.py)
########################################################################################
The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the **win32** and **ui automation** dll frameworks (big thx to the Microsoft :) ).

.. code-block:: python

    # EXAMPLE 1
    from pyOpenRPA.Robot import UIDesktop

    UIDesktop.UIOSelector_Get_UIO(
        inSpecificationList=[
            {"title":"notepad.exe"},{"title":"OK"}],
        inElement=None,
        inFlagRaiseException=True)



.. automodule:: pyOpenRPA.Robot.UIDesktop
    :members:
    :autosummary:


**********
References
**********

`reStructuredText`_

.. target-notes::
.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html