def ignore_region_by_coordinates(self,
left,
top,
width,
height,
target=None):
"""
Returns a Target object that ignores the region specified in the arguments.
See `Defining Ignore and Floating Regions`.
| =Arguments= | =Description= |
| Left (float) | *Mandatory* - The left coordinate of the region to ignore e.g. 100 |
| Top (float) | *Mandatory* - The top coordinate of the region to ignore e.g. 150 |
| Width (float) | *Mandatory* - The width of the region to ignore e.g. 500 |
| Height (float) | *Mandatory* - The height of the region to ignore e.g. 120 |
| Target (Target) | The previously existent Target, to be used if a ignore region or floating region was already set |
*Example:*
| ${target}= | Ignore Region By Coordinates | 10 | 20 | 100 | 100 |
| Check Eyes Window | Google Homepage | target=${target} |
"""
if target is None:
target = Target()
ignore_region = Region(float(left), float(top), float(width),
float(height))
target.ignore(ignore_region)
return target
def ignore_region_by_element(self, element, target=None):
"""
Returns a Target object that ignores the region of the element specified in the arguments.
See `Defining Ignore and Floating Regions`.
| =Arguments= | =Description= |
| Element (WebElement) | *Mandatory* - The WebElement to ignore |
| Target (Target) | The previously existent Target, to be used if a ignore region or floating region was already set |
*Example:*
| ${element}= | Get Webelement | //*[@id="hplogo"] |
| ${target}= | Ignore Region By Element | ${element} |
| Check Eyes Window | Google Homepage | target=${target} |
"""
if target is None:
target = Target()
ignore_region = IgnoreRegionByElement(element)
target.ignore(ignore_region)
return target
def ignore_region_by_selector(self, value, selector="id", target=None):
"""
Returns a Target object that ignores the region of the element specified in the arguments by selector and value.
See `Defining Ignore and Floating Regions` and `Using Selectors`
| =Arguments= | =Description= |
| Value (str) | *Mandatory* - The specific value of the selector. e.g. a CSS SELECTOR value .first.expanded.dropdown |
| Selector (str) | *Mandatory* - The strategy to locate the element. The supported selectors are specified in `Using Selectors` |
| Target (Target) | The previously existent Target, to be used if a ignore region or floating region was already set |
*Example:*
| ${target}= | Ignore Region By Selector | .first.expanded.dropdown | css selector |
| Check Eyes Window | Google Homepage | target=${target} |
"""
if target is None:
target = Target()
selector_strategy = utils.get_selector_strategy(selector)
ignore_region = IgnoreRegionBySelector(selector_strategy, value)
target.ignore(ignore_region)
return target
