From ebb960722811d9bc35426acd1d597389d612b2aa Mon Sep 17 00:00:00 2001
From: Tuomas Koukkari <tkoukkari@copado.com>
Date: Mon, 13 May 2024 14:59:44 +0300
Subject: [PATCH 1/2] docs: minor modification to file/pdf examples + added tag
 "PDF"

---
 QWeb/keywords/file.py | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/QWeb/keywords/file.py b/QWeb/keywords/file.py
index e508b05d..127c482c 100644
--- a/QWeb/keywords/file.py
+++ b/QWeb/keywords/file.py
@@ -36,7 +36,7 @@
 ACTIVE_FILE: File = None  # type: ignore[assignment]
 
 
-@keyword(tags=["File"])
+@keyword(tags=["PDF", "File"])
 def use_pdf(filename: str) -> None:
     r"""Define pdf file for all other pdf keywords.
 
@@ -91,7 +91,7 @@ def use_file(filename: str) -> None:
     ACTIVE_FILE = File.create_text_file_instance(filename)
 
 
-@keyword(tags=("File", "Getters"))
+@keyword(tags=("PDF", "File", "Getters"))
 def get_pdf_text(**kwargs) -> str:
     r"""Get text content from pdf file.
 
@@ -116,6 +116,8 @@ def get_pdf_text(**kwargs) -> str:
         ${text}    GetPdfText    between=Simple???File
 
         # matches to text between Simple and end of file.
+        ${text}    GetPdfText    between=Simple???
+
         # Returns 6 characters from the beginning of match.
         ${text}    GetPdfText    between=Simple???       from_start=6
 
@@ -168,6 +170,8 @@ def get_file_text(**kwargs) -> str:
         ${text}    GetFileText   between=Simple???File
 
         # matches to text between Simple and end of file.
+        ${text}    GetFileText   between=Simple???File
+
         # Returns 6 characters from the beginning of match.
         ${text}    GetFileText   between=Simple???       from_start=6
 
@@ -195,7 +199,7 @@ def get_file_text(**kwargs) -> str:
     return str(ACTIVE_FILE.get(**kwargs))
 
 
-@keyword(tags=("File", "Verification"))
+@keyword(tags=("PDF", "File", "Verification"))
 def verify_pdf_text(text: str, normalize: bool = False) -> None:
     r"""Verify text from pdf file.
 
@@ -223,7 +227,7 @@ def verify_pdf_text(text: str, normalize: bool = False) -> None:
 
 @keyword(tags=("File", "Verification"))
 def verify_file_text(text: str, normalize: bool = False) -> None:
-    r"""Verify text from pdf file.
+    r"""Verify text from plain text file.
 
     Examples
     --------
@@ -246,9 +250,9 @@ def verify_file_text(text: str, normalize: bool = False) -> None:
     ACTIVE_FILE.verify(text, normalize)
 
 
-@keyword(tags=("File", "Verification"))
+@keyword(tags=("PDF", "File", "Verification"))
 def verify_no_pdf_text(text: str, normalize: bool = False) -> None:
-    r"""Verify text not exists in pdf-file.
+    r"""Check that the text does not exist in the PDF file.
 
     Examples
     --------
@@ -277,7 +281,7 @@ def verify_no_pdf_text(text: str, normalize: bool = False) -> None:
 
 @keyword(tags=("File", "Verification"))
 def verify_no_file_text(text: str, normalize: bool = False) -> None:
-    r"""Verify text not exists in pdf-file.
+    r"""Check that the text does not exist in the plain text file.
 
     Examples
     --------
@@ -329,7 +333,7 @@ def remove_file(file: Optional[str] = None) -> None:
             os.remove(file)
 
 
-@keyword(tags=("File", "Interaction"))
+@keyword(tags=("PDF", "File", "Interaction"))
 def remove_pdf() -> None:
     r"""Remove a file.
 

From bbd1fa0e482da711eb6bb850a8cd9c5c8b94543b Mon Sep 17 00:00:00 2001
From: Tuomas Koukkari <tkoukkari@copado.com>
Date: Mon, 13 May 2024 15:05:51 +0300
Subject: [PATCH 2/2] docs: Added NOTE: to all dropdown kw's about these being
 meant for real dropdowns containing <select> and <option> tags

---
 QWeb/keywords/dropdown.py | 18 ++++++++++++++++++
 docs/QWeb.html            |  2 +-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/QWeb/keywords/dropdown.py b/QWeb/keywords/dropdown.py
index a850b0fb..f62c4a06 100644
--- a/QWeb/keywords/dropdown.py
+++ b/QWeb/keywords/dropdown.py
@@ -40,6 +40,9 @@ def drop_down(
 ) -> None:
     r"""Select an option from dropdown menu/list.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
@@ -136,6 +139,9 @@ def verify_selected_option(
     r"""Verify that an option is selected from dropdown menu/list.
     Note: with multiselection dropdown verify each option individually.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
@@ -188,6 +194,9 @@ def get_selected(
 ) -> None:
     r"""Get selected option to variable from dropdown menu/list.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
@@ -248,6 +257,9 @@ def verify_option(
 ) -> None:
     r"""Verify that option exist in dropdown menu/list.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
@@ -299,6 +311,9 @@ def get_drop_down_values(
 ) -> None:
     r"""Return all options from a dropdown menu/list.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
@@ -349,6 +364,9 @@ def verify_no_option(
 ) -> None:
     r"""Verify that a given option is not in a dropdown menu/list.
 
+    **NOTE:** This keyword is designed to function exclusively with actual dropdowns
+    that contain **<select>** and **<option>** tags.
+
     Examples
     --------
     .. code-block:: robotframework
diff --git a/docs/QWeb.html b/docs/QWeb.html
index b1055f6a..ab2d84d5 100644
--- a/docs/QWeb.html
+++ b/docs/QWeb.html
@@ -1180,7 +1180,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"specversion": 2, "name": "QWeb", "doc": "<div class=\"document\">\n<p>QWeb is a powerful and versatile <a class=\"reference external\" href=\"https://robotframework.org/\">Robot Framework</a> library that\nenables efficient and reliable web testing and automation. One of the key strengths of QWeb\nis its intuitive and user-friendly syntax, which makes it easy to write and maintain complex\ntest cases.</p>\n<p>The library offers:</p>\n<ul class=\"simple\">\n<li><strong>Intuitive Syntax</strong>: User-friendly syntax for writing and maintaining complex test cases.</li>\n<li><strong>Smart locators</strong>: Interact with web elements using natural language locators.\n| <a class=\"reference internal\" href=\"#locators\">Locators</a></li>\n<li><strong>Anchors</strong>: Used to pinpoint specific instances of web elements with the same locator.\n| <a class=\"reference internal\" href=\"#anchors\">Anchors</a></li>\n<li><strong>Visibility</strong>: By default interacting with visible elements only, but allowing access to\nhidden elements when needed.\n| <a class=\"reference internal\" href=\"#visibility\">Visibility</a></li>\n<li><strong>Shadow DOM support</strong>: Allows interaction with elements inside a shadow DOM, which are\nencapsulated from the main document.\n| <a class=\"reference internal\" href=\"#shadow-dom\">Shadow_dom</a></li>\n<li><strong>Automatic waits</strong>: Automatically handling latencies etc. via automatic wait times.\n| <a class=\"reference internal\" href=\"#waits\">Waits</a></li>\n<li><strong>Automatic frame handling</strong>: Automatically moving between frames and finding elements from\nany embedded frame.</li>\n<li>And many more features...</li>\n</ul>\n<div class=\"section\" id=\"driver-management\">\n<h1>Driver Management</h1>\n<p>QWeb uses the Selenium WebDriver internally to interact with a web browser.\nSince QWeb 3.0.0 / Selenium 4.10.0 <cite>browser drivers</cite> can be automatically downloaded and\ninstalled using Selenium Manager, provided that driver is not found in PATH.\nAlternatively you can still manually download and install drivers or let 3rd party\nutilities like Webdriver Manager do it for you.</p>\n<p>For Chrome <cite>browser_version</cite> can also be given; if your locally installed Chrome matches\nthis version, it will be used. If not, a suitable version of <cite>Chrome for Testing</cite> will be\nautomatically downloaded</p>\n</div>\n<div class=\"section\" id=\"locator-strategies\">\n<span id=\"locators\"></span><h1>Locator strategies</h1>\n<p>One of the greatest conceptual difference of QWeb compared to other web test automation\nlibraries is the use of UI texts as a locator when ever it\u2019s possible.\nWith UI text as a locator there is no need to inspect html source, you can just use what\nyou see on the screen. On the other hand, textual locators are usually easier to maintain.</p>\n<p>There are situations where more complex locators (xpaths etc.) might be needed, but it\u2019s\nusually a small portion of test cases / steps. If you notice yourself using xpaths in most\nsteps, please consider re-factoring your test script implementation!</p>\n<p>Here are four ways of finding elements. These are presented in order of preference of using\nthem:</p>\n<p><strong>Text</strong></p>\n<p>The most preferred way is using UI texts as locators. Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using textual locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">       </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyText</span><span class=\"p\">          </span><span class=\"s\">The animal friendly clothing company</span><span class=\"p\">\n    </span><span class=\"nf\">ClickText</span><span class=\"p\">           </span><span class=\"s\">Scar the Lion</span><span class=\"p\">\n    ...\n    </span><span class=\"c\"># finds input field based on label\n</span><span class=\"p\">    </span><span class=\"nf\">TypeText</span><span class=\"p\">            </span><span class=\"s\">Username</span><span class=\"p\">        </span><span class=\"s\">myusername&#64;test.com</span>\n</pre>\n<p><strong>Attribute values</strong></p>\n<p>If there is no visible UI text available, it's possible to find elements using any attribute\nvalue the element has. In the simplest form you can hover over an element and see the alt\ntext/title value, if available.</p>\n<p>Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using attribute values as locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">    </span><span class=\"s\">hrrps://www.google.com</span><span class=\"p\">      </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"c\"># finds input field based on attribute title value\n</span><span class=\"p\">    </span><span class=\"nf\">TypeText</span><span class=\"p\">            </span><span class=\"s\">Search</span><span class=\"p\">                     </span><span class=\"s\">Copado Robotic Testing</span><span class=\"p\">\n    </span><span class=\"nf\">ClickItem</span><span class=\"p\">           </span><span class=\"s\">Clear search</span>\n</pre>\n<p><strong>Xpaths</strong></p>\n<p>Xpaths are also supported as locators. These are mostly used by QWords ending with\n<strong>*Element</strong>.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using xpaths as locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">    </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyElement</span><span class=\"p\">       </span><span class=\"s\">//ul[&#64;class\\=&quot;product-list&quot;]</span><span class=\"p\">\n    </span><span class=\"nf\">ClickText</span><span class=\"p\">           </span><span class=\"s\">Our Story</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyNoElement</span><span class=\"p\">     </span><span class=\"s\">xpath\\=//ul[&#64;class\\=&quot;product-list&quot;]</span>\n</pre>\n<div class=\"admonition caution\">\n<p class=\"first admonition-title\">Caution!</p>\n<p class=\"last\">Xpath locators or keywords using them do not work in Shadow DOM. If your\nweb application uses Shadow DOM\u2019s, use <strong>*Text</strong> and <strong>*Item</strong> keywords instead.</p>\n</div>\n<p><strong>Icons / images</strong></p>\n<p>Bitmap/image comparison can also be used.\nIn that case, you need to have a reference image and it will be found (or clicked) on\na screen.\nTypically image comparison tends to be a bit harder to maintain.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using reference image as locator</span><span class=\"p\">\n    </span><span class=\"nf\">SetConfig</span><span class=\"p\">           </span><span class=\"s\">LogMatchedIcons</span><span class=\"p\">    </span><span class=\"s\">True</span><span class=\"p\">  </span><span class=\"c\"># Log matched image to logs\n</span><span class=\"p\">    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">    </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyIcon</span><span class=\"p\">          </span><span class=\"s\">paw.png</span><span class=\"p\">\n    </span><span class=\"nf\">ClickIcon</span><span class=\"p\">           </span><span class=\"s\">cart.png</span>\n</pre>\n<div class=\"admonition note\">\n<p class=\"first admonition-title\">Note</p>\n<p class=\"last\">Keywords for using icons/images have a naming convention <strong>*Icon</strong>.\n(ClickIcon, VerifyIcon etc.)</p>\n</div>\n</div>\n<div class=\"section\" id=\"anchors-1\">\n<span id=\"anchors\"></span><h1>Anchors</h1>\n<p>When a locator identifies multiple elements, <tt class=\"docutils literal\">anchors</tt> can be used to pinpoint a\nspecific instance. Anchor can be another nearby text or a numeric index.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Login</span><span class=\"p\">      </span><span class=\"c\">anchor=Cancel</span><span class=\"p\">  </span><span class=\"c\"># Textual anchor\nClickText</span><span class=\"p\">    </span><span class=\"c\">Login</span><span class=\"p\">      </span><span class=\"c\">anchor=3</span><span class=\"p\">       </span><span class=\"c\"># Numeric anchor</span>\n</pre>\n</div>\n<div class=\"section\" id=\"shadow-dom-1\">\n<span id=\"shadow-dom\"></span><h1>Shadow DOM</h1>\n<p>Shadow DOM is a web standard that allows for encapsulation of styling and markup in web\ncomponents. It's like a lightweight document inside the main document, with its own set of\nelements. Elements inside a shadow DOM are not directly accessible using traditional locators\nlike XPath or CSS selectors.</p>\n<p>Special methods or settings are often required in automation frameworks to interact with\nelements inside a shadow DOM. QWeb provides support for elements inside a shadow DOM, which are\nencapsulated from the main document. To enable searching elements inside the shadow DOM, use:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">  </span><span class=\"c\"># or 'on'</span>\n</pre>\n<div class=\"admonition tip\">\n<p class=\"first admonition-title\">Tip</p>\n<p class=\"last\">Any QWeb keyword accepting locator as a <strong>text</strong> or <strong>attribute value</strong> will work with\nelements inside a shadow DOM.</p>\n</div>\n<div class=\"admonition important\">\n<p class=\"first admonition-title\">Important</p>\n<p class=\"last\">SetConfig ShadowDOM    True    must be used to enable element search inside\na shadow DOM</p>\n</div>\n<div class=\"admonition caution\">\n<p class=\"first admonition-title\">Caution!</p>\n<p class=\"last\">Some keywords, for example GetWebElement, work with many locator types.</p>\n</div>\n<p>These keywords work with elements inside a shadow DOM when text or attribute values are used\nas a locator. Note that some of these keywords may require you to give an additional argument,\nfor example:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">     </span><span class=\"c\">GetWebelement</span><span class=\"p\">   </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"visibility-1\">\n<span id=\"visibility\"></span><h1>Visibility</h1>\n<p>In web automation, visibility refers to whether a web element is visible to the user or not.\nAn element might exist in the DOM (Document Object Model) but may not be visible due to\nvarious reasons like CSS styles (e.g., display: none) or even by mistake.\nAutomation frameworks often provide ways to interact only with visible elements,\nas invisible elements are typically not interactable by the user.</p>\n<p>QWeb by default finds only visible elements, but provides support for elements that are not\nvisible by default.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">       </span><span class=\"c\">visibility=False</span><span class=\"p\">  </span><span class=\"c\"># extend one element search to invisible elements\n</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">Visibility</span><span class=\"p\">  </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\"># extend element search to invisible elements globally</span>\n</pre>\n</div>\n<div class=\"section\" id=\"automatic-wait-times\">\n<span id=\"waits\"></span><h1>Automatic Wait Times</h1>\n<p>QWeb automatically handles latencies by introducing wait times.\nThis ensures that the automation script waits for the web elements to load or become\ninteractable before performing actions, reducing the chances of test failures due to element\nnot found or not interactable errors.</p>\n<p>There should not be reason to use <strong>Sleep</strong> keyword or such except in very exceptional cases.\nAlmost all QWords have an inbuilt timeout, i.e they keep re-trying to find elements and do\ntheir action until action succeeds OR until timeout limit is reached.\nBy default this timeout limit is 10 seconds.</p>\n<p>You can change this timeout temporarily by giving an argument timeout:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># only wait 3 seconds for element to appear\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">Username</span><span class=\"p\">    </span><span class=\"c\">timeout=3</span><span class=\"p\">\n\n</span><span class=\"c\"># wait max 30 seconds for element to appear\nClickText</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">       </span><span class=\"c\">timeout=30</span>\n</pre>\n<p>You can also change timeouts for every keyword (globally) with SetConfig:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">60</span><span class=\"p\">\n</span><span class=\"c\"># would wait 60 seconds for text to appear before failing\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">Username</span><span class=\"p\">\n</span><span class=\"c\"># would wait max 60 seconds for element to appear\nClickText</span><span class=\"p\">       </span><span class=\"c\">Login</span>\n</pre>\n<div class=\"admonition tip\">\n<p class=\"first admonition-title\">Tip</p>\n<p>It's preferable to use QWeb's automatic wait times instead of Sleep keyword.</p>\n<ul class=\"last simple\">\n<li><strong>Sleep</strong> keyword waits for the specified amount of time.</li>\n<li>QWeb automatically waits until element is visible or until timeout limit is reached and\nthen continue.</li>\n</ul>\n</div>\n</div>\n</div>\n", "version": "", "generated": "2024-05-03T09:50:58+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\__init__.py", "lineno": 66, "tags": ["Alert", "Browser", "Checkbox", "Config", "Debug", "Dropdown", "Error handling", "File", "Getters", "Icon", "Input", "Interaction", "Item", "Javascript", "Lists", "Logging", "Remote", "Tables", "Text", "Verification", "Window"], "inits": [{"name": "__init__", "args": [{"name": "run_on_failure_keyword", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Log Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure_keyword: str = Log Screenshot"}], "doc": "<div class=\"document\">\n<p>Initializes the QWeb library and adds all the keywords to the instance.</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">run_on_failure_keyword</tt>:\nThe keyword to run when a failure occurs. Default is &quot;Log Screenshot&quot;.</li>\n</ul>\n</div>\n", "shortdoc": "Initializes the QWeb library and adds all the keywords to the instance.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\__init__.py", "lineno": 299}], "keywords": [{"name": "Appstate", "args": [{"name": "block", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "block: str"}, {"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<div class=\"document\">\n<p>Appstate is a pre-condition of a test case.</p>\n<p>It sets Application(s) under test to correct, known state.\nFirst keyword of every test case is Appstate.\nIt is a navigation system across different states in system under test,\nor between separate applications.\nThey are typically set under resources folder, keywords.robot file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Appstate</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">\n</span><span class=\"c\">#with arguments:\nAppstate</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">fenix</span><span class=\"p\">   </span><span class=\"c\">rising123</span><span class=\"p\">\n\n</span><span class=\"c\">#Example block:\nLogin</span><span class=\"p\">\n    </span><span class=\"c\">[Arguments]</span><span class=\"p\">     </span><span class=\"c\">${USER}=username</span><span class=\"p\">     </span><span class=\"c\">${PASS}=password</span><span class=\"p\">\n    </span><span class=\"c\">Goto</span><span class=\"p\">        </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Password</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">Welcome, ${USER}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>block <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Action word/Block to execute</dd>\n<dt>args <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">any</span></dt>\n<dd>Possible args for block</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Run%20Block\" class=\"name\">RunBlock</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Appstate is a pre-condition of a test case.", "tags": ["Config", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\blocks.py", "lineno": 98}, {"name": "Back", "args": [], "doc": "<div class=\"document\">\n<p>Navigates back in the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Back</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Forward\" class=\"name\">Forward</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Navigates back in the current window.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 103}, {"name": "Capture Icon", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "folder", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshots", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "folder: str = screenshots"}, {"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshot_{}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = screenshot_{}.png"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Take a screenshot of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${some_xpath}=</span><span class=\"p\">       </span><span class=\"c\">//*[&#64;value\\=&quot;Button3&quot;]</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">${some_xpath}</span><span class=\"p\">\n\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">filename=custom_screenshot_name_123.png</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">C:/custom/folder/path</span><span class=\"p\">   </span><span class=\"c\">custom_screenshot_name_123.png</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for the element we are trying to capture, XPath or attribute value. When using\nXPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>folder <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional folder path. Default value is the screenshots folder.</dd>\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional filename.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>filepath : full path to saved screenshot</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Take a screenshot of an element.", "tags": ["Icon", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 282}, {"name": "Case Insensitive", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CaseInsensitive</cite> instead.</p>\n<p>Set containing_text_match according to selected case sensitivity.</p>\n<p>Default = False\nNote: if containing_text_match has been overwritten manually\nthis will return the default value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CaseInsensitive` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 238, "deprecated": true}, {"name": "Check Input Value", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CheckInputValue</cite> instead.</p>\n<p>Check that real value matches to preferred value after TypeText.</p>\n<p>If value is not match we try to re type (three times before fail)\nThis is optional feature. Default = false.\nUse with caution on elements where webdriver has tendency to lost focus\nand some part of the preferred text gone missing.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>,\n<a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CheckInputValue` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 185, "deprecated": true}, {"name": "Click Cell", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click table cell.</p>\n<p>Locates cell by coordinates or text from active table and clicks it</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCell</span><span class=\"p\">    </span><span class=\"c\">r2c3</span><span class=\"p\">\n</span><span class=\"c\">ClickCell</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">                  </span><span class=\"c\">#Last row, last cell\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?SomeText/c3</span><span class=\"p\">           </span><span class=\"c\">#Click cell 3 in row that contains text SomeText\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">      </span><span class=\"c\">Hello</span><span class=\"p\">   </span><span class=\"c\">#Click cell 3 in row with words Robot and Hello in it\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">            </span><span class=\"c\">tag=a</span><span class=\"p\">   </span><span class=\"c\">#Clicks first child element with a tag\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">      </span><span class=\"c\">index=2</span><span class=\"p\">  </span><span class=\"c\">tag=input</span><span class=\"p\">  </span><span class=\"c\">#Clicks the second child element of cell 3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table or some text that locates in preferred row.\nR specifies row and c column.\nr1 = first row, r-1 = last row, r?Qentinel/ = row that contains word Qentinel</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If row is located by text which is not unique, use anchor to point correct one.\nAnchor can be some other text in same row or index. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Use index when table cell contains more than one clickable element and preferred one\nis not the first one. Requires the use of tag and value should be &gt; 0, default = 1.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>partial_match</strong>: This argument lets you decide if you want to find column names</div>\n<div class=\"line\">by looking for an exact match to your search term or if a partial match is</div>\n<div class=\"line\">good enough. For example, when you're specifying which column to look at using</div>\n<div class=\"line\">a text-based method (like &quot;r1/?cRobot&quot;), this determines whether the system should</div>\n<div class=\"line\">look for an exact match to &quot;Robot&quot; or if it can work with columns that only partly</div>\n<div class=\"line\">match the word &quot;Robot&quot;.</div>\n<div class=\"line\">Default: if partial_match is not given, the value of SetConfig PartialMatch is used.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Click table cell.", "tags": ["Interaction", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 228}, {"name": "Click Checkbox", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check or uncheck a checkbox.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">               </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">              </span><span class=\"c\">off</span><span class=\"p\">  </span><span class=\"c\">#last row, third cell\nClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">        </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">anchor text</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">         </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">Test</span><span class=\"p\">  </span><span class=\"c\">#row contains texts Robot and Test\nClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">         </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">    </span><span class=\"c\">#third row which contains text Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Value of the checkbox. On or off.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundErr</dt>\n<dd>CheckBox element not found</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Check or uncheck a checkbox.", "tags": ["Checkbox", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 33}, {"name": "Click Element", "args": [{"name": "xpath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click element specified by xpath.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\"># using WebElement instance\n${elem}=</span><span class=\"p\">              </span><span class=\"c\">GetWebElement</span><span class=\"p\">    </span><span class=\"c\">Click Me</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">${elem}</span>\n</pre>\n<p>To double-click element, use argument <strong>doubleclick=True</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">             </span><span class=\"c\">double_click_me</span><span class=\"p\">       </span><span class=\"c\">doubleclick=True</span>\n</pre>\n<p>Or use SetConfig</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">             </span><span class=\"c\">DoubleClick</span><span class=\"p\">           </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">double_click_me</span><span class=\"p\">       </span><span class=\"c\">tag=button</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript click instead of Selenium.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20List\" class=\"name\">ClickList</a>,\n<a href=\"#Click%20Text\" class=\"name\">ClickText</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Right%20Click\" class=\"name\">RightClick</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Click element specified by xpath.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 31}, {"name": "Click Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Click the icon/bitmap on the screen.</p>\n<p>This keyword is designed to locate and interact with graphical icons/bitmpas on a screen\nby comparing them to a reference image. The function searches the current screen content\nfor the image specified in the 'image' parameter.</p>\n<p>If reference picture is not stored in default folders (images, files, downloads) then\neither full path to image should be used or variable BASE_IMAGE_PATH should be defined\nbefore using this keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Click icon with stricter tolerance and comparing colors\nClickIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">      </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">     </span><span class=\"c\">grayscale=False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Element\" class=\"name\">ClickElement</a>,\n<a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a>,\n<a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Click the icon/bitmap on the screen.", "tags": ["Icon", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 33}, {"name": "Click Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click item (usually icon or picture) on webpage.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only).</em></p>\n<p>Keyword tries to click element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the ClickItem keyword will click the word Canis.\nIf there are multiple instances of the word Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickItem</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># clicks the third &quot;Canis&quot; on the page\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; near to the word &quot;Dog&quot;</span>\n</pre>\n<p>To enable searching items also from Shadow DOM, use SetConfig   Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">        </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">ClickItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it.  (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Click%20Element\" class=\"name\">ClickElement</a>,\n<a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Click item (usually icon or picture) on webpage.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 918}, {"name": "Click Item Until", "args": [{"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.\nKeyword is also handful in situations where we are waiting for some process\nto be ready and there is some button to press for getting results</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># ClickItem submit until Order 1234 exists on page:\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">Order 1234</span><span class=\"p\">         </span><span class=\"c\">submit</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem counter once/second until text Done appears.\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">Done</span><span class=\"p\">                </span><span class=\"c\">counter</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem ++ near to text Main Cart until there is 10 items in carts.\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">10 items</span><span class=\"p\">            </span><span class=\"c\">++</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem save until element with attr confirm_box appears\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">confirm_box</span><span class=\"p\">         </span><span class=\"c\">save</span><span class=\"p\">    </span><span class=\"c\">element=True</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Some attr value to locate element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text appears.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1772}, {"name": "Click Item While", "args": [{"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_disappear: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click Item until a text or element disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until certain text or\nelement disappears.</p>\n<p>If text_to_disappear is not entered, keyword will wait until clicked element disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If element to disappear is same as clickable item. ClickItem with Add attribute\n# while it exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Add</span><span class=\"p\">      </span><span class=\"c\">element=True</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem add while text Empty Cart exists. Timeout after 5s:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Empty Cart</span><span class=\"p\">         </span><span class=\"c\">Add</span><span class=\"p\">           </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem Cart contents while h1 type element with attr some_attr exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">some_attr</span><span class=\"p\">     </span><span class=\"c\">Cart contents</span><span class=\"p\">   </span><span class=\"c\">element=True</span><span class=\"p\">  </span><span class=\"c\">tag=h1</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem Go to cart once/second while text Cart exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Some attr value to locate element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click Item until a text or element disappears.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1692}, {"name": "Click List", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: int | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = True"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click list element with in given index.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickList</span><span class=\"p\">       </span><span class=\"c\">1</span><span class=\"p\">\n</span><span class=\"c\">ClickList</span><span class=\"p\">       </span><span class=\"c\">1</span><span class=\"p\">       </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Click list element with in given index.", "tags": ["Interaction", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 141}, {"name": "Click Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text on web page.</p>\n<p>Keyword looks for an exact match and if not found uses xpath defined in\nSearch Strategy. If the given text corresponds to multiple elements, it\nclicks the first element.</p>\n<p>If you want to click other element than the first one found, you need to\nuse anchor or index.</p>\n<p>Keyword tries to click element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the ClickText keyword will click the word Canis.\nIf there are multiple instances of the word Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># clicks the third &quot;Canis&quot; on the page\nClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; near to the word &quot;Dog&quot;\n# handling numeric anchors as text, not index\nClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\">anchor_type=text</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; next text &quot;3&quot;</span>\n</pre>\n<p>If you want to specify how long ClickText tries, you need to add both anchor\nand timeout.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">1</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\"># Tries to click the first &quot;Canis&quot; for 20s</span>\n</pre>\n<p>If clickable element is child or parent of locator element use child/parent\nattribute + elements tagname to pick right element</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">parent=span # Clicks Canis element's first parent with span -tag</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">child=a</span><span class=\"p\">     </span><span class=\"c\"># First childnode with a -tag</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">js=true</span><span class=\"p\">     </span><span class=\"c\">#Use Javascript click instead of Selenium</span>\n</pre>\n<p>To double-click text, use argument doubleclick=True</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">doubleclick=True</span>\n</pre>\n<p>Or use SetConfig</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DoubleClick</span><span class=\"p\">     </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span>\n</pre>\n<p>To search text also from shadow DOM, use SetConfig ShadowDOM.\nNote that certain arguments like partial_match are ignored when\nsearching from shadow DOM.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait element to appear and click to succeed</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text. In practise this means that also non-clickable texts\n(e.g. spans) are considered. By default ClickText only finds texts that\nare considered &quot;clickable&quot;.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Right%20Click\" class=\"name\">RightClick</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Click text on web page.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 346}, {"name": "Click Until", "args": [{"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "text_to_click", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_click: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.\nKeyword is also handful in situations where we are waiting for some process\nto be ready and there is some button to press for getting results</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># ClickText Get Data until Order 1234 exists on page:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Order 1234</span><span class=\"p\">         </span><span class=\"c\">Get Data</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Update until there is text Process finished available.\n# Wait eight seconds between clicks:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Process finished</span><span class=\"p\">   </span><span class=\"c\">Update</span><span class=\"p\">      </span><span class=\"c\">interval=8s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Add near to text Main Cart until there is 10 items in carts.\n# Timeout after 20 seconds if attempts are unsuccessful. Interval 1 second:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">10 items</span><span class=\"p\">            </span><span class=\"c\">Add</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Submit until element with attr confirm_box appears\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">confirm_box</span><span class=\"p\">         </span><span class=\"c\">Submit</span><span class=\"p\">    </span><span class=\"c\">element=True</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>text_to_click <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text appears.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1607}, {"name": "Click While", "args": [{"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_disappear: str"}, {"name": "text_to_click", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_click: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text or element disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until certain text or\nelement disappears.</p>\n<p>If text_to_disappear is not entered, keyword will wait until clicked text disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If text to disappear is same as clickable text. ClickText Cart while it exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Button while text Cart exists. Timeout after 5s:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">          </span><span class=\"c\">Button</span><span class=\"p\">          </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Cart contents while element with attr some_attr exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">some_attr</span><span class=\"p\">     </span><span class=\"c\">Cart contents</span><span class=\"p\">   </span><span class=\"c\">element=True</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Go to cart once/second while text Cart exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>text_to_click <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text or element disappears.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1521}, {"name": "Close Alert", "args": [{"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Close popup alert.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Accept</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Dismiss</span><span class=\"p\">\n</span><span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Nothing</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>action <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>What is done for popup. Options are:\nACCEPT: accept alert\nDISMISS: dismiss alert\nNOTHING: don't close alert</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Close popup alert.", "tags": ["Alert", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 26}, {"name": "Close All Browsers", "args": [], "doc": "<div class=\"document\">\n<p>Close all opened browsers.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseAllBrowsers</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Remote%20Browser\" class=\"name\">CloseRemoteBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close all opened browsers.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 473}, {"name": "Close Browser", "args": [], "doc": "<div class=\"document\">\n<p>Close current browser.</p>\n<p>This will also close remote browser sessions if open.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseBrowser</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Remote%20Browser\" class=\"name\">CloseRemoteBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close current browser.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 409}, {"name": "Close Others", "args": [], "doc": "<div class=\"document\">\n<p>Close all windows except the first window.</p>\n<p>If you have a test that may open new windows, this keyword closes them\nand switches to the first window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseOthers</span>\n</pre>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchWindowException</dt>\n<dd>If other windows cannot been closed</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Window\" class=\"name\">CloseWindow</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Close all windows except the first window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 102}, {"name": "Close Remote Browser", "args": [], "doc": "<div class=\"document\">\n<p>Close remote browser session which is connected to the target browser.</p>\n<p>Closes only the remote browser session and leaves the target browser\nrunning. This makes it possible to continue using the existing browser\nfor other tests.</p>\n<p>It is important to use this keyword to free up the resources i.e.\nunnecessary chrome instances are not left to run. However,\nit is good to monitor chromedriver processes as those might be still\nrunning.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseBrowserSession</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close remote browser session which is connected to the target browser.", "tags": ["Browser", "Interaction", "Remote"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 442}, {"name": "Close Window", "args": [], "doc": "<div class=\"document\">\n<p>Close current tab and switch context to another window handle.</p>\n<p>If you need to change to specific tab, use switch window keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseWindow</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Close current tab and switch context to another window handle.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 144}, {"name": "Copy Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}], "doc": "<div class=\"document\">\n<p>Perform a copy.</p>\n<p>Copies whatever is active at the UI to the clipboard. If text is\nprovided copies that to the clipboard.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str, optional</span></dt>\n<dd>Text to copy to the clipboard</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Copy the provided text\nCopyText</span><span class=\"p\">        </span><span class=\"c\">text to clipboard</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Perform a copy.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1498}, {"name": "Css Selectors", "args": [{"name": "state", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CssSelectors</cite> instead.</p>\n<p>Use CSS selectors for finding elements.</p>\n<p>CSS selectors is optional way to find elements that\nare difficult to catch by default selectors. Typically\nthose elements are inputs, checkboxes and dropdowns\nwithout placeholder texts.</p>\n<p>With CSS selectors the detection is tried with:</p>\n<ul class=\"simple\">\n<li>Placeholder or tooltip</li>\n<li>Label with 'for' attribute</li>\n<li>DOM traversing to detect sibling element</li>\n</ul>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">           </span><span class=\"c\">MyLocator</span><span class=\"p\">   </span><span class=\"c\">Robot</span><span class=\"p\">\n</span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CssSelectors` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 156, "deprecated": true}, {"name": "Debug Off", "args": [], "doc": "<div class=\"document\">\n<p>Exit debugger. Set timeout and SearchMode back to default.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">debugoff</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Debug%20On\" class=\"name\">DebugOn</a></p>\n</div>\n</div>\n", "shortdoc": "Exit debugger. Set timeout and SearchMode back to default.", "tags": ["Debug", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\debug.py", "lineno": 64}, {"name": "Debug On", "args": [{"name": "mode", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "draw", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode: str = draw"}], "doc": "<div class=\"document\">\n<p>Start debugger with drawing mode and set default timeout down to 2 sec.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">debugon</span><span class=\"p\">    </span><span class=\"c\">#Start debugger and set timeout to 2sec.\ndebugon</span><span class=\"p\">    </span><span class=\"c\">debug</span><span class=\"p\">   </span><span class=\"c\">#Start debugger with SearchMode debug and set timeout to 2sec.</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>mode <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>debug(default) = Highlight(blink) element without executing kw\ndraw = Highlight element and execute kw</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Debug%20Off\" class=\"name\">DebugOff</a></p>\n</div>\n</div>\n", "shortdoc": "Start debugger with drawing mode and set default timeout down to 2 sec.", "tags": ["Debug", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\debug.py", "lineno": 29}, {"name": "Default Document", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  DefaultDocument</cite> instead.</p>\n<p>Switches to default frame automatically.</p>\n<p>If some other frame is used by previous keyword\nwe switch back to default after keyword is executed so\nthat we are starting to find next locator from html document\ninstead of previously used frame.\nDefault = True\nUse False only when there is need to use and move\nbetween frames and page manually for some reason.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  DefaultDocument` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 211, "deprecated": true}, {"name": "Default Timeout", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: int | float | str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  DefaultTimeout</cite> instead.</p>\n<p>Set default timeout for QWeb keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">    </span><span class=\"c\">60s</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  DefaultTimeout` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 103, "deprecated": true}, {"name": "Delete All Cookies", "args": [], "doc": "<div class=\"document\">\n<p>Delete all cookies in browser.</p>\n<p>Cookies can be only deleted when browser is open. Cookies are automatically\ndeleted when you Close All Browsers</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DeleteAllCookies</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#List%20Cookies\" class=\"name\">ListCookies</a>, <a href=\"#Is%20Cookie\" class=\"name\">IsCookie</a></p>\n</div>\n</div>\n", "shortdoc": "Delete all cookies in browser.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 31}, {"name": "Drag Drop", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "target_locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target_locator: str"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "target_anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "target_anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "dragtime", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": "0.5s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dragtime: int | str = 0.5s"}, {"name": "left", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "left: int = 0"}, {"name": "right", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "right: int = 0"}, {"name": "above", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "above: int = 0"}, {"name": "below", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "below: int = 0"}, {"name": "loc_left", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_left: int = 0"}, {"name": "loc_right", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_right: int = 0"}, {"name": "loc_above", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_above: int = 0"}, {"name": "loc_below", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_below: int = 0"}], "doc": "<div class=\"document\">\n<p>Drag and drop element.</p>\n<p>Finds draggable element by it's visible text, tooltip attribute, index\nor xpath.\nTarget element is found by it's visible text or xpath.</p>\n<p>Keyword tries to drag element to target element.\nGets coordinates from WebDriver and uses pyautogui to simulate mouse\nactions based on those coordinates.</p>\n<p>Zoom level needs to be 100% in screen settings so that coordinates\nare matching with actual view. (Preferable resolution 1920x1080)</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">//*[&#64;id=&quot;some_id&quot;]</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">index</span><span class=\"p\">          </span><span class=\"c\">Foo</span><span class=\"p\">       </span><span class=\"c\">index=3</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">dragtime=2s</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">right=5</span><span class=\"p\">   </span><span class=\"c\">below=2</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">right=5</span><span class=\"p\">   </span><span class=\"c\">below=2</span><span class=\"p\">   </span><span class=\"c\">loc_above=40</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some element attribute(check ClickItem), xpath or\ntext index to locate draggable element.</dd>\n<dt>target_locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text or xpath to locate target element for draggable.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Index to point out right draggable if there is many or if\nthere is no visible text/attribute which can be use to locate\ncorrect element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>In some cases(f.e Angular) element could be draggable even if\ndraggable attribute doesn't exists. Then we are using traditional\ntext match(check clicktext) to find correct\nelement. Anchor can be index or some text near to draggable element.\n(default 1)</dd>\n<dt>target_anchor</dt>\n<dd>Text near the target element or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find elemenst before failing</dd>\n<dt>dragtime <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long drag should take. Some applications need longer time</dd>\n<dt>left <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels left of target center we drag</dd>\n<dt>right <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels right of target center we drag</dd>\n<dt>above <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels above of target center we drag</dd>\n<dt>below <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels below of target center we drag</dd>\n<dt>loc_left <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels left of locator center we start dragging</dd>\n<dt>loc_right <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels right of locator center we start dragging</dd>\n<dt>loc_above <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels above of locator center we start dragging</dd>\n<dt>loc_below <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels below of locator center we start dragging</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Drag and drop element.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dragdrop.py", "lineno": 34}, {"name": "Drop Down", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "unselect", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "unselect: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Select an option from dropdown menu/list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DropDown</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the DropDown keyword will select from a dropdown\nthe option: Collie.</p>\n<p>How the dropdown element is searched:\nThe dropdown element is first attempted to be matched based on its\nlabel text and then options.\nIf you give one of the dropdown's options as locator, the element\nwill be matched in this search pass.</p>\n<p>If there are multiple instances of a dropdown with text Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DropDown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Collie</span><span class=\"p\">   </span><span class=\"c\">anchor=3</span><span class=\"p\">     </span><span class=\"c\"># Uses third Canis dropdown\nDropDown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Collie</span><span class=\"p\">   </span><span class=\"c\">anchor=dog</span><span class=\"p\">   </span><span class=\"c\"># Uses Canis dropdown near the word text dog</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">         </span><span class=\"c\">Robot</span><span class=\"p\">     </span><span class=\"c\">#last row, third cell\nDropdown</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">   </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n<p>Choose dropdown option with index:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">[[2]]</span>\n</pre>\n<p>Unselect a selected option from multiselection dropdown:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">Collie</span><span class=\"p\">  </span><span class=\"c\">unselect=True</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element</dd>\n<dt>option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Label of the option you want to select</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundErr</dt>\n<dd>Dropdown element not found</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Select an option from dropdown menu/list.", "tags": ["Dropdown", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 32}, {"name": "Execute Javascript", "args": [{"name": "script", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script: str"}, {"name": "variable_name", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "variable_name: str | None = None"}], "doc": "<div class=\"document\">\n<p>Execute javascript and save the result to suite variable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExecuteJavascript</span><span class=\"p\">   </span><span class=\"c\">document.getElementsByTagName(&quot;p&quot;)[0].innerText=&quot;Write text&quot;;</span><span class=\"p\">\n</span><span class=\"c\">ExecuteJavascript</span><span class=\"p\">   </span><span class=\"c\">return document.title;</span><span class=\"p\">     </span><span class=\"c\">$TITLE</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>script <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Javascript code.</dd>\n<dt>variable_name <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Robot framework variable name without {}. (Default None)</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Execute javascript and save the result to suite variable.", "tags": ["Interaction", "Javascript"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\javascript.py", "lineno": 28}, {"name": "Expect File Download", "args": [], "doc": "<div class=\"document\">\n<p>Turns on polling for time after which file download should happen.</p>\n<p>Run this keyword everytime before <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a> and the action that\nstarts download process.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExpectFileDownload</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">               </span><span class=\"c\">Download</span><span class=\"p\">\n</span><span class=\"c\">VerifyFileDownload</span><span class=\"p\">      </span><span class=\"c\">timeout=20s</span><span class=\"p\">     </span><span class=\"c\"># file should be downloaded in 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a></p>\n</div>\n</div>\n", "shortdoc": "Turns on polling for time after which file download should happen.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\download.py", "lineno": 91}, {"name": "Forward", "args": [], "doc": "<div class=\"document\">\n<p>Navigates forward in the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Forward</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Navigates forward in the current window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 124}, {"name": "Get Alert Text", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Get alert text to variable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${TEXT}</span><span class=\"p\">        </span><span class=\"c\">GetAlertText</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Get alert text to variable.", "tags": ["Alert", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 120}, {"name": "Get Attribute", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get attribute value of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using xpaths like with ClickElement etc. kw:s without specified\nelement_type. Index must be given if element is not unique:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">click_me</span><span class=\"p\">     </span><span class=\"c\">id</span><span class=\"p\">         </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;] name</span><span class=\"p\">\n</span><span class=\"c\"># Get id attribute value from 3rd matching element\n${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">//button</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">  </span><span class=\"c\">index=3</span>\n</pre>\n<p>GetAttribute using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">type</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">id</span><span class=\"p\">      </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">class</span><span class=\"p\">   </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">              </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">placeholder</span><span class=\"p\">     </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">           </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">         </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">input[type=button]</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">    </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Qwords like ClickText/Item, TypeText, Dropdown etc.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>attribute: str</dt>\n<dd>Attribute which value we want to get.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation. When using xpath as locator <strong>index</strong> should be</div>\n<div class=\"line\">specified unless xpath matches to a single element.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>value : Value of attribute (true if attribute exist but does not have value)</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Attribute\" class=\"name\">VerifyAttribute</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Get attribute value of an element.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 528}, {"name": "Get Cell Text", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get cell text to variable.</p>\n<p>Locates cell by coordinates from active table and return value</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r2c3</span><span class=\"p\">\n</span><span class=\"c\">${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r-2c5</span><span class=\"p\">       </span><span class=\"c\">#Row is second to last. Get value from cell c5\n${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r?Robot/c5</span><span class=\"p\">  </span><span class=\"c\">#Row contains text Robot. Get value from cell c5\n${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">  </span><span class=\"c\">#Row contains text Robot. Get value from last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table. R specifies row and c column.\nr1 = first row, r-1 = last row, r?Qentinel/ = row that contains word Qentinel</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If row is located by text which is not unique, use anchor to point correct one.\nAnchor can be some other text in same row or index. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get cell text to variable.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 169}, {"name": "Get Col Header", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | None = None"}], "doc": "<div class=\"document\">\n<p>Get column header names/text as a list.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<p>Note2: If column header has attribute 'aria-label', it's value is returned.\nIf not and 'title' attribute exists, then 'title' value is returned.\nIf neither aria-label or title exists, then full text of column element is returned.\nThis is done due to fact that in many web applications header element text contains other texts\nthan what is visible to end users.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\"># Get all column headers as list\n${columns}</span><span class=\"p\">  </span><span class=\"c\">GetColHeader</span><span class=\"p\">\n</span><span class=\"c\"># -&gt; ['col1', 'col2', 'col3']\n# Get column header by index\n${column_at_index_2}</span><span class=\"p\">    </span><span class=\"c\">GetColHeader</span><span class=\"p\">  </span><span class=\"c\">2</span><span class=\"p\">\n</span><span class=\"c\"># -&gt; 'col2 header'</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Column index. If given, gets the header text of the given column.\nIf not given or if 0 is given, returns all column headers as a list.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the given index value is out of range.</dd>\n<dt>ValueError</dt>\n<dd>Index argument is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header%20Count\" class=\"name\">GetColHeaderCount</a>, <a href=\"#Verify%20Col%20Header\" class=\"name\">VerifyColHeader</a>, <a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get column header names/text as a list.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 369}, {"name": "Get Col Header Count", "args": [], "doc": "<div class=\"document\">\n<p>Get Count of column headers in current active table.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\">${count}</span><span class=\"p\">    </span><span class=\"c\">GetColHeaderCount</span>\n</pre>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Verify%20Col%20Header\" class=\"name\">VerifyColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get Count of column headers in current active table.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 341}, {"name": "Get Config", "args": [{"name": "par", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "par: str | None = None"}], "doc": "<div class=\"document\">\n<p>Return value of given configuration parameter.</p>\n<p>If no parameter is given the GetConfig returns\nall configurations in a python dictionary of current configuration parameter names and their\nvalues.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VAL}</span><span class=\"p\">    </span><span class=\"c\">GetConfig</span><span class=\"p\">    </span><span class=\"c\">default timeout</span><span class=\"p\">      </span><span class=\"c\"># Return default timeout value\n${VAL}</span><span class=\"p\">    </span><span class=\"c\">GetConfig</span><span class=\"p\">                         </span><span class=\"c\"># Return all config parameter names and values</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<blockquote>\n<dl class=\"docutils\">\n<dt>par <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Setting to be fetched</dd>\n</dl>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Reset%20Config\" class=\"name\">ResetConfig</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Return value of given configuration parameter.", "tags": ["Config", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 1013}, {"name": "Get Drop Down Values", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return all options from a dropdown menu/list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${all_options}=</span><span class=\"p\">     </span><span class=\"c\">GetDropDownValues</span><span class=\"p\">     </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">Collie</span><span class=\"p\">\n</span><span class=\"c\">log</span><span class=\"p\">     </span><span class=\"c\">${all_options}</span>\n</pre>\n<p>In the above example the GetDropDownValues keyword saves all items from the\ndropdown menu Canis to a variable.</p>\n<p>This keyword can also be used with table cells and XPaths. When using XPaths, the equal sign &quot;=&quot;\nmust be escaped with a &quot;\\&quot;.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Return all options from a dropdown menu/list.", "tags": ["Dropdown", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 297}, {"name": "Get Element Count", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get count of appearances for certain web element.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>GetElementCount does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetElementCount</span><span class=\"p\">       </span><span class=\"c\">//*[&#64;id\\=&quot;Foo&quot;]</span><span class=\"p\">\n</span><span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetElementCount</span><span class=\"p\">       </span><span class=\"c\">Foo</span><span class=\"p\">    </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath or some attribute value of element. When using XPaths, the equal sign &quot;=&quot; must be\nescaped with a &quot;&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>tag=tagname: Needed when attribute value is used as a locator</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text%20Count\" class=\"name\">GetTextCount</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a></p>\n</div>\n</div>\n", "shortdoc": "Get count of appearances for certain web element.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 209}, {"name": "Get File Text", "args": [{"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text content from a plain text file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">    </span><span class=\"c\">text.txt</span><span class=\"p\">\n</span><span class=\"c\"># returns whole text content\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">\n\n</span><span class=\"c\"># returns whole text content, but remove newlines (\\n)\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">remove_newlines=True</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the beginning\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">from_start=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the end\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">from_end=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns all chars between Simple and File\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">between=Simple???File</span><span class=\"p\">\n\n</span><span class=\"c\"># matches to text between Simple and end of file.\n# Returns 6 characters from the beginning of match.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">between=Simple???</span><span class=\"p\">       </span><span class=\"c\">from_start=6</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">remove_newlines : bool - Remove newlines (\\n) from returned text (True/False)</div>\n</div>\n</div>\n</dd>\n</dl>\n<p>Note that you must use named arguments with this keyword, i.e. use\n<tt class=\"docutils literal\">argument_name=value</tt> format!</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text content from a plain text file.", "tags": ["File", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 147}, {"name": "Get Input Value", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "remove_newlines", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remove_newlines: bool = True"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get input value from input field.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">       </span><span class=\"c\">Submit</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">someattrs</span><span class=\"p\">      </span><span class=\"c\">from_end=3</span><span class=\"p\">  </span><span class=\"c\">int=True</span><span class=\"p\">\n</span><span class=\"c\">#Return empty if there is not value in input element:\n${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">       </span><span class=\"c\">blind=True</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">r?OrderNro/c1</span><span class=\"p\">    </span><span class=\"c\">My Order</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>remove_newlines <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Removes new lines (n)from string, especially from multirow text areas. Default = True</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n<div class=\"line\">blind : True - Return empty instead of error if input element is empty</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Get input value from input field.", "tags": ["Getters", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 592}, {"name": "Get List", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get value(s) from a list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${LIST}</span><span class=\"p\">         </span><span class=\"c\">GetList</span><span class=\"p\">         </span><span class=\"c\">#Get list to variable\n${VAL}</span><span class=\"p\">          </span><span class=\"c\">GetList</span><span class=\"p\">      </span><span class=\"c\">2</span><span class=\"p\">  </span><span class=\"c\">#Get value from list index 2\n#Get substring from list index 1\n${VAL}</span><span class=\"p\">          </span><span class=\"c\">GetList</span><span class=\"p\">      </span><span class=\"c\">1</span><span class=\"p\">  </span><span class=\"c\">between=word???another</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index:</dt>\n<dd>if given, gets text only from that index.</dd>\n<dt>kwargs:</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Get value(s) from a list.", "tags": ["Getters", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 195}, {"name": "Get Pdf Text", "args": [{"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text content from pdf file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePdf</span><span class=\"p\">     </span><span class=\"c\">dummy.pdf</span><span class=\"p\">\n</span><span class=\"c\"># returns whole PDF content\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">\n\n</span><span class=\"c\"># returns whole PDF content, but remove newlines (\\n)\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">remove_newlines=True</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the beginning\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">from_start=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the end\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">from_end=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns all chars between Simple and File\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">between=Simple???File</span><span class=\"p\">\n\n</span><span class=\"c\"># matches to text between Simple and end of file.\n# Returns 6 characters from the beginning of match.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">between=Simple???</span><span class=\"p\">       </span><span class=\"c\">from_start=6</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">remove_newlines : bool - Remove newlines (\\n) from returned text (True/False)</div>\n</div>\n</div>\n</dd>\n</dl>\n<p>Note that you must use named arguments with this keyword, i.e. use\n<tt class=\"docutils literal\">argument_name=value</tt> format!</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text content from pdf file.", "tags": ["File", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 95}, {"name": "Get Selected", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get selected option to variable from dropdown menu/list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example we get selected value from dropdown Canis.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">             </span><span class=\"c\">#last row, third cell\n${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">      </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">unicode</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">unicode</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: unicode</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<dl class=\"docutils\">\n<dt>selected: str</dt>\n<dd>With multiselection dropdowns returns a string containing all values\nseparated by comma (&quot;,&quot;)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Get selected option to variable from dropdown menu/list.", "tags": ["Dropdown", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 186}, {"name": "Get Table Row", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get row (index) from current table.</p>\n<p>Get table row by some visible text or value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">//last</span><span class=\"p\">          </span><span class=\"c\">#returns table length(last row)\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">#return first row which contain text Qentinel\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">2</span><span class=\"p\">     </span><span class=\"c\">#second row with text Qentinel\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">Sepi</span><span class=\"p\">  </span><span class=\"c\">#row contains texts Qentinel &amp; Sepi\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">skip_header=True</span><span class=\"p\">  </span><span class=\"c\">#start counting from first tc row</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or value which is presented in wanted row or //last = last row of the table</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If locator is not unique use anchor to tell which is correct. Anchor can be some text/value\nin same row than locator text or index. 1=first match etc. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get row (index) from current table.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 294}, {"name": "Get Text", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text from element specified by xpath.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">GetText</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">#uses text as a locator:\nGetText</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">       </span><span class=\"c\">between=click???me #returns _</span><span class=\"p\">\n</span><span class=\"c\">#uses any attribute of some div as locator:\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">#returns 5 first chars\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_end=5</span><span class=\"p\">    </span><span class=\"c\">#returns 5 last\n#returns last 5 chars before text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=???Foo</span><span class=\"p\">  </span><span class=\"c\">from_end=5</span><span class=\"p\">\n</span><span class=\"c\">#returns first 5 chars before text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=Foo???</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">\n</span><span class=\"c\">#returns first 5 chars before text Foo and text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">   </span><span class=\"c\">between=Foo???</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">include_locator=True</span><span class=\"p\">\n</span><span class=\"c\">#returns last 5 chars before text Foo and text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=???Foo</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">exclude_post=False</span><span class=\"p\">\n</span><span class=\"c\">GetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">int=True</span><span class=\"p\">    </span><span class=\"c\">#return integer\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_start=3</span><span class=\"p\">    </span><span class=\"c\">float=True</span><span class=\"p\">  </span><span class=\"c\">#return float\n</span><span class=\"p\">\n</span><span class=\"c\"># Get text between &quot; characters. Since one character separator will match the first\n# instance, it's better to include parts of words right before or after them.\n# Let's assume full text would return:\n# Case &quot;1234567&quot; was created.\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">between=Case &quot;???&quot; was</span><span class=\"p\">  </span><span class=\"c\"># Would return 1234567</span>\n</pre>\n<p>Note: when using 'between' argument, separators are expected to be unique, preferably words.\nIf you want to get text between one character separators like &quot;,\nit's best to include parts from words right before or after them. See the last example above.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some attribute of wanted element or Xpath expression without xpath= prefix.\nWhen using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait that element is found before failing.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>text : Xpath value text</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Text\" class=\"name\">Is Text</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text from element specified by xpath.", "tags": ["Getters", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 818}, {"name": "Get Text Count", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get count of appearances for given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>GetTextCount does not require for the text to be unique.\nReturn count of appearances for given tex.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetTextCount</span><span class=\"p\">      </span><span class=\"c\">Canis</span><span class=\"p\">  </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>, <a href=\"#Verify%20Text%20Count\" class=\"name\">VerifyTextCount</a></p>\n</div>\n</div>\n", "shortdoc": "Get count of appearances for given text.", "tags": ["Getters", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 301}, {"name": "Get Timeout", "args": [{"name": "kwargs", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs: Any"}], "doc": "<div class=\"document\">\n</div>\n", "shortdoc": "", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\internal\\decorators.py", "lineno": 177}, {"name": "Get Title", "args": [], "doc": "<div class=\"document\">\n<p>Gets the title of current page/window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${title}=</span><span class=\"p\">   </span><span class=\"c\">GetTitle</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Gets the title of current page/window.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 377}, {"name": "Get Url", "args": [], "doc": "<div class=\"document\">\n<p>Gets current url/location.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${url}=</span><span class=\"p\">   </span><span class=\"c\">GetUrl</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>,<a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Gets current url/location.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 315}, {"name": "Get Webelement", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get Webelement using any Qword -stylish locator.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using attributes or xpaths like with ClickElement etc. kw:s without specified\nelement_type. Result is a type of list unless <strong>index</strong> or <strong>element_type</strong> is given:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span>\n</pre>\n<p>Get element using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">input[type=button]:nth-child(10)</span><span class=\"p\">    </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Qwords like ClickText/Item, TypeText, Dropdown etc.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Get Webelement using any Qword -stylish locator.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 420}, {"name": "Go To", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Switch current page to given url.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">GoTo</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">\n</span><span class=\"c\">GoTo</span><span class=\"p\">    </span><span class=\"c\">file://resources/window.html</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>UnexpectedAlertPresentException</dt>\n<dd>If the page opens with alert popup</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Switch current page to given url.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 30}, {"name": "Hotkey", "args": [{"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Performs key down presses on the arguments passed in order, then performs\nkey releases in reverse order.</p>\n<p>The effect is that calling hotkey('ctrl', 'shift', 'c') would perform a\n&quot;Ctrl-Shift-C&quot; hotkey/keyboard shortcut press.</p>\n<dl class=\"docutils\">\n<dt>Args:</dt>\n<dd><dl class=\"first last docutils\">\n<dt>key(s) (str): The series of keys to press, in order. This can also be a</dt>\n<dd>list of key strings to press.</dd>\n<dt>interval (float, optional): The number of seconds in between each press.</dt>\n<dd>0.0 by default, for no pause in between presses.</dd>\n</dl>\n</dd>\n<dt>Returns:</dt>\n<dd>None</dd>\n</dl>\n</div>\n", "shortdoc": "Performs key down presses on the arguments passed in order, then performs key releases in reverse order.", "tags": [], "source": "c:\\Users\\TuomasKoukkari\\Documents\\qweb\\.venv\\lib\\site-packages\\pyautogui\\__init__.py", "lineno": 1694}, {"name": "Hover Element", "args": [{"name": "xpath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover the element specified by the xpath selector.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;hover_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">HoverElement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id=&quot;hover_me&quot;]</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll\" class=\"name\">Scroll</a>,\n<a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Hover the element specified by the xpath selector.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 154}, {"name": "Hover Item", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover over item.</p>\n<p>Hover over web element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal</span>\n</pre>\n<p>Hover can be chained. For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal</span><span class=\"p\">\n</span><span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal sub</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Element to be hovered-over.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Hover over item.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 645}, {"name": "Hover Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover over text.</p>\n<p>Keyword will fail if text is not visible. You should use VerifyText before HoverText\nif you are not sure text is already visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>Hover can be chained. For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">\n</span><span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis sub</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be hovered-over.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Hover over text.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 604}, {"name": "Is Alert", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1s"}], "doc": "<div class=\"document\">\n<p>Return True/False if alert is found on the screen.</p>\n<p>Used to get alert presence to variable. This keyword returns after alert is found.</p>\n<p>Returns True if alert is found. Returns False if alert is not found within timeout.</p>\n<p>If timeout is not set, keyword returns immediately.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">IsAlert</span><span class=\"p\">     </span><span class=\"c\">2s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if alert is found on the screen.", "tags": ["Alert", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 57}, {"name": "Is Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<div class=\"document\">\n<p>Return True if cookie with name and value is found.</p>\n<p>Cookies are a good way to detect if user has already logged in.\nThis keyword can be used in appstate.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">IsCookie</span><span class=\"p\">    </span><span class=\"c\">domain</span><span class=\"p\">    </span><span class=\"c\">google.fi</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>name <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Cookie dictionary key name</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Expected value for key name</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Delete%20All%20Cookies\" class=\"name\">DeleteAllCookies</a>, <a href=\"#List%20Cookies\" class=\"name\">ListCookies</a></p>\n</div>\n</div>\n", "shortdoc": "Return True if cookie with name and value is found.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 80}, {"name": "Is Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1s"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True if element is visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsElement</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsElement</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to appear before returning. Default 0.1s</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a>, <a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>,\n<a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a>, <a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Return True if element is visible.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 253}, {"name": "Is Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Check is the icon on the screen.</p>\n<p>In case you want to use this keyword you always have to have reference images.\nIf reference image are not in default folders (images, files, downloads) then\nBASE_IMAGE_PATH should be defined in a robot file before using this keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${status}</span><span class=\"p\">    </span><span class=\"c\">IsIcon</span><span class=\"p\">    </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Verify image with stricter tolerance and comparing colors\n${status}</span><span class=\"p\">    </span><span class=\"c\">IsIcon</span><span class=\"p\">    </span><span class=\"c\">plane_red</span><span class=\"p\">    </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">    </span><span class=\"c\">grayscale=False</span>\n</pre>\n<p>${status} will be True or False.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Capture%20Icon\" class=\"name\">CaptureIcon</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Check is the icon on the screen.", "tags": ["Icon", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 119}, {"name": "Is Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check if Item (usually icon or picture) exists.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed or item is found.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<p>IsItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${exists}=</span><span class=\"p\">  </span><span class=\"c\">IsItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the IsItem keyword returns True if element which\nhas attribute Canis exists.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <span class=\"name\">IsNoItem, </span>VerifyItem`</p>\n</div>\n</div>\n", "shortdoc": "Check if Item (usually icon or picture) exists.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1127}, {"name": "Is No Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check if Item (usually icon or picture) does not exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed or element disappears from the screen.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<p>IsNoItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${exists}=</span><span class=\"p\">  </span><span class=\"c\">IsNoItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the IsNoItem keyword returns True if element which\nhas attribute Canis disappears from the screen before timeout expires.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <span class=\"name\">IsItem, </span>VerifyItem`</p>\n</div>\n</div>\n", "shortdoc": "Check if Item (usually icon or picture) does not exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1181}, {"name": "Is No Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "2s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 2s"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True/False if text is found on the screen.</p>\n<p>Used to get text presence info to variable. This keyword returns if text is not visible or\nwhen it disappears.</p>\n<p>If text does not disappear, keyword returns False after timeout is exceeded.</p>\n<p>If timeout is not set, keyword returns immediately.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before returning. Default 0.1s</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if text is found on the screen.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 729}, {"name": "Is Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.5s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.5s"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True/False if text is found on the screen.</p>\n<p>Used to get text presence to variable. This keyword returns after text is found.</p>\n<p>Returns True if text is found. Returns False if text is not found within timeout.</p>\n<p>If timeout is not set, default timeout of 0.5 sec is used.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to appear before returning. Default 0.5s</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Is%20No%20Text\" class=\"name\">IsNoText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if text is found on the screen.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 689}, {"name": "List Cookies", "args": [{"name": "log", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log: bool = True"}], "doc": "<div class=\"document\">\n<p>List all cookies in browser.</p>\n<p>Cookies can be only listed when browser is open. Cookies are automatically\ndeleted when you Close All Browsers.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ListCookies</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>log <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>If true, log list of cookies to html log file. If False, only returns cookie list.\nDefault is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Delete%20All%20Cookies\" class=\"name\">DeleteAllCookies</a>, <a href=\"#Is%20Cookie\" class=\"name\">IsCookie</a></p>\n</div>\n</div>\n", "shortdoc": "List all cookies in browser.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 51}, {"name": "Log Page", "args": [], "doc": "<div class=\"document\">\n<p>Save and log current html.</p>\n<p>The html content is saved as html file in the same folder where log is.\nThe current page and the link to it are represented in the log in\niframe so it one can see the page as it was.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">LogPage</span>\n</pre>\n</div>\n<div class=\"section\" id=\"note\">\n<h1>Note</h1>\n<p>Does not handle frames.</p>\n</div>\n<div class=\"section\" id=\"todo\">\n<h1>Todo</h1>\n<p>Replace relative paths in the src and href attributes. This way we get\ncss properties and icons.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Log%20Screenshot\" class=\"name\">LogScreenshot</a></p>\n</div>\n</div>\n", "shortdoc": "Save and log current html.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 145}, {"name": "Log Screenshot", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshot_{}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = screenshot_{}.png"}, {"name": "fullpage", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullpage: bool = False"}], "doc": "<div class=\"document\">\n<p>Log screenshot to Robot Framework log.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">LogScreenshot</span><span class=\"p\">\n</span><span class=\"c\">${file}=</span><span class=\"p\">     </span><span class=\"c\">LogScreenshot</span><span class=\"p\">  </span><span class=\"c\"># returns full path to saved image file</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><p class=\"first\">Filename where the screenshot is saved.</p>\n<p class=\"last\">Note: if given filename exceeds operating system's limit for a filename length\n(usually 255 characters), this keyword will fail.</p>\n</dd>\n<dt>fullpage <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Capture full page screenshot instead of visible area only (if browser/driver supports it).</div>\n<div class=\"line\">Currently supported in Firefox and Chromium based browsers (Chrome/Edge).</div>\n<div class=\"line\">Default: False (visible area only)</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>filepath : full path to saved screenshot</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Log%20Page\" class=\"name\">LogPage</a></p>\n</div>\n</div>\n", "shortdoc": "Log screenshot to Robot Framework log.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\screenshot.py", "lineno": 37}, {"name": "Maximize Window", "args": [], "doc": "<div class=\"document\">\n<p>Maximizes current browser window.</p>\n<dl class=\"docutils\">\n<dt>Note: This keyword will not fail if maximizing is prevented for some reason.</dt>\n<dd>This can happen for example if window manager is not installed or setup correctly.</dd>\n</dl>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">MaximizeWindow</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>,<a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Maximizes current browser window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 275}, {"name": "Move Files", "args": [{"name": "files_to_move", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "files_to_move: str"}, {"name": "destination_folder", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "destination_folder: str"}], "doc": "<div class=\"document\">\n<p>Move files.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">MoveFiles</span><span class=\"p\">           </span><span class=\"c\">cat1.jpg</span><span class=\"p\">      </span><span class=\"c\">C:/secret_cat_pictures</span><span class=\"p\">\n</span><span class=\"c\">MoveFiles</span><span class=\"p\">           </span><span class=\"c\">cat1.jpg, cat666.jpg, cat4.jpg</span><span class=\"p\">      </span><span class=\"c\">C:/secret_cat_pictures</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>files_to_move <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Files to move, separated by &quot;,&quot; in case of multiple files.</dd>\n<dt>destination_folder <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Destination folder of the moved files.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a></p>\n</div>\n</div>\n", "shortdoc": "Move files.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 409}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "browser_alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "browser_alias: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "options: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Open new browser to given url.</p>\n<p>Browser options can also be given in the robot command, for example:\nrobot -v browser_options:&quot;--kiosk, --disable-gpu&quot; testytest.robot</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Basic usage\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">file://resources/window.html</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n\n</span><span class=\"c\"># Multiple options\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">--allow-running-insecure-content, --xyz</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-headless, -private, -xyz</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">edge</span><span class=\"p\">      </span><span class=\"c\">-headless, -inprivate, -xyz</span><span class=\"p\">\n\n</span><span class=\"c\"># Multiple preferences\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">prefs=&quot;opt1&quot;:&quot;True&quot;, &quot;opt2&quot;:&quot;False&quot;</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">prefs=&quot;option1&quot;:&quot;value1&quot;, &quot;option2&quot;:&quot;value2&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Supply preferences from a dictionary\n${prefs_d}=</span><span class=\"p\">    </span><span class=\"c\">Create Dictionary</span><span class=\"p\">     </span><span class=\"c\">option1</span><span class=\"p\">    </span><span class=\"c\">value1</span><span class=\"p\">    </span><span class=\"c\">option2</span><span class=\"p\">    </span><span class=\"c\">value2</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">    </span><span class=\"c\">prefs=${prefs_d}</span><span class=\"p\">\n\n</span><span class=\"c\"># Common examples:\n# ----------------\n</span><span class=\"p\">\n</span><span class=\"c\"># Use existing profile\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-profile /path/to/profile</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">--user-data-dir\\=C:\\\\temp,--profile-directory\\=Test2</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-private</span><span class=\"p\">    </span><span class=\"c\">prefs=&quot;option1&quot;:&quot;value1&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Use portable browser / non-standard installation path / specific driver\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:support</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">binary=C:/Users/SomeUser/temp/FirefoxPortable/App/Firefox64/firefox.exe</span><span class=\"p\">\n</span><span class=\"c\"># Use Chromium instead of Chrome:\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">chrome_path=/path/to/chromium/chrome.exe</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">executable_path=/path/to/my/chromedriver.exe</span><span class=\"p\">\n\n</span><span class=\"c\"># Use proxy\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">--proxy_server\\=http://127.0.0.1:8080</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">prefs=&quot;network.proxy.type&quot;:&quot;1&quot;,&quot;network.proxy.http&quot;:&quot;localhost&quot;,&quot;network.proxy.http_port&quot;:&quot;8080&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Make Chrome download pdf files instead of opening them\nOpen Browser</span><span class=\"p\">    </span><span class=\"c\">about:blank</span><span class=\"p\">         </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...prefs=download.prompt_for_download: False, plugins.always_open_pdf_externally: True</span><span class=\"p\">\n\n</span><span class=\"c\"># Disable &quot;Save Address&quot; and &quot;Save Credit Card details&quot; dialogs on Chrome.\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:blank</span><span class=\"p\">           </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">prefs=&quot;autofill.profile_enabled&quot;:false, &quot;autofill.credit_card_enabled&quot;:false</span><span class=\"p\">\n\n</span><span class=\"c\"># Mobile emulation\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">emulation=iPhone SE</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">emulation=375x812</span>\n</pre>\n</div>\n<div class=\"section\" id=\"selenium-manager\">\n<h1>Selenium Manager</h1>\n<p>Selenium Manager's automatic browser and driver management is available for Chrome, Firefox\nand Edge. To use specific browser version, add <cite>browser_version</cite> keyword argument.\nIf matching browser &amp; driver(s) can be found in path, they will be used. If not, Selenium\nManager tries to download and install them. With Chrome also specific version of\nbrowser (&quot;Chrome for Testing&quot;) can be used.\nNote that for Edge in Windows local admin rights are required!</p>\n<p>More info:\n<a class=\"reference external\" href=\"https://www.selenium.dev/documentation/selenium_manager/#automated-browser-management\">https://www.selenium.dev/documentation/selenium_manager/#automated-browser-management</a></p>\n<p><strong>NOTE</strong>: if you are using QWeb in some cloud service,\nit's best to use their method of setting browser version.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If Chrome 124 is already installed, it will be used.\n# If not, Chrome for Testing v124 will be downloaded and used.\nOpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">browser_version=124</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">browser_version=124</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">edge</span><span class=\"p\">      </span><span class=\"c\">browser_version=124</span>\n</pre>\n</div>\n<div class=\"section\" id=\"browserstack-usage\">\n<h1>BrowserStack usage</h1>\n<p>QWeb can be directly used with BrowserStack for desktop and mobile browser\ntesting. Your own Browserstack credentials are required.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Using BrowserStack for DESKTOP browser testing\n</span><span class=\"p\">\n</span><span class=\"c\"># Note that these variables can be given in run command\n${PROVIDER}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">bs</span><span class=\"p\">\n</span><span class=\"c\">${USERNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_username</span><span class=\"p\">\n</span><span class=\"c\">${APIKEY}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_token</span><span class=\"p\">\n</span><span class=\"c\">${PROJECTNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${RUNID}=</span><span class=\"p\">       </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${BSOS}=</span><span class=\"p\">        </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">windows</span><span class=\"p\">  </span><span class=\"c\"># optional, default is windows\nOpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">\n\n</span><span class=\"c\">${BSOS}=</span><span class=\"p\">        </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">osx</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n</span><span class=\"c\"># Different os version, browser version and resolution\n${BSOSVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Monterey</span><span class=\"p\">\n</span><span class=\"c\">${BROWSERVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">15</span><span class=\"p\">\n</span><span class=\"c\">${BSRESOLUTION}=</span><span class=\"p\">   </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">2560x1440</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">        </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n\n</span><span class=\"c\"># Using BrowserStack for MOBILE browser testing\n${PROVIDER}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">bs</span><span class=\"p\">\n</span><span class=\"c\">${USERNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_username</span><span class=\"p\">\n</span><span class=\"c\">${APIKEY}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_token</span><span class=\"p\">\n</span><span class=\"c\">${DEVICE}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Google Pixel 4</span><span class=\"p\">\n</span><span class=\"c\">${PROJECTNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${RUNID}=</span><span class=\"p\">       </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">qweb_run_id</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">          </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n</span><span class=\"c\"># Change to Android device and use specific Android version\n${DEVICE}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Google Pixel 4</span><span class=\"p\">\n</span><span class=\"c\">${BSOSVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">11</span><span class=\"p\">  </span><span class=\"c\"># optional\nOpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span>\n</pre>\n</div>\n<div class=\"section\" id=\"mobile-emulation\">\n<h1>Mobile emulation</h1>\n<p>Giving a valid device profile or screen dimensions in &quot;emulation&quot; argument turns on\n&quot;mobile emulation&quot;.</p>\n<p>Supported browsers: desktop Chrome and Edge only.</p>\n<p>See examples above. Always make sure the device profile name exists. You can either define\na new one or use one of the default profiles:</p>\n<blockquote>\n<ul class=\"simple\">\n<li>iPhone SE</li>\n<li>iPhone XR</li>\n<li>iPhone 12 Pro</li>\n<li>Pixel 5</li>\n<li>Samsung Galaxy S8+</li>\n<li>Samsung Galaxy S20 Ultra</li>\n<li>iPad Air</li>\n<li>iPad Mini</li>\n<li>Surface Pro 7</li>\n<li>Surface Duo</li>\n<li>Galaxy Fold</li>\n<li>Samsung Glazy A51/71</li>\n<li>Nest Hub</li>\n<li>Nest Hub Max</li>\n</ul>\n</blockquote>\n<p>Note that profile names given above are expected to change in new browser releases.\nAlways check that the name you are using still exists.</p>\n</div>\n<div class=\"section\" id=\"local-android-device-usage\">\n<h1>Local Android device usage</h1>\n<p>QWeb can be used with local Android device with Chrome. Note that this requires\nAndroid SDK and Appium to be installed in local machine, developer options enabled\nin mobile and USB debugging enabled.</p>\n<p>NOTE: that this feature is not officially supported nor tested in every release. We\ncan't guarantee that it will work with every future release and we can't offer support for Android\nside setup.</p>\n<p>Once you have installed Android SDK, starter Appium server and have your local\nAndroid device plugged in with USB cable, you can run QWeb against local Chrome\nwith the following command:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:support</span><span class=\"p\">    </span><span class=\"c\">android</span>\n</pre>\n<p>To check if your device is correctly connected, run:\n<cite>adb devices</cite> on your terminal and verify that your device is listed.</p>\n</div>\n<div class=\"section\" id=\"experimental-feature-for-test-debugging-for-chrome-only\">\n<h1>Experimental feature for test debugging (for Chrome only):</h1>\n<p>To re-use existing Chrome browser session, you need to set variable BROWSER_REUSE_SESSION\nto True. Next you need to run the first test suite normally including <cite>OpenBrowser</cite> AND\nexcluding <cite>CloseBrowser</cite> (e.g. in Tear Down section). The first run will result to\narguments file in defined output directory. The file name is by default <cite>browser_session.arg</cite>.</p>\n<p>For the next runs, which re-use the existing browser session, you need to specify the argument\nfile in robot command-line using <cite>--argumentfile</cite> parameter. Additionally, test\nsuites (or debugger) has to run <cite>OpenBrowser</cite> normally. QWeb will automatically override\nnormal parameters and use argument file's values instead, thus re-using the existing browser.</p>\n<p>In the first test suite open Chrome browser normally without closing it at the tear down:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set Global Variable</span><span class=\"p\">   </span><span class=\"c\">${BROWSER_REUSE_ENABLED}</span><span class=\"p\">   </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">           </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span>\n</pre>\n<p>By running above, an argument file <cite>browser_session.arg</cite> is created to the output\ndirectory or current working directory. To re-use the existing browser session, use\nfollowing command line examples:</p>\n<pre class=\"code text literal-block\">\nrobot --argumentfile &lt;path&gt;/browser_session.arg ... example.robot\nrfdebug --argumentfile &lt;path&gt;/browser_session.arg\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n<dt>browser_alias <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Browser name. For example chrome, firefox or ie.</dd>\n<dt>options</dt>\n<dd>Arguments for initialization of WebDriver objects(chrome).\nSome available opts: <a class=\"reference external\" href=\"https://peter.sh/experiments/chromium-command-line-switches/\">https://peter.sh/experiments/chromium-command-line-switches/</a></dd>\n<dt>kwargs</dt>\n<dd><dl class=\"first last docutils\">\n<dt>prefs=args:</dt>\n<dd>Experimental options for chrome browser.</dd>\n<dt>emulation:</dt>\n<dd>Turns on &quot;mobile emulation&quot; in desktop browser. Useful for testing websites\nsimulating a mobile device screen dimensions.\nSupported browsers: desktop Chrome and Edge only.\nExisting device profile name (i.e. &quot;iPhone SE&quot;, must exist)\nOR device dimensions in format:\nWIDTHxHEIGHT (i.e. 385x812)</dd>\n</dl>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Unknown browser type</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Get%20Title\" class=\"name\">GetTitle</a>,\n<a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Return%20Browser\" class=\"name\">ReturnBrowser</a>,\n<a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Open new browser to given url.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 65}, {"name": "Open Window", "args": [], "doc": "<div class=\"document\">\n<p>Open new tab.</p>\n<p>Uses javascript to do this so javascript has to be enabled.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenWindow</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>,\n<a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Open new tab.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 61}, {"name": "Press Key", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Simulate user pressing keyboard key on element identified by &quot;locator&quot;.</p>\n<p>The parameter &quot;key&quot; is either a single character or a keyboard key combination\nsurrounded by '{ }'.</p>\n<p>If ${EMPTY} is given as a locator, &quot;global&quot; hotkey combination is sent and handled by the OS.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">q</span><span class=\"p\">\n</span><span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{ENTER}</span><span class=\"p\">\n</span><span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + A}</span><span class=\"p\">    </span><span class=\"c\"># Select all\nPressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + C}</span><span class=\"p\">    </span><span class=\"c\"># Copy selected text\nPressKey</span><span class=\"p\">    </span><span class=\"c\">other_field</span><span class=\"p\">    </span><span class=\"c\">{CONTROL + V}</span><span class=\"p\">    </span><span class=\"c\"># Paste copied text\nPressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{PASTE}</span><span class=\"p\">          </span><span class=\"c\"># Paste copied text\n</span><span class=\"p\">\n</span><span class=\"c\"># Send ESC keypress without locator and let OS decide how it's consumed\n# on Windows this opens task manager\nPressKey</span><span class=\"p\">    </span><span class=\"c\">${EMPTY}</span><span class=\"p\">       </span><span class=\"c\">{CTRL + SHIFT + ESC}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"notes\">\n<h1>Notes</h1>\n<p>Below is a list of supported keys that can be sent to a web element,\nin addition to keys that consist of a single character (like 'c' or '?'):</p>\n<p>'ADD', 'ALT', 'ARROW_DOWN', 'ARROW_LEFT', 'ARROW_RIGHT', 'ARROW_UP', 'BACKSPACE', 'BACK_SPACE',\n'CANCEL', 'CLEAR',COMMAND', 'CONTROL', 'DECIMAL', 'DELETE', 'DIVIDE', 'DOWN', 'END', 'ENTER',\n'EQUALS', 'ESCAPE', 'F1', 'F10', 'F11', 'F12', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9',\n'HELP', 'HOME', 'INSERT', 'LEFT', 'LEFT_ALT', 'LEFT_CONTROL', 'LEFT_SHIFT', 'META', 'MULTIPLY',\n'NULL', 'NUMPAD0', 'NUMPAD1', 'NUMPAD2', 'NUMPAD3', 'NUMPAD4', 'NUMPAD5', 'NUMPAD6', 'NUMPAD7',\n'NUMPAD8', 'NUMPAD9', 'PAGE_DOWN', 'PAGE_UP', 'PAUSE', 'RETURN', 'RIGHT', 'SEMICOLON',\n'SEPARATOR', 'SHIFT', 'SPACE', 'SUBTRACT', 'TAB', 'UP', 'ZENKAKU_HANKAKU'</p>\n</div>\n<div class=\"section\" id=\"notes-1\">\n<h1>Notes</h1>\n<p>Below is a list of supported keys names that can be used as &quot;global&quot; hotkeys,\nin addition to keys that consist of a single character (like 'c' or '?'):</p>\n<p>'ACCEPT', 'ADD', 'ALT', 'ALTLEFT', 'ALTRIGHT', 'APPS', 'BACKSPACE', 'BROWSERBACK',\n'BROWSERFAVORITES', 'BROWSERFORWARD', 'BROWSERHOME', 'BROWSERREFRESH', 'BROWSERSEARCH',\n'BROWSERSTOP', 'CAPSLOCK', 'CLEAR','CONVERT', 'CTRL', 'CTRLLEFT', 'CTRLRIGHT', 'DECIMAL',\n'DEL', 'DELETE', 'DIVIDE', 'DOWN', 'END', 'ENTER', 'ESC', 'ESCAPE', 'EXECUTE', 'F1', 'F10',\n'F11', 'F12', 'F13', 'F14', 'F15', 'F16', 'F17', 'F18', 'F19','F2', 'F20', 'F21', 'F22',\n'F23', 'F24', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'FINAL', 'FN', 'HANGUEL', 'HANGUL',\n'HANJA', 'HELP', 'HOME', 'INSERT', 'JUNJA', 'KANA', 'KANJI', 'LAUNCHAPP1', 'LAUNCHAPP2',\n'LAUNCHMAIL', 'LAUNCHMEDIASELECT', 'LEFT', 'MODECHANGE', 'MULTIPLY', 'NEXTTRACK', 'NONCONVERT',\n'NUM0', 'NUM1', 'NUM2', 'NUM3', 'NUM4', 'NUM5', 'NUM6', 'NUM7', 'NUM8', 'NUM9', 'NUMLOCK',\n'PAGEDOWN', 'PAGEUP', 'PAUSE', 'PGDN', 'PGUP', 'PLAYPAUSE', 'PREVTRACK', 'PRINT',\n'PRINTSCREEN', 'PRNTSCRN', 'PRTSC', 'PRTSCR', 'RETURN', 'RIGHT', 'SCROLLLOCK', 'SELECT',\n'SEPARATOR', 'SHIFT', 'SHIFTLEFT', 'SHIFTRIGHT', 'SLEEP', 'SPACE', 'STOP', 'SUBTRACT',\n'TAB', 'UP', 'VOLUMEDOWN', 'VOLUMEMUTE', 'VOLUMEUP', 'WIN', 'WINLEFT', 'WINRIGHT, 'YEN',\n'COMMAND', 'OPTION', 'OPTIONLEFT', 'OPTIONRIGHT'</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Simulate user pressing keyboard key on element identified by \"locator\".", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 737}, {"name": "Refresh Page", "args": [], "doc": "<div class=\"document\">\n<p>Refresh the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RefreshPage</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Refresh the current window.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 84}, {"name": "Remove File", "args": [{"name": "file", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "file: str | None = None"}], "doc": "<div class=\"document\">\n<p>Remove a file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">        </span><span class=\"c\">yoink.pdf</span><span class=\"p\">\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">\n\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/Desktop/yoink.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Move%20Files\" class=\"name\">MoveFiles</a>, <a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a></p>\n</div>\n</div>\n", "shortdoc": "Remove a file.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 308}, {"name": "Remove Pdf", "args": [], "doc": "<div class=\"document\">\n<p>Remove a file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">        </span><span class=\"c\">yoink.pdf</span><span class=\"p\">\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">\n\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/Desktop/yoink.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Move%20Files\" class=\"name\">MoveFiles</a>, <a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a></p>\n</div>\n</div>\n", "shortdoc": "Remove a file.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 333}, {"name": "Reset Config", "args": [{"name": "par", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "par: str | None = None"}], "doc": "<div class=\"document\">\n<p>Reset the value of given parameter to default value.</p>\n<p>If no parameter is given, reset all\nparameters configuration parameters to their defaults.\nReset also returns the value of the given configuration parameter. If no parameter is given, the\nResetConfig returns all configurations in a python dictionary with configuration parameter\nname and their values.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VAL}</span><span class=\"p\">      </span><span class=\"c\">ResetConfig</span><span class=\"p\">    </span><span class=\"c\">default timeout</span><span class=\"p\">   </span><span class=\"c\"># resets single parameter, and returns value\n${VAL}</span><span class=\"p\">      </span><span class=\"c\">ResetConfig</span><span class=\"p\">                      </span><span class=\"c\"># Resets all parameters, and returns config</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Config\" class=\"name\">GetConfig</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Reset the value of given parameter to default value.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 1050}, {"name": "Return Browser", "args": [], "doc": "<div class=\"document\">\n<p>Return browser instance.</p>\n<p>Use this function if you need to expand QWeb and require direct browser access.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ReturnBrowser</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a></p>\n</div>\n</div>\n", "shortdoc": "Return browser instance.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 45}, {"name": "Right Click", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Right clicks the element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a></p>\n</div>\n</div>\n", "shortdoc": "Right clicks the element.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 106}, {"name": "Run Block", "args": [{"name": "block", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "block: str"}, {"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Run Action word as decorated block.</p>\n<p>Block (usually set of keywords) is handled as one\nindependent action. If any keyword inside of block fails block\nwill retry itself until it passes or given time is up. Retrying is\nstarting from first line of executable block.</p>\n<p>This feature is meant to be used with RPA-cases where FAIL\nis not an option. Think twice before using with Test Automation\nprojects to avoid situations where we have green test even that\nin real life our user interface in SUT might be almost unusable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RunBlock</span><span class=\"p\">       </span><span class=\"c\">Poll</span><span class=\"p\">    </span><span class=\"c\">timeout=15</span><span class=\"p\">\n</span><span class=\"c\">#with arguments:\nRunBlock</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">${USER}</span><span class=\"p\">   </span><span class=\"c\">${PASS}</span><span class=\"p\">   </span><span class=\"c\">timeout=50</span><span class=\"p\">\n</span><span class=\"c\">#with &quot;teardown&quot;:\nRunBlock</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">${USER}</span><span class=\"p\">   </span><span class=\"c\">${PASS}</span><span class=\"p\">   </span><span class=\"c\">timeout=50</span><span class=\"p\">  </span><span class=\"c\">exp_handler=RebootBrowser</span><span class=\"p\">\n</span><span class=\"c\">#Example blocks:\nPOLL</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Click Counter</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">10 clicks</span><span class=\"p\">   </span><span class=\"c\">timeout=1</span><span class=\"p\">\n\n</span><span class=\"c\"># POLL is retried until VerifyText passes (ten times)\n</span><span class=\"p\">\n</span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">[Arguments]</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">Goto</span><span class=\"p\">        </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Password</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">Welcome, ${USER}</span><span class=\"p\">\n\n</span><span class=\"c\"># If for example VerifyText  Welcome, ${USER} fails, RunBlock\n# tries again, starting from first paceword (Goto).\n</span><span class=\"p\">\n</span><span class=\"c\">RebootBrowser</span><span class=\"p\">\n    </span><span class=\"c\">CloseAllBrowsers</span><span class=\"p\">\n    </span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">about:blank</span><span class=\"p\">     </span><span class=\"c\">chrome</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>block <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Action word/Block to execute</dd>\n<dt>args <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">any</span></dt>\n<dd>Possible args for block</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long we try to get is passed before failing. Default 10 (seconds)</dd>\n<dt>kwargs: any</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">exp_handler : Use any Action Word as a teardown. If</div>\n<div class=\"line\">defined, this will be executed after every failed try</div>\n<div class=\"line\">before retrying</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Appstate\" class=\"name\">Appstate</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Run Action word as decorated block.", "tags": ["Config", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\blocks.py", "lineno": 28}, {"name": "Save File", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "filename", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Save file using http-request.</p>\n<p>Needs url of the downloadable content which usually is in element's href attribute.\nText or tooltip can be used as a locator (Works as ClickText or ClickItem).\nIf locator element is not the one with href-attribute, tries to get href from closest\nparent with &lt;a&gt; tag in it.</p>\n<p>url can be used as a locator too.</p>\n<p>Available element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only).</em></p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">filename.pdf</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">filename.xml</span><span class=\"p\">\n\n</span><span class=\"c\"># Locators parent or child element is the one with href:\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">filename.pdf</span><span class=\"p\">    </span><span class=\"c\">child=a</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">filename.xml</span><span class=\"p\">    </span><span class=\"c\">parent=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Create folder for downloadable files:\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">pdf/filename.pdf</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">xml/filename.xml</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">Robot</span><span class=\"p\">         </span><span class=\"c\">pics/filename.png</span><span class=\"p\">\n\n</span><span class=\"c\"># Using url as locator\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">https://www.robot.fi/robot.xml</span><span class=\"p\">  </span><span class=\"c\">filename.xml</span><span class=\"p\">\n\n</span><span class=\"c\"># Get html content of given url\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">      </span><span class=\"c\">qentinel.html</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or item to be &quot;clicked&quot;.</dd>\n<dt>filename: str</dt>\n<dd>Wanted filename</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it.  (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>path <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Wanted path for files. Default path is users download folder.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">parent : str: tag name for clickable parent</div>\n<div class=\"line\">child : str: tag name for clickable child.</div>\n<div class=\"line\">index : str: use index if there is multiple</div>\n<div class=\"line\">childs with same tag name</div>\n<div class=\"line\">headers : dict -Pass headers to http request</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Expect%20File%20Download\" class=\"name\">ExpectFileDownload</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>,\n<a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a></p>\n</div>\n</div>\n", "shortdoc": "Save file using http-request.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\ajax.py", "lineno": 26}, {"name": "Scan Click", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>ClickUntil</cite> instead.</p>\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">\n</span><span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">    </span><span class=\"c\">1</span><span class=\"p\">          </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">  </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">3s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long to wait until text appear before clicking again</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text.\nel_type=item\ntext(default) = find element by visible text | item = find item type element</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `ClickUntil` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 467, "deprecated": true}, {"name": "Screenshot Type", "args": [{"name": "capture_method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "capture_method: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  ScreenshotType</cite> instead.</p>\n<p>Define how screenshot is taken. Default is normal screenshot.</p>\n<p>Html saves page as html frame in test log. All saves both image and html page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">html</span><span class=\"p\">\n</span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">screenshot</span><span class=\"p\">\n</span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">all</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  ScreenshotType` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 138, "deprecated": true}, {"name": "Scroll", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "direction", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "pagedown", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "direction: str = pagedown"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scrolls the page/element to given direction.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Scroll page down default value (one page)\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll page up\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">      </span><span class=\"c\">page_up</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll page right\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">      </span><span class=\"c\">right</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll to the bottom of a list using attribute value and tag\nScroll</span><span class=\"p\">  </span><span class=\"c\">uiScroller</span><span class=\"p\">    </span><span class=\"c\">bottom</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll to the top of a list using attribute value and tag\nScroll</span><span class=\"p\">  </span><span class=\"c\">uiScroller</span><span class=\"p\">    </span><span class=\"c\">top</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll (page) down 3 times in a list\nRepeat Keyword</span><span class=\"p\">     </span><span class=\"c\">3 times</span><span class=\"p\">    </span><span class=\"c\">Scroll</span><span class=\"p\">    </span><span class=\"c\">uiScroller</span><span class=\"p\">   </span><span class=\"c\">down</span><span class=\"p\">    </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath to scrollable element or attribute value of an scrollable element.</dd>\n<dt>direction <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><dl class=\"first last docutils\">\n<dt>Direction to scroll to (down, up, left, right, top, bottom, page_down, page_up).</dt>\n<dd><ul class=\"first last simple\">\n<li>Down/up/left/right map to respective ARROW keys.</li>\n<li>Top/Bottom map to HOME &amp; END keys.</li>\n<li>Page_up/Page_down map to PAGE_UP and PAGE_DOWN keys.</li>\n</ul>\n</dd>\n</dl>\n</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long to scroll in seconds, before timing out.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If direction is not given in correct format.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the given scrollable element is not found.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a></p>\n</div>\n</div>\n", "shortdoc": "Scrolls the page/element to given direction.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 833}, {"name": "Scroll Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scroll page until text is on top.</p>\n<p>Finds text on page and scrolls until it is on top. This is used with visual testing\ntools to align page properly.</p>\n<p>Keyword tries to scroll to element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollText</span><span class=\"p\">       </span><span class=\"c\">Address</span><span class=\"p\">\n</span><span class=\"c\">ScrollText</span><span class=\"p\">       </span><span class=\"c\">Address</span><span class=\"p\">    </span><span class=\"c\">Billing</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Scroll page until text is on top.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1235}, {"name": "Scroll To", "args": [{"name": "text_to_find", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_find: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "scroll_length", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scroll_length: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "120", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 120"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scroll a dynamic web page or scrollbar.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_find <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to find by scrolling a page or an element.</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator text for a scrollable element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Anchor used for the locator.</dd>\n<dt>scroll_length <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Amount of pixels per one scroll.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long to scroll in seconds, before timing out.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span>\n</pre>\n<p>In the above example, the web page is scrolled until the text &quot;Cat&quot; is found.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">scroll_length=2000</span>\n</pre>\n<p>In the above example, the web page is scrolled 2000 pixels per scroll, until the text &quot;Cat&quot; is\nfound.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">List of cats</span>\n</pre>\n<p>In the above example, a scrollbar located by a text &quot;List of cats&quot;, is scrolled until the text\n&quot;Cat&quot; is found.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">List of cats</span><span class=\"p\">    </span><span class=\"c\">scroll_length=2000</span>\n</pre>\n<p>In the above example, a scrollbar located by a text &quot;List of cats&quot;, is scrolled 2000 pixels\nper scroll until the text &quot;Cat&quot; is found.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>,\n<span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a></p>\n</div>\n</div>\n", "shortdoc": "Scroll a dynamic web page or scrollbar.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1427}, {"name": "Search Direction", "args": [{"name": "direction", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "direction: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  SearchDirection</cite> instead.</p>\n<p>Set search direction for element search.</p>\n<p>Search direction is &quot;up&quot;, &quot;down&quot;, &quot;left&quot;, &quot;right&quot; and &quot;closest&quot;</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SearchDirection</span><span class=\"p\">    </span><span class=\"c\">right</span><span class=\"p\">\n</span><span class=\"c\">SearchDirection</span><span class=\"p\">    </span><span class=\"c\">closest</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  SearchDirection` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 28, "deprecated": true}, {"name": "Set Active Area Function", "args": [{"name": "function", "type": {"name": "Callable", "typedoc": null, "nested": [{"name": "...", "typedoc": null, "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Callable[..., Any]"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: Callable[..., Any]"}], "doc": "<div class=\"document\">\n<p>Set function that sets active area where elements are searched.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>function <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">function</span></dt>\n<dd>Function that returns WebElement under which elements are searched.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Set function that sets active area where elements are searched.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\custom_config.py", "lineno": 39}, {"name": "Set Config", "args": [{"name": "par", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "par: str"}, {"name": "val", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "val: Any"}], "doc": "<div class=\"document\">\n<p>Set configuration parameter to given value. Return previous value.</p>\n<p>Summary of possible configurations and their purpose. More information below.</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"27%\" />\n<col width=\"53%\" />\n<col width=\"21%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">Parameter</th>\n<th class=\"head\">Description</th>\n<th class=\"head\">Default value</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td><a class=\"reference internal\" href=\"#activeareaxpath\">ActiveAreaXpath</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#allinputelements\">AllInputElements</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#blindreturn\">BlindReturn</a></td>\n<td>Return value without waiting</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#caseinsensitive\">CaseInsensitive</a></td>\n<td>Allow case insensitive search when\npartial match is used</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#checkinputvalue\">CheckInputValue</a></td>\n<td>Check that typed value is stored\ncorrectly after TypeText.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#clearkey\">ClearKey</a></td>\n<td>Set key to be clear previous value when\ntext is written to input field (or None)</td>\n<td>webdriver's\ndefault clear</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#clicktofocus\">ClickToFocus</a></td>\n<td>Sets focus by clicking the field before\ntyping.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#cssselectors\">CssSelectors</a></td>\n<td>Use CSS selectors for finding elements</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#delay\">Delay</a></td>\n<td>Wait time before each keyword</td>\n<td>0 (no delay)</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#defaultdocument\">DefaultDocument</a></td>\n<td>Automatically switch back to default\nframew after each keyword.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#defaulttimeout\">DefaultTimeout</a></td>\n<td>How long to wait for element to appear\nbefore failing the case.</td>\n<td>10s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#doubleclick\">DoubleClick</a></td>\n<td>Perform double-click action in all click\nkeywords.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#handlealerts\">HandleAlerts</a></td>\n<td>Automatically handle alerts.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#highlightcolor\">HighlightColor</a></td>\n<td>Sets the highlight color to use when\nelement is highlighted.</td>\n<td>blue</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#inputhandler\">InputHandler</a></td>\n<td>Use javascript, selenium or pyautogui\nto input text.</td>\n<td>selenium</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#inviewport\">InViewport</a></td>\n<td>If set to true every element outside of\ncurrent viewport is considered invisible\nand not returned by default searches</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#ismodalxpath\">IsModalXPath</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#linebreak\">LineBreak</a></td>\n<td>Set key to send to text fields after\ntyping.</td>\n<td>ue004 (tab key)</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#logmatchedicons\">LogMatchedIcons</a></td>\n<td>Highlights where icon was found on the\nscreen and adds a sceenshot to logs</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#logscreenshot\">LogScreenShot</a></td>\n<td>Adds screenshot of failure to logs</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#matchinginputelement\">MatchingInputElement</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#multipleanchors\">MultipleAnchors</a></td>\n<td>Accept non-unique anchors.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#offsetcheck\">OffsetCheck</a></td>\n<td>Check element has offset. Element with\nno offset is considered invisible.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#osscreenshots\">OSScreenshots</a></td>\n<td>Use operating system functionalities\ninstead of selenium to take screenshots</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#partialmatch\">PartialMatch</a></td>\n<td>Accept partial matches from element\nsearch functions or require exact match</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#retinadisplay\">RetinaDisplay</a></td>\n<td>Is current monitor Retina display\n(True) or not (False)</td>\n<td>Automatic\ndetection</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#retryinterval\">RetryInterval</a></td>\n<td>Timeout to wait before re-trying in\n-Until/-While keywords.</td>\n<td>5s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#runbefore\">RunBefore</a></td>\n<td>A keyword to be run before every\ninteraction keyword. Useful for example\nwhen there is a custom spinner that\nshould be waited for</td>\n<td>None</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#screenshottype\">ScreenShotType</a></td>\n<td>Log html source, screenshot or both</td>\n<td>screenshot</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#searchdirection\">SearchDirection</a></td>\n<td>Set relative search direction for\nelement search (closest, up, down, left,\nright, up!, down!, left!, right!)</td>\n<td>closest</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#searchmode\">SearchMode</a></td>\n<td>Options for highlighting elements found\nby searches (None, debug, draw).</td>\n<td>draw</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#shadowdom\">ShadowDOM</a></td>\n<td>Extend element searches to shadow DOM.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#xhrtimeout\">XHRTimeout</a></td>\n<td>Maximum wait for page to be loaded</td>\n<td>30s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#verifyappaccuracy\">VerifyAppAccuracy</a></td>\n<td>Threshold for needed similarity in\nVerifyApp keyword.</td>\n<td>0.9999</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#visibility\">Visibility</a></td>\n<td>Set if visibility should be checked when\nsearching for elements.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#windowfind\">WindowFind</a></td>\n<td>Simulate CTRL+F to search for elements\ninstead of searching from DOM</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#windowsize\">WindowSize</a></td>\n<td>Set the size of browser window</td>\n<td>Full screen</td>\n</tr>\n</tbody>\n</table>\n<hr class=\"docutils\" id=\"logscreenshot\" />\n<div class=\"section\" id=\"parameter-logscreenshot\">\n<h1>Parameter: LogScreenshot</h1>\n<p>Enables or disables logging screenshots when keyword fails.\nDefault is screenshot (True). False disables screenshots from logs when keyword fails.</p>\n<div class=\"section\" id=\"examples\">\n<h2>Examples</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogScreenshot</span><span class=\"p\">         </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogScreenshot</span><span class=\"p\">         </span><span class=\"c\">True</span>\n</pre>\n</div>\n<hr class=\"docutils\" id=\"screenshottype\" />\n<div class=\"section\" id=\"parameter-screenshottype\">\n<h2>Parameter: ScreenshotType</h2>\n<p>Defines how screenshot is taken. Default is normal screenshot.\n&quot;html&quot; saves page as html frame in test log. &quot;all&quot; saves both image and html page.</p>\n<div class=\"section\" id=\"examples-1\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">html</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">screenshot</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">all</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"osscreenshots\" />\n<div class=\"section\" id=\"parameter-osscreenshots\">\n<h2>Parameter: OSScreenshots</h2>\n<p>Defines if screenhots are taken using selenium's or operating system's functionalities.\nDefault is selenium screenshot (False).</p>\n<div class=\"section\" id=\"examples-2\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OSScreenshots</span><span class=\"p\">        </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OSScreenshots</span><span class=\"p\">        </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"cssselectors\" />\n<div class=\"section\" id=\"parameter-cssselectors\">\n<h2>Parameter: CssSelectors</h2>\n<p>Use CSS selectors for finding elements.</p>\n<p>CSS selectors is optional way to find elements that\nare difficult to catch by default selectors. Typically\nthose elements are inputs, checkboxes and dropdowns\nwithout placeholder texts.</p>\n<p>With CSS selectors the detection is tried with:</p>\n<ul class=\"simple\">\n<li>Placeholder or tooltip</li>\n<li>Label with 'for' attribute</li>\n<li>DOM traversing to detect sibling element</li>\n</ul>\n<div class=\"section\" id=\"examples-3\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">     </span><span class=\"c\">MyLocator</span><span class=\"p\">   </span><span class=\"c\">Robot</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"searchdirection\" />\n<div class=\"section\" id=\"parameter-searchdirection\">\n<h2>Parameter: SearchDirection</h2>\n<p>Set search direction for element search.</p>\n<p>Search direction is &quot;closest, &quot;up&quot;, &quot;down&quot;, &quot;left&quot;, &quot;right&quot;,\n&quot;up!&quot;, &quot;down!&quot;, &quot;left!&quot;, &quot;right!&quot;.\n&quot;Closest&quot; is the default value.</p>\n<p>Elements are searched according to their relative position to anchor.</p>\n<p>With this setting you can choose between two ways of searching:</p>\n<ul class=\"simple\">\n<li><strong>normal mode</strong></li>\n<li><strong>strict mode</strong> (ending with &quot;!&quot;).</li>\n</ul>\n<p><strong>Normal Mode</strong>: In this mode, you start looking for something starting from a specific point\nor direction you've chosen. If you can't find it there, the search will then try to find\nthe closest match, even if it's not exactly in the direction you started from.</p>\n<p><strong>Strict Mode</strong>: This mode is stricter. You also start searching from a specific direction,\nbut the big difference is that if what you're looking for isn't found exactly in that direction,\nthe search will fail.\nIt won't try to find the next closest thing. The search insists that the item must be found in\nthe direction you specified, or not at all.\nIt's important to note that this enforced format works only when you're searching for text\non a page, like when you're using commands to verify text is there (VerifyText)\nor when you want to click on text (ClickText).</p>\n<div class=\"section\" id=\"examples-4\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">SearchDirection Example</span><span class=\"p\">\n    </span><span class=\"c\"># finds input using text &quot;My Locator&quot; on the right of text &quot;Robot&quot;\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">right</span><span class=\"p\">\n    </span><span class=\"nf\">TypeText</span><span class=\"p\">     </span><span class=\"s\">MyLocator</span><span class=\"p\">  </span><span class=\"s\">Hello</span><span class=\"p\">  </span><span class=\"s\">Robot</span><span class=\"p\">\n\n    </span><span class=\"c\"># finds input using text &quot;My Locator&quot; above of text &quot;Robot&quot;\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">up</span><span class=\"p\">\n    </span><span class=\"nf\">TypeText</span><span class=\"p\">     </span><span class=\"s\">MyLocator</span><span class=\"p\">  </span><span class=\"s\">Hello</span><span class=\"p\">  </span><span class=\"s\">Robot</span><span class=\"p\">\n\n    </span><span class=\"c\"># When using strict mode (!), the test case fails if the locator text is\n</span><span class=\"p\">    </span><span class=\"c\"># not found in the correct direction from the anchor.\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">left!</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyText</span><span class=\"p\">   </span><span class=\"s\">Firstname</span><span class=\"p\">             </span><span class=\"s\">anchor=Lastname</span><span class=\"p\">\n    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">closest</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"linebreak\" />\n<div class=\"section\" id=\"parameter-linebreak\">\n<h2>Parameter: LineBreak</h2>\n<p>Set key to be pressed after text is written to input field.</p>\n<p>By default tab key (ue004) is pressed</p>\n<p>Values, that are mapped for selenium keys are:</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"73%\" />\n<col width=\"27%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">Key</th>\n<th class=\"head\">Value</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td>null</td>\n<td>ue000</td>\n</tr>\n<tr><td>cancel</td>\n<td>ue001</td>\n</tr>\n<tr><td>help</td>\n<td>ue002</td>\n</tr>\n<tr><td>backspace</td>\n<td>ue003</td>\n</tr>\n<tr><td>tab</td>\n<td>ue004</td>\n</tr>\n<tr><td>clear</td>\n<td>ue005</td>\n</tr>\n<tr><td>return</td>\n<td>ue006</td>\n</tr>\n<tr><td>enter</td>\n<td>ue007</td>\n</tr>\n<tr><td>shift</td>\n<td>ue008</td>\n</tr>\n<tr><td>left_shift</td>\n<td>ue008</td>\n</tr>\n<tr><td>control</td>\n<td>ue009</td>\n</tr>\n<tr><td>left_control</td>\n<td>ue009</td>\n</tr>\n<tr><td>alt</td>\n<td>ue00A</td>\n</tr>\n<tr><td>left_alt</td>\n<td>ue00A</td>\n</tr>\n<tr><td>pause</td>\n<td>ue00B</td>\n</tr>\n<tr><td>escape</td>\n<td>ue00C</td>\n</tr>\n<tr><td>space</td>\n<td>ue00D</td>\n</tr>\n<tr><td>page_up</td>\n<td>ue00E</td>\n</tr>\n<tr><td>page_down</td>\n<td>ue00F</td>\n</tr>\n<tr><td>end</td>\n<td>ue010</td>\n</tr>\n<tr><td>home</td>\n<td>ue011</td>\n</tr>\n<tr><td>left</td>\n<td>ue012</td>\n</tr>\n<tr><td>arrow_left</td>\n<td>ue012</td>\n</tr>\n<tr><td>up</td>\n<td>ue013</td>\n</tr>\n<tr><td>arrow_up</td>\n<td>ue013</td>\n</tr>\n<tr><td>right</td>\n<td>ue014</td>\n</tr>\n<tr><td>arrow_right</td>\n<td>ue014</td>\n</tr>\n<tr><td>down</td>\n<td>ue015</td>\n</tr>\n<tr><td>arrow_down</td>\n<td>ue015</td>\n</tr>\n<tr><td>insert</td>\n<td>ue016</td>\n</tr>\n<tr><td>delete</td>\n<td>ue017</td>\n</tr>\n<tr><td>semicolon</td>\n<td>ue018</td>\n</tr>\n<tr><td>equals</td>\n<td>ue019</td>\n</tr>\n<tr><td>numpad0</td>\n<td>ue01A</td>\n</tr>\n<tr><td>numpad1</td>\n<td>ue01B</td>\n</tr>\n<tr><td>numpad2</td>\n<td>ue01C</td>\n</tr>\n<tr><td>numpad3</td>\n<td>ue01D</td>\n</tr>\n<tr><td>numpad4</td>\n<td>ue01E</td>\n</tr>\n<tr><td>numpad5</td>\n<td>ue01F</td>\n</tr>\n<tr><td>numpad6</td>\n<td>ue020</td>\n</tr>\n<tr><td>numpad7</td>\n<td>ue021</td>\n</tr>\n<tr><td>numpad8</td>\n<td>ue022</td>\n</tr>\n<tr><td>numpad9</td>\n<td>ue023</td>\n</tr>\n<tr><td>multiply</td>\n<td>ue024</td>\n</tr>\n<tr><td>add</td>\n<td>ue025</td>\n</tr>\n<tr><td>separator</td>\n<td>ue026</td>\n</tr>\n<tr><td>subtract</td>\n<td>ue027</td>\n</tr>\n<tr><td>decimal</td>\n<td>ue028</td>\n</tr>\n<tr><td>divide</td>\n<td>ue029</td>\n</tr>\n<tr><td>f1</td>\n<td>ue031</td>\n</tr>\n<tr><td>f2</td>\n<td>ue032</td>\n</tr>\n<tr><td>f3</td>\n<td>ue033</td>\n</tr>\n<tr><td>f4</td>\n<td>ue034</td>\n</tr>\n<tr><td>f5</td>\n<td>ue035</td>\n</tr>\n<tr><td>f6</td>\n<td>ue036</td>\n</tr>\n<tr><td>f7</td>\n<td>ue037</td>\n</tr>\n<tr><td>f8</td>\n<td>ue038</td>\n</tr>\n<tr><td>f9</td>\n<td>ue039</td>\n</tr>\n<tr><td>f10</td>\n<td>ue03A</td>\n</tr>\n<tr><td>f11</td>\n<td>ue03B</td>\n</tr>\n<tr><td>f12</td>\n<td>ue03C</td>\n</tr>\n<tr><td>meta</td>\n<td>ue03D</td>\n</tr>\n<tr><td>right_shift</td>\n<td>ue050</td>\n</tr>\n<tr><td>right_control</td>\n<td>ue051</td>\n</tr>\n<tr><td>right_alt</td>\n<td>ue052</td>\n</tr>\n<tr><td>right_meta</td>\n<td>ue053</td>\n</tr>\n<tr><td>numpad_page_up</td>\n<td>ue054</td>\n</tr>\n<tr><td>numpad_page_down</td>\n<td>ue055</td>\n</tr>\n<tr><td>numpad_end</td>\n<td>ue056</td>\n</tr>\n<tr><td>numpad_home</td>\n<td>ue057</td>\n</tr>\n<tr><td>numpad_left</td>\n<td>ue058</td>\n</tr>\n<tr><td>numpad_up</td>\n<td>ue059</td>\n</tr>\n<tr><td>numpad_right</td>\n<td>ue05A</td>\n</tr>\n<tr><td>numpad_down</td>\n<td>ue05B</td>\n</tr>\n<tr><td>numpad_insert</td>\n<td>ue05C</td>\n</tr>\n<tr><td>numpad_delete</td>\n<td>ue05D</td>\n</tr>\n</tbody>\n</table>\n<div class=\"section\" id=\"examples-5\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">\\ue004</span><span class=\"p\">    </span><span class=\"c\"># Tab key\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">\\ue007</span><span class=\"p\">    </span><span class=\"c\"># Enter key\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">${EMPTY}</span><span class=\"p\">  </span><span class=\"c\"># Do not send anything</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"clearkey\" />\n<div class=\"section\" id=\"parameter-clearkey\">\n<h2>Parameter: ClearKey</h2>\n<p>Set key to be pressed before text is written to input field.</p>\n<p>By default uses webdrivers clear method to clear element.</p>\n<p>Available values are same as with LineBreak. Some keyboard shortcuts\nalso available. Some examples from link below:\n<a class=\"reference external\" href=\"https://turbofuture.com/computers/keyboard-shortcut-keys\">https://turbofuture.com/computers/keyboard-shortcut-keys</a>:</p>\n<div class=\"section\" id=\"examples-6\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">None</span><span class=\"p\">           </span><span class=\"c\"># Uses clear method (=default)\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">{NULL}</span><span class=\"p\">         </span><span class=\"c\"># Does nothing\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + A}</span><span class=\"p\">  </span><span class=\"c\"># Select all and overwrite\n# One time use:\nTypeText</span><span class=\"p\">    </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Robot</span><span class=\"p\">       </span><span class=\"c\">clear_key={CONTROL + A}</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"checkinputvalue\" />\n<div class=\"section\" id=\"parameter-checkinputvalue\">\n<h2>Parameter: CheckInputValue</h2>\n<p>Check that real value matches to preferred value after TypeText.</p>\n<p>If value is not match we try to re type (three times before fail)\nThis is optional feature. Default = false.\nUse with caution on elements where webdriver has tendency to lost focus\nand some part of the preferred text gone missing.</p>\n<div class=\"section\" id=\"examples-7\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nTypeText</span><span class=\"p\">    </span><span class=\"c\">username</span><span class=\"p\">           </span><span class=\"c\">Robot</span><span class=\"p\">       </span><span class=\"c\">check=True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"defaulttimeout\" />\n<div class=\"section\" id=\"parameter-defaulttimeout\">\n<h2>Parameter: DefaultTimeout</h2>\n<p>Set default timeout for QWeb keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-8\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nVerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">          </span><span class=\"c\">60s</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"xhrtimeout\" />\n<div class=\"section\" id=\"parameter-xhrtimeout\">\n<h2>Parameter: XHRTimeout</h2>\n<p>Set default timeout for XHR (How log we wait page to be loaded).</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-9\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">XHRTimeout</span><span class=\"p\">        </span><span class=\"c\">60</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"defaultdocument\" />\n<div class=\"section\" id=\"parameter-defaultdocument\">\n<h2>Parameter: DefaultDocument</h2>\n<p>Switches to default frame automatically.</p>\n<p>If some other frame is used by previous keyword\nwe switch back to default after keyword is executed so\nthat we are starting to find next locator from html document\ninstead of previously used frame.\nDefault = True\nUse False only when there is need to use and move\nbetween frames and page manually for some reason.</p>\n<div class=\"section\" id=\"examples-10\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"caseinsensitive\" />\n<div class=\"section\" id=\"parameter-caseinsensitive\">\n<h2>Parameter: CaseInsensitive</h2>\n<p>Set containing_text_match according to selected case sensitivity.</p>\n<p>Default = False\nNote: if containing_text_match has been overwritten manually\nthis will return the default value.</p>\n<div class=\"section\" id=\"examples-11\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"partialmatch\" />\n<div class=\"section\" id=\"parameter-partialmatch\">\n<h2>Parameter: PartialMatch</h2>\n<p>Accept partial match (True) from textual element searches\nor require exact match (False)</p>\n<p>Default = True</p>\n<div class=\"section\" id=\"examples-12\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">PartialMatch</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">PartialMatch</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"verifyappaccuracy\" />\n<div class=\"section\" id=\"parameter-verifyappaccuracy\">\n<h2>Parameter: VerifyAppAccuracy</h2>\n<p>Set VerifyApp accuracy. Default is 0.9999. You should not use\nvalue of 1 because browser rendering will cause false positives.</p>\n<div class=\"section\" id=\"examples-13\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">VerifyAppAccuracy</span><span class=\"p\">     </span><span class=\"c\">0.99999</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"windowsize\" />\n<div class=\"section\" id=\"parameter-windowsize\">\n<h2>Parameter: WindowSize</h2>\n<p>Set window size.</p>\n<div class=\"section\" id=\"examples-14\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowSize</span><span class=\"p\">     </span><span class=\"c\">1920x1080</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"inputhandler\" />\n<div class=\"section\" id=\"parameter-inputhandler\">\n<h2>Parameter: InputHandler</h2>\n<p>Set input handler.</p>\n<p>Default handler is &quot;selenium&quot; which uses Selenium library's\nmethods clear() and send_keys(). These methods assume that\nthe web element is writable (enabled). Inserts tab character\nat the end of text.</p>\n<p>Alternative writers &quot;raw&quot; and &quot;javascript. &quot;raw&quot; uses pyautogui to input text directly\nwithout checking the web element state. &quot;javascript&quot; uses javascript for input.\nThese version are intended to be used when the web page doesn't update input element status\nSelenium compliant way.</p>\n<div class=\"section\" id=\"examples-15\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">raw</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">selenium</span><span class=\"p\">\n\n</span><span class=\"c\"># Use JavaScript to set the text to input element's value attribute\nSetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">javascript</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"offsetcheck\" />\n<div class=\"section\" id=\"parameter-offsetcheck\">\n<h2>Parameter: OffsetCheck</h2>\n<p>Element with no offset is considered invisible by default.\nTo bypass this check set OffsetCheck to false.</p>\n<div class=\"section\" id=\"examples-16\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OffsetCheck</span><span class=\"p\">     </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns also elements that has offset=0\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">OffsetCheck</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#offset is needed (default)\n# One time use:\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">offset=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"visibility\" />\n<div class=\"section\" id=\"parameter-visibility\">\n<h2>Parameter: Visibility</h2>\n<p>If set to false no visibility check is made when searching elements.</p>\n<div class=\"section\" id=\"examples-17\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">Visibility</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns visible and invisible elements\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">Visibility</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#returns only visible elements(default).\n# One time use:\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">visibility=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"inviewport\" />\n<div class=\"section\" id=\"parameter-inviewport\">\n<h2>Parameter: InViewport</h2>\n<p>If InViewport is set to true every element outside of current viewport is considered\ninvisible. This helps to narrow searching area when there is lots of similar texts/elements\nin dom content. This can be also used to prevent searching functions to match any element\nthat is hidden outside of viewport - even if css visibility settings of given element\nsays that it's visible.</p>\n<div class=\"section\" id=\"examples-18\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">InViewport</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns all matching elements(default)\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">InViewport</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#element has to be inside of current viewport\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">viewport=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"searchmode\" />\n<div class=\"section\" id=\"parameter-searchmode\">\n<h2>Parameter: SearchMode</h2>\n<p>When SearchMode is used, any found web element is highlighted with blue borders\nbefore the actual execution. This setting is useful especially in debug mode when\nwe want to search right kw:s and locators to actual testscript.</p>\n<div class=\"section\" id=\"examples-19\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">debug</span><span class=\"p\">  </span><span class=\"c\">#Highlights element, but won't put action on it\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">draw</span><span class=\"p\">   </span><span class=\"c\">#Highlights element and then executes kw (default)\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">None</span><span class=\"p\">   </span><span class=\"c\">#Turns off highlighting element</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"windowfind\" />\n<div class=\"section\" id=\"parameter-windowfind\">\n<h2>Parameter: WindowFind</h2>\n<p>When WindowFind is used VerifyText is not looking texts for dom, but simulates\nctrl+f like search to find if text exists.</p>\n<div class=\"section\" id=\"examples-20\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowFind</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\">#Searching text from current viewport\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowFind</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\">#Searching text from dom(default)</span>\n</pre>\n</div>\n</div>\n<span id=\"ismodalxpath\"></span><span id=\"allinputelements\"></span><span id=\"activeareaxpath\"></span><hr class=\"docutils\" id=\"matchinginputelement\" />\n<div class=\"section\" id=\"parameter-searchstrategy-values\">\n<h2>Parameter: SearchStrategy Values</h2>\n<p>Set search strategy for element search.</p>\n<p>Strategy type is either &quot;all input elements&quot;, or &quot;matching input element&quot;.</p>\n<p>&quot;all input elements&quot; is a plain xpath that is used to find all elements\nconsidered as input elements.</p>\n<p>&quot;matching input element&quot; is an xpath with mandatory placeholder &quot;{}&quot; for\nsearch string. Xpath expression is completed by xpath.format(locator)\ninternally and therefore must include placeholder &quot;{}&quot;. Used to find elements\nmatching with a custom search string. Placeholder can be positional, such as {0}\nand repeated in that case.</p>\n<p>If <strong>IsModalXPath</strong> is set to something else than //body, then text based element\nsearch only considers elements which have the given xpath as ancestor, if\nIsModalXpath exists / is open. This is meant for applications that have modal\ndialogs but do not set elements below the dialog hidden in other means.</p>\n<p>Returns previously used search strategy.</p>\n<div class=\"section\" id=\"examples-21\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ActiveAreaXpath</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MatchingInputElement</span><span class=\"p\">    </span><span class=\"c\">//*[&#64;placeholder=&quot;{}&quot;]</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MatchingInputElement</span><span class=\"p\">    </span><span class=\"c\">containing input element</span><span class=\"p\">\n</span><span class=\"c\">${previous}= SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">//input</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">${previous}</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">IsModalXPath</span><span class=\"p\">       </span><span class=\"c\">//div[contains(&#64;class, 'modal-container')]</span>\n</pre>\n<p>note: in the above case &quot;containing input element&quot; will use an xpath expression\nsuch that input elements that contain partial matches are used.</p>\n</div>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h2>Parameters</h2>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>xpath expression with or without &quot;xpath = &quot;</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h2>Raises</h2>\n<p>ValueError: Unknown search strategy</p>\n</div>\n<hr class=\"docutils\" id=\"multipleanchors\" />\n<div class=\"section\" id=\"parameter-multipleanchors\">\n<h2>Parameter: MultipleAnchors</h2>\n<p>Normally QWeb requires anchor to be an unique text. If MultipleAnchors is set to True,\nQWeb accepts multiple anchors and selects the first one.</p>\n<div class=\"section\" id=\"examples-22\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MultipleAnchors</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># Accept multiple anchors\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">MultipleAnchors</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Raise error if anchor is not unique</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"clicktofocus\" />\n<div class=\"section\" id=\"parameter-clicktofocus\">\n<h2>Parameter: ClickToFocus</h2>\n<p>Clicks Input element before typing. This is sometimes needed to activate\ntarget element.</p>\n<div class=\"section\" id=\"examples-23\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ClickToFocus</span><span class=\"p\">         </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># Clicks element before TypeText\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">ClickToFocus</span><span class=\"p\">         </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Handle TypeText without clicks(default)</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"doubleclick\" />\n<div class=\"section\" id=\"parameter-doubleclick\">\n<h2>Parameter: DoubleClick</h2>\n<p>Sets double-click the default action for all Click* keywords.</p>\n<div class=\"section\" id=\"examples-24\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">DoubleClick</span><span class=\"p\">          </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># All Click keywords perform double-click action\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">DoubleClick</span><span class=\"p\">          </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Single-click action(default)</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"handlealerts\" />\n<div class=\"section\" id=\"parameter-handlealerts\">\n<h2>Parameter: HandleAlerts</h2>\n<p>Option for handling alerts boxes, on by default.</p>\n<div class=\"section\" id=\"examples-25\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">HandleAlerts</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"blindreturn\" />\n<div class=\"section\" id=\"parameter-blindreturn\">\n<h2>Parameter: BlindReturn</h2>\n<p>Return any value (even empty) from input element without waiting.\nDefault = false (Raises QWebValueError if field is empty after timeout).</p>\n<div class=\"section\" id=\"examples-26\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">BlindReturn</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">\n</span><span class=\"c\">#Some value must exists inside of given timeout(default):\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">BlindReturn</span><span class=\"p\">       </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\n${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">     </span><span class=\"c\">blind=True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"delay\" />\n<div class=\"section\" id=\"parameter-delay\">\n<h2>Parameter: Delay</h2>\n<p>Set delay for Paceword.\nThis is meant to be used in demo purposes only\nand is not recommended way to control execution flow.\nDefault = 0s (No delays before execution).</p>\n<div class=\"section\" id=\"examples-27\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Wait 0.5 seconds before any Paceword is executed:\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">Delay</span><span class=\"p\">             </span><span class=\"c\">0.5s</span><span class=\"p\">\n</span><span class=\"c\"># One time use - Wait 1s before given Paceword is executed:\nTypeText</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">          </span><span class=\"c\">QRobot</span><span class=\"p\">   </span><span class=\"c\">delay=1s</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"retryinterval\" />\n<div class=\"section\" id=\"parameter-retryinterval\">\n<h2>Parameter: RetryInterval</h2>\n<p>Set default interval for QWeb retry keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-28\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">RetryInterval</span><span class=\"p\">    </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Foo</span><span class=\"p\">         </span><span class=\"c\">button</span><span class=\"p\">       </span><span class=\"c\">interval=3</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"runbefore\" />\n<div class=\"section\" id=\"parameter-runbefore\">\n<h2>Parameter: RunBefore</h2>\n<p>Set a verificaton keyword to be run before any interaction\nkeywords (click*, get_text, dropdown).</p>\n<p>Most common use for this configuration is in applications, that have a custom\n&quot;spinner&quot;/ loading indicator which needs to be waited even if\npage itself is already in ReadyState.</p>\n<p>Any custom robot fw keywords which start with word &quot;Verify&quot; can be used as RunBefore keyword.\nA resource file defining this keyword must be imported prior to usage.</p>\n<p>Supports giving keyword to run and parameters either in python or in robot framework syntax.\nRobot fw syntax needs to be given in a variable due to handling of arguments.</p>\n<div class=\"section\" id=\"examples-29\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Python syntax\nSetConfig</span><span class=\"p\">  </span><span class=\"c\">RunBefore</span><span class=\"p\">   </span><span class=\"c\">element.verify_no_element('//html[contains(&#64;class, &quot;custom-busy&quot;)]')</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">  </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\"># Waits that custom spinner disappears before running other keywords\n</span><span class=\"p\">\n</span><span class=\"c\"># Robot Framework syntax, needs to be in variable\n${run_bf}=</span><span class=\"p\">   </span><span class=\"c\">SetVariable</span><span class=\"p\">    </span><span class=\"c\">VerifyNoText</span><span class=\"p\">    </span><span class=\"c\">Loading....</span><span class=\"p\">     </span><span class=\"c\">timeout=5</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">RunBefore</span><span class=\"p\">      </span><span class=\"c\">${run_bf}</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\"># Waits that text &quot;Loading...&quot; disappears before running other keywords</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"retinadisplay\" />\n<div class=\"section\" id=\"parameter-retinadisplay\">\n<h2>Parameter: RetinaDisplay</h2>\n<p>Is current monitor Retina display (True) or not (False). Will be automatically\nset based on used monitor, but can be changed for testing purposes if needed.</p>\n<div class=\"section\" id=\"examples-30\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">RetinaDisplay</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"logmatchedicons\" />\n<div class=\"section\" id=\"parameter-logmatchedicons\">\n<h2>Parameter: LogMatchedIcons</h2>\n<p>When True, highlights where icon was found on the screen and adds a sceenshot\nto logs. Default = False (Screenshots are not added to the logs).</p>\n<div class=\"section\" id=\"examples-31\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogMatchedIcons</span><span class=\"p\">       </span><span class=\"c\">True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"highlightcolor\" />\n<div class=\"section\" id=\"parameter-highlightcolor\">\n<h2>Parameter: HighlightColor</h2>\n<p>Sets the highlight color to use when element is highlighted.</p>\n<p>Accepted colors are:</p>\n<ul class=\"simple\">\n<li>aqua</li>\n<li>black</li>\n<li>blue</li>\n<li>fuchsia</li>\n<li>green</li>\n<li>lime</li>\n<li>navy</li>\n<li>olive</li>\n<li>orange</li>\n<li>purple</li>\n<li>red</li>\n<li>teal</li>\n<li>yellow</li>\n</ul>\n<p>Default = &quot;blue&quot;.</p>\n<div class=\"section\" id=\"examples-32\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">HighlightColor</span><span class=\"p\">       </span><span class=\"c\">olive</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"shadowdom\" />\n<div class=\"section\" id=\"parameter-shadowdom\">\n<h2>Parameter: ShadowDOM</h2>\n<p>Extends element search to open shadow roots / shadow DOM.\nElments under shadow dom are not reachable by normal means, so setting\nthis configuration to True also changes how elements are searched.\nThis basically means that some attributes given to keywords can be ignored\nand other search strategies are overridden.</p>\n<p>It's best to use this setting only in specific situations where shadow dom\nelements need to be verified or interacted with.</p>\n<p>Default = False (Elements are only searched from the light / normal dom).</p>\n<div class=\"section\" id=\"examples-33\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\"># Do things related to shadow dom elements\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">This is under shadow root</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">       </span><span class=\"c\">As is this</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n<p>---</p>\n</div>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h2>Related keywords</h2>\n<p><a href=\"#Get%20Config\" class=\"name\">GetConfig</a>, <a href=\"#Reset%20Config\" class=\"name\">ResetConfig</a></p>\n</div>\n</div>\n</div>\n", "shortdoc": "Set configuration parameter to given value. Return previous value.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 27}, {"name": "Set Input Handler", "args": [{"name": "input_method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_method: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set input handler.</p>\n<p>Default handler is &quot;selenium&quot; which uses Selenium librarys\nmethods clear() and send_keys(). These methods assume that\nthe web element is writable (enabled). Inserts tab character\nat the end of text.</p>\n<p>Alternative writer &quot;raw&quot; uses pyautogui to input text directly\nwithout checking the web element state. This version is intended\nto be used when the web page doesn't update input element status\nSelenium compliant way.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set input handler</span><span class=\"p\">    </span><span class=\"c\">raw</span><span class=\"p\">\n</span><span class=\"c\">Set input handler</span><span class=\"p\">    </span><span class=\"c\">selenium</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>input_method <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Input method used by input handler, &quot;selenium&quot; or &quot;raw&quot;.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": ["Config", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 37, "deprecated": true}, {"name": "Set Line Break", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": ["Config", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 69, "deprecated": true}, {"name": "Set Search Strategy", "args": [{"name": "strategy_type", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_type: str"}, {"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set search strategy for element search.</p>\n<p>Strategy type is either &quot;all input elements&quot;, or &quot;matching input element&quot;.</p>\n<p>&quot;all input elements&quot; is a plain xpath that is used to find all elements\nconsidered as input elements.</p>\n<p>&quot;matching input element&quot; is an xpath with mandatory placeholder &quot;{}&quot; for\nsearch string. Xpath expression is completed by xpath.format(locator)\ninternally and therefore must include placeholder &quot;{}&quot;. Used to find elements\nmatching with a custom search string. Placeholder can be positional, such as {0}\nand repeated in that case.</p>\n<p>Returns previously used search strategy.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">active area xpath</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">matching input element</span><span class=\"p\">    </span><span class=\"c\">//*[&#64;placeholder=&quot;{}&quot;]</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">matching input element</span><span class=\"p\">    </span><span class=\"c\">containing input element</span><span class=\"p\">\n</span><span class=\"c\">${previous}= Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">//input</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">${previous}</span>\n</pre>\n<p>note: in the above case &quot;containing input element&quot; will use an xpath expression\nsuch that input elements that contain partial matches are used.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>xpath expression with or without &quot;xpath = &quot;</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Wrong strategy type</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 45, "deprecated": true}, {"name": "Set Wait Function", "args": [{"name": "function", "type": {"name": "Callable", "typedoc": null, "nested": [{"name": "...", "typedoc": null, "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Callable[..., Any]"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: Callable[..., Any]"}], "doc": "<div class=\"document\">\n<p>Set custom wait function that is run at the beginning of keywords.</p>\n<p><strong>Note</strong>: Not meant to be used as robot framework keyword but as a helper\nfunction to extend / customize QWeb via Python.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code python literal-block\">\n<span class=\"kn\">from</span> <span class=\"nn\">QWeb.custom_config</span> <span class=\"kn\">import</span> <span class=\"n\">set_wait_function</span><span class=\"w\">\n\n</span><span class=\"k\">def</span> <span class=\"nf\">my_wait_function</span><span class=\"p\">():</span><span class=\"w\">\n</span>    <span class=\"c1\"># your own wait logic here</span><span class=\"w\">\n</span>    <span class=\"o\">...</span><span class=\"w\">\n\n</span><span class=\"c1\"># This will make QWeb use &quot;my_wait_function&quot; as wait function</span><span class=\"w\">\n</span><span class=\"c1\"># instead of the default one</span><span class=\"w\">\n</span><span class=\"n\">set_wait_function</span><span class=\"p\">(</span><span class=\"n\">my_wait_function</span><span class=\"p\">)</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>function <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">function</span></dt>\n<dd>Function that does not need to return anything.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Set custom wait function that is run at the beginning of keywords.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\custom_config.py", "lineno": 5}, {"name": "Set Window Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set current window size.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetWindowSize</span><span class=\"p\">     </span><span class=\"c\">1920</span><span class=\"p\">    </span><span class=\"c\">1080</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>width <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>The width value of the window</dd>\n<dt>height: int</dt>\n<dd>The height value of the window</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 249, "deprecated": true}, {"name": "Skim Click", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_disappear: str = "}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>ClickWhile</cite> instead.</p>\n<p>Click text until a text disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text disappears.</p>\n<p>If text_to_disappear is not entered, it keyword will wait until text\nclicked disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">            </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">            </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">20s</span><span class=\"p\">    </span><span class=\"c\">5s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long to wait until text disappears</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text\nel_type = 'item':\ntext(default) = find element by visible text | item = find item type element</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `ClickWhile` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 536, "deprecated": true}, {"name": "Swipe Down", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes down on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeDown</span><span class=\"p\">   </span><span class=\"c\"># Swipes down once\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes down five times\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">  </span><span class=\"c\"># Swipes down once, starting from the text &quot;Qentinel Touch&quot;\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">  </span><span class=\"c\"># Swipes down five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times we swipe / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes down on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 442}, {"name": "Swipe Left", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes left on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeLeft</span><span class=\"p\">   </span><span class=\"c\"># Swipes left once\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes left five times\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes left once, from the text &quot;Qentinel Touch&quot;\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes left five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes left on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 506}, {"name": "Swipe Right", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes right on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeRight</span><span class=\"p\">   </span><span class=\"c\"># Swipes right once\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes right five times\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes right once, from the text &quot;Qentinel Touch&quot;\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes right five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes right on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 538}, {"name": "Swipe Up", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes up on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeUp</span><span class=\"p\">   </span><span class=\"c\"># Swipes up once\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes up five times\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes up once, from the text &quot;Qentinel Touch&quot;\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">    </span><span class=\"c\"># Swipes up five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes up on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 474}, {"name": "Switch Browser", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: int | str"}], "doc": "<div class=\"document\">\n<p>Switches to another browser instance in browser cache.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">about:chrome</span><span class=\"p\">                </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.github.com</span><span class=\"p\">      </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">      </span><span class=\"c\">edge</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">       </span><span class=\"c\"># following keywords will interact with chrome instance\n...</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">NEW</span><span class=\"p\">     </span><span class=\"c\"># following keywords will interact with latest opened browser (edge)\n...</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">2</span><span class=\"p\">       </span><span class=\"c\"># following keywords will interact with firefox instance</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<blockquote>\n<span class=\"name\">OpenBrowser,  </span>CloseBrowser,  <span class=\"name\">SwitchWindow, </span>GetWebElement`</blockquote>\n</div>\n</div>\n", "shortdoc": "Switches to another browser instance in browser cache.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 349}, {"name": "Switch Window", "args": [{"name": "index", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Switch to another tab.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwitchWindow</span><span class=\"p\">     </span><span class=\"c\">1</span><span class=\"p\">\n</span><span class=\"c\">SwitchWindow</span><span class=\"p\">     </span><span class=\"c\">NEW</span><span class=\"p\">    </span><span class=\"c\"># Switches to latest opened tab</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index of the tab starting from one and counting from left to right.\nOR\nSpecial keyword &quot;NEW&quot; which can be used to move to the latest opened tab.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the window index is out of reach</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Window\" class=\"name\">CloseWindow</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Switch to another tab.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 191}, {"name": "Type Alert", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Accept", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = Accept"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Type and close popup alert.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeAlert</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeAlert</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">     </span><span class=\"c\">Nothing</span><span class=\"p\">   </span><span class=\"c\">10s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to type</dd>\n<dt>action <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default = Accept)</span></dt>\n<dd>What is done for popup. Options are:\nACCEPT: accept alert\nDISMISS: dismiss alert\nNOTHING: don't close alert</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Type and close popup alert.", "tags": ["Alert", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 88}, {"name": "Type Secret", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type secret information such as password.</p>\n<p>Logging in start_keyword and end_keyword is filtered,\notherwise functionality is the same as TypeText.</p>\n<p>Generally all secret credentials in Robot FW scripts should\nbe provided as external variables. Secrets must not be\nstored directly to test script and not even to version control\nsystem.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># PASSWD is set outside the script\n# Provide this to Robot FW as follows:\n# robot --variable PASSWD:mypass123 test.robot\nTypeSecret</span><span class=\"p\">            </span><span class=\"c\">password</span><span class=\"p\">    </span><span class=\"c\">${PASSWD}</span><span class=\"p\">\n</span><span class=\"c\">TypeSecret</span><span class=\"p\">            </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">${PASSWD}</span><span class=\"p\">  </span><span class=\"c\">#table</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Type secret information such as password.", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 120}, {"name": "Type Secret3", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type sensitive information such as personal data.</p>\n<p>the first 1 or 3 digits of the secret value are displayed\nin the logfile, otherwise functionality is the same as Type Secret.</p>\n<p>Generally all secret credentials in Robot FW scripts should\nbe provided as external variables. Secrets must not be\nstored directly to test script and not even to version control\nsystem.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># NAME is set outside the script\n# Provide this to Robot FW as follows:\n# robot --variable NAME:janedoe test.robot\nTypeSecret3</span><span class=\"p\">      </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">${NAME}</span><span class=\"p\">\n</span><span class=\"c\">TypeSecret3</span><span class=\"p\">      </span><span class=\"c\">r1c1</span><span class=\"p\">    </span><span class=\"c\">${NAME} #table</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Type sensitive information such as personal data.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 79}, {"name": "Type Text", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type given text to a text field.</p>\n<p>First look through if there are any input fields that have the\nlocator as a placeholder. If not then locates the input field by\nwhich is closest to the locator text.</p>\n<p>When input field is found, it is first cleared of all text and after\nthat the text is input.</p>\n<div class=\"section\" id=\"simple-example\">\n<h1>Simple Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>input_text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that will be written in the input field</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">check : bool(True/False)</div>\n<div class=\"line\">- Shortcut to switch CheckInputValue on or off for one time use.</div>\n<div class=\"line\">- If CheckInputValue is used, use expected parameter when expected value</div>\n<div class=\"line\">is different than written value. Expected: str | int</div>\n<div class=\"line\">click : bool(True/False)</div>\n<div class=\"line\">- Shortcut to switch ClickToFocus on or off for one time use.</div>\n<div class=\"line\">- If click is set to True, input field is focused by clicking it before typing.</div>\n<div class=\"line\">- CheckInputValue defines if TypeText verifies input field value after it is typed.</div>\n<div class=\"line\">- Default is Off. Valid parameters are On, True, Off and False.</div>\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n<div class=\"line\">clear_key: key or character</div>\n<div class=\"line\">- used generally if there's problems clearing input field with default methods</div>\n<div class=\"line\">- sets what key or key combination is is used to clear the input field</div>\n<div class=\"line\">- using clear_key will set clear key</div>\n<div class=\"line\">- enclose special keys in curly brackets, for example {CONTROL + a} or {BACKSPACE}</div>\n<div class=\"line\">- corresponding configuration parameter is ClearKey</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples-with-settings\">\n<h1>Examples with settings</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">          </span><span class=\"c\">CheckInputValue</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">          </span><span class=\"c\">CheckInputValue</span><span class=\"p\">     </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">           </span><span class=\"c\">Qentinel</span>\n</pre>\n<p>SetConfig LineBreak defines what kind of line break is typed after input text. Default is\ntab key.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">           </span><span class=\"c\">LineBreak</span><span class=\"p\">   </span><span class=\"c\">None</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">someattr</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"examples-with-table\">\n<h1>Examples with table</h1>\n<p>(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nTypeText</span><span class=\"p\">            </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"more-examples\">\n<h1>More Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">clear_key={BACKSPACE}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">clear_key={CONTROL + a}</span><span class=\"p\">\n</span><span class=\"c\"># same thing with using SetConfig\nSetConfig</span><span class=\"p\">           </span><span class=\"c\">ClearKey</span><span class=\"p\">    </span><span class=\"c\">{BACKSPACE}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">           </span><span class=\"c\">ClearKey</span><span class=\"p\">    </span><span class=\"c\">{CONTROL + a}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\"># using WebElement instance\n${elem}=</span><span class=\"p\">            </span><span class=\"c\">GetWebElement</span><span class=\"p\">  </span><span class=\"c\">//input[&#64;title\\=&quot;Search&quot;]</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">${elem}</span><span class=\"p\">     </span><span class=\"c\">Text to search for</span><span class=\"p\">\n</span><span class=\"c\"># Type to input in shadow DOM input\nSetConfig</span><span class=\"p\">           </span><span class=\"c\">ShadowDOM</span><span class=\"p\">   </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">Search</span><span class=\"p\">      </span><span class=\"c\">Test</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Texts\" class=\"name\">TypeTexts</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Type given text to a text field.", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 157}, {"name": "Type Texts", "args": [{"name": "input_texts", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["dict[str, str]", "str"], "typedocs": {"dict": "dictionary", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_texts: dict[str, str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Type text to multiple fields.</p>\n<p>Accepts a .txt file or Robot FW dictionary as a parameter. If using a text file, the locator\nand the text should be separated with a comma on each row.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">list_of_locators_and_texts.txt</span><span class=\"p\">\n</span><span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_dict}=</span><span class=\"p\">           </span><span class=\"c\">Create Dictionary</span><span class=\"p\">    </span><span class=\"c\">Name=Jane</span><span class=\"p\">    </span><span class=\"c\">Email=janedoe&#64;iddqd.com</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">                     </span><span class=\"c\">Phone=04049292243923</span><span class=\"p\">     </span><span class=\"c\">Address=Yellow street 33 C 44</span><span class=\"p\">\n</span><span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">${cool_dict}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Type text to multiple fields.", "tags": ["File", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 287}, {"name": "Upload File", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Upload file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">Upload</span><span class=\"p\">      </span><span class=\"c\">text.txt</span><span class=\"p\">\n</span><span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">Foo</span><span class=\"p\">         </span><span class=\"c\">C:/path/to/file/test.pdf</span><span class=\"p\">\n</span><span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">           </span><span class=\"c\">text.txt #Using index as locator</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">text.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or index that locates the upload element.</dd>\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">file to upload</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted element. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>ValueError: File not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Save%20File\" class=\"name\">SaveFile</a></p>\n</div>\n</div>\n", "shortdoc": "Upload file.", "tags": ["File", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 667}, {"name": "Use File", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Define text file for all other file keywords.</p>\n<p>Sets active file for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">            </span><span class=\"c\">foobar..txt</span><span class=\"p\">\n</span><span class=\"c\">UseFile</span><span class=\"p\">            </span><span class=\"c\">some/existing/path/file.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files.\nPath is not needed if file is in default folder.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20File%20Text\" class=\"name\">GetFileText</a>, <a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>,\n<a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Define text file for all other file keywords.", "tags": ["File"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 67}, {"name": "Use Frame", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}], "doc": "<div class=\"document\">\n<p>Make following keywords to use frame on a page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFrame</span><span class=\"p\">    </span><span class=\"c\">//iframe</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix or index (first = 1 etc.)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchFrameException</dt>\n<dd>If the frame is not found</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Make following keywords to use frame on a page.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 33}, {"name": "Use List", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Define list for all other list keywords.</p>\n<p>Sets active table for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">//*[&#64;class\\=&quot;list&quot;]</span><span class=\"p\">\n</span><span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">list</span><span class=\"p\">                </span><span class=\"c\">selector=class</span><span class=\"p\">\n</span><span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">Calendar</span><span class=\"p\">            </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">#Calendar is inside of ordered list instead of ul (ul=default):\nUseList</span><span class=\"p\">            </span><span class=\"c\">Calendar</span><span class=\"p\">            </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">tag=ol</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the list. If text is inside of unordered list\nthen list is selected. If there is no known texts in list\nxpath can be used to locate correct list. If wanted list is multiple amount\nof whatever web elements with some common attribute, xpath can be used\nto select those elements. When using XPaths, the equal sign &quot;=&quot; must be\nescaped with a &quot;&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd>Accepted kwargs: tag = html_tag to identify if list is ordered or unordered one.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Define list for all other list keywords.", "tags": ["Config", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 44}, {"name": "Use Page", "args": [], "doc": "<div class=\"document\">\n<p>Make following keywords to use the page and not a frame on a page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePage</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Make following keywords to use the page and not a frame on a page.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 68}, {"name": "Use Pdf", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Define pdf file for all other pdf keywords.</p>\n<p>Sets active file for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePdf</span><span class=\"p\">            </span><span class=\"c\">foobar.pdf</span><span class=\"p\">\n</span><span class=\"c\">UsePdf</span><span class=\"p\">            </span><span class=\"c\">some/existing/path/file.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files.\nPath is not needed if file is in default folder.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Pdf%20Text\" class=\"name\">GetPdfText</a>, <a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Define pdf file for all other pdf keywords.", "tags": ["File"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 40}, {"name": "Use Table", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: bool = False"}, {"name": "child", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: bool = False"}, {"name": "level", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "level: int = 1"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}], "doc": "<div class=\"document\">\n<p>Define table for all other table keywords.</p>\n<p>Sets active table for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">parent=True # Use parent table of Calendar</span><span class=\"p\">\n</span><span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">child=True</span><span class=\"p\">  </span><span class=\"c\"># Use child table of Calendar</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the table. The table that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Use when correct table is parent of located table</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Use when correct table is child of located table</dd>\n<dt>level <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If wanted parent table is not the first one use level to pick correct one.\nFor example level=2 means parent table of parent table etc.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple childtables exists. Use index to pick correct one.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Define table for all other table keywords.", "tags": ["Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 43}, {"name": "Verify Alert Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify alert text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAlertText</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Text to Verify</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a></p>\n</div>\n</div>\n", "shortdoc": "Verify alert text.", "tags": ["Alert", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 143}, {"name": "Verify All", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify page contains given texts.</p>\n<p>The texts should be separated with a comma.</p>\n<p>Also accepts a .txt file or Robot FW list as a parameter. Each row in the text file will be\nverified, or each item in the Robot FW list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">Cat, Mouse, Dog, Lion, iddqd66402</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">list_of_cats.txt</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_list}=</span><span class=\"p\">    </span><span class=\"c\">Create List</span><span class=\"p\">    </span><span class=\"c\">Cat</span><span class=\"p\">    </span><span class=\"c\">Mouse</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">    </span><span class=\"c\">Lion</span><span class=\"p\">    </span><span class=\"c\">iddqd66402</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">${cool_list}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Any\" class=\"name\">VerifyAny</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>,\n<a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given texts.", "tags": ["File", "Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1381}, {"name": "Verify Any", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify any of the given texts.</p>\n<p>Verify that at least one of the texts is found. Useful for handling\nsession dependent states, such as logins or popups.</p>\n<p>Note: multiple texts need to be given as one list or as strings separated by &quot;,&quot;.</p>\n<div class=\"section\" id=\"other-parameters\">\n<h1>Other Parameters</h1>\n<p>&lt;other_parameters&gt;</p>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># as strings separated with &quot;,&quot;\nVerifyAny</span><span class=\"p\">    </span><span class=\"c\">Login,Front Page</span><span class=\"p\">\n\n</span><span class=\"c\"># as list\n${texts}=</span><span class=\"p\">    </span><span class=\"c\">Create List</span><span class=\"p\">     </span><span class=\"c\">abc</span><span class=\"p\">    </span><span class=\"c\">def</span><span class=\"p\">\n</span><span class=\"c\">VerifyAny</span><span class=\"p\">    </span><span class=\"c\">${texts}</span><span class=\"p\">\n\n</span><span class=\"c\"># Follow up to check which state\n${login}=</span><span class=\"p\">    </span><span class=\"c\">IsText</span><span class=\"p\">       </span><span class=\"c\">Login</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>,\n<a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify any of the given texts.", "tags": ["File", "Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1318}, {"name": "Verify App", "args": [{"name": "imagename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "imagename: str"}], "doc": "<div class=\"document\">\n<p>Compare image to a known good one.</p>\n<table class=\"docutils field-list\" frame=\"void\" rules=\"none\">\n<col class=\"field-name\" />\n<col class=\"field-body\" />\n<tbody valign=\"top\">\n<tr class=\"field\"><th class=\"field-name\" colspan=\"2\">param imagename:</th></tr>\n<tr class=\"field\"><td>&nbsp;</td><td class=\"field-body\"></td>\n</tr>\n<tr class=\"field\"><th class=\"field-name\">return:</th><td class=\"field-body\"></td>\n</tr>\n</tbody>\n</table>\n</div>\n", "shortdoc": "Compare image to a known good one.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\screenshot.py", "lineno": 25}, {"name": "Verify Attribute", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify attribute value of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using attributes or xpaths like with ClickElement etc. kw:s without specified\nelement_type. If element_type is not specified end result is a type of list:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">click_me</span><span class=\"p\">                        </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">my_button</span><span class=\"p\">   </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">            </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">click_here</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">     </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">click_here</span>\n</pre>\n<p>GetAttribute using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">login</span><span class=\"p\">       </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">value abc</span><span class=\"p\">         </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">name</span><span class=\"p\">  </span><span class=\"c\">contact1</span><span class=\"p\">    </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">login</span><span class=\"p\">   </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">placeholder</span><span class=\"p\">   </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">     </span><span class=\"c\">Finland</span><span class=\"p\">         </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">   </span><span class=\"c\">checked</span><span class=\"p\">         </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">          </span><span class=\"c\">input[type=button]</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">    </span><span class=\"c\">Click Me</span><span class=\"p\">     </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Pacewords like ClickText/Item, TypeText, Dropdown etc.</p>\n<p>In addition, operator performing verification can be given as keyword argument.\nIf 'operator' argument is not given, 'equals' is expected. Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Not equal\nVerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//img</span><span class=\"p\">    </span><span class=\"c\">data-icon</span><span class=\"p\">    </span><span class=\"c\">screen123</span><span class=\"p\">    </span><span class=\"c\">operator=not equal</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//img</span><span class=\"p\">    </span><span class=\"c\">data-icon</span><span class=\"p\">    </span><span class=\"c\">screen123</span><span class=\"p\">    </span><span class=\"c\">operator=!=</span><span class=\"p\">\n\n</span><span class=\"c\"># Greater than\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">7</span><span class=\"p\">    </span><span class=\"c\">element_type=Text</span><span class=\"p\">    </span><span class=\"c\">operator=greater than</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">5</span><span class=\"p\">    </span><span class=\"c\">element_type=Text</span><span class=\"p\">    </span><span class=\"c\">operator=&gt;</span><span class=\"p\">\n\n</span><span class=\"c\"># less than or equal\n# ('operator=less than or equal' also works)\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">10</span><span class=\"p\">   </span><span class=\"c\">element_type=Item</span><span class=\"p\">   </span><span class=\"c\">operator=&lt;=</span><span class=\"p\">\n\n</span><span class=\"c\"># contains\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">somebutton</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">skim</span><span class=\"p\">      </span><span class=\"c\">element_type=Text</span><span class=\"p\">   </span><span class=\"c\">operator=contains</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>attribute: str</dt>\n<dd>Attribute which value we want to get.</dd>\n<dt>value: str</dt>\n<dd>Expected attribute value to verify against.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation</div>\n<div class=\"line\"><br /></div>\n<div class=\"line\">In addition:</div>\n<div class=\"line\">operator : str</div>\n<div class=\"line-block\">\n<div class=\"line\">Which operator use for verification. Possible values:</div>\n<div class=\"line-block\">\n<div class=\"line\">* 'Equals' or '==' (Default)</div>\n<div class=\"line\">* 'Not Equal' or '!='</div>\n<div class=\"line\">* 'Less than' or '&lt;'</div>\n<div class=\"line\">* 'Greater than' or '&gt;'</div>\n<div class=\"line\">* 'Less than or equal' or  '&lt;='</div>\n<div class=\"line\">* 'Greater than or equal' or '&gt;='</div>\n<div class=\"line\">* 'Contains'</div>\n<div class=\"line\">* 'Not Contains'</div>\n</div>\n</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Verify attribute value of an element.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 627}, {"name": "Verify Checkbox", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that checkbox element exist.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">r1c1</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">      </span><span class=\"c\">Cars</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Foo/c2</span><span class=\"p\">      </span><span class=\"c\">Bar</span><span class=\"p\">  </span><span class=\"c\">#row contain texts Foo and Bar</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>NoSuchElementException: Checkbox element not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that checkbox element exist.", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 271}, {"name": "Verify Checkbox Status", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "status", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": null, "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index=1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify checkbox is enabled or disabled.</p>\n<p>In other words verify can user interact with a checkbox or not.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"p\">   </span><span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">    </span><span class=\"c\">enabled</span><span class=\"p\">\n\n</span><span class=\"c\">With table(Pick table with use table keyword first):</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">disabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">enabled</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">enabled</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">   </span><span class=\"c\">Checked</span><span class=\"p\">    </span><span class=\"c\">disabled</span><span class=\"p\">     </span><span class=\"c\">anchor text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>status <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Status for the checkbox. Either enabled or disabled.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Checkbox interaction with the checkbox was not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify checkbox is enabled or disabled.", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 111}, {"name": "Verify Checkbox Value", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify checkbox is on (checked) or off (unchecked).</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">           </span><span class=\"c\">on</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">on</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">          </span><span class=\"c\">off</span><span class=\"p\">     </span><span class=\"c\">Car</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">   </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">2</span><span class=\"p\">  </span><span class=\"c\">#second row that contains text Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Value of the checkbox. On or off.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>ValueError : The checkbox value is not the same</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a></p>\n</div>\n</div>\n", "shortdoc": "Verify checkbox is on (checked) or off (unchecked).", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 192}, {"name": "Verify Col Header", "args": [{"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verifies that a column header with given index matches the expected text.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<p>Note2: If column header has attribute 'aria-label', it's value is considered as expected value.\nIf not and 'title' attribute exists, then title is considered as expected value.\nIf neither aria-label or title exists, then column text is considered as expected value.\nThis is done due to fact that in many web applications header element text contains other texts\nthan what is visible to end users.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Verifies that second column's text is Year\nUseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\"># Verifies that table includes column &quot;Year&quot; at any position\nVerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">\n</span><span class=\"c\">VerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">0</span><span class=\"p\">  </span><span class=\"c\"># 0 = any column\n# Verifies that table includes column &quot;Year&quot; at position 2\nVerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">2</span><span class=\"p\">\n</span><span class=\"c\">VerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">index=2</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>expected <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or value which should be in the column</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Column index. If given, expected text is verified against the given column.\nIf not given or if 0 is given, expected text is verified against any column\n(i.e. column text must exist at any position)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>partial_match: Allow partial match of expected text. Defaults to True unless default value\nhas been changed with SetConfig    PartialMatch</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n<dt>QWebValueError</dt>\n<dd>If the given index value is out of range</dd>\n<dt>ValueError</dt>\n<dd>Index argument is not an integer.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the expected text does not match the actual column text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header%20Count\" class=\"name\">GetColHeaderCount</a>, <a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that a column header with given index matches the expected text.", "tags": ["Tables", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 432}, {"name": "Verify Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that element can be found on the page and it is visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span>\n</pre>\n<p>This keyword has timeout functionality. If the element is not visible after\ngiven timeout, error is raised.\nFor example.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">   </span><span class=\"c\">#waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix. The equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for finding the element. If the element is not visible after\ngiven timeout, error is raised. The str is converted to integer\nusing robot.utils.timestr_to_secs. (default 10 seconds)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundError</dt>\n<dd>Page did not contain element</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a>, <a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>,\n<a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that element can be found on the page and it is visible.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 303}, {"name": "Verify Element Text", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "text_to_find", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_find: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that element contains specified text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElementText</span><span class=\"p\">       </span><span class=\"c\">//input[&#64;value\\=&quot;Button3&quot;]</span><span class=\"p\">      </span><span class=\"c\">ButtonText</span><span class=\"p\">\n</span><span class=\"c\">VerifyElementText</span><span class=\"p\">       </span><span class=\"c\">ipsum</span><span class=\"p\">    </span><span class=\"c\">dolore</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some attribute of wanted element or Xpath expression without xpath= prefix.\nWhen using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>text_to_find <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The text we are trying to verify from the element.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait that element is found before failing.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">strict : bool - Verify that the texts are an exact match.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that element contains specified text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 770}, {"name": "Verify File", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Verify file exists.</p>\n<p>If reference file are not in default folders (images, files, downloads) then\npath should be defined. Returns path.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">cat1.jpg</span><span class=\"p\">\n</span><span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">C:/this/is/path/to/cat1.jpg</span><span class=\"p\">\n</span><span class=\"c\">${path}</span><span class=\"p\">             </span><span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">dog.jpg</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Filename or path to find.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Verify file exists.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 439}, {"name": "Verify File Download", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify file has been downloaded and return file path.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExpectFileDownload</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">               </span><span class=\"c\">Download</span><span class=\"p\">\n</span><span class=\"c\">VerifyFileDownload</span><span class=\"p\">      </span><span class=\"c\">timeout=20s</span><span class=\"p\">     </span><span class=\"c\"># file should be downloaded in 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for the download.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Found more than one file or did not found files at all</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>text : downloaded file path</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Expect%20File%20Download\" class=\"name\">ExpectFileDownload</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a></p>\n</div>\n</div>\n", "shortdoc": "Verify file has been downloaded and return file path.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\download.py", "lineno": 31}, {"name": "Verify File Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text from pdf file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyFileText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to verify</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20File%20Text\" class=\"name\">GetFileText</a>,<a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text from pdf file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 225}, {"name": "Verify Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Verify page contains icon/bitmap.</p>\n<p>This keyword is designed to locate graphical icons/bitmpas on a screen\nby comparing them to a reference image. The function searches the current screen content\nfor the image specified in the 'image' parameter.</p>\n<p>If reference picture is not stored in default folders (images, files, downloads) then\neither full path to image should be used or variable BASE_IMAGE_PATH should be defined\nbefore using this keyword.</p>\n<p>LogMatchedIcons configuration can be used to log screenshots of matched images\nto logs. By default matched images are not logged.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">                    </span><span class=\"c\">LogMatchedIcons</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">  </span><span class=\"c\"># Log matched image to logs\u00df\nVerifyIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Verify image with stricter tolerance and comparing colors\nVerifyIcon</span><span class=\"p\">                   </span><span class=\"c\">plane_red</span><span class=\"p\">      </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">     </span><span class=\"c\">grayscale=False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Capture%20Icon\" class=\"name\">CaptureIcon</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains icon/bitmap.", "tags": ["Icon", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 196}, {"name": "Verify Input Element", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that input element exist.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">Username</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">r1c1</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">Password</span><span class=\"p\">       </span><span class=\"c\">Username</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">r?Qentinel/c3</span><span class=\"p\">  </span><span class=\"c\">Robot</span><span class=\"p\">   </span><span class=\"c\">#row contains texts Qentinel and Robot, cell 3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it. (default None)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>NoSuchElementException: Checkbox element not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that input element exist.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 531}, {"name": "Verify Input Status", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "status", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify input field is enabled or disabled.</p>\n<p>In other words verify can user interact with an input field or not.\nElement is considered to be disabled if disabled or readonly attribute exists</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">Password</span><span class=\"p\">        </span><span class=\"c\">Enabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">SSN</span><span class=\"p\">             </span><span class=\"c\">Disabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">SSN</span><span class=\"p\">             </span><span class=\"c\">ReadOnly</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputStatus</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">Enabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Disabled</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>status <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Status for the input field. Either enabled, readonly or disabled.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the field interaction is not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input field is enabled or disabled.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 448}, {"name": "Verify Input Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected_value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify input field has given value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValue</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValue</span><span class=\"p\">    </span><span class=\"c\">Phone Nro</span><span class=\"p\">         </span><span class=\"c\">0401234567</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">0401234567</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>expected_value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that the input field should contain.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs :</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the input value is not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input field has given value.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 329}, {"name": "Verify Input Values", "args": [{"name": "input_values", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["dict[str, str]", "str"], "typedocs": {"dict": "dictionary", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_values: dict[str, str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify input fields have given values.</p>\n<p>Accepts a .txt file or Robot FW dictionary as a parameter. If using a text file, the locator\nand the expected value should be separated with a comma on each row.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">list_of_locators_and_values.txt</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_dict}=</span><span class=\"p\">           </span><span class=\"c\">Create Dictionary</span><span class=\"p\">    </span><span class=\"c\">Name=Jane</span><span class=\"p\">    </span><span class=\"c\">Email=janedoe&#64;iddqd.com</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">                     </span><span class=\"c\">Phone=04049292243923</span><span class=\"p\">     </span><span class=\"c\">Address=Yellow street 33 C 44</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">${cool_dict}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input fields have given values.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 401}, {"name": "Verify Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify Item (usually icon or picture) exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyItem does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the VerifyItem keyword verifies that element which\nhas attribute Canis exist.\nIf there are multiple instances of such of elements you can\nspecific which one is looking for by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>To enable searching items also from Shadow DOM, use SetConfig Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">         </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">VerifyItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>tag:</strong> html tag of preferred element -</div>\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n<div class=\"line\"><strong>partial_match: False</strong>. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Verify Item (usually icon or picture) exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 996}, {"name": "Verify Length", "args": [{"name": "expected_length", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_length: int | str"}], "doc": "<div class=\"document\">\n<p>Verify lists length.</p>\n</div>\n", "shortdoc": "Verify lists length.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 94}, {"name": "Verify Links", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "current", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = current"}, {"name": "log_all", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log_all: bool = False"}, {"name": "header_only", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "header_only: bool = True"}, {"name": "timeout", "type": null, "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=0"}], "doc": "<div class=\"document\">\n<p>Verify that all links on a given website return good HTTP status codes.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">https://qentinel.com/</span>\n</pre>\n<p>The above example verifies that all links work on qentinel.com</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">https://qentinel.com/</span><span class=\"p\">       </span><span class=\"c\">True</span>\n</pre>\n<p>The above example verifies that all links work on qentinel.com and logs the status of all the\nchecked links.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span>\n</pre>\n<p>The above example verifies that all links work on on the current website.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">header_only=False</span>\n</pre>\n<p>The above example verifies that all links work on on the current website.\nArgument <strong>header_only=False</strong> instructs QWeb to double-check 404/405's\nusing GET method (by default only headers are checked).\nHeaders should normally return same code as GET, but in some cases header can be configured\nintentionally to return something else.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n<dt>log_all <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Browser name. For example chrome, firefox or ie.</dd>\n<dt>header_only <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>True: check headers only (default)\nFalse: In case of header returning 404 or 405, double-check with GET</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int (optional)</span></dt>\n<dd>How long we wait for API call response before failing.\nDefault as defined in &quot;DefaultTimeout&quot;.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Go%20To\" class=\"name\">GoTo</a>,<a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that all links on a given website return good HTTP status codes.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 508}, {"name": "Verify List", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify list contains given text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyList</span><span class=\"p\">      </span><span class=\"c\">Pace Robot</span><span class=\"p\">              </span><span class=\"c\">#list contains given text (text can be anywhere)\nVerifyList</span><span class=\"p\">      </span><span class=\"c\">Test Automation</span><span class=\"p\">     </span><span class=\"c\">2</span><span class=\"p\">   </span><span class=\"c\">#List index 2 contains given text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20No%20List\" class=\"name\">VerifyNoList</a>, <a href=\"#Verify%20Length\" class=\"name\">VerifyLength</a></p>\n</div>\n</div>\n", "shortdoc": "Verify list contains given text.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 110}, {"name": "Verify No Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Wait element can not be found on the page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;do_not_wait_me&quot;]</span>\n</pre>\n<p>This keyword has timeout functionality. If the element is still visible after\ngiven timeout, error is raised.\nFor example.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">   </span><span class=\"c\">#waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix. The equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for the element to disappear. If the element is visible after\ngiven timeout, error is raised. The str is converted to integer\nusing robot.utils.timestr_to_secs. (default 10 seconds)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchElementException</dt>\n<dd>Page did contain the element</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Wait element can not be found on the page.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 360}, {"name": "Verify No File Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text not exists in pdf-file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoFileText</span><span class=\"p\">     </span><span class=\"c\">Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that should not exist.</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newline (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text not exists in pdf-file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 279}, {"name": "Verify No Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify Item (usually icon or picture) is not exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the VerifyItem keyword verifies that element which\nhas attribute Canis is not exist.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Verify Item (usually icon or picture) is not exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1069}, {"name": "Verify No List", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}], "doc": "<div class=\"document\">\n<p>Verify that text is not in the list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyNoList</span><span class=\"p\">    </span><span class=\"c\">Pace Robot</span><span class=\"p\">              </span><span class=\"c\">#Text is not in list\nVerifyNoList</span><span class=\"p\">    </span><span class=\"c\">Test Automation</span><span class=\"p\">     </span><span class=\"c\">2</span><span class=\"p\">   </span><span class=\"c\">#List index 2 not containing text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that text is not in the list.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 169}, {"name": "Verify No Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that a given option is not in a dropdown menu/list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoOption</span><span class=\"p\">     </span><span class=\"c\">Foobar</span><span class=\"p\">    </span><span class=\"c\">Cat</span>\n</pre>\n<p>In the above example VerifyNoOption keyword checks that the option &quot;Cat&quot; is not found\nfrom the Foobar dropdown menu/list.</p>\n<p>This keyword can also be used with table cells and XPaths. When using XPaths, the equal sign &quot;=&quot;\nmust be escaped with a &quot;\\&quot;.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Option text that should not exists in options list</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that a given option is not in a dropdown menu/list.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 342}, {"name": "Verify No Pdf Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text not exists in pdf-file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoPdfText</span><span class=\"p\">     </span><span class=\"c\">Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that should not exist.</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>,<a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text not exists in pdf-file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 250}, {"name": "Verify No Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that page does not contain given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait 10 seconds until checks if the\nCanis exist on the page</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">      </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If page does not contain text</dd>\n</dl>\n<p>Searches using XPath contains function so that substrings are also\nlooked through.</p>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that page does not contain given text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 156}, {"name": "Verify Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "expected_option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that option exist in dropdown menu/list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyOption</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the VerifyOption keyword verifies from a dropdown\nthat Collie is in a list.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>expected_option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>option that should be included in dropdown options</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that option exist in dropdown menu/list.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 241}, {"name": "Verify Pdf Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text from pdf file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyPdfText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span><span class=\"p\">\n</span><span class=\"c\">VerifyPdfText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span><span class=\"p\">    </span><span class=\"c\">normalize=True</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to verify</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Pdf%20Text\" class=\"name\">GetPdfText</a>,<a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text from pdf file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 199}, {"name": "Verify Selected Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "expected_option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that an option is selected from dropdown menu/list.\nNote: with multiselection dropdown verify each option individually.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the VerifySelectedOption keyword verifies from a dropdown\nthat Collie is selected.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">         </span><span class=\"c\">Robot</span><span class=\"p\">     </span><span class=\"c\">#last row, third cell\nVerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">   </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>expected_option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>option which should be selected</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that an option is selected from dropdown menu/list. Note: with multiselection dropdown verify each option individually.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 128}, {"name": "Verify Table", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify text in table coordinates.</p>\n<p>Reads cell value from coordinates in active table and verifies it\nagainst expected value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTable</span><span class=\"p\">            </span><span class=\"c\">r2c3</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table. R specifies row and c column.\nOrder does not matter.</dd>\n<dt>expected <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Expected value that needs to be found in table.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>partial_match</strong>: This argument lets you decide if you want to find column names</div>\n<div class=\"line\">by looking for an exact match to your search term or if a partial match is</div>\n<div class=\"line\">good enough. For example, when you're specifying which column to look at using</div>\n<div class=\"line\">a text-based method (like &quot;r1/?cRobot&quot;), this determines whether the system should</div>\n<div class=\"line\">look for an exact match to &quot;Robot&quot; or if it can work with columns that only partly</div>\n<div class=\"line\">match the word &quot;Robot&quot;.</div>\n<div class=\"line\">It also applies to checking values: this setting controls whether a value that only</div>\n<div class=\"line\">partially matches your criteria is considered okay.</div>\n<div class=\"line\">Default: if partial_match is not given, the value of SetConfig PartialMatch is used.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueMismatchErr</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text in table coordinates.", "tags": ["Tables", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 100}, {"name": "Verify Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify page contains given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyText does not require for the text to be unique.</p>\n<p><em>Note: Slots are a bit unique as they do not have size/offset. This means\nthat our default visibility check will treat slots as not visible. If text is\ndirectly on the slot, use visibility=False argument in VerifyText keyword. For example:</em></p>\n<pre class=\"code html literal-block\">\n<span class=\"p\">&lt;</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>My Text<span class=\"p\">&lt;/</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>\n</pre>\n<p><em>The above needs visibility=False argument, as text is directly on the slot. However,\nthis one would work without turning visibility check off, since text is on a child\nelement under slot:</em></p>\n<pre class=\"code html literal-block\">\n<span class=\"p\">&lt;</span><span class=\"nt\">slot</span><span class=\"p\">&gt;&lt;</span><span class=\"nt\">span</span><span class=\"p\">&gt;</span>My Text<span class=\"p\">&lt;/</span><span class=\"nt\">span</span><span class=\"p\">&gt;&lt;/</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>\n</pre>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n<p>To enable searching items also from Shadow DOM, use SetConfig Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">         </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text.\nwindow_find : True - When WindowFind is used VerifyText is not looking\ntexts for dom, but simulates ctrl+f like search to current viewport.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundError</dt>\n<dd>If page does not contain text</dd>\n</dl>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a>, <a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20Any\" class=\"name\">VerifyAny</a>, <a href=\"#Verify%20Attribute\" class=\"name\">VerifyAttribute</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>,\n<a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a>, <a href=\"#Verify%20Links\" class=\"name\">VerifyLinks</a>,\n<a href=\"#Verify%20No%20Text\" class=\"name\">VerifyNoText</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a>,\n<a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 55}, {"name": "Verify Text Count", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "expected_count", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_count: int | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify page contains given text given times.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyTextCount does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">3</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">3</span><span class=\"p\">      </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">              </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">   </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>expected_count <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How many times text must be shown on page</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If page does not contain text expected number of times</dd>\n</dl>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>, <a href=\"#Get%20Text%20Count\" class=\"name\">GetTextCount</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given text given times.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 221}, {"name": "Verify Texts", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>VerifyAll</cite> instead.</p>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `VerifyAll` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1291, "deprecated": true}, {"name": "Verify Title", "args": [{"name": "title", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verifies that current page's title matches expected title.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTitle</span><span class=\"p\">      </span><span class=\"c\">Google</span><span class=\"p\">\n</span><span class=\"c\">VerifyTitle</span><span class=\"p\">      </span><span class=\"c\">Google</span><span class=\"p\">     </span><span class=\"c\">timeout=3</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>title <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The expected title</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for title to change before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the expected title differs from actual page title</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>, <a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that current page's title matches expected title.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 404}, {"name": "Verify Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verifies that current page url/location matches expected url.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyUrl</span><span class=\"p\">      </span><span class=\"c\">https://www.google.com</span><span class=\"p\">\n</span><span class=\"c\">VerifyUrl</span><span class=\"p\">      </span><span class=\"c\">https://www.google.com</span><span class=\"p\">     </span><span class=\"c\">timeout=5</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The expected url</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for url to change before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the expected url differs from current url</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>, <a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that current page url/location matches expected url.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 339}, {"name": "Version", "args": [{"name": "distribution_name", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "distribution_name"}], "doc": "<div class=\"document\">\n<p>Get the version string for the named package.</p>\n<table class=\"docutils field-list\" frame=\"void\" rules=\"none\">\n<col class=\"field-name\" />\n<col class=\"field-body\" />\n<tbody valign=\"top\">\n<tr class=\"field\"><th class=\"field-name\" colspan=\"2\">param distribution_name:</th></tr>\n<tr class=\"field\"><td>&nbsp;</td><td class=\"field-body\">The name of the distribution package to query.</td>\n</tr>\n<tr class=\"field\"><th class=\"field-name\">return:</th><td class=\"field-body\">The version string for the package as defined in the package's\n&quot;Version&quot; metadata key.</td>\n</tr>\n</tbody>\n</table>\n</div>\n", "shortdoc": "Get the version string for the named package.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\.pyenv\\pyenv-win\\versions\\3.9.12\\lib\\importlib\\metadata.py", "lineno": 562}, {"name": "Write Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type text with single-character keys.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to type.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>delay = Time to wait (seconds) before typing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">WriteText</span><span class=\"p\">    </span><span class=\"c\">Hello World!</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Type text with single-character keys.", "tags": ["input", "Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1263}, {"name": "Xhr Timeout", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: int | float | str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  XHRTimeout</cite> instead.</p>\n<p>Set default timeout for XHR (How log we wait page to be loaded).</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">XHRTimeout</span><span class=\"p\">        </span><span class=\"c\">60</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  XHRTimeout` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 121, "deprecated": true}, {"name": "Zip Files", "args": [{"name": "name_of_zip", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_of_zip: str"}, {"name": "files_to_zip", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "files_to_zip: str"}], "doc": "<div class=\"document\">\n<p>Zip files.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file</span><span class=\"p\">      </span><span class=\"c\">rabbit.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_2</span><span class=\"p\">    </span><span class=\"c\">dog.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_3</span><span class=\"p\">    </span><span class=\"c\">rabbit.txt, dog.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_4</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/secrets/cat.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_5</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/secrets/cat.txt, C:/automation/kangaroo.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>name_of_zip <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Name of the zip file created.</dd>\n<dt>files_to_zip <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Files to be zipped, separated by &quot;,&quot; in case of multiple files.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Zip files.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 364}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Get Timeout", "Set Active Area Function", "Set Config", "Set Wait Function"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Case Insensitive", "Check Input Value", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Default Document", "Drop Down", "Get Input Value", "Is Icon", "List Cookies", "Log Screenshot", "Scan Click", "Skim Click", "Use Table", "Verify File Text", "Verify Icon", "Verify Links", "Verify No File Text", "Verify No Pdf Text", "Verify Pdf Text"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["Type Texts", "Verify Input Values"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Capture Icon", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Default Timeout", "Drag Drop", "Drop Down", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Press Key", "Right Click", "Run Block", "Save File", "Scan Click", "Scroll", "Scroll Text", "Scroll To", "Skim Click", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use List", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Element", "Verify Element Text", "Verify File Download", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify List", "Verify No Element", "Verify No Item", "Verify No Option", "Verify No Text", "Verify Option", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Xhr Timeout"], "accepts": ["string", "Real"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Capture Icon", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Default Timeout", "Drag Drop", "Drop Down", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Col Header", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get List", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Press Key", "Right Click", "Run Block", "Save File", "Scan Click", "Scroll", "Scroll Text", "Scroll To", "Set Window Size", "Skim Click", "Switch Browser", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use List", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Col Header", "Verify Element", "Verify Element Text", "Verify File Download", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify Length", "Verify List", "Verify No Element", "Verify No Item", "Verify No List", "Verify No Option", "Verify No Text", "Verify Option", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Xhr Timeout"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Verify All", "Verify Any", "Verify Texts"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["Click Icon", "Click Item Until", "Click Item While", "Click Text", "Click Until", "Click While", "Execute Javascript", "Get Attribute", "Get Col Header", "Get Config", "Get List", "Get Webelement", "Is Icon", "Open Browser", "Remove File", "Reset Config", "Save File", "Scan Click", "Scroll To", "Skim Click", "Swipe Down", "Swipe Left", "Swipe Right", "Swipe Up", "Use List", "Verify Attribute", "Verify Col Header", "Verify Icon", "Verify List", "Verify No List"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Appstate", "Capture Icon", "Case Insensitive", "Check Input Value", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Copy Text", "Css Selectors", "Debug On", "Default Document", "Default Timeout", "Drag Drop", "Drop Down", "Execute Javascript", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Config", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get List", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Cookie", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Log Screenshot", "Move Files", "Open Browser", "Press Key", "Remove File", "Reset Config", "Right Click", "Run Block", "Save File", "Scan Click", "Screenshot Type", "Scroll", "Scroll Text", "Scroll To", "Search Direction", "Set Config", "Set Input Handler", "Set Line Break", "Set Search Strategy", "Skim Click", "Swipe Down", "Swipe Left", "Swipe Right", "Swipe Up", "Switch Browser", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use File", "Use Frame", "Use List", "Use Pdf", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify App", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Col Header", "Verify Element", "Verify Element Text", "Verify File", "Verify File Download", "Verify File Text", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify Length", "Verify Links", "Verify List", "Verify No Element", "Verify No File Text", "Verify No Item", "Verify No List", "Verify No Option", "Verify No Pdf Text", "Verify No Text", "Verify Option", "Verify Pdf Text", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Write Text", "Xhr Timeout", "Zip Files"], "accepts": ["Any"]}]}
+libdoc = {"specversion": 2, "name": "QWeb", "doc": "<div class=\"document\">\n<p>QWeb is a powerful and versatile <a class=\"reference external\" href=\"https://robotframework.org/\">Robot Framework</a> library that\nenables efficient and reliable web testing and automation. One of the key strengths of QWeb\nis its intuitive and user-friendly syntax, which makes it easy to write and maintain complex\ntest cases.</p>\n<p>The library offers:</p>\n<ul class=\"simple\">\n<li><strong>Intuitive Syntax</strong>: User-friendly syntax for writing and maintaining complex test cases.</li>\n<li><strong>Smart locators</strong>: Interact with web elements using natural language locators.\n| <a class=\"reference internal\" href=\"#locators\">Locators</a></li>\n<li><strong>Anchors</strong>: Used to pinpoint specific instances of web elements with the same locator.\n| <a class=\"reference internal\" href=\"#anchors\">Anchors</a></li>\n<li><strong>Visibility</strong>: By default interacting with visible elements only, but allowing access to\nhidden elements when needed.\n| <a class=\"reference internal\" href=\"#visibility\">Visibility</a></li>\n<li><strong>Shadow DOM support</strong>: Allows interaction with elements inside a shadow DOM, which are\nencapsulated from the main document.\n| <a class=\"reference internal\" href=\"#shadow-dom\">Shadow_dom</a></li>\n<li><strong>Automatic waits</strong>: Automatically handling latencies etc. via automatic wait times.\n| <a class=\"reference internal\" href=\"#waits\">Waits</a></li>\n<li><strong>Automatic frame handling</strong>: Automatically moving between frames and finding elements from\nany embedded frame.</li>\n<li>And many more features...</li>\n</ul>\n<div class=\"section\" id=\"driver-management\">\n<h1>Driver Management</h1>\n<p>QWeb uses the Selenium WebDriver internally to interact with a web browser.\nSince QWeb 3.0.0 / Selenium 4.10.0 <cite>browser drivers</cite> can be automatically downloaded and\ninstalled using Selenium Manager, provided that driver is not found in PATH.\nAlternatively you can still manually download and install drivers or let 3rd party\nutilities like Webdriver Manager do it for you.</p>\n<p>For Chrome <cite>browser_version</cite> can also be given; if your locally installed Chrome matches\nthis version, it will be used. If not, a suitable version of <cite>Chrome for Testing</cite> will be\nautomatically downloaded</p>\n</div>\n<div class=\"section\" id=\"locator-strategies\">\n<span id=\"locators\"></span><h1>Locator strategies</h1>\n<p>One of the greatest conceptual difference of QWeb compared to other web test automation\nlibraries is the use of UI texts as a locator when ever it\u2019s possible.\nWith UI text as a locator there is no need to inspect html source, you can just use what\nyou see on the screen. On the other hand, textual locators are usually easier to maintain.</p>\n<p>There are situations where more complex locators (xpaths etc.) might be needed, but it\u2019s\nusually a small portion of test cases / steps. If you notice yourself using xpaths in most\nsteps, please consider re-factoring your test script implementation!</p>\n<p>Here are four ways of finding elements. These are presented in order of preference of using\nthem:</p>\n<p><strong>Text</strong></p>\n<p>The most preferred way is using UI texts as locators. Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using textual locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">       </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyText</span><span class=\"p\">          </span><span class=\"s\">The animal friendly clothing company</span><span class=\"p\">\n    </span><span class=\"nf\">ClickText</span><span class=\"p\">           </span><span class=\"s\">Scar the Lion</span><span class=\"p\">\n    ...\n    </span><span class=\"c\"># finds input field based on label\n</span><span class=\"p\">    </span><span class=\"nf\">TypeText</span><span class=\"p\">            </span><span class=\"s\">Username</span><span class=\"p\">        </span><span class=\"s\">myusername&#64;test.com</span>\n</pre>\n<p><strong>Attribute values</strong></p>\n<p>If there is no visible UI text available, it's possible to find elements using any attribute\nvalue the element has. In the simplest form you can hover over an element and see the alt\ntext/title value, if available.</p>\n<p>Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using attribute values as locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">    </span><span class=\"s\">hrrps://www.google.com</span><span class=\"p\">      </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"c\"># finds input field based on attribute title value\n</span><span class=\"p\">    </span><span class=\"nf\">TypeText</span><span class=\"p\">            </span><span class=\"s\">Search</span><span class=\"p\">                     </span><span class=\"s\">Copado Robotic Testing</span><span class=\"p\">\n    </span><span class=\"nf\">ClickItem</span><span class=\"p\">           </span><span class=\"s\">Clear search</span>\n</pre>\n<p><strong>Xpaths</strong></p>\n<p>Xpaths are also supported as locators. These are mostly used by QWords ending with\n<strong>*Element</strong>.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using xpaths as locators</span><span class=\"p\">\n    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">    </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyElement</span><span class=\"p\">       </span><span class=\"s\">//ul[&#64;class\\=&quot;product-list&quot;]</span><span class=\"p\">\n    </span><span class=\"nf\">ClickText</span><span class=\"p\">           </span><span class=\"s\">Our Story</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyNoElement</span><span class=\"p\">     </span><span class=\"s\">xpath\\=//ul[&#64;class\\=&quot;product-list&quot;]</span>\n</pre>\n<div class=\"admonition caution\">\n<p class=\"first admonition-title\">Caution!</p>\n<p class=\"last\">Xpath locators or keywords using them do not work in Shadow DOM. If your\nweb application uses Shadow DOM\u2019s, use <strong>*Text</strong> and <strong>*Item</strong> keywords instead.</p>\n</div>\n<p><strong>Icons / images</strong></p>\n<p>Bitmap/image comparison can also be used.\nIn that case, you need to have a reference image and it will be found (or clicked) on\na screen.\nTypically image comparison tends to be a bit harder to maintain.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Example test case using reference image as locator</span><span class=\"p\">\n    </span><span class=\"nf\">SetConfig</span><span class=\"p\">           </span><span class=\"s\">LogMatchedIcons</span><span class=\"p\">    </span><span class=\"s\">True</span><span class=\"p\">  </span><span class=\"c\"># Log matched image to logs\n</span><span class=\"p\">    </span><span class=\"nf\">OpenBrowser</span><span class=\"p\">         </span><span class=\"s\">https://qentinelqi.github.io/shop</span><span class=\"p\">    </span><span class=\"s\">chrome</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyIcon</span><span class=\"p\">          </span><span class=\"s\">paw.png</span><span class=\"p\">\n    </span><span class=\"nf\">ClickIcon</span><span class=\"p\">           </span><span class=\"s\">cart.png</span>\n</pre>\n<div class=\"admonition note\">\n<p class=\"first admonition-title\">Note</p>\n<p class=\"last\">Keywords for using icons/images have a naming convention <strong>*Icon</strong>.\n(ClickIcon, VerifyIcon etc.)</p>\n</div>\n</div>\n<div class=\"section\" id=\"anchors-1\">\n<span id=\"anchors\"></span><h1>Anchors</h1>\n<p>When a locator identifies multiple elements, <tt class=\"docutils literal\">anchors</tt> can be used to pinpoint a\nspecific instance. Anchor can be another nearby text or a numeric index.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Login</span><span class=\"p\">      </span><span class=\"c\">anchor=Cancel</span><span class=\"p\">  </span><span class=\"c\"># Textual anchor\nClickText</span><span class=\"p\">    </span><span class=\"c\">Login</span><span class=\"p\">      </span><span class=\"c\">anchor=3</span><span class=\"p\">       </span><span class=\"c\"># Numeric anchor</span>\n</pre>\n</div>\n<div class=\"section\" id=\"shadow-dom-1\">\n<span id=\"shadow-dom\"></span><h1>Shadow DOM</h1>\n<p>Shadow DOM is a web standard that allows for encapsulation of styling and markup in web\ncomponents. It's like a lightweight document inside the main document, with its own set of\nelements. Elements inside a shadow DOM are not directly accessible using traditional locators\nlike XPath or CSS selectors.</p>\n<p>Special methods or settings are often required in automation frameworks to interact with\nelements inside a shadow DOM. QWeb provides support for elements inside a shadow DOM, which are\nencapsulated from the main document. To enable searching elements inside the shadow DOM, use:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">  </span><span class=\"c\"># or 'on'</span>\n</pre>\n<div class=\"admonition tip\">\n<p class=\"first admonition-title\">Tip</p>\n<p class=\"last\">Any QWeb keyword accepting locator as a <strong>text</strong> or <strong>attribute value</strong> will work with\nelements inside a shadow DOM.</p>\n</div>\n<div class=\"admonition important\">\n<p class=\"first admonition-title\">Important</p>\n<p class=\"last\">SetConfig ShadowDOM    True    must be used to enable element search inside\na shadow DOM</p>\n</div>\n<div class=\"admonition caution\">\n<p class=\"first admonition-title\">Caution!</p>\n<p class=\"last\">Some keywords, for example GetWebElement, work with many locator types.</p>\n</div>\n<p>These keywords work with elements inside a shadow DOM when text or attribute values are used\nas a locator. Note that some of these keywords may require you to give an additional argument,\nfor example:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">     </span><span class=\"c\">GetWebelement</span><span class=\"p\">   </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"visibility-1\">\n<span id=\"visibility\"></span><h1>Visibility</h1>\n<p>In web automation, visibility refers to whether a web element is visible to the user or not.\nAn element might exist in the DOM (Document Object Model) but may not be visible due to\nvarious reasons like CSS styles (e.g., display: none) or even by mistake.\nAutomation frameworks often provide ways to interact only with visible elements,\nas invisible elements are typically not interactable by the user.</p>\n<p>QWeb by default finds only visible elements, but provides support for elements that are not\nvisible by default.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">       </span><span class=\"c\">visibility=False</span><span class=\"p\">  </span><span class=\"c\"># extend one element search to invisible elements\n</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">Visibility</span><span class=\"p\">  </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\"># extend element search to invisible elements globally</span>\n</pre>\n</div>\n<div class=\"section\" id=\"automatic-wait-times\">\n<span id=\"waits\"></span><h1>Automatic Wait Times</h1>\n<p>QWeb automatically handles latencies by introducing wait times.\nThis ensures that the automation script waits for the web elements to load or become\ninteractable before performing actions, reducing the chances of test failures due to element\nnot found or not interactable errors.</p>\n<p>There should not be reason to use <strong>Sleep</strong> keyword or such except in very exceptional cases.\nAlmost all QWords have an inbuilt timeout, i.e they keep re-trying to find elements and do\ntheir action until action succeeds OR until timeout limit is reached.\nBy default this timeout limit is 10 seconds.</p>\n<p>You can change this timeout temporarily by giving an argument timeout:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># only wait 3 seconds for element to appear\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">Username</span><span class=\"p\">    </span><span class=\"c\">timeout=3</span><span class=\"p\">\n\n</span><span class=\"c\"># wait max 30 seconds for element to appear\nClickText</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">       </span><span class=\"c\">timeout=30</span>\n</pre>\n<p>You can also change timeouts for every keyword (globally) with SetConfig:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">60</span><span class=\"p\">\n</span><span class=\"c\"># would wait 60 seconds for text to appear before failing\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">Username</span><span class=\"p\">\n</span><span class=\"c\"># would wait max 60 seconds for element to appear\nClickText</span><span class=\"p\">       </span><span class=\"c\">Login</span>\n</pre>\n<div class=\"admonition tip\">\n<p class=\"first admonition-title\">Tip</p>\n<p>It's preferable to use QWeb's automatic wait times instead of Sleep keyword.</p>\n<ul class=\"last simple\">\n<li><strong>Sleep</strong> keyword waits for the specified amount of time.</li>\n<li>QWeb automatically waits until element is visible or until timeout limit is reached and\nthen continue.</li>\n</ul>\n</div>\n</div>\n</div>\n", "version": "", "generated": "2024-05-13T11:51:21+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\__init__.py", "lineno": 66, "tags": ["Alert", "Browser", "Checkbox", "Config", "Debug", "Dropdown", "Error handling", "File", "Getters", "Icon", "Input", "Interaction", "Item", "Javascript", "Lists", "Logging", "PDF", "Remote", "Tables", "Text", "Verification", "Window"], "inits": [{"name": "__init__", "args": [{"name": "run_on_failure_keyword", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Log Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure_keyword: str = Log Screenshot"}], "doc": "<div class=\"document\">\n<p>Initializes the QWeb library and adds all the keywords to the instance.</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">run_on_failure_keyword</tt>:\nThe keyword to run when a failure occurs. Default is &quot;Log Screenshot&quot;.</li>\n</ul>\n</div>\n", "shortdoc": "Initializes the QWeb library and adds all the keywords to the instance.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\__init__.py", "lineno": 299}], "keywords": [{"name": "Appstate", "args": [{"name": "block", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "block: str"}, {"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<div class=\"document\">\n<p>Appstate is a pre-condition of a test case.</p>\n<p>It sets Application(s) under test to correct, known state.\nFirst keyword of every test case is Appstate.\nIt is a navigation system across different states in system under test,\nor between separate applications.\nThey are typically set under resources folder, keywords.robot file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Appstate</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">\n</span><span class=\"c\">#with arguments:\nAppstate</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">fenix</span><span class=\"p\">   </span><span class=\"c\">rising123</span><span class=\"p\">\n\n</span><span class=\"c\">#Example block:\nLogin</span><span class=\"p\">\n    </span><span class=\"c\">[Arguments]</span><span class=\"p\">     </span><span class=\"c\">${USER}=username</span><span class=\"p\">     </span><span class=\"c\">${PASS}=password</span><span class=\"p\">\n    </span><span class=\"c\">Goto</span><span class=\"p\">        </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Password</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">Welcome, ${USER}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>block <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Action word/Block to execute</dd>\n<dt>args <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">any</span></dt>\n<dd>Possible args for block</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Run%20Block\" class=\"name\">RunBlock</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Appstate is a pre-condition of a test case.", "tags": ["Config", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\blocks.py", "lineno": 98}, {"name": "Back", "args": [], "doc": "<div class=\"document\">\n<p>Navigates back in the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Back</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Forward\" class=\"name\">Forward</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Navigates back in the current window.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 103}, {"name": "Capture Icon", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "folder", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshots", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "folder: str = screenshots"}, {"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshot_{}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = screenshot_{}.png"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Take a screenshot of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${some_xpath}=</span><span class=\"p\">       </span><span class=\"c\">//*[&#64;value\\=&quot;Button3&quot;]</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">${some_xpath}</span><span class=\"p\">\n\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">filename=custom_screenshot_name_123.png</span><span class=\"p\">\n</span><span class=\"c\">CaptureIcon</span><span class=\"p\">          </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">C:/custom/folder/path</span><span class=\"p\">   </span><span class=\"c\">custom_screenshot_name_123.png</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for the element we are trying to capture, XPath or attribute value. When using\nXPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>folder <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional folder path. Default value is the screenshots folder.</dd>\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional filename.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>filepath : full path to saved screenshot</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Take a screenshot of an element.", "tags": ["Icon", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 282}, {"name": "Case Insensitive", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CaseInsensitive</cite> instead.</p>\n<p>Set containing_text_match according to selected case sensitivity.</p>\n<p>Default = False\nNote: if containing_text_match has been overwritten manually\nthis will return the default value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CaseInsensitive` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 238, "deprecated": true}, {"name": "Check Input Value", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CheckInputValue</cite> instead.</p>\n<p>Check that real value matches to preferred value after TypeText.</p>\n<p>If value is not match we try to re type (three times before fail)\nThis is optional feature. Default = false.\nUse with caution on elements where webdriver has tendency to lost focus\nand some part of the preferred text gone missing.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>,\n<a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CheckInputValue` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 185, "deprecated": true}, {"name": "Click Cell", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click table cell.</p>\n<p>Locates cell by coordinates or text from active table and clicks it</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCell</span><span class=\"p\">    </span><span class=\"c\">r2c3</span><span class=\"p\">\n</span><span class=\"c\">ClickCell</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">                  </span><span class=\"c\">#Last row, last cell\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?SomeText/c3</span><span class=\"p\">           </span><span class=\"c\">#Click cell 3 in row that contains text SomeText\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">      </span><span class=\"c\">Hello</span><span class=\"p\">   </span><span class=\"c\">#Click cell 3 in row with words Robot and Hello in it\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">            </span><span class=\"c\">tag=a</span><span class=\"p\">   </span><span class=\"c\">#Clicks first child element with a tag\nClickCell</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">      </span><span class=\"c\">index=2</span><span class=\"p\">  </span><span class=\"c\">tag=input</span><span class=\"p\">  </span><span class=\"c\">#Clicks the second child element of cell 3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table or some text that locates in preferred row.\nR specifies row and c column.\nr1 = first row, r-1 = last row, r?Qentinel/ = row that contains word Qentinel</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If row is located by text which is not unique, use anchor to point correct one.\nAnchor can be some other text in same row or index. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Use index when table cell contains more than one clickable element and preferred one\nis not the first one. Requires the use of tag and value should be &gt; 0, default = 1.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>partial_match</strong>: This argument lets you decide if you want to find column names</div>\n<div class=\"line\">by looking for an exact match to your search term or if a partial match is</div>\n<div class=\"line\">good enough. For example, when you're specifying which column to look at using</div>\n<div class=\"line\">a text-based method (like &quot;r1/?cRobot&quot;), this determines whether the system should</div>\n<div class=\"line\">look for an exact match to &quot;Robot&quot; or if it can work with columns that only partly</div>\n<div class=\"line\">match the word &quot;Robot&quot;.</div>\n<div class=\"line\">Default: if partial_match is not given, the value of SetConfig PartialMatch is used.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Click table cell.", "tags": ["Interaction", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 228}, {"name": "Click Checkbox", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check or uncheck a checkbox.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">               </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">              </span><span class=\"c\">off</span><span class=\"p\">  </span><span class=\"c\">#last row, third cell\nClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">        </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">I am not a robot</span><span class=\"p\">    </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">anchor text</span><span class=\"p\">\n</span><span class=\"c\">ClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">         </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">Test</span><span class=\"p\">  </span><span class=\"c\">#row contains texts Robot and Test\nClickCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">         </span><span class=\"c\">on</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">    </span><span class=\"c\">#third row which contains text Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Value of the checkbox. On or off.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundErr</dt>\n<dd>CheckBox element not found</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Check or uncheck a checkbox.", "tags": ["Checkbox", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 33}, {"name": "Click Element", "args": [{"name": "xpath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click element specified by xpath.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\"># using WebElement instance\n${elem}=</span><span class=\"p\">              </span><span class=\"c\">GetWebElement</span><span class=\"p\">    </span><span class=\"c\">Click Me</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">${elem}</span>\n</pre>\n<p>To double-click element, use argument <strong>doubleclick=True</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">             </span><span class=\"c\">double_click_me</span><span class=\"p\">       </span><span class=\"c\">doubleclick=True</span>\n</pre>\n<p>Or use SetConfig</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">             </span><span class=\"c\">DoubleClick</span><span class=\"p\">           </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">ClickElement</span><span class=\"p\">          </span><span class=\"c\">double_click_me</span><span class=\"p\">       </span><span class=\"c\">tag=button</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript click instead of Selenium.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20List\" class=\"name\">ClickList</a>,\n<a href=\"#Click%20Text\" class=\"name\">ClickText</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Right%20Click\" class=\"name\">RightClick</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Click element specified by xpath.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 31}, {"name": "Click Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Click the icon/bitmap on the screen.</p>\n<p>This keyword is designed to locate and interact with graphical icons/bitmpas on a screen\nby comparing them to a reference image. The function searches the current screen content\nfor the image specified in the 'image' parameter.</p>\n<p>If reference picture is not stored in default folders (images, files, downloads) then\neither full path to image should be used or variable BASE_IMAGE_PATH should be defined\nbefore using this keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Click icon with stricter tolerance and comparing colors\nClickIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">      </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">     </span><span class=\"c\">grayscale=False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Element\" class=\"name\">ClickElement</a>,\n<a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a>,\n<a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Click the icon/bitmap on the screen.", "tags": ["Icon", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 33}, {"name": "Click Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click item (usually icon or picture) on webpage.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only).</em></p>\n<p>Keyword tries to click element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the ClickItem keyword will click the word Canis.\nIf there are multiple instances of the word Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickItem</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># clicks the third &quot;Canis&quot; on the page\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; near to the word &quot;Dog&quot;</span>\n</pre>\n<p>To enable searching items also from Shadow DOM, use SetConfig   Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">        </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">ClickItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it.  (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Click%20Element\" class=\"name\">ClickElement</a>,\n<a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Click item (usually icon or picture) on webpage.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 918}, {"name": "Click Item Until", "args": [{"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.\nKeyword is also handful in situations where we are waiting for some process\nto be ready and there is some button to press for getting results</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># ClickItem submit until Order 1234 exists on page:\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">Order 1234</span><span class=\"p\">         </span><span class=\"c\">submit</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem counter once/second until text Done appears.\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">Done</span><span class=\"p\">                </span><span class=\"c\">counter</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem ++ near to text Main Cart until there is 10 items in carts.\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">10 items</span><span class=\"p\">            </span><span class=\"c\">++</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem save until element with attr confirm_box appears\nClickItemUntil</span><span class=\"p\">     </span><span class=\"c\">confirm_box</span><span class=\"p\">         </span><span class=\"c\">save</span><span class=\"p\">    </span><span class=\"c\">element=True</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Some attr value to locate element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text appears.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1772}, {"name": "Click Item While", "args": [{"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_disappear: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click Item until a text or element disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until certain text or\nelement disappears.</p>\n<p>If text_to_disappear is not entered, keyword will wait until clicked element disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If element to disappear is same as clickable item. ClickItem with Add attribute\n# while it exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Add</span><span class=\"p\">      </span><span class=\"c\">element=True</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem add while text Empty Cart exists. Timeout after 5s:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Empty Cart</span><span class=\"p\">         </span><span class=\"c\">Add</span><span class=\"p\">           </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem Cart contents while h1 type element with attr some_attr exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">some_attr</span><span class=\"p\">     </span><span class=\"c\">Cart contents</span><span class=\"p\">   </span><span class=\"c\">element=True</span><span class=\"p\">  </span><span class=\"c\">tag=h1</span><span class=\"p\">\n</span><span class=\"c\"># ClickItem Go to cart once/second while text Cart exists:\nClickItemWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Some attr value to locate element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click Item until a text or element disappears.", "tags": ["Interaction", "Item"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1692}, {"name": "Click List", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: int | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = True"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click list element with in given index.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickList</span><span class=\"p\">       </span><span class=\"c\">1</span><span class=\"p\">\n</span><span class=\"c\">ClickList</span><span class=\"p\">       </span><span class=\"c\">1</span><span class=\"p\">       </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Click list element with in given index.", "tags": ["Interaction", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 141}, {"name": "Click Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text on web page.</p>\n<p>Keyword looks for an exact match and if not found uses xpath defined in\nSearch Strategy. If the given text corresponds to multiple elements, it\nclicks the first element.</p>\n<p>If you want to click other element than the first one found, you need to\nuse anchor or index.</p>\n<p>Keyword tries to click element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the ClickText keyword will click the word Canis.\nIf there are multiple instances of the word Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># clicks the third &quot;Canis&quot; on the page\nClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; near to the word &quot;Dog&quot;\n# handling numeric anchors as text, not index\nClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\">anchor_type=text</span><span class=\"p\">   </span><span class=\"c\"># clicks the &quot;Canis&quot; next text &quot;3&quot;</span>\n</pre>\n<p>If you want to specify how long ClickText tries, you need to add both anchor\nand timeout.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">1</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\"># Tries to click the first &quot;Canis&quot; for 20s</span>\n</pre>\n<p>If clickable element is child or parent of locator element use child/parent\nattribute + elements tagname to pick right element</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">parent=span # Clicks Canis element's first parent with span -tag</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">child=a</span><span class=\"p\">     </span><span class=\"c\"># First childnode with a -tag</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">js=true</span><span class=\"p\">     </span><span class=\"c\">#Use Javascript click instead of Selenium</span>\n</pre>\n<p>To double-click text, use argument doubleclick=True</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">doubleclick=True</span>\n</pre>\n<p>Or use SetConfig</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DoubleClick</span><span class=\"p\">     </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span>\n</pre>\n<p>To search text also from shadow DOM, use SetConfig ShadowDOM.\nNote that certain arguments like partial_match are ignored when\nsearching from shadow DOM.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ShadowDOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait element to appear and click to succeed</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text. In practise this means that also non-clickable texts\n(e.g. spans) are considered. By default ClickText only finds texts that\nare considered &quot;clickable&quot;.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Right%20Click\" class=\"name\">RightClick</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Click text on web page.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 346}, {"name": "Click Until", "args": [{"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "text_to_click", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_click: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.\nKeyword is also handful in situations where we are waiting for some process\nto be ready and there is some button to press for getting results</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># ClickText Get Data until Order 1234 exists on page:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Order 1234</span><span class=\"p\">         </span><span class=\"c\">Get Data</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Update until there is text Process finished available.\n# Wait eight seconds between clicks:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Process finished</span><span class=\"p\">   </span><span class=\"c\">Update</span><span class=\"p\">      </span><span class=\"c\">interval=8s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Add near to text Main Cart until there is 10 items in carts.\n# Timeout after 20 seconds if attempts are unsuccessful. Interval 1 second:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">10 items</span><span class=\"p\">            </span><span class=\"c\">Add</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">     </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Submit until element with attr confirm_box appears\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">confirm_box</span><span class=\"p\">         </span><span class=\"c\">Submit</span><span class=\"p\">    </span><span class=\"c\">element=True</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>text_to_click <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20While\" class=\"name\">ClickWhile</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text appears.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1607}, {"name": "Click While", "args": [{"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_disappear: str"}, {"name": "text_to_click", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_click: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Click text until a text or element disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until certain text or\nelement disappears.</p>\n<p>If text_to_disappear is not entered, keyword will wait until clicked text disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If text to disappear is same as clickable text. ClickText Cart while it exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Button while text Cart exists. Timeout after 5s:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">          </span><span class=\"c\">Button</span><span class=\"p\">          </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Cart contents while element with attr some_attr exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">some_attr</span><span class=\"p\">     </span><span class=\"c\">Cart contents</span><span class=\"p\">   </span><span class=\"c\">element=True</span><span class=\"p\">\n</span><span class=\"c\"># ClickText Go to cart once/second while text Cart exists:\nClickWhile</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">interval=1s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>text_to_click <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Interval between clicks until element disappears (default=5s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>element=True: Use this if element is expected to disappear instead of visible text\ncss=False/off: Use this to bypass css search when finding elements\nby visible text\ntag=html tag: Use this if element to disappear is not default type of item element.\nforce_click=True: Use this to bypass checks (istext/isnotext) before click.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Click%20Until\" class=\"name\">ClickUntil</a></p>\n</div>\n</div>\n", "shortdoc": "Click text until a text or element disappears.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1521}, {"name": "Close Alert", "args": [{"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Close popup alert.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Accept</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Dismiss</span><span class=\"p\">\n</span><span class=\"c\">Close Alert</span><span class=\"p\">    </span><span class=\"c\">Nothing</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>action <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>What is done for popup. Options are:\nACCEPT: accept alert\nDISMISS: dismiss alert\nNOTHING: don't close alert</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Close popup alert.", "tags": ["Alert", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 26}, {"name": "Close All Browsers", "args": [], "doc": "<div class=\"document\">\n<p>Close all opened browsers.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseAllBrowsers</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Remote%20Browser\" class=\"name\">CloseRemoteBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close all opened browsers.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 473}, {"name": "Close Browser", "args": [], "doc": "<div class=\"document\">\n<p>Close current browser.</p>\n<p>This will also close remote browser sessions if open.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseBrowser</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Remote%20Browser\" class=\"name\">CloseRemoteBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close current browser.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 409}, {"name": "Close Others", "args": [], "doc": "<div class=\"document\">\n<p>Close all windows except the first window.</p>\n<p>If you have a test that may open new windows, this keyword closes them\nand switches to the first window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseOthers</span>\n</pre>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchWindowException</dt>\n<dd>If other windows cannot been closed</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Window\" class=\"name\">CloseWindow</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Close all windows except the first window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 102}, {"name": "Close Remote Browser", "args": [], "doc": "<div class=\"document\">\n<p>Close remote browser session which is connected to the target browser.</p>\n<p>Closes only the remote browser session and leaves the target browser\nrunning. This makes it possible to continue using the existing browser\nfor other tests.</p>\n<p>It is important to use this keyword to free up the resources i.e.\nunnecessary chrome instances are not left to run. However,\nit is good to monitor chromedriver processes as those might be still\nrunning.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseBrowserSession</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a></p>\n</div>\n</div>\n", "shortdoc": "Close remote browser session which is connected to the target browser.", "tags": ["Browser", "Interaction", "Remote"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 442}, {"name": "Close Window", "args": [], "doc": "<div class=\"document\">\n<p>Close current tab and switch context to another window handle.</p>\n<p>If you need to change to specific tab, use switch window keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CloseWindow</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Close current tab and switch context to another window handle.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 144}, {"name": "Copy Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}], "doc": "<div class=\"document\">\n<p>Perform a copy.</p>\n<p>Copies whatever is active at the UI to the clipboard. If text is\nprovided copies that to the clipboard.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str, optional</span></dt>\n<dd>Text to copy to the clipboard</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Copy the provided text\nCopyText</span><span class=\"p\">        </span><span class=\"c\">text to clipboard</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Perform a copy.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1498}, {"name": "Css Selectors", "args": [{"name": "state", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  CssSelectors</cite> instead.</p>\n<p>Use CSS selectors for finding elements.</p>\n<p>CSS selectors is optional way to find elements that\nare difficult to catch by default selectors. Typically\nthose elements are inputs, checkboxes and dropdowns\nwithout placeholder texts.</p>\n<p>With CSS selectors the detection is tried with:</p>\n<ul class=\"simple\">\n<li>Placeholder or tooltip</li>\n<li>Label with 'for' attribute</li>\n<li>DOM traversing to detect sibling element</li>\n</ul>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">           </span><span class=\"c\">MyLocator</span><span class=\"p\">   </span><span class=\"c\">Robot</span><span class=\"p\">\n</span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  CssSelectors` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 156, "deprecated": true}, {"name": "Debug Off", "args": [], "doc": "<div class=\"document\">\n<p>Exit debugger. Set timeout and SearchMode back to default.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">debugoff</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Debug%20On\" class=\"name\">DebugOn</a></p>\n</div>\n</div>\n", "shortdoc": "Exit debugger. Set timeout and SearchMode back to default.", "tags": ["Debug", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\debug.py", "lineno": 64}, {"name": "Debug On", "args": [{"name": "mode", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "draw", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode: str = draw"}], "doc": "<div class=\"document\">\n<p>Start debugger with drawing mode and set default timeout down to 2 sec.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">debugon</span><span class=\"p\">    </span><span class=\"c\">#Start debugger and set timeout to 2sec.\ndebugon</span><span class=\"p\">    </span><span class=\"c\">debug</span><span class=\"p\">   </span><span class=\"c\">#Start debugger with SearchMode debug and set timeout to 2sec.</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>mode <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>debug(default) = Highlight(blink) element without executing kw\ndraw = Highlight element and execute kw</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Debug%20Off\" class=\"name\">DebugOff</a></p>\n</div>\n</div>\n", "shortdoc": "Start debugger with drawing mode and set default timeout down to 2 sec.", "tags": ["Debug", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\debug.py", "lineno": 29}, {"name": "Default Document", "args": [{"name": "state", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "types": ["str", "bool"], "typedocs": {"str": "string", "bool": "boolean"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "state: str | bool"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  DefaultDocument</cite> instead.</p>\n<p>Switches to default frame automatically.</p>\n<p>If some other frame is used by previous keyword\nwe switch back to default after keyword is executed so\nthat we are starting to find next locator from html document\ninstead of previously used frame.\nDefault = True\nUse False only when there is need to use and move\nbetween frames and page manually for some reason.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  DefaultDocument` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 211, "deprecated": true}, {"name": "Default Timeout", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: int | float | str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  DefaultTimeout</cite> instead.</p>\n<p>Set default timeout for QWeb keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">    </span><span class=\"c\">60s</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  DefaultTimeout` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 103, "deprecated": true}, {"name": "Delete All Cookies", "args": [], "doc": "<div class=\"document\">\n<p>Delete all cookies in browser.</p>\n<p>Cookies can be only deleted when browser is open. Cookies are automatically\ndeleted when you Close All Browsers</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DeleteAllCookies</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#List%20Cookies\" class=\"name\">ListCookies</a>, <a href=\"#Is%20Cookie\" class=\"name\">IsCookie</a></p>\n</div>\n</div>\n", "shortdoc": "Delete all cookies in browser.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 31}, {"name": "Drag Drop", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "target_locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target_locator: str"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "target_anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "target_anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "dragtime", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": "0.5s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dragtime: int | str = 0.5s"}, {"name": "left", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "left: int = 0"}, {"name": "right", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "right: int = 0"}, {"name": "above", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "above: int = 0"}, {"name": "below", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "below: int = 0"}, {"name": "loc_left", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_left: int = 0"}, {"name": "loc_right", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_right: int = 0"}, {"name": "loc_above", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_above: int = 0"}, {"name": "loc_below", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loc_below: int = 0"}], "doc": "<div class=\"document\">\n<p>Drag and drop element.</p>\n<p>Finds draggable element by it's visible text, tooltip attribute, index\nor xpath.\nTarget element is found by it's visible text or xpath.</p>\n<p>Keyword tries to drag element to target element.\nGets coordinates from WebDriver and uses pyautogui to simulate mouse\nactions based on those coordinates.</p>\n<p>Zoom level needs to be 100% in screen settings so that coordinates\nare matching with actual view. (Preferable resolution 1920x1080)</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">//*[&#64;id=&quot;some_id&quot;]</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">index</span><span class=\"p\">          </span><span class=\"c\">Foo</span><span class=\"p\">       </span><span class=\"c\">index=3</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">dragtime=2s</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">right=5</span><span class=\"p\">   </span><span class=\"c\">below=2</span><span class=\"p\">\n</span><span class=\"c\">DragDrop</span><span class=\"p\">       </span><span class=\"c\">draggable</span><span class=\"p\">      </span><span class=\"c\">target</span><span class=\"p\">    </span><span class=\"c\">right=5</span><span class=\"p\">   </span><span class=\"c\">below=2</span><span class=\"p\">   </span><span class=\"c\">loc_above=40</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some element attribute(check ClickItem), xpath or\ntext index to locate draggable element.</dd>\n<dt>target_locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text or xpath to locate target element for draggable.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Index to point out right draggable if there is many or if\nthere is no visible text/attribute which can be use to locate\ncorrect element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>In some cases(f.e Angular) element could be draggable even if\ndraggable attribute doesn't exists. Then we are using traditional\ntext match(check clicktext) to find correct\nelement. Anchor can be index or some text near to draggable element.\n(default 1)</dd>\n<dt>target_anchor</dt>\n<dd>Text near the target element or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find elemenst before failing</dd>\n<dt>dragtime <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long drag should take. Some applications need longer time</dd>\n<dt>left <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels left of target center we drag</dd>\n<dt>right <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels right of target center we drag</dd>\n<dt>above <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels above of target center we drag</dd>\n<dt>below <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels below of target center we drag</dd>\n<dt>loc_left <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels left of locator center we start dragging</dd>\n<dt>loc_right <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels right of locator center we start dragging</dd>\n<dt>loc_above <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels above of locator center we start dragging</dd>\n<dt>loc_below <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Offset how many pixels below of locator center we start dragging</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Drag and drop element.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dragdrop.py", "lineno": 34}, {"name": "Drop Down", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "unselect", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "unselect: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Select an option from dropdown menu/list.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DropDown</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the DropDown keyword will select from a dropdown\nthe option: Collie.</p>\n<p>How the dropdown element is searched:\nThe dropdown element is first attempted to be matched based on its\nlabel text and then options.\nIf you give one of the dropdown's options as locator, the element\nwill be matched in this search pass.</p>\n<p>If there are multiple instances of a dropdown with text Canis on the page, first one\nwill be clicked unless 'anchor' is given. You can\nspecific which one should be clicked by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DropDown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Collie</span><span class=\"p\">   </span><span class=\"c\">anchor=3</span><span class=\"p\">     </span><span class=\"c\"># Uses third Canis dropdown\nDropDown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">    </span><span class=\"c\">Collie</span><span class=\"p\">   </span><span class=\"c\">anchor=dog</span><span class=\"p\">   </span><span class=\"c\"># Uses Canis dropdown near the word text dog</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">         </span><span class=\"c\">Robot</span><span class=\"p\">     </span><span class=\"c\">#last row, third cell\nDropdown</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">   </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n<p>Choose dropdown option with index:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">[[2]]</span>\n</pre>\n<p>Unselect a selected option from multiselection dropdown:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Dropdown</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">Collie</span><span class=\"p\">  </span><span class=\"c\">unselect=True</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element</dd>\n<dt>option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Label of the option you want to select</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundErr</dt>\n<dd>Dropdown element not found</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Select an option from dropdown menu/list.", "tags": ["Dropdown", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 32}, {"name": "Execute Javascript", "args": [{"name": "script", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script: str"}, {"name": "variable_name", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "variable_name: str | None = None"}], "doc": "<div class=\"document\">\n<p>Execute javascript and save the result to suite variable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExecuteJavascript</span><span class=\"p\">   </span><span class=\"c\">document.getElementsByTagName(&quot;p&quot;)[0].innerText=&quot;Write text&quot;;</span><span class=\"p\">\n</span><span class=\"c\">ExecuteJavascript</span><span class=\"p\">   </span><span class=\"c\">return document.title;</span><span class=\"p\">     </span><span class=\"c\">$TITLE</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>script <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Javascript code.</dd>\n<dt>variable_name <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Robot framework variable name without {}. (Default None)</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Execute javascript and save the result to suite variable.", "tags": ["Interaction", "Javascript"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\javascript.py", "lineno": 28}, {"name": "Expect File Download", "args": [], "doc": "<div class=\"document\">\n<p>Turns on polling for time after which file download should happen.</p>\n<p>Run this keyword everytime before <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a> and the action that\nstarts download process.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExpectFileDownload</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">               </span><span class=\"c\">Download</span><span class=\"p\">\n</span><span class=\"c\">VerifyFileDownload</span><span class=\"p\">      </span><span class=\"c\">timeout=20s</span><span class=\"p\">     </span><span class=\"c\"># file should be downloaded in 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a></p>\n</div>\n</div>\n", "shortdoc": "Turns on polling for time after which file download should happen.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\download.py", "lineno": 91}, {"name": "Forward", "args": [], "doc": "<div class=\"document\">\n<p>Navigates forward in the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Forward</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Navigates forward in the current window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 124}, {"name": "Get Alert Text", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Get alert text to variable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${TEXT}</span><span class=\"p\">        </span><span class=\"c\">GetAlertText</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Get alert text to variable.", "tags": ["Alert", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 120}, {"name": "Get Attribute", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get attribute value of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using xpaths like with ClickElement etc. kw:s without specified\nelement_type. Index must be given if element is not unique:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">click_me</span><span class=\"p\">     </span><span class=\"c\">id</span><span class=\"p\">         </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;] name</span><span class=\"p\">\n</span><span class=\"c\"># Get id attribute value from 3rd matching element\n${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">            </span><span class=\"c\">//button</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">  </span><span class=\"c\">index=3</span>\n</pre>\n<p>GetAttribute using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">type</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">id</span><span class=\"p\">      </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">   </span><span class=\"c\">GetAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">class</span><span class=\"p\">   </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">              </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">placeholder</span><span class=\"p\">     </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">           </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">         </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${attribute_value}</span><span class=\"p\">  </span><span class=\"c\">GetAttribute</span><span class=\"p\">          </span><span class=\"c\">input[type=button]</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">    </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Qwords like ClickText/Item, TypeText, Dropdown etc.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>attribute: str</dt>\n<dd>Attribute which value we want to get.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation. When using xpath as locator <strong>index</strong> should be</div>\n<div class=\"line\">specified unless xpath matches to a single element.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>value : Value of attribute (true if attribute exist but does not have value)</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Attribute\" class=\"name\">VerifyAttribute</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Get attribute value of an element.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 528}, {"name": "Get Cell Text", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get cell text to variable.</p>\n<p>Locates cell by coordinates from active table and return value</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r2c3</span><span class=\"p\">\n</span><span class=\"c\">${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r-2c5</span><span class=\"p\">       </span><span class=\"c\">#Row is second to last. Get value from cell c5\n${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r?Robot/c5</span><span class=\"p\">  </span><span class=\"c\">#Row contains text Robot. Get value from cell c5\n${value}</span><span class=\"p\">    </span><span class=\"c\">GetCellText</span><span class=\"p\">  </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">  </span><span class=\"c\">#Row contains text Robot. Get value from last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table. R specifies row and c column.\nr1 = first row, r-1 = last row, r?Qentinel/ = row that contains word Qentinel</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If row is located by text which is not unique, use anchor to point correct one.\nAnchor can be some other text in same row or index. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get cell text to variable.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 169}, {"name": "Get Col Header", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | None = None"}], "doc": "<div class=\"document\">\n<p>Get column header names/text as a list.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<p>Note2: If column header has attribute 'aria-label', it's value is returned.\nIf not and 'title' attribute exists, then 'title' value is returned.\nIf neither aria-label or title exists, then full text of column element is returned.\nThis is done due to fact that in many web applications header element text contains other texts\nthan what is visible to end users.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\"># Get all column headers as list\n${columns}</span><span class=\"p\">  </span><span class=\"c\">GetColHeader</span><span class=\"p\">\n</span><span class=\"c\"># -&gt; ['col1', 'col2', 'col3']\n# Get column header by index\n${column_at_index_2}</span><span class=\"p\">    </span><span class=\"c\">GetColHeader</span><span class=\"p\">  </span><span class=\"c\">2</span><span class=\"p\">\n</span><span class=\"c\"># -&gt; 'col2 header'</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Column index. If given, gets the header text of the given column.\nIf not given or if 0 is given, returns all column headers as a list.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the given index value is out of range.</dd>\n<dt>ValueError</dt>\n<dd>Index argument is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header%20Count\" class=\"name\">GetColHeaderCount</a>, <a href=\"#Verify%20Col%20Header\" class=\"name\">VerifyColHeader</a>, <a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get column header names/text as a list.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 369}, {"name": "Get Col Header Count", "args": [], "doc": "<div class=\"document\">\n<p>Get Count of column headers in current active table.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\">${count}</span><span class=\"p\">    </span><span class=\"c\">GetColHeaderCount</span>\n</pre>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Verify%20Col%20Header\" class=\"name\">VerifyColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get Count of column headers in current active table.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 341}, {"name": "Get Config", "args": [{"name": "par", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "par: str | None = None"}], "doc": "<div class=\"document\">\n<p>Return value of given configuration parameter.</p>\n<p>If no parameter is given the GetConfig returns\nall configurations in a python dictionary of current configuration parameter names and their\nvalues.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VAL}</span><span class=\"p\">    </span><span class=\"c\">GetConfig</span><span class=\"p\">    </span><span class=\"c\">default timeout</span><span class=\"p\">      </span><span class=\"c\"># Return default timeout value\n${VAL}</span><span class=\"p\">    </span><span class=\"c\">GetConfig</span><span class=\"p\">                         </span><span class=\"c\"># Return all config parameter names and values</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<blockquote>\n<dl class=\"docutils\">\n<dt>par <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Setting to be fetched</dd>\n</dl>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Reset%20Config\" class=\"name\">ResetConfig</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Return value of given configuration parameter.", "tags": ["Config", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 1013}, {"name": "Get Drop Down Values", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return all options from a dropdown menu/list.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${all_options}=</span><span class=\"p\">     </span><span class=\"c\">GetDropDownValues</span><span class=\"p\">     </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">Collie</span><span class=\"p\">\n</span><span class=\"c\">log</span><span class=\"p\">     </span><span class=\"c\">${all_options}</span>\n</pre>\n<p>In the above example the GetDropDownValues keyword saves all items from the\ndropdown menu Canis to a variable.</p>\n<p>This keyword can also be used with table cells and XPaths. When using XPaths, the equal sign &quot;=&quot;\nmust be escaped with a &quot;\\&quot;.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Return all options from a dropdown menu/list.", "tags": ["Dropdown", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 309}, {"name": "Get Element Count", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get count of appearances for certain web element.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>GetElementCount does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetElementCount</span><span class=\"p\">       </span><span class=\"c\">//*[&#64;id\\=&quot;Foo&quot;]</span><span class=\"p\">\n</span><span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetElementCount</span><span class=\"p\">       </span><span class=\"c\">Foo</span><span class=\"p\">    </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath or some attribute value of element. When using XPaths, the equal sign &quot;=&quot; must be\nescaped with a &quot;&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>tag=tagname: Needed when attribute value is used as a locator</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text%20Count\" class=\"name\">GetTextCount</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a></p>\n</div>\n</div>\n", "shortdoc": "Get count of appearances for certain web element.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 209}, {"name": "Get File Text", "args": [{"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text content from a plain text file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">    </span><span class=\"c\">text.txt</span><span class=\"p\">\n</span><span class=\"c\"># returns whole text content\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">\n\n</span><span class=\"c\"># returns whole text content, but remove newlines (\\n)\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">remove_newlines=True</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the beginning\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">from_start=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the end\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">from_end=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns all chars between Simple and File\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">between=Simple???File</span><span class=\"p\">\n\n</span><span class=\"c\"># matches to text between Simple and end of file.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">between=Simple???File</span><span class=\"p\">\n\n</span><span class=\"c\"># Returns 6 characters from the beginning of match.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetFileText</span><span class=\"p\">   </span><span class=\"c\">between=Simple???</span><span class=\"p\">       </span><span class=\"c\">from_start=6</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">remove_newlines : bool - Remove newlines (\\n) from returned text (True/False)</div>\n</div>\n</div>\n</dd>\n</dl>\n<p>Note that you must use named arguments with this keyword, i.e. use\n<tt class=\"docutils literal\">argument_name=value</tt> format!</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text content from a plain text file.", "tags": ["File", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 149}, {"name": "Get Input Value", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "remove_newlines", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remove_newlines: bool = True"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get input value from input field.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">       </span><span class=\"c\">Submit</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">someattrs</span><span class=\"p\">      </span><span class=\"c\">from_end=3</span><span class=\"p\">  </span><span class=\"c\">int=True</span><span class=\"p\">\n</span><span class=\"c\">#Return empty if there is not value in input element:\n${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">OrderNro</span><span class=\"p\">       </span><span class=\"c\">blind=True</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">\n</span><span class=\"c\">${value}=</span><span class=\"p\">    </span><span class=\"c\">GetInputValue</span><span class=\"p\">    </span><span class=\"c\">r?OrderNro/c1</span><span class=\"p\">    </span><span class=\"c\">My Order</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>remove_newlines <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Removes new lines (n)from string, especially from multirow text areas. Default = True</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n<div class=\"line\">blind : True - Return empty instead of error if input element is empty</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Get input value from input field.", "tags": ["Getters", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 592}, {"name": "Get List", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get value(s) from a list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${LIST}</span><span class=\"p\">         </span><span class=\"c\">GetList</span><span class=\"p\">         </span><span class=\"c\">#Get list to variable\n${VAL}</span><span class=\"p\">          </span><span class=\"c\">GetList</span><span class=\"p\">      </span><span class=\"c\">2</span><span class=\"p\">  </span><span class=\"c\">#Get value from list index 2\n#Get substring from list index 1\n${VAL}</span><span class=\"p\">          </span><span class=\"c\">GetList</span><span class=\"p\">      </span><span class=\"c\">1</span><span class=\"p\">  </span><span class=\"c\">between=word???another</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index:</dt>\n<dd>if given, gets text only from that index.</dd>\n<dt>kwargs:</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Get value(s) from a list.", "tags": ["Getters", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 195}, {"name": "Get Pdf Text", "args": [{"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text content from pdf file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePdf</span><span class=\"p\">     </span><span class=\"c\">dummy.pdf</span><span class=\"p\">\n</span><span class=\"c\"># returns whole PDF content\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">\n\n</span><span class=\"c\"># returns whole PDF content, but remove newlines (\\n)\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">remove_newlines=True</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the beginning\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">from_start=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns 6 characters from the end\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">from_end=6</span><span class=\"p\">\n\n</span><span class=\"c\"># returns all chars between Simple and File\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">between=Simple???File</span><span class=\"p\">\n\n</span><span class=\"c\"># matches to text between Simple and end of file.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">between=Simple???</span><span class=\"p\">\n\n</span><span class=\"c\"># Returns 6 characters from the beginning of match.\n${text}</span><span class=\"p\">    </span><span class=\"c\">GetPdfText</span><span class=\"p\">    </span><span class=\"c\">between=Simple???</span><span class=\"p\">       </span><span class=\"c\">from_start=6</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n<div class=\"line\">remove_newlines : bool - Remove newlines (\\n) from returned text (True/False)</div>\n</div>\n</div>\n</dd>\n</dl>\n<p>Note that you must use named arguments with this keyword, i.e. use\n<tt class=\"docutils literal\">argument_name=value</tt> format!</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text content from pdf file.", "tags": ["File", "Getters", "PDF"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 95}, {"name": "Get Selected", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get selected option to variable from dropdown menu/list.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example we get selected value from dropdown Canis.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">             </span><span class=\"c\">#last row, third cell\n${VALUE}</span><span class=\"p\">    </span><span class=\"c\">GetSelected</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">      </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">unicode</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">unicode</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: unicode</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<dl class=\"docutils\">\n<dt>selected: str</dt>\n<dd>With multiselection dropdowns returns a string containing all values\nseparated by comma (&quot;,&quot;)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Get selected option to variable from dropdown menu/list.", "tags": ["Dropdown", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 192}, {"name": "Get Table Row", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get row (index) from current table.</p>\n<p>Get table row by some visible text or value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">//last</span><span class=\"p\">          </span><span class=\"c\">#returns table length(last row)\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">#return first row which contain text Qentinel\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">2</span><span class=\"p\">     </span><span class=\"c\">#second row with text Qentinel\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">Sepi</span><span class=\"p\">  </span><span class=\"c\">#row contains texts Qentinel &amp; Sepi\n${row}</span><span class=\"p\">       </span><span class=\"c\">GetTableRow</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">skip_header=True</span><span class=\"p\">  </span><span class=\"c\">#start counting from first tc row</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or value which is presented in wanted row or //last = last row of the table</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>If locator is not unique use anchor to tell which is correct. Anchor can be some text/value\nin same row than locator text or index. 1=first match etc. Default = 1</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Get row (index) from current table.", "tags": ["Getters", "Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 294}, {"name": "Get Text", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get text from element specified by xpath.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">GetText</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">#uses text as a locator:\nGetText</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">       </span><span class=\"c\">between=click???me #returns _</span><span class=\"p\">\n</span><span class=\"c\">#uses any attribute of some div as locator:\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">#returns 5 first chars\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_end=5</span><span class=\"p\">    </span><span class=\"c\">#returns 5 last\n#returns last 5 chars before text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=???Foo</span><span class=\"p\">  </span><span class=\"c\">from_end=5</span><span class=\"p\">\n</span><span class=\"c\">#returns first 5 chars before text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=Foo???</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">\n</span><span class=\"c\">#returns first 5 chars before text Foo and text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">   </span><span class=\"c\">between=Foo???</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">include_locator=True</span><span class=\"p\">\n</span><span class=\"c\">#returns last 5 chars before text Foo and text Foo\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">between=???Foo</span><span class=\"p\">  </span><span class=\"c\">from_start=5</span><span class=\"p\">  </span><span class=\"c\">exclude_post=False</span><span class=\"p\">\n</span><span class=\"c\">GetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">int=True</span><span class=\"p\">    </span><span class=\"c\">#return integer\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">tag=div</span><span class=\"p\">     </span><span class=\"c\">from_start=3</span><span class=\"p\">    </span><span class=\"c\">float=True</span><span class=\"p\">  </span><span class=\"c\">#return float\n</span><span class=\"p\">\n</span><span class=\"c\"># Get text between &quot; characters. Since one character separator will match the first\n# instance, it's better to include parts of words right before or after them.\n# Let's assume full text would return:\n# Case &quot;1234567&quot; was created.\nGetText</span><span class=\"p\">          </span><span class=\"c\">someattr</span><span class=\"p\">       </span><span class=\"c\">between=Case &quot;???&quot; was</span><span class=\"p\">  </span><span class=\"c\"># Would return 1234567</span>\n</pre>\n<p>Note: when using 'between' argument, separators are expected to be unique, preferably words.\nIf you want to get text between one character separators like &quot;,\nit's best to include parts from words right before or after them. See the last example above.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some attribute of wanted element or Xpath expression without xpath= prefix.\nWhen using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait that element is found before failing.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">between : str/int - Start???End - Return all chars between texts Start and End.</div>\n<div class=\"line\">from_start : int - Return x amount of chars. Starting from first char</div>\n<div class=\"line\">from_end : int - Return x amount of chars. Starting from last char</div>\n<div class=\"line\">include_locator : True - Starting text is part of returned string</div>\n<div class=\"line\">exclude_post : False - Ending text is part of returned string</div>\n<div class=\"line\">int : True - Return integer instead of string</div>\n<div class=\"line\">float : int - Return float instead of string</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>text : Xpath value text</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Text\" class=\"name\">Is Text</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Get text from element specified by xpath.", "tags": ["Getters", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 818}, {"name": "Get Text Count", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get count of appearances for given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>GetTextCount does not require for the text to be unique.\nReturn count of appearances for given tex.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${COUNT}</span><span class=\"p\">    </span><span class=\"c\">GetTextCount</span><span class=\"p\">      </span><span class=\"c\">Canis</span><span class=\"p\">  </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>, <a href=\"#Verify%20Text%20Count\" class=\"name\">VerifyTextCount</a></p>\n</div>\n</div>\n", "shortdoc": "Get count of appearances for given text.", "tags": ["Getters", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 301}, {"name": "Get Timeout", "args": [{"name": "kwargs", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs: Any"}], "doc": "<div class=\"document\">\n</div>\n", "shortdoc": "", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\internal\\decorators.py", "lineno": 177}, {"name": "Get Title", "args": [], "doc": "<div class=\"document\">\n<p>Gets the title of current page/window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${title}=</span><span class=\"p\">   </span><span class=\"c\">GetTitle</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Gets the title of current page/window.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 377}, {"name": "Get Url", "args": [], "doc": "<div class=\"document\">\n<p>Gets current url/location.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${url}=</span><span class=\"p\">   </span><span class=\"c\">GetUrl</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>,<a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Gets current url/location.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 315}, {"name": "Get Webelement", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Get Webelement using any Qword -stylish locator.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using attributes or xpaths like with ClickElement etc. kw:s without specified\nelement_type. Result is a type of list unless <strong>index</strong> or <strong>element_type</strong> is given:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">${list of elems}</span><span class=\"p\">    </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span>\n</pre>\n<p>Get element using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${elem}</span><span class=\"p\">      </span><span class=\"c\">GetWebelement</span><span class=\"p\">          </span><span class=\"c\">input[type=button]:nth-child(10)</span><span class=\"p\">    </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Qwords like ClickText/Item, TypeText, Dropdown etc.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Get Webelement using any Qword -stylish locator.", "tags": ["Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 420}, {"name": "Go To", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Switch current page to given url.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">GoTo</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">\n</span><span class=\"c\">GoTo</span><span class=\"p\">    </span><span class=\"c\">file://resources/window.html</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>UnexpectedAlertPresentException</dt>\n<dd>If the page opens with alert popup</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Switch current page to given url.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 30}, {"name": "Hotkey", "args": [{"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Performs key down presses on the arguments passed in order, then performs\nkey releases in reverse order.</p>\n<p>The effect is that calling hotkey('ctrl', 'shift', 'c') would perform a\n&quot;Ctrl-Shift-C&quot; hotkey/keyboard shortcut press.</p>\n<dl class=\"docutils\">\n<dt>Args:</dt>\n<dd><dl class=\"first last docutils\">\n<dt>key(s) (str): The series of keys to press, in order. This can also be a</dt>\n<dd>list of key strings to press.</dd>\n<dt>interval (float, optional): The number of seconds in between each press.</dt>\n<dd>0.0 by default, for no pause in between presses.</dd>\n</dl>\n</dd>\n<dt>Returns:</dt>\n<dd>None</dd>\n</dl>\n</div>\n", "shortdoc": "Performs key down presses on the arguments passed in order, then performs key releases in reverse order.", "tags": [], "source": "c:\\Users\\TuomasKoukkari\\Documents\\qweb\\.venv\\lib\\site-packages\\pyautogui\\__init__.py", "lineno": 1694}, {"name": "Hover Element", "args": [{"name": "xpath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover the element specified by the xpath selector.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;hover_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">HoverElement</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id=&quot;hover_me&quot;]</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll\" class=\"name\">Scroll</a>,\n<a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Hover the element specified by the xpath selector.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 154}, {"name": "Hover Item", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover over item.</p>\n<p>Hover over web element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal</span>\n</pre>\n<p>Hover can be chained. For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal</span><span class=\"p\">\n</span><span class=\"c\">HoverItem</span><span class=\"p\">        </span><span class=\"c\">attrVal sub</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Element to be hovered-over.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Hover over item.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 645}, {"name": "Hover Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Hover over text.</p>\n<p>Keyword will fail if text is not visible. You should use VerifyText before HoverText\nif you are not sure text is already visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>Hover can be chained. For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">\n</span><span class=\"c\">HoverText</span><span class=\"p\">        </span><span class=\"c\">Canis sub</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be hovered-over.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Hover over text.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 604}, {"name": "Is Alert", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1s"}], "doc": "<div class=\"document\">\n<p>Return True/False if alert is found on the screen.</p>\n<p>Used to get alert presence to variable. This keyword returns after alert is found.</p>\n<p>Returns True if alert is found. Returns False if alert is not found within timeout.</p>\n<p>If timeout is not set, keyword returns immediately.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">IsAlert</span><span class=\"p\">     </span><span class=\"c\">2s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if alert is found on the screen.", "tags": ["Alert", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 57}, {"name": "Is Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<div class=\"document\">\n<p>Return True if cookie with name and value is found.</p>\n<p>Cookies are a good way to detect if user has already logged in.\nThis keyword can be used in appstate.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">IsCookie</span><span class=\"p\">    </span><span class=\"c\">domain</span><span class=\"p\">    </span><span class=\"c\">google.fi</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>name <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Cookie dictionary key name</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Expected value for key name</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Delete%20All%20Cookies\" class=\"name\">DeleteAllCookies</a>, <a href=\"#List%20Cookies\" class=\"name\">ListCookies</a></p>\n</div>\n</div>\n", "shortdoc": "Return True if cookie with name and value is found.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 80}, {"name": "Is Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1s"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True if element is visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsElement</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsElement</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to appear before returning. Default 0.1s</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a>, <a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>,\n<a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a>, <a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Return True if element is visible.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 253}, {"name": "Is Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Check is the icon on the screen.</p>\n<p>In case you want to use this keyword you always have to have reference images.\nIf reference image are not in default folders (images, files, downloads) then\nBASE_IMAGE_PATH should be defined in a robot file before using this keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${status}</span><span class=\"p\">    </span><span class=\"c\">IsIcon</span><span class=\"p\">    </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Verify image with stricter tolerance and comparing colors\n${status}</span><span class=\"p\">    </span><span class=\"c\">IsIcon</span><span class=\"p\">    </span><span class=\"c\">plane_red</span><span class=\"p\">    </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">    </span><span class=\"c\">grayscale=False</span>\n</pre>\n<p>${status} will be True or False.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Capture%20Icon\" class=\"name\">CaptureIcon</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Check is the icon on the screen.", "tags": ["Icon", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 119}, {"name": "Is Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check if Item (usually icon or picture) exists.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed or item is found.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<p>IsItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${exists}=</span><span class=\"p\">  </span><span class=\"c\">IsItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the IsItem keyword returns True if element which\nhas attribute Canis exists.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <span class=\"name\">IsNoItem, </span>VerifyItem`</p>\n</div>\n</div>\n", "shortdoc": "Check if Item (usually icon or picture) exists.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1127}, {"name": "Is No Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Check if Item (usually icon or picture) does not exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed or element disappears from the screen.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<p>IsNoItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${exists}=</span><span class=\"p\">  </span><span class=\"c\">IsNoItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the IsNoItem keyword returns True if element which\nhas attribute Canis disappears from the screen before timeout expires.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <span class=\"name\">IsItem, </span>VerifyItem`</p>\n</div>\n</div>\n", "shortdoc": "Check if Item (usually icon or picture) does not exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1181}, {"name": "Is No Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "2s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 2s"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True/False if text is found on the screen.</p>\n<p>Used to get text presence info to variable. This keyword returns if text is not visible or\nwhen it disappears.</p>\n<p>If text does not disappear, keyword returns False after timeout is exceeded.</p>\n<p>If timeout is not set, keyword returns immediately.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before returning. Default 0.1s</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if text is found on the screen.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 729}, {"name": "Is Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0.5s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0.5s"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Return True/False if text is found on the screen.</p>\n<p>Used to get text presence to variable. This keyword returns after text is found.</p>\n<p>Returns True if text is found. Returns False if text is not found within timeout.</p>\n<p>If timeout is not set, default timeout of 0.5 sec is used.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">\n</span><span class=\"c\">$note_visible=</span><span class=\"p\">  </span><span class=\"c\">IsText</span><span class=\"p\">        </span><span class=\"c\">Paused</span><span class=\"p\">     </span><span class=\"c\">5s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be searched from the screen.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to appear before returning. Default 0.5s</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>Bool : True or False</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Is%20No%20Text\" class=\"name\">IsNoText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Return True/False if text is found on the screen.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 689}, {"name": "List Cookies", "args": [{"name": "log", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log: bool = True"}], "doc": "<div class=\"document\">\n<p>List all cookies in browser.</p>\n<p>Cookies can be only listed when browser is open. Cookies are automatically\ndeleted when you Close All Browsers.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ListCookies</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>log <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>If true, log list of cookies to html log file. If False, only returns cookie list.\nDefault is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Delete%20All%20Cookies\" class=\"name\">DeleteAllCookies</a>, <a href=\"#Is%20Cookie\" class=\"name\">IsCookie</a></p>\n</div>\n</div>\n", "shortdoc": "List all cookies in browser.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\cookies.py", "lineno": 51}, {"name": "Log Page", "args": [], "doc": "<div class=\"document\">\n<p>Save and log current html.</p>\n<p>The html content is saved as html file in the same folder where log is.\nThe current page and the link to it are represented in the log in\niframe so it one can see the page as it was.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">LogPage</span>\n</pre>\n</div>\n<div class=\"section\" id=\"note\">\n<h1>Note</h1>\n<p>Does not handle frames.</p>\n</div>\n<div class=\"section\" id=\"todo\">\n<h1>Todo</h1>\n<p>Replace relative paths in the src and href attributes. This way we get\ncss properties and icons.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Log%20Screenshot\" class=\"name\">LogScreenshot</a></p>\n</div>\n</div>\n", "shortdoc": "Save and log current html.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 145}, {"name": "Log Screenshot", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "screenshot_{}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = screenshot_{}.png"}, {"name": "fullpage", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullpage: bool = False"}], "doc": "<div class=\"document\">\n<p>Log screenshot to Robot Framework log.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">LogScreenshot</span><span class=\"p\">\n</span><span class=\"c\">${file}=</span><span class=\"p\">     </span><span class=\"c\">LogScreenshot</span><span class=\"p\">  </span><span class=\"c\"># returns full path to saved image file</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><p class=\"first\">Filename where the screenshot is saved.</p>\n<p class=\"last\">Note: if given filename exceeds operating system's limit for a filename length\n(usually 255 characters), this keyword will fail.</p>\n</dd>\n<dt>fullpage <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Capture full page screenshot instead of visible area only (if browser/driver supports it).</div>\n<div class=\"line\">Currently supported in Firefox and Chromium based browsers (Chrome/Edge).</div>\n<div class=\"line\">Default: False (visible area only)</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>filepath : full path to saved screenshot</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Log%20Page\" class=\"name\">LogPage</a></p>\n</div>\n</div>\n", "shortdoc": "Log screenshot to Robot Framework log.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\screenshot.py", "lineno": 37}, {"name": "Maximize Window", "args": [], "doc": "<div class=\"document\">\n<p>Maximizes current browser window.</p>\n<dl class=\"docutils\">\n<dt>Note: This keyword will not fail if maximizing is prevented for some reason.</dt>\n<dd>This can happen for example if window manager is not installed or setup correctly.</dd>\n</dl>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">MaximizeWindow</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<p>None</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>,<a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Maximizes current browser window.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 275}, {"name": "Move Files", "args": [{"name": "files_to_move", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "files_to_move: str"}, {"name": "destination_folder", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "destination_folder: str"}], "doc": "<div class=\"document\">\n<p>Move files.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">MoveFiles</span><span class=\"p\">           </span><span class=\"c\">cat1.jpg</span><span class=\"p\">      </span><span class=\"c\">C:/secret_cat_pictures</span><span class=\"p\">\n</span><span class=\"c\">MoveFiles</span><span class=\"p\">           </span><span class=\"c\">cat1.jpg, cat666.jpg, cat4.jpg</span><span class=\"p\">      </span><span class=\"c\">C:/secret_cat_pictures</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>files_to_move <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Files to move, separated by &quot;,&quot; in case of multiple files.</dd>\n<dt>destination_folder <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Destination folder of the moved files.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a></p>\n</div>\n</div>\n", "shortdoc": "Move files.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 413}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "browser_alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "browser_alias: str"}, {"name": "options", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "options: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Open new browser to given url.</p>\n<p>Browser options can also be given in the robot command, for example:\nrobot -v browser_options:&quot;--kiosk, --disable-gpu&quot; testytest.robot</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Basic usage\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">file://resources/window.html</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n\n</span><span class=\"c\"># Multiple options\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">--allow-running-insecure-content, --xyz</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-headless, -private, -xyz</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">edge</span><span class=\"p\">      </span><span class=\"c\">-headless, -inprivate, -xyz</span><span class=\"p\">\n\n</span><span class=\"c\"># Multiple preferences\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">prefs=&quot;opt1&quot;:&quot;True&quot;, &quot;opt2&quot;:&quot;False&quot;</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">prefs=&quot;option1&quot;:&quot;value1&quot;, &quot;option2&quot;:&quot;value2&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Supply preferences from a dictionary\n${prefs_d}=</span><span class=\"p\">    </span><span class=\"c\">Create Dictionary</span><span class=\"p\">     </span><span class=\"c\">option1</span><span class=\"p\">    </span><span class=\"c\">value1</span><span class=\"p\">    </span><span class=\"c\">option2</span><span class=\"p\">    </span><span class=\"c\">value2</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">    </span><span class=\"c\">prefs=${prefs_d}</span><span class=\"p\">\n\n</span><span class=\"c\"># Common examples:\n# ----------------\n</span><span class=\"p\">\n</span><span class=\"c\"># Use existing profile\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-profile /path/to/profile</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">--user-data-dir\\=C:\\\\temp,--profile-directory\\=Test2</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">-private</span><span class=\"p\">    </span><span class=\"c\">prefs=&quot;option1&quot;:&quot;value1&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Use portable browser / non-standard installation path / specific driver\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:support</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">binary=C:/Users/SomeUser/temp/FirefoxPortable/App/Firefox64/firefox.exe</span><span class=\"p\">\n</span><span class=\"c\"># Use Chromium instead of Chrome:\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">chrome_path=/path/to/chromium/chrome.exe</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">executable_path=/path/to/my/chromedriver.exe</span><span class=\"p\">\n\n</span><span class=\"c\"># Use proxy\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">--proxy_server\\=http://127.0.0.1:8080</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">prefs=&quot;network.proxy.type&quot;:&quot;1&quot;,&quot;network.proxy.http&quot;:&quot;localhost&quot;,&quot;network.proxy.http_port&quot;:&quot;8080&quot;</span><span class=\"p\">\n\n</span><span class=\"c\"># Make Chrome download pdf files instead of opening them\nOpen Browser</span><span class=\"p\">    </span><span class=\"c\">about:blank</span><span class=\"p\">         </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...prefs=download.prompt_for_download: False, plugins.always_open_pdf_externally: True</span><span class=\"p\">\n\n</span><span class=\"c\"># Disable &quot;Save Address&quot; and &quot;Save Credit Card details&quot; dialogs on Chrome.\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:blank</span><span class=\"p\">           </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">            </span><span class=\"c\">prefs=&quot;autofill.profile_enabled&quot;:false, &quot;autofill.credit_card_enabled&quot;:false</span><span class=\"p\">\n\n</span><span class=\"c\"># Mobile emulation\nOpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">emulation=iPhone SE</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">http://google.com</span><span class=\"p\">     </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">emulation=375x812</span>\n</pre>\n</div>\n<div class=\"section\" id=\"selenium-manager\">\n<h1>Selenium Manager</h1>\n<p>Selenium Manager's automatic browser and driver management is available for Chrome, Firefox\nand Edge. To use specific browser version, add <cite>browser_version</cite> keyword argument.\nIf matching browser &amp; driver(s) can be found in path, they will be used. If not, Selenium\nManager tries to download and install them. With Chrome also specific version of\nbrowser (&quot;Chrome for Testing&quot;) can be used.\nNote that for Edge in Windows local admin rights are required!</p>\n<p>More info:\n<a class=\"reference external\" href=\"https://www.selenium.dev/documentation/selenium_manager/#automated-browser-management\">https://www.selenium.dev/documentation/selenium_manager/#automated-browser-management</a></p>\n<p><strong>NOTE</strong>: if you are using QWeb in some cloud service,\nit's best to use their method of setting browser version.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># If Chrome 124 is already installed, it will be used.\n# If not, Chrome for Testing v124 will be downloaded and used.\nOpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">    </span><span class=\"c\">browser_version=124</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">firefox</span><span class=\"p\">   </span><span class=\"c\">browser_version=124</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">   </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">edge</span><span class=\"p\">      </span><span class=\"c\">browser_version=124</span>\n</pre>\n</div>\n<div class=\"section\" id=\"browserstack-usage\">\n<h1>BrowserStack usage</h1>\n<p>QWeb can be directly used with BrowserStack for desktop and mobile browser\ntesting. Your own Browserstack credentials are required.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Using BrowserStack for DESKTOP browser testing\n</span><span class=\"p\">\n</span><span class=\"c\"># Note that these variables can be given in run command\n${PROVIDER}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">bs</span><span class=\"p\">\n</span><span class=\"c\">${USERNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_username</span><span class=\"p\">\n</span><span class=\"c\">${APIKEY}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_token</span><span class=\"p\">\n</span><span class=\"c\">${PROJECTNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${RUNID}=</span><span class=\"p\">       </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${BSOS}=</span><span class=\"p\">        </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">windows</span><span class=\"p\">  </span><span class=\"c\"># optional, default is windows\nOpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span><span class=\"p\">\n\n</span><span class=\"c\">${BSOS}=</span><span class=\"p\">        </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">osx</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n</span><span class=\"c\"># Different os version, browser version and resolution\n${BSOSVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Monterey</span><span class=\"p\">\n</span><span class=\"c\">${BROWSERVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">15</span><span class=\"p\">\n</span><span class=\"c\">${BSRESOLUTION}=</span><span class=\"p\">   </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">2560x1440</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">        </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n\n</span><span class=\"c\"># Using BrowserStack for MOBILE browser testing\n${PROVIDER}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">bs</span><span class=\"p\">\n</span><span class=\"c\">${USERNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_username</span><span class=\"p\">\n</span><span class=\"c\">${APIKEY}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">your_browserstack_token</span><span class=\"p\">\n</span><span class=\"c\">${DEVICE}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Google Pixel 4</span><span class=\"p\">\n</span><span class=\"c\">${PROJECTNAME}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">   </span><span class=\"c\">qweb_run</span><span class=\"p\">\n</span><span class=\"c\">${RUNID}=</span><span class=\"p\">       </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">qweb_run_id</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">          </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">safari</span><span class=\"p\">\n\n</span><span class=\"c\"># Change to Android device and use specific Android version\n${DEVICE}=</span><span class=\"p\">      </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">Google Pixel 4</span><span class=\"p\">\n</span><span class=\"c\">${BSOSVERSION}=</span><span class=\"p\">    </span><span class=\"c\">Set Variable</span><span class=\"p\">      </span><span class=\"c\">11</span><span class=\"p\">  </span><span class=\"c\"># optional\nOpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span>\n</pre>\n</div>\n<div class=\"section\" id=\"mobile-emulation\">\n<h1>Mobile emulation</h1>\n<p>Giving a valid device profile or screen dimensions in &quot;emulation&quot; argument turns on\n&quot;mobile emulation&quot;.</p>\n<p>Supported browsers: desktop Chrome and Edge only.</p>\n<p>See examples above. Always make sure the device profile name exists. You can either define\na new one or use one of the default profiles:</p>\n<blockquote>\n<ul class=\"simple\">\n<li>iPhone SE</li>\n<li>iPhone XR</li>\n<li>iPhone 12 Pro</li>\n<li>Pixel 5</li>\n<li>Samsung Galaxy S8+</li>\n<li>Samsung Galaxy S20 Ultra</li>\n<li>iPad Air</li>\n<li>iPad Mini</li>\n<li>Surface Pro 7</li>\n<li>Surface Duo</li>\n<li>Galaxy Fold</li>\n<li>Samsung Glazy A51/71</li>\n<li>Nest Hub</li>\n<li>Nest Hub Max</li>\n</ul>\n</blockquote>\n<p>Note that profile names given above are expected to change in new browser releases.\nAlways check that the name you are using still exists.</p>\n</div>\n<div class=\"section\" id=\"local-android-device-usage\">\n<h1>Local Android device usage</h1>\n<p>QWeb can be used with local Android device with Chrome. Note that this requires\nAndroid SDK and Appium to be installed in local machine, developer options enabled\nin mobile and USB debugging enabled.</p>\n<p>NOTE: that this feature is not officially supported nor tested in every release. We\ncan't guarantee that it will work with every future release and we can't offer support for Android\nside setup.</p>\n<p>Once you have installed Android SDK, starter Appium server and have your local\nAndroid device plugged in with USB cable, you can run QWeb against local Chrome\nwith the following command:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenBrowser</span><span class=\"p\">    </span><span class=\"c\">about:support</span><span class=\"p\">    </span><span class=\"c\">android</span>\n</pre>\n<p>To check if your device is correctly connected, run:\n<cite>adb devices</cite> on your terminal and verify that your device is listed.</p>\n</div>\n<div class=\"section\" id=\"experimental-feature-for-test-debugging-for-chrome-only\">\n<h1>Experimental feature for test debugging (for Chrome only):</h1>\n<p>To re-use existing Chrome browser session, you need to set variable BROWSER_REUSE_SESSION\nto True. Next you need to run the first test suite normally including <cite>OpenBrowser</cite> AND\nexcluding <cite>CloseBrowser</cite> (e.g. in Tear Down section). The first run will result to\narguments file in defined output directory. The file name is by default <cite>browser_session.arg</cite>.</p>\n<p>For the next runs, which re-use the existing browser session, you need to specify the argument\nfile in robot command-line using <cite>--argumentfile</cite> parameter. Additionally, test\nsuites (or debugger) has to run <cite>OpenBrowser</cite> normally. QWeb will automatically override\nnormal parameters and use argument file's values instead, thus re-using the existing browser.</p>\n<p>In the first test suite open Chrome browser normally without closing it at the tear down:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set Global Variable</span><span class=\"p\">   </span><span class=\"c\">${BROWSER_REUSE_ENABLED}</span><span class=\"p\">   </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">           </span><span class=\"c\">http://google.com</span><span class=\"p\">    </span><span class=\"c\">chrome</span>\n</pre>\n<p>By running above, an argument file <cite>browser_session.arg</cite> is created to the output\ndirectory or current working directory. To re-use the existing browser session, use\nfollowing command line examples:</p>\n<pre class=\"code text literal-block\">\nrobot --argumentfile &lt;path&gt;/browser_session.arg ... example.robot\nrfdebug --argumentfile &lt;path&gt;/browser_session.arg\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n<dt>browser_alias <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Browser name. For example chrome, firefox or ie.</dd>\n<dt>options</dt>\n<dd>Arguments for initialization of WebDriver objects(chrome).\nSome available opts: <a class=\"reference external\" href=\"https://peter.sh/experiments/chromium-command-line-switches/\">https://peter.sh/experiments/chromium-command-line-switches/</a></dd>\n<dt>kwargs</dt>\n<dd><dl class=\"first last docutils\">\n<dt>prefs=args:</dt>\n<dd>Experimental options for chrome browser.</dd>\n<dt>emulation:</dt>\n<dd>Turns on &quot;mobile emulation&quot; in desktop browser. Useful for testing websites\nsimulating a mobile device screen dimensions.\nSupported browsers: desktop Chrome and Edge only.\nExisting device profile name (i.e. &quot;iPhone SE&quot;, must exist)\nOR device dimensions in format:\nWIDTHxHEIGHT (i.e. 385x812)</dd>\n</dl>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Unknown browser type</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Get%20Title\" class=\"name\">GetTitle</a>,\n<a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Refresh%20Page\" class=\"name\">RefreshPage</a>, <a href=\"#Return%20Browser\" class=\"name\">ReturnBrowser</a>,\n<a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Open new browser to given url.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 65}, {"name": "Open Window", "args": [], "doc": "<div class=\"document\">\n<p>Open new tab.</p>\n<p>Uses javascript to do this so javascript has to be enabled.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenWindow</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20All%20Browsers\" class=\"name\">CloseAllBrowsers</a>, <a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>,\n<a href=\"#Open%20Browser\" class=\"name\">OpenBrowser</a>, <a href=\"#Switch%20Window\" class=\"name\">SwitchWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Open new tab.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 61}, {"name": "Press Key", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Simulate user pressing keyboard key on element identified by &quot;locator&quot;.</p>\n<p>The parameter &quot;key&quot; is either a single character or a keyboard key combination\nsurrounded by '{ }'.</p>\n<p>If ${EMPTY} is given as a locator, &quot;global&quot; hotkey combination is sent and handled by the OS.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">q</span><span class=\"p\">\n</span><span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{ENTER}</span><span class=\"p\">\n</span><span class=\"c\">PressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + A}</span><span class=\"p\">    </span><span class=\"c\"># Select all\nPressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + C}</span><span class=\"p\">    </span><span class=\"c\"># Copy selected text\nPressKey</span><span class=\"p\">    </span><span class=\"c\">other_field</span><span class=\"p\">    </span><span class=\"c\">{CONTROL + V}</span><span class=\"p\">    </span><span class=\"c\"># Paste copied text\nPressKey</span><span class=\"p\">    </span><span class=\"c\">text_field</span><span class=\"p\">     </span><span class=\"c\">{PASTE}</span><span class=\"p\">          </span><span class=\"c\"># Paste copied text\n</span><span class=\"p\">\n</span><span class=\"c\"># Send ESC keypress without locator and let OS decide how it's consumed\n# on Windows this opens task manager\nPressKey</span><span class=\"p\">    </span><span class=\"c\">${EMPTY}</span><span class=\"p\">       </span><span class=\"c\">{CTRL + SHIFT + ESC}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"notes\">\n<h1>Notes</h1>\n<p>Below is a list of supported keys that can be sent to a web element,\nin addition to keys that consist of a single character (like 'c' or '?'):</p>\n<p>'ADD', 'ALT', 'ARROW_DOWN', 'ARROW_LEFT', 'ARROW_RIGHT', 'ARROW_UP', 'BACKSPACE', 'BACK_SPACE',\n'CANCEL', 'CLEAR',COMMAND', 'CONTROL', 'DECIMAL', 'DELETE', 'DIVIDE', 'DOWN', 'END', 'ENTER',\n'EQUALS', 'ESCAPE', 'F1', 'F10', 'F11', 'F12', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9',\n'HELP', 'HOME', 'INSERT', 'LEFT', 'LEFT_ALT', 'LEFT_CONTROL', 'LEFT_SHIFT', 'META', 'MULTIPLY',\n'NULL', 'NUMPAD0', 'NUMPAD1', 'NUMPAD2', 'NUMPAD3', 'NUMPAD4', 'NUMPAD5', 'NUMPAD6', 'NUMPAD7',\n'NUMPAD8', 'NUMPAD9', 'PAGE_DOWN', 'PAGE_UP', 'PAUSE', 'RETURN', 'RIGHT', 'SEMICOLON',\n'SEPARATOR', 'SHIFT', 'SPACE', 'SUBTRACT', 'TAB', 'UP', 'ZENKAKU_HANKAKU'</p>\n</div>\n<div class=\"section\" id=\"notes-1\">\n<h1>Notes</h1>\n<p>Below is a list of supported keys names that can be used as &quot;global&quot; hotkeys,\nin addition to keys that consist of a single character (like 'c' or '?'):</p>\n<p>'ACCEPT', 'ADD', 'ALT', 'ALTLEFT', 'ALTRIGHT', 'APPS', 'BACKSPACE', 'BROWSERBACK',\n'BROWSERFAVORITES', 'BROWSERFORWARD', 'BROWSERHOME', 'BROWSERREFRESH', 'BROWSERSEARCH',\n'BROWSERSTOP', 'CAPSLOCK', 'CLEAR','CONVERT', 'CTRL', 'CTRLLEFT', 'CTRLRIGHT', 'DECIMAL',\n'DEL', 'DELETE', 'DIVIDE', 'DOWN', 'END', 'ENTER', 'ESC', 'ESCAPE', 'EXECUTE', 'F1', 'F10',\n'F11', 'F12', 'F13', 'F14', 'F15', 'F16', 'F17', 'F18', 'F19','F2', 'F20', 'F21', 'F22',\n'F23', 'F24', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'FINAL', 'FN', 'HANGUEL', 'HANGUL',\n'HANJA', 'HELP', 'HOME', 'INSERT', 'JUNJA', 'KANA', 'KANJI', 'LAUNCHAPP1', 'LAUNCHAPP2',\n'LAUNCHMAIL', 'LAUNCHMEDIASELECT', 'LEFT', 'MODECHANGE', 'MULTIPLY', 'NEXTTRACK', 'NONCONVERT',\n'NUM0', 'NUM1', 'NUM2', 'NUM3', 'NUM4', 'NUM5', 'NUM6', 'NUM7', 'NUM8', 'NUM9', 'NUMLOCK',\n'PAGEDOWN', 'PAGEUP', 'PAUSE', 'PGDN', 'PGUP', 'PLAYPAUSE', 'PREVTRACK', 'PRINT',\n'PRINTSCREEN', 'PRNTSCRN', 'PRTSC', 'PRTSCR', 'RETURN', 'RIGHT', 'SCROLLLOCK', 'SELECT',\n'SEPARATOR', 'SHIFT', 'SHIFTLEFT', 'SHIFTRIGHT', 'SLEEP', 'SPACE', 'STOP', 'SUBTRACT',\n'TAB', 'UP', 'VOLUMEDOWN', 'VOLUMEMUTE', 'VOLUMEUP', 'WIN', 'WINLEFT', 'WINRIGHT, 'YEN',\n'COMMAND', 'OPTION', 'OPTIONLEFT', 'OPTIONRIGHT'</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Simulate user pressing keyboard key on element identified by \"locator\".", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 737}, {"name": "Refresh Page", "args": [], "doc": "<div class=\"document\">\n<p>Refresh the current window.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RefreshPage</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Back\" class=\"name\">Back</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Maximize%20Window\" class=\"name\">MaximizeWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Refresh the current window.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 84}, {"name": "Remove File", "args": [{"name": "file", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "file: str | None = None"}], "doc": "<div class=\"document\">\n<p>Remove a file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">        </span><span class=\"c\">yoink.pdf</span><span class=\"p\">\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">\n\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/Desktop/yoink.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Move%20Files\" class=\"name\">MoveFiles</a>, <a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a></p>\n</div>\n</div>\n", "shortdoc": "Remove a file.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 312}, {"name": "Remove Pdf", "args": [], "doc": "<div class=\"document\">\n<p>Remove a file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">        </span><span class=\"c\">yoink.pdf</span><span class=\"p\">\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">\n\n</span><span class=\"c\">RemoveFile</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/Desktop/yoink.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Move%20Files\" class=\"name\">MoveFiles</a>, <a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a></p>\n</div>\n</div>\n", "shortdoc": "Remove a file.", "tags": ["File", "Interaction", "PDF"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 337}, {"name": "Reset Config", "args": [{"name": "par", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "par: str | None = None"}], "doc": "<div class=\"document\">\n<p>Reset the value of given parameter to default value.</p>\n<p>If no parameter is given, reset all\nparameters configuration parameters to their defaults.\nReset also returns the value of the given configuration parameter. If no parameter is given, the\nResetConfig returns all configurations in a python dictionary with configuration parameter\nname and their values.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">${VAL}</span><span class=\"p\">      </span><span class=\"c\">ResetConfig</span><span class=\"p\">    </span><span class=\"c\">default timeout</span><span class=\"p\">   </span><span class=\"c\"># resets single parameter, and returns value\n${VAL}</span><span class=\"p\">      </span><span class=\"c\">ResetConfig</span><span class=\"p\">                      </span><span class=\"c\"># Resets all parameters, and returns config</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Config\" class=\"name\">GetConfig</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Reset the value of given parameter to default value.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 1050}, {"name": "Return Browser", "args": [], "doc": "<div class=\"document\">\n<p>Return browser instance.</p>\n<p>Use this function if you need to expand QWeb and require direct browser access.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ReturnBrowser</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a></p>\n</div>\n</div>\n", "shortdoc": "Return browser instance.", "tags": ["Browser", "Getters"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 45}, {"name": "Right Click", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Right clicks the element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">click_me</span><span class=\"p\">      </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">\n</span><span class=\"c\">RightClick</span><span class=\"p\">          </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression with or without xpath= prefix. The equal sign &quot;=&quot; must be escaped\nwith a &quot;&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait before failing.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple found, use index to pick correct one.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Click%20Text\" class=\"name\">ClickText</a></p>\n</div>\n</div>\n", "shortdoc": "Right clicks the element.", "tags": ["Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 106}, {"name": "Run Block", "args": [{"name": "block", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "block: str"}, {"name": "args", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Run Action word as decorated block.</p>\n<p>Block (usually set of keywords) is handled as one\nindependent action. If any keyword inside of block fails block\nwill retry itself until it passes or given time is up. Retrying is\nstarting from first line of executable block.</p>\n<p>This feature is meant to be used with RPA-cases where FAIL\nis not an option. Think twice before using with Test Automation\nprojects to avoid situations where we have green test even that\nin real life our user interface in SUT might be almost unusable.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">RunBlock</span><span class=\"p\">       </span><span class=\"c\">Poll</span><span class=\"p\">    </span><span class=\"c\">timeout=15</span><span class=\"p\">\n</span><span class=\"c\">#with arguments:\nRunBlock</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">${USER}</span><span class=\"p\">   </span><span class=\"c\">${PASS}</span><span class=\"p\">   </span><span class=\"c\">timeout=50</span><span class=\"p\">\n</span><span class=\"c\">#with &quot;teardown&quot;:\nRunBlock</span><span class=\"p\">       </span><span class=\"c\">Login</span><span class=\"p\">    </span><span class=\"c\">${USER}</span><span class=\"p\">   </span><span class=\"c\">${PASS}</span><span class=\"p\">   </span><span class=\"c\">timeout=50</span><span class=\"p\">  </span><span class=\"c\">exp_handler=RebootBrowser</span><span class=\"p\">\n</span><span class=\"c\">#Example blocks:\nPOLL</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Click Counter</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">10 clicks</span><span class=\"p\">   </span><span class=\"c\">timeout=1</span><span class=\"p\">\n\n</span><span class=\"c\"># POLL is retried until VerifyText passes (ten times)\n</span><span class=\"p\">\n</span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">[Arguments]</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">Goto</span><span class=\"p\">        </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">     </span><span class=\"c\">${USER}</span><span class=\"p\">\n    </span><span class=\"c\">TypeText</span><span class=\"p\">    </span><span class=\"c\">Password</span><span class=\"p\">     </span><span class=\"c\">${PASS}</span><span class=\"p\">\n    </span><span class=\"c\">ClickText</span><span class=\"p\">   </span><span class=\"c\">Login</span><span class=\"p\">\n    </span><span class=\"c\">VerifyText</span><span class=\"p\">  </span><span class=\"c\">Welcome, ${USER}</span><span class=\"p\">\n\n</span><span class=\"c\"># If for example VerifyText  Welcome, ${USER} fails, RunBlock\n# tries again, starting from first paceword (Goto).\n</span><span class=\"p\">\n</span><span class=\"c\">RebootBrowser</span><span class=\"p\">\n    </span><span class=\"c\">CloseAllBrowsers</span><span class=\"p\">\n    </span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">about:blank</span><span class=\"p\">     </span><span class=\"c\">chrome</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>block <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Action word/Block to execute</dd>\n<dt>args <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">any</span></dt>\n<dd>Possible args for block</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long we try to get is passed before failing. Default 10 (seconds)</dd>\n<dt>kwargs: any</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">exp_handler : Use any Action Word as a teardown. If</div>\n<div class=\"line\">defined, this will be executed after every failed try</div>\n<div class=\"line\">before retrying</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Appstate\" class=\"name\">Appstate</a>, <a href=\"#Set%20Config\" class=\"name\">SetConfig</a></p>\n</div>\n</div>\n", "shortdoc": "Run Action word as decorated block.", "tags": ["Config", "Error handling"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\blocks.py", "lineno": 28}, {"name": "Save File", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "filename", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Save file using http-request.</p>\n<p>Needs url of the downloadable content which usually is in element's href attribute.\nText or tooltip can be used as a locator (Works as ClickText or ClickItem).\nIf locator element is not the one with href-attribute, tries to get href from closest\nparent with &lt;a&gt; tag in it.</p>\n<p>url can be used as a locator too.</p>\n<p>Available element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only).</em></p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">filename.pdf</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">filename.xml</span><span class=\"p\">\n\n</span><span class=\"c\"># Locators parent or child element is the one with href:\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">filename.pdf</span><span class=\"p\">    </span><span class=\"c\">child=a</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">filename.xml</span><span class=\"p\">    </span><span class=\"c\">parent=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Create folder for downloadable files:\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">ClickMe</span><span class=\"p\">       </span><span class=\"c\">pdf/filename.pdf</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">tooltip</span><span class=\"p\">       </span><span class=\"c\">xml/filename.xml</span><span class=\"p\">\n</span><span class=\"c\">SaveFile</span><span class=\"p\">      </span><span class=\"c\">Robot</span><span class=\"p\">         </span><span class=\"c\">pics/filename.png</span><span class=\"p\">\n\n</span><span class=\"c\"># Using url as locator\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">https://www.robot.fi/robot.xml</span><span class=\"p\">  </span><span class=\"c\">filename.xml</span><span class=\"p\">\n\n</span><span class=\"c\"># Get html content of given url\nSaveFile</span><span class=\"p\">      </span><span class=\"c\">https://www.qentinel.com</span><span class=\"p\">      </span><span class=\"c\">qentinel.html</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or item to be &quot;clicked&quot;.</dd>\n<dt>filename: str</dt>\n<dd>Wanted filename</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it.  (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>path <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Wanted path for files. Default path is users download folder.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">parent : str: tag name for clickable parent</div>\n<div class=\"line\">child : str: tag name for clickable child.</div>\n<div class=\"line\">index : str: use index if there is multiple</div>\n<div class=\"line\">childs with same tag name</div>\n<div class=\"line\">headers : dict -Pass headers to http request</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Expect%20File%20Download\" class=\"name\">ExpectFileDownload</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>,\n<a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a></p>\n</div>\n</div>\n", "shortdoc": "Save file using http-request.", "tags": ["Logging"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\ajax.py", "lineno": 26}, {"name": "Scan Click", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "text_to_appear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_appear: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>ClickUntil</cite> instead.</p>\n<p>Click text until a text appears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text appears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">\n</span><span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">    </span><span class=\"c\">1</span><span class=\"p\">          </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">ScanClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">    </span><span class=\"c\">Main Cart</span><span class=\"p\">  </span><span class=\"c\">20s</span><span class=\"p\">   </span><span class=\"c\">3s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>text_to_appear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long button is clicked if text does not appear</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long to wait until text appear before clicking again</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text.\nel_type=item\ntext(default) = find element by visible text | item = find item type element</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `ClickUntil` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 467, "deprecated": true}, {"name": "Screenshot Type", "args": [{"name": "capture_method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "capture_method: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  ScreenshotType</cite> instead.</p>\n<p>Define how screenshot is taken. Default is normal screenshot.</p>\n<p>Html saves page as html frame in test log. All saves both image and html page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">html</span><span class=\"p\">\n</span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">screenshot</span><span class=\"p\">\n</span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">all</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  ScreenshotType` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 138, "deprecated": true}, {"name": "Scroll", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "direction", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "pagedown", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "direction: str = pagedown"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scrolls the page/element to given direction.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Scroll page down default value (one page)\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll page up\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">      </span><span class=\"c\">page_up</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll page right\nScroll</span><span class=\"p\">  </span><span class=\"c\">//html</span><span class=\"p\">      </span><span class=\"c\">right</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll to the bottom of a list using attribute value and tag\nScroll</span><span class=\"p\">  </span><span class=\"c\">uiScroller</span><span class=\"p\">    </span><span class=\"c\">bottom</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll to the top of a list using attribute value and tag\nScroll</span><span class=\"p\">  </span><span class=\"c\">uiScroller</span><span class=\"p\">    </span><span class=\"c\">top</span><span class=\"p\">    </span><span class=\"c\">tag=div</span><span class=\"p\">\n\n</span><span class=\"c\"># Scroll (page) down 3 times in a list\nRepeat Keyword</span><span class=\"p\">     </span><span class=\"c\">3 times</span><span class=\"p\">    </span><span class=\"c\">Scroll</span><span class=\"p\">    </span><span class=\"c\">uiScroller</span><span class=\"p\">   </span><span class=\"c\">down</span><span class=\"p\">    </span><span class=\"c\">tag=div</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath to scrollable element or attribute value of an scrollable element.</dd>\n<dt>direction <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd><dl class=\"first last docutils\">\n<dt>Direction to scroll to (down, up, left, right, top, bottom, page_down, page_up).</dt>\n<dd><ul class=\"first last simple\">\n<li>Down/up/left/right map to respective ARROW keys.</li>\n<li>Top/Bottom map to HOME &amp; END keys.</li>\n<li>Page_up/Page_down map to PAGE_UP and PAGE_DOWN keys.</li>\n</ul>\n</dd>\n</dl>\n</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long to scroll in seconds, before timing out.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If direction is not given in correct format.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the given scrollable element is not found.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a></p>\n</div>\n</div>\n", "shortdoc": "Scrolls the page/element to given direction.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 833}, {"name": "Scroll Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scroll page until text is on top.</p>\n<p>Finds text on page and scrolls until it is on top. This is used with visual testing\ntools to align page properly.</p>\n<p>Keyword tries to scroll to element until it succeeds or timeout has passed.\nIf timeout is not specified, it uses default timeout that can be adjusted\nwith DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollText</span><span class=\"p\">       </span><span class=\"c\">Address</span><span class=\"p\">\n</span><span class=\"c\">ScrollText</span><span class=\"p\">       </span><span class=\"c\">Address</span><span class=\"p\">    </span><span class=\"c\">Billing</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>, <span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20To\" class=\"name\">ScrollTo</a></p>\n</div>\n</div>\n", "shortdoc": "Scroll page until text is on top.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1235}, {"name": "Scroll To", "args": [{"name": "text_to_find", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_find: str"}, {"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: str | None = None"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "scroll_length", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scroll_length: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "120", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 120"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Scroll a dynamic web page or scrollbar.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text_to_find <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to find by scrolling a page or an element.</dd>\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator text for a scrollable element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Anchor used for the locator.</dd>\n<dt>scroll_length <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Amount of pixels per one scroll.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long to scroll in seconds, before timing out.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span>\n</pre>\n<p>In the above example, the web page is scrolled until the text &quot;Cat&quot; is found.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">scroll_length=2000</span>\n</pre>\n<p>In the above example, the web page is scrolled 2000 pixels per scroll, until the text &quot;Cat&quot; is\nfound.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">List of cats</span>\n</pre>\n<p>In the above example, a scrollbar located by a text &quot;List of cats&quot;, is scrolled until the text\n&quot;Cat&quot; is found.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ScrollTo</span><span class=\"p\">       </span><span class=\"c\">Cat</span><span class=\"p\">      </span><span class=\"c\">List of cats</span><span class=\"p\">    </span><span class=\"c\">scroll_length=2000</span>\n</pre>\n<p>In the above example, a scrollbar located by a text &quot;List of cats&quot;, is scrolled 2000 pixels\nper scroll until the text &quot;Cat&quot; is found.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Hover%20Element\" class=\"name\">HoverElement</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Hover%20Text\" class=\"name\">HoverText</a>,\n<span class=\"name\">HoverTo</span>, <a href=\"#Scroll%20Text\" class=\"name\">ScrollText</a></p>\n</div>\n</div>\n", "shortdoc": "Scroll a dynamic web page or scrollbar.", "tags": ["Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1427}, {"name": "Search Direction", "args": [{"name": "direction", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "direction: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  SearchDirection</cite> instead.</p>\n<p>Set search direction for element search.</p>\n<p>Search direction is &quot;up&quot;, &quot;down&quot;, &quot;left&quot;, &quot;right&quot; and &quot;closest&quot;</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SearchDirection</span><span class=\"p\">    </span><span class=\"c\">right</span><span class=\"p\">\n</span><span class=\"c\">SearchDirection</span><span class=\"p\">    </span><span class=\"c\">closest</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  SearchDirection` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 28, "deprecated": true}, {"name": "Set Active Area Function", "args": [{"name": "function", "type": {"name": "Callable", "typedoc": null, "nested": [{"name": "...", "typedoc": null, "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Callable[..., Any]"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: Callable[..., Any]"}], "doc": "<div class=\"document\">\n<p>Set function that sets active area where elements are searched.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>function <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">function</span></dt>\n<dd>Function that returns WebElement under which elements are searched.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Set function that sets active area where elements are searched.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\custom_config.py", "lineno": 39}, {"name": "Set Config", "args": [{"name": "par", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "par: str"}, {"name": "val", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "val: Any"}], "doc": "<div class=\"document\">\n<p>Set configuration parameter to given value. Return previous value.</p>\n<p>Summary of possible configurations and their purpose. More information below.</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"27%\" />\n<col width=\"53%\" />\n<col width=\"21%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">Parameter</th>\n<th class=\"head\">Description</th>\n<th class=\"head\">Default value</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td><a class=\"reference internal\" href=\"#activeareaxpath\">ActiveAreaXpath</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#allinputelements\">AllInputElements</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#blindreturn\">BlindReturn</a></td>\n<td>Return value without waiting</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#caseinsensitive\">CaseInsensitive</a></td>\n<td>Allow case insensitive search when\npartial match is used</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#checkinputvalue\">CheckInputValue</a></td>\n<td>Check that typed value is stored\ncorrectly after TypeText.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#clearkey\">ClearKey</a></td>\n<td>Set key to be clear previous value when\ntext is written to input field (or None)</td>\n<td>webdriver's\ndefault clear</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#clicktofocus\">ClickToFocus</a></td>\n<td>Sets focus by clicking the field before\ntyping.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#cssselectors\">CssSelectors</a></td>\n<td>Use CSS selectors for finding elements</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#delay\">Delay</a></td>\n<td>Wait time before each keyword</td>\n<td>0 (no delay)</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#defaultdocument\">DefaultDocument</a></td>\n<td>Automatically switch back to default\nframew after each keyword.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#defaulttimeout\">DefaultTimeout</a></td>\n<td>How long to wait for element to appear\nbefore failing the case.</td>\n<td>10s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#doubleclick\">DoubleClick</a></td>\n<td>Perform double-click action in all click\nkeywords.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#handlealerts\">HandleAlerts</a></td>\n<td>Automatically handle alerts.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#highlightcolor\">HighlightColor</a></td>\n<td>Sets the highlight color to use when\nelement is highlighted.</td>\n<td>blue</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#inputhandler\">InputHandler</a></td>\n<td>Use javascript, selenium or pyautogui\nto input text.</td>\n<td>selenium</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#inviewport\">InViewport</a></td>\n<td>If set to true every element outside of\ncurrent viewport is considered invisible\nand not returned by default searches</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#ismodalxpath\">IsModalXPath</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#linebreak\">LineBreak</a></td>\n<td>Set key to send to text fields after\ntyping.</td>\n<td>ue004 (tab key)</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#logmatchedicons\">LogMatchedIcons</a></td>\n<td>Highlights where icon was found on the\nscreen and adds a sceenshot to logs</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#logscreenshot\">LogScreenShot</a></td>\n<td>Adds screenshot of failure to logs</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#matchinginputelement\">MatchingInputElement</a></td>\n<td>Set search strategy for element search.</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#multipleanchors\">MultipleAnchors</a></td>\n<td>Accept non-unique anchors.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#offsetcheck\">OffsetCheck</a></td>\n<td>Check element has offset. Element with\nno offset is considered invisible.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#osscreenshots\">OSScreenshots</a></td>\n<td>Use operating system functionalities\ninstead of selenium to take screenshots</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#partialmatch\">PartialMatch</a></td>\n<td>Accept partial matches from element\nsearch functions or require exact match</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#retinadisplay\">RetinaDisplay</a></td>\n<td>Is current monitor Retina display\n(True) or not (False)</td>\n<td>Automatic\ndetection</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#retryinterval\">RetryInterval</a></td>\n<td>Timeout to wait before re-trying in\n-Until/-While keywords.</td>\n<td>5s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#runbefore\">RunBefore</a></td>\n<td>A keyword to be run before every\ninteraction keyword. Useful for example\nwhen there is a custom spinner that\nshould be waited for</td>\n<td>None</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#screenshottype\">ScreenShotType</a></td>\n<td>Log html source, screenshot or both</td>\n<td>screenshot</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#searchdirection\">SearchDirection</a></td>\n<td>Set relative search direction for\nelement search (closest, up, down, left,\nright, up!, down!, left!, right!)</td>\n<td>closest</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#searchmode\">SearchMode</a></td>\n<td>Options for highlighting elements found\nby searches (None, debug, draw).</td>\n<td>draw</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#shadowdom\">ShadowDOM</a></td>\n<td>Extend element searches to shadow DOM.</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#xhrtimeout\">XHRTimeout</a></td>\n<td>Maximum wait for page to be loaded</td>\n<td>30s</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#verifyappaccuracy\">VerifyAppAccuracy</a></td>\n<td>Threshold for needed similarity in\nVerifyApp keyword.</td>\n<td>0.9999</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#visibility\">Visibility</a></td>\n<td>Set if visibility should be checked when\nsearching for elements.</td>\n<td>True</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#windowfind\">WindowFind</a></td>\n<td>Simulate CTRL+F to search for elements\ninstead of searching from DOM</td>\n<td>False</td>\n</tr>\n<tr><td><a class=\"reference internal\" href=\"#windowsize\">WindowSize</a></td>\n<td>Set the size of browser window</td>\n<td>Full screen</td>\n</tr>\n</tbody>\n</table>\n<hr class=\"docutils\" id=\"logscreenshot\" />\n<div class=\"section\" id=\"parameter-logscreenshot\">\n<h1>Parameter: LogScreenshot</h1>\n<p>Enables or disables logging screenshots when keyword fails.\nDefault is screenshot (True). False disables screenshots from logs when keyword fails.</p>\n<div class=\"section\" id=\"examples\">\n<h2>Examples</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogScreenshot</span><span class=\"p\">         </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogScreenshot</span><span class=\"p\">         </span><span class=\"c\">True</span>\n</pre>\n</div>\n<hr class=\"docutils\" id=\"screenshottype\" />\n<div class=\"section\" id=\"parameter-screenshottype\">\n<h2>Parameter: ScreenshotType</h2>\n<p>Defines how screenshot is taken. Default is normal screenshot.\n&quot;html&quot; saves page as html frame in test log. &quot;all&quot; saves both image and html page.</p>\n<div class=\"section\" id=\"examples-1\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">html</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">screenshot</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ScreenshotType</span><span class=\"p\">        </span><span class=\"c\">all</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"osscreenshots\" />\n<div class=\"section\" id=\"parameter-osscreenshots\">\n<h2>Parameter: OSScreenshots</h2>\n<p>Defines if screenhots are taken using selenium's or operating system's functionalities.\nDefault is selenium screenshot (False).</p>\n<div class=\"section\" id=\"examples-2\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OSScreenshots</span><span class=\"p\">        </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OSScreenshots</span><span class=\"p\">        </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"cssselectors\" />\n<div class=\"section\" id=\"parameter-cssselectors\">\n<h2>Parameter: CssSelectors</h2>\n<p>Use CSS selectors for finding elements.</p>\n<p>CSS selectors is optional way to find elements that\nare difficult to catch by default selectors. Typically\nthose elements are inputs, checkboxes and dropdowns\nwithout placeholder texts.</p>\n<p>With CSS selectors the detection is tried with:</p>\n<ul class=\"simple\">\n<li>Placeholder or tooltip</li>\n<li>Label with 'for' attribute</li>\n<li>DOM traversing to detect sibling element</li>\n</ul>\n<div class=\"section\" id=\"examples-3\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">     </span><span class=\"c\">MyLocator</span><span class=\"p\">   </span><span class=\"c\">Robot</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">CssSelectors</span><span class=\"p\">       </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"searchdirection\" />\n<div class=\"section\" id=\"parameter-searchdirection\">\n<h2>Parameter: SearchDirection</h2>\n<p>Set search direction for element search.</p>\n<p>Search direction is &quot;closest, &quot;up&quot;, &quot;down&quot;, &quot;left&quot;, &quot;right&quot;,\n&quot;up!&quot;, &quot;down!&quot;, &quot;left!&quot;, &quot;right!&quot;.\n&quot;Closest&quot; is the default value.</p>\n<p>Elements are searched according to their relative position to anchor.</p>\n<p>With this setting you can choose between two ways of searching:</p>\n<ul class=\"simple\">\n<li><strong>normal mode</strong></li>\n<li><strong>strict mode</strong> (ending with &quot;!&quot;).</li>\n</ul>\n<p><strong>Normal Mode</strong>: In this mode, you start looking for something starting from a specific point\nor direction you've chosen. If you can't find it there, the search will then try to find\nthe closest match, even if it's not exactly in the direction you started from.</p>\n<p><strong>Strict Mode</strong>: This mode is stricter. You also start searching from a specific direction,\nbut the big difference is that if what you're looking for isn't found exactly in that direction,\nthe search will fail.\nIt won't try to find the next closest thing. The search insists that the item must be found in\nthe direction you specified, or not at all.\nIt's important to note that this enforced format works only when you're searching for text\non a page, like when you're using commands to verify text is there (VerifyText)\nor when you want to click on text (ClickText).</p>\n<div class=\"section\" id=\"examples-4\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">SearchDirection Example</span><span class=\"p\">\n    </span><span class=\"c\"># finds input using text &quot;My Locator&quot; on the right of text &quot;Robot&quot;\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">right</span><span class=\"p\">\n    </span><span class=\"nf\">TypeText</span><span class=\"p\">     </span><span class=\"s\">MyLocator</span><span class=\"p\">  </span><span class=\"s\">Hello</span><span class=\"p\">  </span><span class=\"s\">Robot</span><span class=\"p\">\n\n    </span><span class=\"c\"># finds input using text &quot;My Locator&quot; above of text &quot;Robot&quot;\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">up</span><span class=\"p\">\n    </span><span class=\"nf\">TypeText</span><span class=\"p\">     </span><span class=\"s\">MyLocator</span><span class=\"p\">  </span><span class=\"s\">Hello</span><span class=\"p\">  </span><span class=\"s\">Robot</span><span class=\"p\">\n\n    </span><span class=\"c\"># When using strict mode (!), the test case fails if the locator text is\n</span><span class=\"p\">    </span><span class=\"c\"># not found in the correct direction from the anchor.\n</span><span class=\"p\">    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">left!</span><span class=\"p\">\n    </span><span class=\"nf\">VerifyText</span><span class=\"p\">   </span><span class=\"s\">Firstname</span><span class=\"p\">             </span><span class=\"s\">anchor=Lastname</span><span class=\"p\">\n    </span><span class=\"nf\">SetConfig</span><span class=\"p\">    </span><span class=\"s\">SearchDirection</span><span class=\"p\">       </span><span class=\"s\">closest</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"linebreak\" />\n<div class=\"section\" id=\"parameter-linebreak\">\n<h2>Parameter: LineBreak</h2>\n<p>Set key to be pressed after text is written to input field.</p>\n<p>By default tab key (ue004) is pressed</p>\n<p>Values, that are mapped for selenium keys are:</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"73%\" />\n<col width=\"27%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">Key</th>\n<th class=\"head\">Value</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td>null</td>\n<td>ue000</td>\n</tr>\n<tr><td>cancel</td>\n<td>ue001</td>\n</tr>\n<tr><td>help</td>\n<td>ue002</td>\n</tr>\n<tr><td>backspace</td>\n<td>ue003</td>\n</tr>\n<tr><td>tab</td>\n<td>ue004</td>\n</tr>\n<tr><td>clear</td>\n<td>ue005</td>\n</tr>\n<tr><td>return</td>\n<td>ue006</td>\n</tr>\n<tr><td>enter</td>\n<td>ue007</td>\n</tr>\n<tr><td>shift</td>\n<td>ue008</td>\n</tr>\n<tr><td>left_shift</td>\n<td>ue008</td>\n</tr>\n<tr><td>control</td>\n<td>ue009</td>\n</tr>\n<tr><td>left_control</td>\n<td>ue009</td>\n</tr>\n<tr><td>alt</td>\n<td>ue00A</td>\n</tr>\n<tr><td>left_alt</td>\n<td>ue00A</td>\n</tr>\n<tr><td>pause</td>\n<td>ue00B</td>\n</tr>\n<tr><td>escape</td>\n<td>ue00C</td>\n</tr>\n<tr><td>space</td>\n<td>ue00D</td>\n</tr>\n<tr><td>page_up</td>\n<td>ue00E</td>\n</tr>\n<tr><td>page_down</td>\n<td>ue00F</td>\n</tr>\n<tr><td>end</td>\n<td>ue010</td>\n</tr>\n<tr><td>home</td>\n<td>ue011</td>\n</tr>\n<tr><td>left</td>\n<td>ue012</td>\n</tr>\n<tr><td>arrow_left</td>\n<td>ue012</td>\n</tr>\n<tr><td>up</td>\n<td>ue013</td>\n</tr>\n<tr><td>arrow_up</td>\n<td>ue013</td>\n</tr>\n<tr><td>right</td>\n<td>ue014</td>\n</tr>\n<tr><td>arrow_right</td>\n<td>ue014</td>\n</tr>\n<tr><td>down</td>\n<td>ue015</td>\n</tr>\n<tr><td>arrow_down</td>\n<td>ue015</td>\n</tr>\n<tr><td>insert</td>\n<td>ue016</td>\n</tr>\n<tr><td>delete</td>\n<td>ue017</td>\n</tr>\n<tr><td>semicolon</td>\n<td>ue018</td>\n</tr>\n<tr><td>equals</td>\n<td>ue019</td>\n</tr>\n<tr><td>numpad0</td>\n<td>ue01A</td>\n</tr>\n<tr><td>numpad1</td>\n<td>ue01B</td>\n</tr>\n<tr><td>numpad2</td>\n<td>ue01C</td>\n</tr>\n<tr><td>numpad3</td>\n<td>ue01D</td>\n</tr>\n<tr><td>numpad4</td>\n<td>ue01E</td>\n</tr>\n<tr><td>numpad5</td>\n<td>ue01F</td>\n</tr>\n<tr><td>numpad6</td>\n<td>ue020</td>\n</tr>\n<tr><td>numpad7</td>\n<td>ue021</td>\n</tr>\n<tr><td>numpad8</td>\n<td>ue022</td>\n</tr>\n<tr><td>numpad9</td>\n<td>ue023</td>\n</tr>\n<tr><td>multiply</td>\n<td>ue024</td>\n</tr>\n<tr><td>add</td>\n<td>ue025</td>\n</tr>\n<tr><td>separator</td>\n<td>ue026</td>\n</tr>\n<tr><td>subtract</td>\n<td>ue027</td>\n</tr>\n<tr><td>decimal</td>\n<td>ue028</td>\n</tr>\n<tr><td>divide</td>\n<td>ue029</td>\n</tr>\n<tr><td>f1</td>\n<td>ue031</td>\n</tr>\n<tr><td>f2</td>\n<td>ue032</td>\n</tr>\n<tr><td>f3</td>\n<td>ue033</td>\n</tr>\n<tr><td>f4</td>\n<td>ue034</td>\n</tr>\n<tr><td>f5</td>\n<td>ue035</td>\n</tr>\n<tr><td>f6</td>\n<td>ue036</td>\n</tr>\n<tr><td>f7</td>\n<td>ue037</td>\n</tr>\n<tr><td>f8</td>\n<td>ue038</td>\n</tr>\n<tr><td>f9</td>\n<td>ue039</td>\n</tr>\n<tr><td>f10</td>\n<td>ue03A</td>\n</tr>\n<tr><td>f11</td>\n<td>ue03B</td>\n</tr>\n<tr><td>f12</td>\n<td>ue03C</td>\n</tr>\n<tr><td>meta</td>\n<td>ue03D</td>\n</tr>\n<tr><td>right_shift</td>\n<td>ue050</td>\n</tr>\n<tr><td>right_control</td>\n<td>ue051</td>\n</tr>\n<tr><td>right_alt</td>\n<td>ue052</td>\n</tr>\n<tr><td>right_meta</td>\n<td>ue053</td>\n</tr>\n<tr><td>numpad_page_up</td>\n<td>ue054</td>\n</tr>\n<tr><td>numpad_page_down</td>\n<td>ue055</td>\n</tr>\n<tr><td>numpad_end</td>\n<td>ue056</td>\n</tr>\n<tr><td>numpad_home</td>\n<td>ue057</td>\n</tr>\n<tr><td>numpad_left</td>\n<td>ue058</td>\n</tr>\n<tr><td>numpad_up</td>\n<td>ue059</td>\n</tr>\n<tr><td>numpad_right</td>\n<td>ue05A</td>\n</tr>\n<tr><td>numpad_down</td>\n<td>ue05B</td>\n</tr>\n<tr><td>numpad_insert</td>\n<td>ue05C</td>\n</tr>\n<tr><td>numpad_delete</td>\n<td>ue05D</td>\n</tr>\n</tbody>\n</table>\n<div class=\"section\" id=\"examples-5\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">\\ue004</span><span class=\"p\">    </span><span class=\"c\"># Tab key\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">\\ue007</span><span class=\"p\">    </span><span class=\"c\"># Enter key\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">LineBreak</span><span class=\"p\">    </span><span class=\"c\">${EMPTY}</span><span class=\"p\">  </span><span class=\"c\"># Do not send anything</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"clearkey\" />\n<div class=\"section\" id=\"parameter-clearkey\">\n<h2>Parameter: ClearKey</h2>\n<p>Set key to be pressed before text is written to input field.</p>\n<p>By default uses webdrivers clear method to clear element.</p>\n<p>Available values are same as with LineBreak. Some keyboard shortcuts\nalso available. Some examples from link below:\n<a class=\"reference external\" href=\"https://turbofuture.com/computers/keyboard-shortcut-keys\">https://turbofuture.com/computers/keyboard-shortcut-keys</a>:</p>\n<div class=\"section\" id=\"examples-6\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">None</span><span class=\"p\">           </span><span class=\"c\"># Uses clear method (=default)\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">{NULL}</span><span class=\"p\">         </span><span class=\"c\"># Does nothing\nSetConfig</span><span class=\"p\">   </span><span class=\"c\">ClearKey</span><span class=\"p\">     </span><span class=\"c\">{CONTROL + A}</span><span class=\"p\">  </span><span class=\"c\"># Select all and overwrite\n# One time use:\nTypeText</span><span class=\"p\">    </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Robot</span><span class=\"p\">       </span><span class=\"c\">clear_key={CONTROL + A}</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"checkinputvalue\" />\n<div class=\"section\" id=\"parameter-checkinputvalue\">\n<h2>Parameter: CheckInputValue</h2>\n<p>Check that real value matches to preferred value after TypeText.</p>\n<p>If value is not match we try to re type (three times before fail)\nThis is optional feature. Default = false.\nUse with caution on elements where webdriver has tendency to lost focus\nand some part of the preferred text gone missing.</p>\n<div class=\"section\" id=\"examples-7\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CheckInputValue</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nTypeText</span><span class=\"p\">    </span><span class=\"c\">username</span><span class=\"p\">           </span><span class=\"c\">Robot</span><span class=\"p\">       </span><span class=\"c\">check=True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"defaulttimeout\" />\n<div class=\"section\" id=\"parameter-defaulttimeout\">\n<h2>Parameter: DefaultTimeout</h2>\n<p>Set default timeout for QWeb keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-8\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">10s</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nVerifyText</span><span class=\"p\">        </span><span class=\"c\">Foo</span><span class=\"p\">          </span><span class=\"c\">60s</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"xhrtimeout\" />\n<div class=\"section\" id=\"parameter-xhrtimeout\">\n<h2>Parameter: XHRTimeout</h2>\n<p>Set default timeout for XHR (How log we wait page to be loaded).</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-9\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">XHRTimeout</span><span class=\"p\">        </span><span class=\"c\">60</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"defaultdocument\" />\n<div class=\"section\" id=\"parameter-defaultdocument\">\n<h2>Parameter: DefaultDocument</h2>\n<p>Switches to default frame automatically.</p>\n<p>If some other frame is used by previous keyword\nwe switch back to default after keyword is executed so\nthat we are starting to find next locator from html document\ninstead of previously used frame.\nDefault = True\nUse False only when there is need to use and move\nbetween frames and page manually for some reason.</p>\n<div class=\"section\" id=\"examples-10\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">DefaultDocument</span><span class=\"p\">    </span><span class=\"c\">off</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"caseinsensitive\" />\n<div class=\"section\" id=\"parameter-caseinsensitive\">\n<h2>Parameter: CaseInsensitive</h2>\n<p>Set containing_text_match according to selected case sensitivity.</p>\n<p>Default = False\nNote: if containing_text_match has been overwritten manually\nthis will return the default value.</p>\n<div class=\"section\" id=\"examples-11\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">CaseInsensitive</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"partialmatch\" />\n<div class=\"section\" id=\"parameter-partialmatch\">\n<h2>Parameter: PartialMatch</h2>\n<p>Accept partial match (True) from textual element searches\nor require exact match (False)</p>\n<p>Default = True</p>\n<div class=\"section\" id=\"examples-12\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">PartialMatch</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">PartialMatch</span><span class=\"p\">    </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"verifyappaccuracy\" />\n<div class=\"section\" id=\"parameter-verifyappaccuracy\">\n<h2>Parameter: VerifyAppAccuracy</h2>\n<p>Set VerifyApp accuracy. Default is 0.9999. You should not use\nvalue of 1 because browser rendering will cause false positives.</p>\n<div class=\"section\" id=\"examples-13\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">VerifyAppAccuracy</span><span class=\"p\">     </span><span class=\"c\">0.99999</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"windowsize\" />\n<div class=\"section\" id=\"parameter-windowsize\">\n<h2>Parameter: WindowSize</h2>\n<p>Set window size.</p>\n<div class=\"section\" id=\"examples-14\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowSize</span><span class=\"p\">     </span><span class=\"c\">1920x1080</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"inputhandler\" />\n<div class=\"section\" id=\"parameter-inputhandler\">\n<h2>Parameter: InputHandler</h2>\n<p>Set input handler.</p>\n<p>Default handler is &quot;selenium&quot; which uses Selenium library's\nmethods clear() and send_keys(). These methods assume that\nthe web element is writable (enabled). Inserts tab character\nat the end of text.</p>\n<p>Alternative writers &quot;raw&quot; and &quot;javascript. &quot;raw&quot; uses pyautogui to input text directly\nwithout checking the web element state. &quot;javascript&quot; uses javascript for input.\nThese version are intended to be used when the web page doesn't update input element status\nSelenium compliant way.</p>\n<div class=\"section\" id=\"examples-15\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">raw</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">selenium</span><span class=\"p\">\n\n</span><span class=\"c\"># Use JavaScript to set the text to input element's value attribute\nSetConfig</span><span class=\"p\">      </span><span class=\"c\">InputHandler</span><span class=\"p\">        </span><span class=\"c\">javascript</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"offsetcheck\" />\n<div class=\"section\" id=\"parameter-offsetcheck\">\n<h2>Parameter: OffsetCheck</h2>\n<p>Element with no offset is considered invisible by default.\nTo bypass this check set OffsetCheck to false.</p>\n<div class=\"section\" id=\"examples-16\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">OffsetCheck</span><span class=\"p\">     </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns also elements that has offset=0\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">OffsetCheck</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#offset is needed (default)\n# One time use:\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">offset=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"visibility\" />\n<div class=\"section\" id=\"parameter-visibility\">\n<h2>Parameter: Visibility</h2>\n<p>If set to false no visibility check is made when searching elements.</p>\n<div class=\"section\" id=\"examples-17\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">Visibility</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns visible and invisible elements\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">Visibility</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#returns only visible elements(default).\n# One time use:\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">visibility=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"inviewport\" />\n<div class=\"section\" id=\"parameter-inviewport\">\n<h2>Parameter: InViewport</h2>\n<p>If InViewport is set to true every element outside of current viewport is considered\ninvisible. This helps to narrow searching area when there is lots of similar texts/elements\nin dom content. This can be also used to prevent searching functions to match any element\nthat is hidden outside of viewport - even if css visibility settings of given element\nsays that it's visible.</p>\n<div class=\"section\" id=\"examples-18\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">InViewport</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">  </span><span class=\"c\">#returns all matching elements(default)\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">InViewport</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">   </span><span class=\"c\">#element has to be inside of current viewport\nClickItem</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">        </span><span class=\"c\">viewport=False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"searchmode\" />\n<div class=\"section\" id=\"parameter-searchmode\">\n<h2>Parameter: SearchMode</h2>\n<p>When SearchMode is used, any found web element is highlighted with blue borders\nbefore the actual execution. This setting is useful especially in debug mode when\nwe want to search right kw:s and locators to actual testscript.</p>\n<div class=\"section\" id=\"examples-19\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">debug</span><span class=\"p\">  </span><span class=\"c\">#Highlights element, but won't put action on it\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">draw</span><span class=\"p\">   </span><span class=\"c\">#Highlights element and then executes kw (default)\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">SearchMode</span><span class=\"p\">      </span><span class=\"c\">None</span><span class=\"p\">   </span><span class=\"c\">#Turns off highlighting element</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"windowfind\" />\n<div class=\"section\" id=\"parameter-windowfind\">\n<h2>Parameter: WindowFind</h2>\n<p>When WindowFind is used VerifyText is not looking texts for dom, but simulates\nctrl+f like search to find if text exists.</p>\n<div class=\"section\" id=\"examples-20\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowFind</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\">#Searching text from current viewport\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">WindowFind</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\">#Searching text from dom(default)</span>\n</pre>\n</div>\n</div>\n<span id=\"ismodalxpath\"></span><span id=\"allinputelements\"></span><span id=\"activeareaxpath\"></span><hr class=\"docutils\" id=\"matchinginputelement\" />\n<div class=\"section\" id=\"parameter-searchstrategy-values\">\n<h2>Parameter: SearchStrategy Values</h2>\n<p>Set search strategy for element search.</p>\n<p>Strategy type is either &quot;all input elements&quot;, or &quot;matching input element&quot;.</p>\n<p>&quot;all input elements&quot; is a plain xpath that is used to find all elements\nconsidered as input elements.</p>\n<p>&quot;matching input element&quot; is an xpath with mandatory placeholder &quot;{}&quot; for\nsearch string. Xpath expression is completed by xpath.format(locator)\ninternally and therefore must include placeholder &quot;{}&quot;. Used to find elements\nmatching with a custom search string. Placeholder can be positional, such as {0}\nand repeated in that case.</p>\n<p>If <strong>IsModalXPath</strong> is set to something else than //body, then text based element\nsearch only considers elements which have the given xpath as ancestor, if\nIsModalXpath exists / is open. This is meant for applications that have modal\ndialogs but do not set elements below the dialog hidden in other means.</p>\n<p>Returns previously used search strategy.</p>\n<div class=\"section\" id=\"examples-21\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ActiveAreaXpath</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MatchingInputElement</span><span class=\"p\">    </span><span class=\"c\">//*[&#64;placeholder=&quot;{}&quot;]</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MatchingInputElement</span><span class=\"p\">    </span><span class=\"c\">containing input element</span><span class=\"p\">\n</span><span class=\"c\">${previous}= SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">//input</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">AllInputElements</span><span class=\"p\">    </span><span class=\"c\">${previous}</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">IsModalXPath</span><span class=\"p\">       </span><span class=\"c\">//div[contains(&#64;class, 'modal-container')]</span>\n</pre>\n<p>note: in the above case &quot;containing input element&quot; will use an xpath expression\nsuch that input elements that contain partial matches are used.</p>\n</div>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h2>Parameters</h2>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>xpath expression with or without &quot;xpath = &quot;</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h2>Raises</h2>\n<p>ValueError: Unknown search strategy</p>\n</div>\n<hr class=\"docutils\" id=\"multipleanchors\" />\n<div class=\"section\" id=\"parameter-multipleanchors\">\n<h2>Parameter: MultipleAnchors</h2>\n<p>Normally QWeb requires anchor to be an unique text. If MultipleAnchors is set to True,\nQWeb accepts multiple anchors and selects the first one.</p>\n<div class=\"section\" id=\"examples-22\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">MultipleAnchors</span><span class=\"p\">      </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># Accept multiple anchors\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">MultipleAnchors</span><span class=\"p\">      </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Raise error if anchor is not unique</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"clicktofocus\" />\n<div class=\"section\" id=\"parameter-clicktofocus\">\n<h2>Parameter: ClickToFocus</h2>\n<p>Clicks Input element before typing. This is sometimes needed to activate\ntarget element.</p>\n<div class=\"section\" id=\"examples-23\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">ClickToFocus</span><span class=\"p\">         </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># Clicks element before TypeText\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">ClickToFocus</span><span class=\"p\">         </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Handle TypeText without clicks(default)</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"doubleclick\" />\n<div class=\"section\" id=\"parameter-doubleclick\">\n<h2>Parameter: DoubleClick</h2>\n<p>Sets double-click the default action for all Click* keywords.</p>\n<div class=\"section\" id=\"examples-24\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">DoubleClick</span><span class=\"p\">          </span><span class=\"c\">True</span><span class=\"p\">    </span><span class=\"c\"># All Click keywords perform double-click action\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">DoubleClick</span><span class=\"p\">          </span><span class=\"c\">False</span><span class=\"p\">   </span><span class=\"c\"># Single-click action(default)</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"handlealerts\" />\n<div class=\"section\" id=\"parameter-handlealerts\">\n<h2>Parameter: HandleAlerts</h2>\n<p>Option for handling alerts boxes, on by default.</p>\n<div class=\"section\" id=\"examples-25\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">HandleAlerts</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"blindreturn\" />\n<div class=\"section\" id=\"parameter-blindreturn\">\n<h2>Parameter: BlindReturn</h2>\n<p>Return any value (even empty) from input element without waiting.\nDefault = false (Raises QWebValueError if field is empty after timeout).</p>\n<div class=\"section\" id=\"examples-26\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">BlindReturn</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">\n</span><span class=\"c\">#Some value must exists inside of given timeout(default):\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">BlindReturn</span><span class=\"p\">       </span><span class=\"c\">False</span><span class=\"p\">\n</span><span class=\"c\">${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\n${VALUE}</span><span class=\"p\">     </span><span class=\"c\">GetInputValue</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">     </span><span class=\"c\">blind=True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"delay\" />\n<div class=\"section\" id=\"parameter-delay\">\n<h2>Parameter: Delay</h2>\n<p>Set delay for Paceword.\nThis is meant to be used in demo purposes only\nand is not recommended way to control execution flow.\nDefault = 0s (No delays before execution).</p>\n<div class=\"section\" id=\"examples-27\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Wait 0.5 seconds before any Paceword is executed:\nSetConfig</span><span class=\"p\">    </span><span class=\"c\">Delay</span><span class=\"p\">             </span><span class=\"c\">0.5s</span><span class=\"p\">\n</span><span class=\"c\"># One time use - Wait 1s before given Paceword is executed:\nTypeText</span><span class=\"p\">     </span><span class=\"c\">username</span><span class=\"p\">          </span><span class=\"c\">QRobot</span><span class=\"p\">   </span><span class=\"c\">delay=1s</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"retryinterval\" />\n<div class=\"section\" id=\"parameter-retryinterval\">\n<h2>Parameter: RetryInterval</h2>\n<p>Set default interval for QWeb retry keywords.</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples-28\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">   </span><span class=\"c\">RetryInterval</span><span class=\"p\">    </span><span class=\"c\">1s</span><span class=\"p\">\n</span><span class=\"c\"># One time use:\nClickUntil</span><span class=\"p\">      </span><span class=\"c\">Foo</span><span class=\"p\">         </span><span class=\"c\">button</span><span class=\"p\">       </span><span class=\"c\">interval=3</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"runbefore\" />\n<div class=\"section\" id=\"parameter-runbefore\">\n<h2>Parameter: RunBefore</h2>\n<p>Set a verificaton keyword to be run before any interaction\nkeywords (click*, get_text, dropdown).</p>\n<p>Most common use for this configuration is in applications, that have a custom\n&quot;spinner&quot;/ loading indicator which needs to be waited even if\npage itself is already in ReadyState.</p>\n<p>Any custom robot fw keywords which start with word &quot;Verify&quot; can be used as RunBefore keyword.\nA resource file defining this keyword must be imported prior to usage.</p>\n<p>Supports giving keyword to run and parameters either in python or in robot framework syntax.\nRobot fw syntax needs to be given in a variable due to handling of arguments.</p>\n<div class=\"section\" id=\"examples-29\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Python syntax\nSetConfig</span><span class=\"p\">  </span><span class=\"c\">RunBefore</span><span class=\"p\">   </span><span class=\"c\">element.verify_no_element('//html[contains(&#64;class, &quot;custom-busy&quot;)]')</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">  </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\"># Waits that custom spinner disappears before running other keywords\n</span><span class=\"p\">\n</span><span class=\"c\"># Robot Framework syntax, needs to be in variable\n${run_bf}=</span><span class=\"p\">   </span><span class=\"c\">SetVariable</span><span class=\"p\">    </span><span class=\"c\">VerifyNoText</span><span class=\"p\">    </span><span class=\"c\">Loading....</span><span class=\"p\">     </span><span class=\"c\">timeout=5</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">RunBefore</span><span class=\"p\">      </span><span class=\"c\">${run_bf}</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">    </span><span class=\"c\">Foo</span><span class=\"p\">\n</span><span class=\"c\"># Waits that text &quot;Loading...&quot; disappears before running other keywords</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"retinadisplay\" />\n<div class=\"section\" id=\"parameter-retinadisplay\">\n<h2>Parameter: RetinaDisplay</h2>\n<p>Is current monitor Retina display (True) or not (False). Will be automatically\nset based on used monitor, but can be changed for testing purposes if needed.</p>\n<div class=\"section\" id=\"examples-30\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">RetinaDisplay</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"logmatchedicons\" />\n<div class=\"section\" id=\"parameter-logmatchedicons\">\n<h2>Parameter: LogMatchedIcons</h2>\n<p>When True, highlights where icon was found on the screen and adds a sceenshot\nto logs. Default = False (Screenshots are not added to the logs).</p>\n<div class=\"section\" id=\"examples-31\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">LogMatchedIcons</span><span class=\"p\">       </span><span class=\"c\">True</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"highlightcolor\" />\n<div class=\"section\" id=\"parameter-highlightcolor\">\n<h2>Parameter: HighlightColor</h2>\n<p>Sets the highlight color to use when element is highlighted.</p>\n<p>Accepted colors are:</p>\n<ul class=\"simple\">\n<li>aqua</li>\n<li>black</li>\n<li>blue</li>\n<li>fuchsia</li>\n<li>green</li>\n<li>lime</li>\n<li>navy</li>\n<li>olive</li>\n<li>orange</li>\n<li>purple</li>\n<li>red</li>\n<li>teal</li>\n<li>yellow</li>\n</ul>\n<p>Default = &quot;blue&quot;.</p>\n<div class=\"section\" id=\"examples-32\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">    </span><span class=\"c\">HighlightColor</span><span class=\"p\">       </span><span class=\"c\">olive</span>\n</pre>\n</div>\n</div>\n<hr class=\"docutils\" id=\"shadowdom\" />\n<div class=\"section\" id=\"parameter-shadowdom\">\n<h2>Parameter: ShadowDOM</h2>\n<p>Extends element search to open shadow roots / shadow DOM.\nElments under shadow dom are not reachable by normal means, so setting\nthis configuration to True also changes how elements are searched.\nThis basically means that some attributes given to keywords can be ignored\nand other search strategies are overridden.</p>\n<p>It's best to use this setting only in specific situations where shadow dom\nelements need to be verified or interacted with.</p>\n<p>Default = False (Elements are only searched from the light / normal dom).</p>\n<div class=\"section\" id=\"examples-33\">\n<h3>Examples</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\"># Do things related to shadow dom elements\nVerifyText</span><span class=\"p\">      </span><span class=\"c\">This is under shadow root</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">       </span><span class=\"c\">As is this</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">       </span><span class=\"c\">ShadowDOM</span><span class=\"p\">       </span><span class=\"c\">False</span>\n</pre>\n<p>---</p>\n</div>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h2>Related keywords</h2>\n<p><a href=\"#Get%20Config\" class=\"name\">GetConfig</a>, <a href=\"#Reset%20Config\" class=\"name\">ResetConfig</a></p>\n</div>\n</div>\n</div>\n", "shortdoc": "Set configuration parameter to given value. Return previous value.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\config.py", "lineno": 27}, {"name": "Set Input Handler", "args": [{"name": "input_method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_method: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set input handler.</p>\n<p>Default handler is &quot;selenium&quot; which uses Selenium librarys\nmethods clear() and send_keys(). These methods assume that\nthe web element is writable (enabled). Inserts tab character\nat the end of text.</p>\n<p>Alternative writer &quot;raw&quot; uses pyautogui to input text directly\nwithout checking the web element state. This version is intended\nto be used when the web page doesn't update input element status\nSelenium compliant way.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set input handler</span><span class=\"p\">    </span><span class=\"c\">raw</span><span class=\"p\">\n</span><span class=\"c\">Set input handler</span><span class=\"p\">    </span><span class=\"c\">selenium</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>input_method <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Input method used by input handler, &quot;selenium&quot; or &quot;raw&quot;.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": ["Config", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 37, "deprecated": true}, {"name": "Set Line Break", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": ["Config", "Input"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 69, "deprecated": true}, {"name": "Set Search Strategy", "args": [{"name": "strategy_type", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_type: str"}, {"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set search strategy for element search.</p>\n<p>Strategy type is either &quot;all input elements&quot;, or &quot;matching input element&quot;.</p>\n<p>&quot;all input elements&quot; is a plain xpath that is used to find all elements\nconsidered as input elements.</p>\n<p>&quot;matching input element&quot; is an xpath with mandatory placeholder &quot;{}&quot; for\nsearch string. Xpath expression is completed by xpath.format(locator)\ninternally and therefore must include placeholder &quot;{}&quot;. Used to find elements\nmatching with a custom search string. Placeholder can be positional, such as {0}\nand repeated in that case.</p>\n<p>Returns previously used search strategy.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">active area xpath</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">//input//textarea</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">matching input element</span><span class=\"p\">    </span><span class=\"c\">//*[&#64;placeholder=&quot;{}&quot;]</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">matching input element</span><span class=\"p\">    </span><span class=\"c\">containing input element</span><span class=\"p\">\n</span><span class=\"c\">${previous}= Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">//input</span><span class=\"p\">\n</span><span class=\"c\">Set search strategy</span><span class=\"p\">    </span><span class=\"c\">all input elements</span><span class=\"p\">    </span><span class=\"c\">${previous}</span>\n</pre>\n<p>note: in the above case &quot;containing input element&quot; will use an xpath expression\nsuch that input elements that contain partial matches are used.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>xpath expression with or without &quot;xpath = &quot;</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Wrong strategy type</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 45, "deprecated": true}, {"name": "Set Wait Function", "args": [{"name": "function", "type": {"name": "Callable", "typedoc": null, "nested": [{"name": "...", "typedoc": null, "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Callable[..., Any]"], "typedocs": {"Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: Callable[..., Any]"}], "doc": "<div class=\"document\">\n<p>Set custom wait function that is run at the beginning of keywords.</p>\n<p><strong>Note</strong>: Not meant to be used as robot framework keyword but as a helper\nfunction to extend / customize QWeb via Python.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code python literal-block\">\n<span class=\"kn\">from</span> <span class=\"nn\">QWeb.custom_config</span> <span class=\"kn\">import</span> <span class=\"n\">set_wait_function</span><span class=\"w\">\n\n</span><span class=\"k\">def</span> <span class=\"nf\">my_wait_function</span><span class=\"p\">():</span><span class=\"w\">\n</span>    <span class=\"c1\"># your own wait logic here</span><span class=\"w\">\n</span>    <span class=\"o\">...</span><span class=\"w\">\n\n</span><span class=\"c1\"># This will make QWeb use &quot;my_wait_function&quot; as wait function</span><span class=\"w\">\n</span><span class=\"c1\"># instead of the default one</span><span class=\"w\">\n</span><span class=\"n\">set_wait_function</span><span class=\"p\">(</span><span class=\"n\">my_wait_function</span><span class=\"p\">)</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>function <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">function</span></dt>\n<dd>Function that does not need to return anything.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Set custom wait function that is run at the beginning of keywords.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\custom_config.py", "lineno": 5}, {"name": "Set Window Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig</cite> instead.</p>\n<p>Set current window size.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetWindowSize</span><span class=\"p\">     </span><span class=\"c\">1920</span><span class=\"p\">    </span><span class=\"c\">1080</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>width <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>The width value of the window</dd>\n<dt>height: int</dt>\n<dd>The height value of the window</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 249, "deprecated": true}, {"name": "Skim Click", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "text_to_disappear", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text_to_disappear: str = "}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "interval", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval: str | None = None"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "js", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "js: bool = False"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>ClickWhile</cite> instead.</p>\n<p>Click text until a text disappears.</p>\n<p>This keyword is required on slow pages where it takes time for a button\nlistener to start. This clicks button and waits until text disappears.</p>\n<p>If text_to_disappear is not entered, it keyword will wait until text\nclicked disappears.</p>\n<p>For example</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">            </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart contents</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Go to cart</span><span class=\"p\">      </span><span class=\"c\">5s</span><span class=\"p\">\n</span><span class=\"c\">SkimClick</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">    </span><span class=\"c\">Cart</span><span class=\"p\">            </span><span class=\"c\">1</span><span class=\"p\">    </span><span class=\"c\">20s</span><span class=\"p\">    </span><span class=\"c\">5s</span>\n</pre>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>text_to_disappear <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that appears after click</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long to button is clicked if text has not disappeared</dd>\n<dt>interval <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long to wait until text disappears</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable parent.</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>tag name for clickable child.</dd>\n<dt>js <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">boolean</span></dt>\n<dd>If set to true, uses javascript instead of selenium to click element.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text\nel_type = 'item':\ntext(default) = find element by visible text | item = find item type element</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `ClickWhile` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 536, "deprecated": true}, {"name": "Swipe Down", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes down on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeDown</span><span class=\"p\">   </span><span class=\"c\"># Swipes down once\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes down five times\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">  </span><span class=\"c\"># Swipes down once, starting from the text &quot;Qentinel Touch&quot;\nSwipeDown</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">  </span><span class=\"c\"># Swipes down five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times we swipe / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes down on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 442}, {"name": "Swipe Left", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes left on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeLeft</span><span class=\"p\">   </span><span class=\"c\"># Swipes left once\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes left five times\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes left once, from the text &quot;Qentinel Touch&quot;\nSwipeLeft</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes left five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes left on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 506}, {"name": "Swipe Right", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes right on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeRight</span><span class=\"p\">   </span><span class=\"c\"># Swipes right once\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes right five times\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes right once, from the text &quot;Qentinel Touch&quot;\nSwipeRight</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes right five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Up\" class=\"name\">SwipeUp</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes right on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 538}, {"name": "Swipe Up", "args": [{"name": "times", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "times: str = 1"}, {"name": "start", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "start: str | None = None"}], "doc": "<div class=\"document\">\n<p>Swipes up on the screen.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwipeUp</span><span class=\"p\">   </span><span class=\"c\"># Swipes up once\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\"># Swipes up five times\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">   </span><span class=\"c\"># Swipes up once, from the text &quot;Qentinel Touch&quot;\nSwipeUp</span><span class=\"p\">   </span><span class=\"c\">5</span><span class=\"p\">   </span><span class=\"c\">Qentinel Touch</span><span class=\"p\">    </span><span class=\"c\"># Swipes up five times, from the text &quot;Qentinel Touch&quot;</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>times <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The amount of times swiped / length of the swipe</dd>\n<dt>start <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional starting point for the swipe</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the swipe amount is not an integer.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Swipe%20Down\" class=\"name\">SwipeDown</a>, <a href=\"#Swipe%20Left\" class=\"name\">SwipeLeft</a>, <a href=\"#Swipe%20Right\" class=\"name\">SwipeRight</a></p>\n</div>\n</div>\n", "shortdoc": "Swipes up on the screen.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 474}, {"name": "Switch Browser", "args": [{"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: int | str"}], "doc": "<div class=\"document\">\n<p>Switches to another browser instance in browser cache.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">about:chrome</span><span class=\"p\">                </span><span class=\"c\">chrome</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.github.com</span><span class=\"p\">      </span><span class=\"c\">firefox</span><span class=\"p\">\n</span><span class=\"c\">OpenBrowser</span><span class=\"p\">     </span><span class=\"c\">https://www.google.com</span><span class=\"p\">      </span><span class=\"c\">edge</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">       </span><span class=\"c\"># following keywords will interact with chrome instance\n...</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">NEW</span><span class=\"p\">     </span><span class=\"c\"># following keywords will interact with latest opened browser (edge)\n...</span><span class=\"p\">\n</span><span class=\"c\">SwitchBrowser</span><span class=\"p\">   </span><span class=\"c\">2</span><span class=\"p\">       </span><span class=\"c\"># following keywords will interact with firefox instance</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<blockquote>\n<span class=\"name\">OpenBrowser,  </span>CloseBrowser,  <span class=\"name\">SwitchWindow, </span>GetWebElement`</blockquote>\n</div>\n</div>\n", "shortdoc": "Switches to another browser instance in browser cache.", "tags": ["Browser", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 349}, {"name": "Switch Window", "args": [{"name": "index", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Switch to another tab.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SwitchWindow</span><span class=\"p\">     </span><span class=\"c\">1</span><span class=\"p\">\n</span><span class=\"c\">SwitchWindow</span><span class=\"p\">     </span><span class=\"c\">NEW</span><span class=\"p\">    </span><span class=\"c\"># Switches to latest opened tab</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index of the tab starting from one and counting from left to right.\nOR\nSpecial keyword &quot;NEW&quot; which can be used to move to the latest opened tab.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the window index is out of reach</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Browser\" class=\"name\">CloseBrowser</a>, <a href=\"#Close%20Window\" class=\"name\">CloseWindow</a>, <a href=\"#Close%20Others\" class=\"name\">CloseOthers</a>, <a href=\"#Go%20To\" class=\"name\">GoTo</a>, <a href=\"#Open%20Window\" class=\"name\">OpenWindow</a></p>\n</div>\n</div>\n", "shortdoc": "Switch to another tab.", "tags": ["Browser", "Interaction", "Window"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 191}, {"name": "Type Alert", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Accept", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = Accept"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Type and close popup alert.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeAlert</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeAlert</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">     </span><span class=\"c\">Nothing</span><span class=\"p\">   </span><span class=\"c\">10s</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to type</dd>\n<dt>action <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default = Accept)</span></dt>\n<dd>What is done for popup. Options are:\nACCEPT: accept alert\nDISMISS: dismiss alert\nNOTHING: don't close alert</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a></p>\n</div>\n</div>\n", "shortdoc": "Type and close popup alert.", "tags": ["Alert", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 88}, {"name": "Type Secret", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type secret information such as password.</p>\n<p>Logging in start_keyword and end_keyword is filtered,\notherwise functionality is the same as TypeText.</p>\n<p>Generally all secret credentials in Robot FW scripts should\nbe provided as external variables. Secrets must not be\nstored directly to test script and not even to version control\nsystem.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># PASSWD is set outside the script\n# Provide this to Robot FW as follows:\n# robot --variable PASSWD:mypass123 test.robot\nTypeSecret</span><span class=\"p\">            </span><span class=\"c\">password</span><span class=\"p\">    </span><span class=\"c\">${PASSWD}</span><span class=\"p\">\n</span><span class=\"c\">TypeSecret</span><span class=\"p\">            </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">${PASSWD}</span><span class=\"p\">  </span><span class=\"c\">#table</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Type secret information such as password.", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 120}, {"name": "Type Secret3", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type sensitive information such as personal data.</p>\n<p>the first 1 or 3 digits of the secret value are displayed\nin the logfile, otherwise functionality is the same as Type Secret.</p>\n<p>Generally all secret credentials in Robot FW scripts should\nbe provided as external variables. Secrets must not be\nstored directly to test script and not even to version control\nsystem.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># NAME is set outside the script\n# Provide this to Robot FW as follows:\n# robot --variable NAME:janedoe test.robot\nTypeSecret3</span><span class=\"p\">      </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">${NAME}</span><span class=\"p\">\n</span><span class=\"c\">TypeSecret3</span><span class=\"p\">      </span><span class=\"c\">r1c1</span><span class=\"p\">    </span><span class=\"c\">${NAME} #table</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Type sensitive information such as personal data.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 79}, {"name": "Type Text", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "input_text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type given text to a text field.</p>\n<p>First look through if there are any input fields that have the\nlocator as a placeholder. If not then locates the input field by\nwhich is closest to the locator text.</p>\n<p>When input field is found, it is first cleared of all text and after\nthat the text is input.</p>\n<div class=\"section\" id=\"simple-example\">\n<h1>Simple Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | selenium.webdriver.remote.webelement.WebElement</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.\nCan also be a WebElement instance returned by GetWebElement keyword or javascript.</dd>\n<dt>input_text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that will be written in the input field</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">check : bool(True/False)</div>\n<div class=\"line\">- Shortcut to switch CheckInputValue on or off for one time use.</div>\n<div class=\"line\">- If CheckInputValue is used, use expected parameter when expected value</div>\n<div class=\"line\">is different than written value. Expected: str | int</div>\n<div class=\"line\">click : bool(True/False)</div>\n<div class=\"line\">- Shortcut to switch ClickToFocus on or off for one time use.</div>\n<div class=\"line\">- If click is set to True, input field is focused by clicking it before typing.</div>\n<div class=\"line\">- CheckInputValue defines if TypeText verifies input field value after it is typed.</div>\n<div class=\"line\">- Default is Off. Valid parameters are On, True, Off and False.</div>\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n<div class=\"line\">clear_key: key or character</div>\n<div class=\"line\">- used generally if there's problems clearing input field with default methods</div>\n<div class=\"line\">- sets what key or key combination is is used to clear the input field</div>\n<div class=\"line\">- using clear_key will set clear key</div>\n<div class=\"line\">- enclose special keys in curly brackets, for example {CONTROL + a} or {BACKSPACE}</div>\n<div class=\"line\">- corresponding configuration parameter is ClearKey</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples-with-settings\">\n<h1>Examples with settings</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">          </span><span class=\"c\">CheckInputValue</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">          </span><span class=\"c\">CheckInputValue</span><span class=\"p\">     </span><span class=\"c\">On</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">           </span><span class=\"c\">Qentinel</span>\n</pre>\n<p>SetConfig LineBreak defines what kind of line break is typed after input text. Default is\ntab key.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">           </span><span class=\"c\">LineBreak</span><span class=\"p\">   </span><span class=\"c\">None</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">someattr</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"examples-with-table\">\n<h1>Examples with table</h1>\n<p>(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nTypeText</span><span class=\"p\">            </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"more-examples\">\n<h1>More Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">clear_key={BACKSPACE}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">clear_key={CONTROL + a}</span><span class=\"p\">\n</span><span class=\"c\"># same thing with using SetConfig\nSetConfig</span><span class=\"p\">           </span><span class=\"c\">ClearKey</span><span class=\"p\">    </span><span class=\"c\">{BACKSPACE}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">SetConfig</span><span class=\"p\">           </span><span class=\"c\">ClearKey</span><span class=\"p\">    </span><span class=\"c\">{CONTROL + a}</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">company</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\"># using WebElement instance\n${elem}=</span><span class=\"p\">            </span><span class=\"c\">GetWebElement</span><span class=\"p\">  </span><span class=\"c\">//input[&#64;title\\=&quot;Search&quot;]</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">${elem}</span><span class=\"p\">     </span><span class=\"c\">Text to search for</span><span class=\"p\">\n</span><span class=\"c\"># Type to input in shadow DOM input\nSetConfig</span><span class=\"p\">           </span><span class=\"c\">ShadowDOM</span><span class=\"p\">   </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">TypeText</span><span class=\"p\">            </span><span class=\"c\">Search</span><span class=\"p\">      </span><span class=\"c\">Test</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Texts\" class=\"name\">TypeTexts</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Type given text to a text field.", "tags": ["Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 157}, {"name": "Type Texts", "args": [{"name": "input_texts", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["dict[str, str]", "str"], "typedocs": {"dict": "dictionary", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_texts: dict[str, str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Type text to multiple fields.</p>\n<p>Accepts a .txt file or Robot FW dictionary as a parameter. If using a text file, the locator\nand the text should be separated with a comma on each row.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">list_of_locators_and_texts.txt</span><span class=\"p\">\n</span><span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_dict}=</span><span class=\"p\">           </span><span class=\"c\">Create Dictionary</span><span class=\"p\">    </span><span class=\"c\">Name=Jane</span><span class=\"p\">    </span><span class=\"c\">Email=janedoe&#64;iddqd.com</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">                     </span><span class=\"c\">Phone=04049292243923</span><span class=\"p\">     </span><span class=\"c\">Address=Yellow street 33 C 44</span><span class=\"p\">\n</span><span class=\"c\">TypeTexts</span><span class=\"p\">               </span><span class=\"c\">${cool_dict}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Secret\" class=\"name\">TypeSecret</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a>, <a href=\"#Write%20Text\" class=\"name\">WriteText</a></p>\n</div>\n</div>\n", "shortdoc": "Type text to multiple fields.", "tags": ["File", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 287}, {"name": "Upload File", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Upload file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">Upload</span><span class=\"p\">      </span><span class=\"c\">text.txt</span><span class=\"p\">\n</span><span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">Foo</span><span class=\"p\">         </span><span class=\"c\">C:/path/to/file/test.pdf</span><span class=\"p\">\n</span><span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">1</span><span class=\"p\">           </span><span class=\"c\">text.txt #Using index as locator</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UploadFile</span><span class=\"p\">   </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">text.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or index that locates the upload element.</dd>\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">file to upload</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted element. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>ValueError: File not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Save%20File\" class=\"name\">SaveFile</a></p>\n</div>\n</div>\n", "shortdoc": "Upload file.", "tags": ["File", "Input", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 667}, {"name": "Use File", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Define text file for all other file keywords.</p>\n<p>Sets active file for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFile</span><span class=\"p\">            </span><span class=\"c\">foobar..txt</span><span class=\"p\">\n</span><span class=\"c\">UseFile</span><span class=\"p\">            </span><span class=\"c\">some/existing/path/file.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files.\nPath is not needed if file is in default folder.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20File%20Text\" class=\"name\">GetFileText</a>, <a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a>,\n<a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20File%20Download\" class=\"name\">VerifyFileDownload</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Define text file for all other file keywords.", "tags": ["File"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 67}, {"name": "Use Frame", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}], "doc": "<div class=\"document\">\n<p>Make following keywords to use frame on a page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseFrame</span><span class=\"p\">    </span><span class=\"c\">//iframe</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix or index (first = 1 etc.)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchFrameException</dt>\n<dd>If the frame is not found</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Make following keywords to use frame on a page.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 33}, {"name": "Use List", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: str | None = None"}, {"name": "child", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: str | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Define list for all other list keywords.</p>\n<p>Sets active table for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">//*[&#64;class\\=&quot;list&quot;]</span><span class=\"p\">\n</span><span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">list</span><span class=\"p\">                </span><span class=\"c\">selector=class</span><span class=\"p\">\n</span><span class=\"c\">UseList</span><span class=\"p\">            </span><span class=\"c\">Calendar</span><span class=\"p\">            </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">#Calendar is inside of ordered list instead of ul (ul=default):\nUseList</span><span class=\"p\">            </span><span class=\"c\">Calendar</span><span class=\"p\">            </span><span class=\"c\">Qentinel</span><span class=\"p\">    </span><span class=\"c\">tag=ol</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the list. If text is inside of unordered list\nthen list is selected. If there is no known texts in list\nxpath can be used to locate correct list. If wanted list is multiple amount\nof whatever web elements with some common attribute, xpath can be used\nto select those elements. When using XPaths, the equal sign &quot;=&quot; must be\nescaped with a &quot;&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd>Accepted kwargs: tag = html_tag to identify if list is ordered or unordered one.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Define list for all other list keywords.", "tags": ["Config", "Lists"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 44}, {"name": "Use Page", "args": [], "doc": "<div class=\"document\">\n<p>Make following keywords to use the page and not a frame on a page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePage</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "Make following keywords to use the page and not a frame on a page.", "tags": ["Config"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\frame.py", "lineno": 68}, {"name": "Use Pdf", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Define pdf file for all other pdf keywords.</p>\n<p>Sets active file for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UsePdf</span><span class=\"p\">            </span><span class=\"c\">foobar.pdf</span><span class=\"p\">\n</span><span class=\"c\">UsePdf</span><span class=\"p\">            </span><span class=\"c\">some/existing/path/file.pdf</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Default folders = users/downloads, project_dir/files or ${EXECDIR}/**/files.\nPath is not needed if file is in default folder.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Pdf%20Text\" class=\"name\">GetPdfText</a>, <a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Define pdf file for all other pdf keywords.", "tags": ["File", "PDF"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 40}, {"name": "Use Table", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "parent", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent: bool = False"}, {"name": "child", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "child: bool = False"}, {"name": "level", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "level: int = 1"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}], "doc": "<div class=\"document\">\n<p>Define table for all other table keywords.</p>\n<p>Sets active table for other keywords.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">parent=True # Use parent table of Calendar</span><span class=\"p\">\n</span><span class=\"c\">UseTable</span><span class=\"p\">       </span><span class=\"c\">Calendar</span><span class=\"p\">    </span><span class=\"c\">child=True</span><span class=\"p\">  </span><span class=\"c\"># Use child table of Calendar</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the table. The table that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>parent <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Use when correct table is parent of located table</dd>\n<dt>child <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Use when correct table is child of located table</dd>\n<dt>level <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If wanted parent table is not the first one use level to pick correct one.\nFor example level=2 means parent table of parent table etc.</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If multiple childtables exists. Use index to pick correct one.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Define table for all other table keywords.", "tags": ["Tables"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 43}, {"name": "Verify Alert Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify alert text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAlertText</span><span class=\"p\">     </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Text to Verify</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing. Default 10 (seconds)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Close%20Alert\" class=\"name\">CloseAlert</a>, <a href=\"#Get%20Alert%20Text\" class=\"name\">GetAlertText</a>, <a href=\"#Is%20Alert\" class=\"name\">IsAlert</a>, <a href=\"#Type%20Alert\" class=\"name\">TypeAlert</a></p>\n</div>\n</div>\n", "shortdoc": "Verify alert text.", "tags": ["Alert", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\alert.py", "lineno": 143}, {"name": "Verify All", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify page contains given texts.</p>\n<p>The texts should be separated with a comma.</p>\n<p>Also accepts a .txt file or Robot FW list as a parameter. Each row in the text file will be\nverified, or each item in the Robot FW list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">Cat, Mouse, Dog, Lion, iddqd66402</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">list_of_cats.txt</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_list}=</span><span class=\"p\">    </span><span class=\"c\">Create List</span><span class=\"p\">    </span><span class=\"c\">Cat</span><span class=\"p\">    </span><span class=\"c\">Mouse</span><span class=\"p\">    </span><span class=\"c\">Dog</span><span class=\"p\">    </span><span class=\"c\">Lion</span><span class=\"p\">    </span><span class=\"c\">iddqd66402</span><span class=\"p\">\n</span><span class=\"c\">VerifyAll</span><span class=\"p\">      </span><span class=\"c\">${cool_list}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Any\" class=\"name\">VerifyAny</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>,\n<a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given texts.", "tags": ["File", "Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1381}, {"name": "Verify Any", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify any of the given texts.</p>\n<p>Verify that at least one of the texts is found. Useful for handling\nsession dependent states, such as logins or popups.</p>\n<p>Note: multiple texts need to be given as one list or as strings separated by &quot;,&quot;.</p>\n<div class=\"section\" id=\"other-parameters\">\n<h1>Other Parameters</h1>\n<p>&lt;other_parameters&gt;</p>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># as strings separated with &quot;,&quot;\nVerifyAny</span><span class=\"p\">    </span><span class=\"c\">Login,Front Page</span><span class=\"p\">\n\n</span><span class=\"c\"># as list\n${texts}=</span><span class=\"p\">    </span><span class=\"c\">Create List</span><span class=\"p\">     </span><span class=\"c\">abc</span><span class=\"p\">    </span><span class=\"c\">def</span><span class=\"p\">\n</span><span class=\"c\">VerifyAny</span><span class=\"p\">    </span><span class=\"c\">${texts}</span><span class=\"p\">\n\n</span><span class=\"c\"># Follow up to check which state\n${login}=</span><span class=\"p\">    </span><span class=\"c\">IsText</span><span class=\"p\">       </span><span class=\"c\">Login</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20File\" class=\"name\">VerifyFile</a>, <a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>,\n<a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify any of the given texts.", "tags": ["File", "Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1318}, {"name": "Verify App", "args": [{"name": "imagename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "imagename: str"}], "doc": "<div class=\"document\">\n<p>Compare image to a known good one.</p>\n<table class=\"docutils field-list\" frame=\"void\" rules=\"none\">\n<col class=\"field-name\" />\n<col class=\"field-body\" />\n<tbody valign=\"top\">\n<tr class=\"field\"><th class=\"field-name\" colspan=\"2\">param imagename:</th></tr>\n<tr class=\"field\"><td>&nbsp;</td><td class=\"field-body\"></td>\n</tr>\n<tr class=\"field\"><th class=\"field-name\">return:</th><td class=\"field-body\"></td>\n</tr>\n</tbody>\n</table>\n</div>\n", "shortdoc": "Compare image to a known good one.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\screenshot.py", "lineno": 25}, {"name": "Verify Attribute", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "element_type", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "element_type: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify attribute value of an element.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<p>Using attributes or xpaths like with ClickElement etc. kw:s without specified\nelement_type. If element_type is not specified end result is a type of list:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">click_me</span><span class=\"p\">                        </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">my_button</span><span class=\"p\">   </span><span class=\"c\">tag=button</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">            </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">click_here</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">xpath\\=//*[&#64;id\\=&quot;click_me&quot;]</span><span class=\"p\">     </span><span class=\"c\">name</span><span class=\"p\">    </span><span class=\"c\">click_here</span>\n</pre>\n<p>GetAttribute using element_type attribute to locate element.\nText elements works as ClickText, VerifyText, GetText etc.:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">login</span><span class=\"p\">       </span><span class=\"c\">element_type=text</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">value abc</span><span class=\"p\">         </span><span class=\"c\">element_type=text</span><span class=\"p\">  </span><span class=\"c\">anchor=Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Contact</span><span class=\"p\">   </span><span class=\"c\">name</span><span class=\"p\">  </span><span class=\"c\">contact1</span><span class=\"p\">    </span><span class=\"c\">parent=div</span>\n</pre>\n<p>Item, Input, Dropdown, Checkbox elements:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Log In</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">login</span><span class=\"p\">   </span><span class=\"c\">element_type=item</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Username</span><span class=\"p\">  </span><span class=\"c\">placeholder</span><span class=\"p\">   </span><span class=\"c\">username</span><span class=\"p\">    </span><span class=\"c\">element_type=input</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Country</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">     </span><span class=\"c\">Finland</span><span class=\"p\">         </span><span class=\"c\">element_type=dropdown</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">Gender</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">   </span><span class=\"c\">checked</span><span class=\"p\">         </span><span class=\"c\">element_type=checkbox</span>\n</pre>\n<p>Any element using css selectors:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyAttribute</span><span class=\"p\">          </span><span class=\"c\">input[type=button]</span><span class=\"p\">   </span><span class=\"c\">value</span><span class=\"p\">    </span><span class=\"c\">Click Me</span><span class=\"p\">     </span><span class=\"c\">element_type=css</span>\n</pre>\n<p>All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).\nin same way as you are using those with Pacewords like ClickText/Item, TypeText, Dropdown etc.</p>\n<p>In addition, operator performing verification can be given as keyword argument.\nIf 'operator' argument is not given, 'equals' is expected. Examples:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Not equal\nVerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//img</span><span class=\"p\">    </span><span class=\"c\">data-icon</span><span class=\"p\">    </span><span class=\"c\">screen123</span><span class=\"p\">    </span><span class=\"c\">operator=not equal</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">     </span><span class=\"c\">//img</span><span class=\"p\">    </span><span class=\"c\">data-icon</span><span class=\"p\">    </span><span class=\"c\">screen123</span><span class=\"p\">    </span><span class=\"c\">operator=!=</span><span class=\"p\">\n\n</span><span class=\"c\"># Greater than\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">7</span><span class=\"p\">    </span><span class=\"c\">element_type=Text</span><span class=\"p\">    </span><span class=\"c\">operator=greater than</span><span class=\"p\">\n</span><span class=\"c\">VerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">5</span><span class=\"p\">    </span><span class=\"c\">element_type=Text</span><span class=\"p\">    </span><span class=\"c\">operator=&gt;</span><span class=\"p\">\n\n</span><span class=\"c\"># less than or equal\n# ('operator=less than or equal' also works)\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">Button3</span><span class=\"p\">    </span><span class=\"c\">data-id</span><span class=\"p\">    </span><span class=\"c\">10</span><span class=\"p\">   </span><span class=\"c\">element_type=Item</span><span class=\"p\">   </span><span class=\"c\">operator=&lt;=</span><span class=\"p\">\n\n</span><span class=\"c\"># contains\nVerifyAttribute</span><span class=\"p\">    </span><span class=\"c\">somebutton</span><span class=\"p\">    </span><span class=\"c\">id</span><span class=\"p\">    </span><span class=\"c\">skim</span><span class=\"p\">      </span><span class=\"c\">element_type=Text</span><span class=\"p\">   </span><span class=\"c\">operator=contains</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, attribute value or Xpath expression with or without xpath= prefix.\nThe equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>attribute: str</dt>\n<dd>Attribute which value we want to get.</dd>\n<dt>value: str</dt>\n<dd>Expected attribute value to verify against.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Used when element_type is defined. Default=1 (first match)</dd>\n<dt>element_type <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">string</span></dt>\n<dd>Define element type/preferred searching method\n(available types: text, input, checkbox, item, dropdown or css).</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait element to appear. Default=10 sec</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">Any available for picked searching method.</div>\n<div class=\"line\">See interacting with text, item, input etc. elements from</div>\n<div class=\"line\">documentation</div>\n<div class=\"line\"><br /></div>\n<div class=\"line\">In addition:</div>\n<div class=\"line\">operator : str</div>\n<div class=\"line-block\">\n<div class=\"line\">Which operator use for verification. Possible values:</div>\n<div class=\"line-block\">\n<div class=\"line\">* 'Equals' or '==' (Default)</div>\n<div class=\"line\">* 'Not Equal' or '!='</div>\n<div class=\"line\">* 'Less than' or '&lt;'</div>\n<div class=\"line\">* 'Greater than' or '&gt;'</div>\n<div class=\"line\">* 'Less than or equal' or  '&lt;='</div>\n<div class=\"line\">* 'Greater than or equal' or '&gt;='</div>\n<div class=\"line\">* 'Contains'</div>\n<div class=\"line\">* 'Not Contains'</div>\n</div>\n</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Verify attribute value of an element.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 627}, {"name": "Verify Checkbox", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that checkbox element exist.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">r1c1</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">      </span><span class=\"c\">Cars</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckbox</span><span class=\"p\">    </span><span class=\"c\">r?Foo/c2</span><span class=\"p\">      </span><span class=\"c\">Bar</span><span class=\"p\">  </span><span class=\"c\">#row contain texts Foo and Bar</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>NoSuchElementException: Checkbox element not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that checkbox element exist.", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 271}, {"name": "Verify Checkbox Status", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "status", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": null, "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index=1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify checkbox is enabled or disabled.</p>\n<p>In other words verify can user interact with a checkbox or not.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"p\">   </span><span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">checked</span><span class=\"p\">    </span><span class=\"c\">enabled</span><span class=\"p\">\n\n</span><span class=\"c\">With table(Pick table with use table keyword first):</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">disabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">enabled</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyCheckboxStatus</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">enabled</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxStatus</span><span class=\"p\">   </span><span class=\"c\">Checked</span><span class=\"p\">    </span><span class=\"c\">disabled</span><span class=\"p\">     </span><span class=\"c\">anchor text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>status <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Status for the checkbox. Either enabled or disabled.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Checkbox interaction with the checkbox was not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Value\" class=\"name\">VerifyCheckboxValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify checkbox is enabled or disabled.", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 111}, {"name": "Verify Checkbox Value", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify checkbox is on (checked) or off (unchecked).</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">           </span><span class=\"c\">on</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">on</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">on</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">Mercedes</span><span class=\"p\">          </span><span class=\"c\">off</span><span class=\"p\">     </span><span class=\"c\">Car</span><span class=\"p\">\n</span><span class=\"c\">VerifyCheckboxValue</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">   </span><span class=\"c\">on</span><span class=\"p\">   </span><span class=\"c\">2</span><span class=\"p\">  </span><span class=\"c\">#second row that contains text Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the checkbox. The checkbox that is closest to the\ntext is selected. Also one can use xpath by adding xpath= prefix and\nthen the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Value of the checkbox. On or off.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str (default None)</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one checkbox elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>ValueError : The checkbox value is not the same</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Checkbox\" class=\"name\">ClickCheckbox</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>, <a href=\"#Verify%20Checkbox%20Status\" class=\"name\">VerifyCheckboxStatus</a></p>\n</div>\n</div>\n", "shortdoc": "Verify checkbox is on (checked) or off (unchecked).", "tags": ["Checkbox", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\checkbox.py", "lineno": 192}, {"name": "Verify Col Header", "args": [{"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | None = None"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verifies that a column header with given index matches the expected text.</p>\n<p>Note: only visible columns may be counted in some dynamic tables.</p>\n<p>Note2: If column header has attribute 'aria-label', it's value is considered as expected value.\nIf not and 'title' attribute exists, then title is considered as expected value.\nIf neither aria-label or title exists, then column text is considered as expected value.\nThis is done due to fact that in many web applications header element text contains other texts\nthan what is visible to end users.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\"># Verifies that second column's text is Year\nUseTable</span><span class=\"p\">    </span><span class=\"c\">my_table</span><span class=\"p\">\n</span><span class=\"c\"># Verifies that table includes column &quot;Year&quot; at any position\nVerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">\n</span><span class=\"c\">VerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">0</span><span class=\"p\">  </span><span class=\"c\"># 0 = any column\n# Verifies that table includes column &quot;Year&quot; at position 2\nVerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">2</span><span class=\"p\">\n</span><span class=\"c\">VerifyColHeader</span><span class=\"p\">    </span><span class=\"c\">Year</span><span class=\"p\">    </span><span class=\"c\">index=2</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>expected <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text or value which should be in the column</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Column index. If given, expected text is verified against the given column.\nIf not given or if 0 is given, expected text is verified against any column\n(i.e. column text must exist at any position)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>partial_match: Allow partial match of expected text. Defaults to True unless default value\nhas been changed with SetConfig    PartialMatch</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebInstanceDoesNotExistError</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n<dt>QWebValueError</dt>\n<dd>If the given index value is out of range</dd>\n<dt>ValueError</dt>\n<dd>Index argument is not an integer.</dd>\n<dt>QWebElementNotFoundError</dt>\n<dd>If the expected text does not match the actual column text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Col%20Header%20Count\" class=\"name\">GetColHeaderCount</a>, <a href=\"#Get%20Col%20Header\" class=\"name\">GetColHeader</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a>, <a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that a column header with given index matches the expected text.", "tags": ["Tables", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 432}, {"name": "Verify Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that element can be found on the page and it is visible.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span>\n</pre>\n<p>This keyword has timeout functionality. If the element is not visible after\ngiven timeout, error is raised.\nFor example.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">   </span><span class=\"c\">#waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix. The equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for finding the element. If the element is not visible after\ngiven timeout, error is raised. The str is converted to integer\nusing robot.utils.timestr_to_secs. (default 10 seconds)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundError</dt>\n<dd>Page did not contain element</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Element\" class=\"name\">ClickElement</a>, <a href=\"#Get%20Attribute\" class=\"name\">GetAttribute</a>, <a href=\"#Get%20Webelement\" class=\"name\">GetWebElement</a>, <a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>,\n<a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that element can be found on the page and it is visible.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 303}, {"name": "Verify Element Text", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "text_to_find", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text_to_find: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that element contains specified text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyElementText</span><span class=\"p\">       </span><span class=\"c\">//input[&#64;value\\=&quot;Button3&quot;]</span><span class=\"p\">      </span><span class=\"c\">ButtonText</span><span class=\"p\">\n</span><span class=\"c\">VerifyElementText</span><span class=\"p\">       </span><span class=\"c\">ipsum</span><span class=\"p\">    </span><span class=\"c\">dolore</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Visible text, some attribute of wanted element or Xpath expression without xpath= prefix.\nWhen using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>text_to_find <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The text we are trying to verify from the element.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we wait that element is found before failing.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index.</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">strict : bool - Verify that the texts are an exact match.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Text\" class=\"name\">GetText</a>, <a href=\"#Is%20Text\" class=\"name\">IsText</a>, <a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that element contains specified text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 770}, {"name": "Verify File", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "filename: str"}], "doc": "<div class=\"document\">\n<p>Verify file exists.</p>\n<p>If reference file are not in default folders (images, files, downloads) then\npath should be defined. Returns path.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">cat1.jpg</span><span class=\"p\">\n</span><span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">C:/this/is/path/to/cat1.jpg</span><span class=\"p\">\n</span><span class=\"c\">${path}</span><span class=\"p\">             </span><span class=\"c\">VerifyFile</span><span class=\"p\">          </span><span class=\"c\">dog.jpg</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>filename <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Filename or path to find.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Verify file exists.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 443}, {"name": "Verify File Download", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify file has been downloaded and return file path.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ExpectFileDownload</span><span class=\"p\">\n</span><span class=\"c\">ClickText</span><span class=\"p\">               </span><span class=\"c\">Download</span><span class=\"p\">\n</span><span class=\"c\">VerifyFileDownload</span><span class=\"p\">      </span><span class=\"c\">timeout=20s</span><span class=\"p\">     </span><span class=\"c\"># file should be downloaded in 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for the download.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>Found more than one file or did not found files at all</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"returns\">\n<h1>Returns</h1>\n<p>text : downloaded file path</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Expect%20File%20Download\" class=\"name\">ExpectFileDownload</a>, <a href=\"#Save%20File\" class=\"name\">SaveFile</a>, <a href=\"#Upload%20File\" class=\"name\">UploadFile</a></p>\n</div>\n</div>\n", "shortdoc": "Verify file has been downloaded and return file path.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\download.py", "lineno": 31}, {"name": "Verify File Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text from plain text file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyFileText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to verify</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20File%20Text\" class=\"name\">GetFileText</a>,<a href=\"#Remove%20File\" class=\"name\">RemoveFile</a>, <a href=\"#Use%20File\" class=\"name\">UseFile</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text from plain text file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 229}, {"name": "Verify Icon", "args": [{"name": "image", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image: str"}, {"name": "template_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "template_res_w: int | None = None"}, {"name": "browser_res_w", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser_res_w: int | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "tolerance", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "types": ["float"], "typedocs": {"float": "float"}, "defaultValue": "0.95", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tolerance: float = 0.95"}, {"name": "grayscale", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "grayscale: bool = True"}], "doc": "<div class=\"document\">\n<p>Verify page contains icon/bitmap.</p>\n<p>This keyword is designed to locate graphical icons/bitmpas on a screen\nby comparing them to a reference image. The function searches the current screen content\nfor the image specified in the 'image' parameter.</p>\n<p>If reference picture is not stored in default folders (images, files, downloads) then\neither full path to image should be used or variable BASE_IMAGE_PATH should be defined\nbefore using this keyword.</p>\n<p>LogMatchedIcons configuration can be used to log screenshots of matched images\nto logs. By default matched images are not logged.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Variables ***</span><span class=\"p\">\n${</span><span class=\"nv\">BASE_IMAGE_PATH</span><span class=\"p\">}          ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">..</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">resources</span><span class=\"p\">${</span><span class=\"nv\">/</span><span class=\"p\">}</span><span class=\"s\">images</span>\n</pre>\n<p>BASE_IMAGE_PATH should lead to the folder where all your reference icons are</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">                    </span><span class=\"c\">LogMatchedIcons</span><span class=\"p\">    </span><span class=\"c\">True</span><span class=\"p\">  </span><span class=\"c\"># Log matched image to logs\u00df\nVerifyIcon</span><span class=\"p\">                   </span><span class=\"c\">plane</span><span class=\"p\">\n</span><span class=\"c\"># Verify image with stricter tolerance and comparing colors\nVerifyIcon</span><span class=\"p\">                   </span><span class=\"c\">plane_red</span><span class=\"p\">      </span><span class=\"c\">tolerance=0.99</span><span class=\"p\">     </span><span class=\"c\">grayscale=False</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>image <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Image name with or without extension</dd>\n<dt>template_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Reference image resolution / width. 1920 by default and\nimage will be scaled to most common resolutions.</dd>\n<dt>browser_res_w <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>Browser resolution / width. None (default) indicates\nthat QWeb will figure out current browser width.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>How long we try to find the element for.</dd>\n<dt>tolerance <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">float</span></dt>\n<dd>Tolerance level for image comparison. Default is 0.95, where 1.0 is exact match.</dd>\n<dt>grayscale <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>When set to True, the image comparison is done in grayscale, which tends to be quicker\nand more reliable.\nWhen set to False, the comparison is done in color, which provides a stricter assessment.\nThe default setting is True.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Capture%20Icon\" class=\"name\">CaptureIcon</a>, <a href=\"#Click%20Icon\" class=\"name\">ClickIcon</a>, <a href=\"#Is%20Icon\" class=\"name\">IsIcon</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains icon/bitmap.", "tags": ["Icon", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\icon.py", "lineno": 196}, {"name": "Verify Input Element", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that input element exist.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">Username</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">r1c1</span>\n</pre>\n<p>With anchor</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">Password</span><span class=\"p\">       </span><span class=\"c\">Username</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputElement</span><span class=\"p\">   </span><span class=\"c\">r?Qentinel/c3</span><span class=\"p\">  </span><span class=\"c\">Robot</span><span class=\"p\">   </span><span class=\"c\">#row contains texts Qentinel and Robot, cell 3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the element.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the checkbox's locator element. If the page contains many\nplaces where the locator text is then anchor is used to get the\none that is closest to it. (default None)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<p>NoSuchElementException: Checkbox element not found</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that input element exist.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 531}, {"name": "Verify Input Status", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "status", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify input field is enabled or disabled.</p>\n<p>In other words verify can user interact with an input field or not.\nElement is considered to be disabled if disabled or readonly attribute exists</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">Password</span><span class=\"p\">        </span><span class=\"c\">Enabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">SSN</span><span class=\"p\">             </span><span class=\"c\">Disabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">   </span><span class=\"c\">SSN</span><span class=\"p\">             </span><span class=\"c\">ReadOnly</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputStatus</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">Enabled</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputStatus</span><span class=\"p\">    </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Disabled</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>status <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Status for the input field. Either enabled, readonly or disabled.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the field interaction is not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input field is enabled or disabled.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 448}, {"name": "Verify Input Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["WebElement", "str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected_value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify input field has given value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValue</span><span class=\"p\">    </span><span class=\"c\">Username</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValue</span><span class=\"p\">    </span><span class=\"c\">Phone Nro</span><span class=\"p\">         </span><span class=\"c\">0401234567</span>\n</pre>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r1c1</span><span class=\"p\">        </span><span class=\"c\">0401234567</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r-1c-1</span><span class=\"p\">      </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#last row, last cell\nVerifyInputValue</span><span class=\"p\">     </span><span class=\"c\">r?Robot/c3</span><span class=\"p\">  </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, cell c3</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that locates the input field. The input field that is closest\nto the text is selected. Also one can use xpath by adding xpath= prefix\nand then the xpath. Error is raised if the xpath matches to multiple\nelements. When using XPaths, the equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>expected_value <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that the input field should contain.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>How long we find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If table cell contains more than one input elements or if there is some kind of\nnested structure inside of given input index may needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs :</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>ValueError</dt>\n<dd>If the input value is not the same</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Input%20Value\" class=\"name\">GetInputValue</a>, <a href=\"#Verify%20Input%20Element\" class=\"name\">VerifyInputElement</a>, <a href=\"#Verify%20Input%20Status\" class=\"name\">VerifyInputStatus</a>, <a href=\"#Verify%20Input%20Values\" class=\"name\">VerifyInputValues</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input field has given value.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 329}, {"name": "Verify Input Values", "args": [{"name": "input_values", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["dict[str, str]", "str"], "typedocs": {"dict": "dictionary", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input_values: dict[str, str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify input fields have given values.</p>\n<p>Accepts a .txt file or Robot FW dictionary as a parameter. If using a text file, the locator\nand the expected value should be separated with a comma on each row.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">list_of_locators_and_values.txt</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">C:/Users/pace/Desktop/textfile.txt</span><span class=\"p\">\n\n</span><span class=\"c\">${cool_dict}=</span><span class=\"p\">           </span><span class=\"c\">Create Dictionary</span><span class=\"p\">    </span><span class=\"c\">Name=Jane</span><span class=\"p\">    </span><span class=\"c\">Email=janedoe&#64;iddqd.com</span><span class=\"p\">\n</span><span class=\"c\">...</span><span class=\"p\">                     </span><span class=\"c\">Phone=04049292243923</span><span class=\"p\">     </span><span class=\"c\">Address=Yellow street 33 C 44</span><span class=\"p\">\n</span><span class=\"c\">VerifyInputValues</span><span class=\"p\">       </span><span class=\"c\">${cool_dict}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a></p>\n</div>\n</div>\n", "shortdoc": "Verify input fields have given values.", "tags": ["Input", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\input_.py", "lineno": 401}, {"name": "Verify Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify Item (usually icon or picture) exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyItem does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the VerifyItem keyword verifies that element which\nhas attribute Canis exist.\nIf there are multiple instances of such of elements you can\nspecific which one is looking for by either:</p>\n<ul class=\"simple\">\n<li>a number or</li>\n<li>a word that is near to the word Canis</li>\n</ul>\n<p>To enable searching items also from Shadow DOM, use SetConfig Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">         </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">VerifyItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be clicked.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text near the element to be clicked or index. If the page contains many\nplaces where the text argument is then anchor is used to get the\none that is closest to it. (default 1)</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>tag:</strong> html tag of preferred element -</div>\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n<div class=\"line\"><strong>partial_match: False</strong>. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item%20Until\" class=\"name\">ClickItemUntil</a>, <a href=\"#Click%20Item%20While\" class=\"name\">ClickItemWhile</a>, <a href=\"#Hover%20Item\" class=\"name\">HoverItem</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Verify Item (usually icon or picture) exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 996}, {"name": "Verify Length", "args": [{"name": "expected_length", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_length: int | str"}], "doc": "<div class=\"document\">\n<p>Verify lists length.</p>\n</div>\n", "shortdoc": "Verify lists length.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 94}, {"name": "Verify Links", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "current", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = current"}, {"name": "log_all", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "log_all: bool = False"}, {"name": "header_only", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "header_only: bool = True"}, {"name": "timeout", "type": null, "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=0"}], "doc": "<div class=\"document\">\n<p>Verify that all links on a given website return good HTTP status codes.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">https://qentinel.com/</span>\n</pre>\n<p>The above example verifies that all links work on qentinel.com</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">https://qentinel.com/</span><span class=\"p\">       </span><span class=\"c\">True</span>\n</pre>\n<p>The above example verifies that all links work on qentinel.com and logs the status of all the\nchecked links.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span>\n</pre>\n<p>The above example verifies that all links work on on the current website.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyLinks</span><span class=\"p\">     </span><span class=\"c\">header_only=False</span>\n</pre>\n<p>The above example verifies that all links work on on the current website.\nArgument <strong>header_only=False</strong> instructs QWeb to double-check 404/405's\nusing GET method (by default only headers are checked).\nHeaders should normally return same code as GET, but in some cases header can be configured\nintentionally to return something else.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>URL of the website that will be opened.</dd>\n<dt>log_all <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Browser name. For example chrome, firefox or ie.</dd>\n<dt>header_only <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>True: check headers only (default)\nFalse: In case of header returning 404 or 405, double-check with GET</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int (optional)</span></dt>\n<dd>How long we wait for API call response before failing.\nDefault as defined in &quot;DefaultTimeout&quot;.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Go%20To\" class=\"name\">GoTo</a>,<a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that all links on a given website return good HTTP status codes.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\browser.py", "lineno": 508}, {"name": "Verify List", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verify list contains given text.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyList</span><span class=\"p\">      </span><span class=\"c\">Pace Robot</span><span class=\"p\">              </span><span class=\"c\">#list contains given text (text can be anywhere)\nVerifyList</span><span class=\"p\">      </span><span class=\"c\">Test Automation</span><span class=\"p\">     </span><span class=\"c\">2</span><span class=\"p\">   </span><span class=\"c\">#List index 2 contains given text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20List\" class=\"name\">ClickList</a>, <a href=\"#Get%20List\" class=\"name\">GetList</a>, <a href=\"#Use%20List\" class=\"name\">UseList</a>, <a href=\"#Verify%20No%20List\" class=\"name\">VerifyNoList</a>, <a href=\"#Verify%20Length\" class=\"name\">VerifyLength</a></p>\n</div>\n</div>\n", "shortdoc": "Verify list contains given text.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 110}, {"name": "Verify No Element", "args": [{"name": "xpath", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Wait element can not be found on the page.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;do_not_wait_me&quot;]</span>\n</pre>\n<p>This keyword has timeout functionality. If the element is still visible after\ngiven timeout, error is raised.\nFor example.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoElement</span><span class=\"p\">          </span><span class=\"c\">//*[&#64;id\\=&quot;wait_me&quot;]</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">   </span><span class=\"c\">#waits 20 seconds</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>xpath <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Xpath expression without xpath= prefix. The equal sign &quot;=&quot; must be escaped with a &quot;\\&quot;.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>Timeout for the element to disappear. If the element is visible after\ngiven timeout, error is raised. The str is converted to integer\nusing robot.utils.timestr_to_secs. (default 10 seconds)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred elemenr -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute (xpath is not needed)</div>\n</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>NoSuchElementException</dt>\n<dd>Page did contain the element</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a></p>\n</div>\n</div>\n", "shortdoc": "Wait element can not be found on the page.", "tags": ["Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\element.py", "lineno": 360}, {"name": "Verify No File Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Check that the text does not exist in the plain text file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoFileText</span><span class=\"p\">     </span><span class=\"c\">Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that should not exist.</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newline (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a></p>\n</div>\n</div>\n", "shortdoc": "Check that the text does not exist in the plain text file.", "tags": ["File", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 283}, {"name": "Verify No Item", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify Item (usually icon or picture) is not exist.</p>\n<p>Finds webelement by it's tooltip text (title or alt) or some another\nattribute.\nAvailable attributes: any\nAvailable element types without using tag attribute:\n<em>a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input*\n(*submit buttons only)</em></p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyItem does not require for the attribute to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoItem</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the VerifyItem keyword verifies that element which\nhas attribute Canis is not exist.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Attribute value of item.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Parameter not used with this kw.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for element to be ready for click</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">tag : html tag of preferred element -</div>\n<div class=\"line-block\">\n<div class=\"line\">If tag is used then element is found</div>\n<div class=\"line\">by some of it's attribute</div>\n</div>\n<div class=\"line\">partial_match: False. If only full match is accepted set</div>\n<div class=\"line\">partial_match to False.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Item\" class=\"name\">ClickItem</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a></p>\n</div>\n</div>\n", "shortdoc": "Verify Item (usually icon or picture) is not exist.", "tags": ["Item", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1069}, {"name": "Verify No List", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "index", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["int", "str", "None"], "typedocs": {"int": "integer", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int | str | None = None"}], "doc": "<div class=\"document\">\n<p>Verify that text is not in the list.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">UseList</span><span class=\"p\">         </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifyNoList</span><span class=\"p\">    </span><span class=\"c\">Pace Robot</span><span class=\"p\">              </span><span class=\"c\">#Text is not in list\nVerifyNoList</span><span class=\"p\">    </span><span class=\"c\">Test Automation</span><span class=\"p\">     </span><span class=\"c\">2</span><span class=\"p\">   </span><span class=\"c\">#List index 2 not containing text</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20List\" class=\"name\">VerifyList</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that text is not in the list.", "tags": ["Lists", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\lists.py", "lineno": 169}, {"name": "Verify No Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that a given option is not in a dropdown menu/list.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoOption</span><span class=\"p\">     </span><span class=\"c\">Foobar</span><span class=\"p\">    </span><span class=\"c\">Cat</span>\n</pre>\n<p>In the above example VerifyNoOption keyword checks that the option &quot;Cat&quot; is not found\nfrom the Foobar dropdown menu/list.</p>\n<p>This keyword can also be used with table cells and XPaths. When using XPaths, the equal sign &quot;=&quot;\nmust be escaped with a &quot;\\&quot;.</p>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Option text that should not exists in options list</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that a given option is not in a dropdown menu/list.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 357}, {"name": "Verify No Pdf Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Check that the text does not exist in the PDF file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoPdfText</span><span class=\"p\">     </span><span class=\"c\">Robot</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text that should not exist.</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>,<a href=\"#Verify%20File%20Text\" class=\"name\">VerifyFileText</a></p>\n</div>\n</div>\n", "shortdoc": "Check that the text does not exist in the PDF file.", "tags": ["File", "PDF", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 254}, {"name": "Verify No Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that page does not contain given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait 10 seconds until checks if the\nCanis exist on the page</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">      </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyNoText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for text to disappear before failing.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If page does not contain text</dd>\n</dl>\n<p>Searches using XPath contains function so that substrings are also\nlooked through.</p>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Text\" class=\"name\">VerifyText</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that page does not contain given text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 156}, {"name": "Verify Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "expected_option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that option exist in dropdown menu/list.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyOption</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the VerifyOption keyword verifies from a dropdown\nthat Collie is in a list.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>expected_option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>option that should be included in dropdown options</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>,\n<a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that option exist in dropdown menu/list.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 250}, {"name": "Verify Pdf Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "normalize", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "normalize: bool = False"}], "doc": "<div class=\"document\">\n<p>Verify text from pdf file.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyPdfText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span><span class=\"p\">\n</span><span class=\"c\">VerifyPdfText</span><span class=\"p\">     </span><span class=\"c\">Test Automation</span><span class=\"p\">    </span><span class=\"c\">normalize=True</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to verify</dd>\n<dt>normalize <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">bool</span></dt>\n<dd>Remove extra newlines (\\\\n)</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Pdf%20Text\" class=\"name\">GetPdfText</a>,<a href=\"#Remove%20Pdf\" class=\"name\">RemovePdf</a>, <a href=\"#Use%20Pdf\" class=\"name\">UsePdf</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text from pdf file.", "tags": ["File", "PDF", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 203}, {"name": "Verify Selected Option", "args": [{"name": "locator", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: str"}, {"name": "expected_option", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_option: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "index", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index: int = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify that an option is selected from dropdown menu/list.\nNote: with multiselection dropdown verify each option individually.</p>\n<p><strong>NOTE:</strong> This keyword is designed to function exclusively with actual dropdowns\nthat contain <strong>&lt;select&gt;</strong> and <strong>&lt;option&gt;</strong> tags.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">Canis</span><span class=\"p\">   </span><span class=\"c\">Collie</span>\n</pre>\n<p>In the above example the VerifySelectedOption keyword verifies from a dropdown\nthat Collie is selected.</p>\n<p>With table(Pick table with use table keyword first):</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r1c1</span><span class=\"p\">          </span><span class=\"c\">Qentinel</span><span class=\"p\">\n</span><span class=\"c\">VerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r-1c3</span><span class=\"p\">         </span><span class=\"c\">Robot</span><span class=\"p\">     </span><span class=\"c\">#last row, third cell\nVerifySelectedOption</span><span class=\"p\">    </span><span class=\"c\">r?Robot/c-1</span><span class=\"p\">   </span><span class=\"c\">Qentinel</span><span class=\"p\">  </span><span class=\"c\">#row that contains text Robot, last cell</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>locator <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Locator for searching the dropdown element. Usually some label-text</dd>\n<dt>expected_option <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>option which should be selected</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Optional parameter for locating the element if locator text is not unique</dd>\n<dt>timeout: str</dt>\n<dd>How long we try to find element before failing. Default 10 (seconds)</dd>\n<dt>index <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">int</span></dt>\n<dd>If cell contains more than one dropdown elements index is needed. Default = 1 (first)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\">limit_traverse : False. If limit traverse is set to false we are heading up to</div>\n<div class=\"line\">fifth parent element if needed when finding relative input element for some label.</div>\n<div class=\"line\">partial_match: True. If element is found by it's attribute set partial_match</div>\n<div class=\"line\">to True to allow partial match</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Drop%20Down\" class=\"name\">DropDown</a>, <a href=\"#Get%20Drop%20Down%20Values\" class=\"name\">GetDropDownValues</a>, <a href=\"#Get%20Selected\" class=\"name\">GetSelected</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20No%20Option\" class=\"name\">VerifyNoOption</a></p>\n</div>\n</div>\n", "shortdoc": "Verify that an option is selected from dropdown menu/list. Note: with multiselection dropdown verify each option individually.", "tags": ["Dropdown", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\dropdown.py", "lineno": 131}, {"name": "Verify Table", "args": [{"name": "coordinates", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinates: str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify text in table coordinates.</p>\n<p>Reads cell value from coordinates in active table and verifies it\nagainst expected value.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTable</span><span class=\"p\">            </span><span class=\"c\">r2c3</span><span class=\"p\">    </span><span class=\"c\">Qentinel</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>coordinates <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Row and column coordinates in table. R specifies row and c column.\nOrder does not matter.</dd>\n<dt>expected <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Expected value that needs to be found in table.</dd>\n<dt>anchor <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Index number or text near the input field's locator element.\nIf the page contains many places where the locator is then anchor is used\nto select the wanted item. Index number selects the item from the list\nof matching entries starting with 1. Text selects the entry with the closest\ndistance.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we search before failing. Default = Search Strategy default timeout (10s)</dd>\n<dt>kwargs :</dt>\n<dd><div class=\"first last line-block\">\n<div class=\"line\">Accepted kwargs:</div>\n<div class=\"line-block\">\n<div class=\"line\"><strong>partial_match</strong>: This argument lets you decide if you want to find column names</div>\n<div class=\"line\">by looking for an exact match to your search term or if a partial match is</div>\n<div class=\"line\">good enough. For example, when you're specifying which column to look at using</div>\n<div class=\"line\">a text-based method (like &quot;r1/?cRobot&quot;), this determines whether the system should</div>\n<div class=\"line\">look for an exact match to &quot;Robot&quot; or if it can work with columns that only partly</div>\n<div class=\"line\">match the word &quot;Robot&quot;.</div>\n<div class=\"line\">It also applies to checking values: this setting controls whether a value that only</div>\n<div class=\"line\">partially matches your criteria is considered okay.</div>\n<div class=\"line\">Default: if partial_match is not given, the value of SetConfig PartialMatch is used.</div>\n</div>\n</div>\n</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueMismatchErr</dt>\n<dd>If the table is not defined by UseTable keyword</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Click%20Cell\" class=\"name\">ClickCell</a>, <a href=\"#Get%20Cell%20Text\" class=\"name\">GetCellText</a>, <a href=\"#Get%20Table%20Row\" class=\"name\">GetTableRow</a>, <a href=\"#Use%20Table\" class=\"name\">UseTable</a></p>\n</div>\n</div>\n", "shortdoc": "Verify text in table coordinates.", "tags": ["Tables", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\table.py", "lineno": 100}, {"name": "Verify Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "anchor", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "anchor: str = 1"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify page contains given text.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyText does not require for the text to be unique.</p>\n<p><em>Note: Slots are a bit unique as they do not have size/offset. This means\nthat our default visibility check will treat slots as not visible. If text is\ndirectly on the slot, use visibility=False argument in VerifyText keyword. For example:</em></p>\n<pre class=\"code html literal-block\">\n<span class=\"p\">&lt;</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>My Text<span class=\"p\">&lt;/</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>\n</pre>\n<p><em>The above needs visibility=False argument, as text is directly on the slot. However,\nthis one would work without turning visibility check off, since text is on a child\nelement under slot:</em></p>\n<pre class=\"code html literal-block\">\n<span class=\"p\">&lt;</span><span class=\"nt\">slot</span><span class=\"p\">&gt;&lt;</span><span class=\"nt\">span</span><span class=\"p\">&gt;</span>My Text<span class=\"p\">&lt;/</span><span class=\"nt\">span</span><span class=\"p\">&gt;&lt;/</span><span class=\"nt\">slot</span><span class=\"p\">&gt;</span>\n</pre>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">DefaultTimeout</span><span class=\"p\">    </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n<p>To enable searching items also from Shadow DOM, use SetConfig Shadow DOM.</p>\n</div>\n<div class=\"section\" id=\"shadow-dom-example\">\n<h1>Shadow DOM Example</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">         </span><span class=\"c\">Shadow DOM</span><span class=\"p\">     </span><span class=\"c\">True</span><span class=\"p\">\n</span><span class=\"c\">VerifyText</span><span class=\"p\">        </span><span class=\"c\">Canis</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text.\nwindow_find : True - When WindowFind is used VerifyText is not looking\ntexts for dom, but simulates ctrl+f like search to current viewport.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebElementNotFoundError</dt>\n<dd>If page does not contain text</dd>\n</dl>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Verify%20Alert%20Text\" class=\"name\">VerifyAlertText</a>, <a href=\"#Verify%20All\" class=\"name\">VerifyAll</a>, <a href=\"#Verify%20Any\" class=\"name\">VerifyAny</a>, <a href=\"#Verify%20Attribute\" class=\"name\">VerifyAttribute</a>, <a href=\"#Verify%20Checkbox\" class=\"name\">VerifyCheckbox</a>,\n<a href=\"#Verify%20Element\" class=\"name\">VerifyElement</a>, <a href=\"#Verify%20Icon\" class=\"name\">VerifyIcon</a>, <a href=\"#Verify%20Input%20Value\" class=\"name\">VerifyInputValue</a>, <a href=\"#Verify%20Item\" class=\"name\">VerifyItem</a>, <a href=\"#Verify%20Links\" class=\"name\">VerifyLinks</a>,\n<a href=\"#Verify%20No%20Text\" class=\"name\">VerifyNoText</a>, <a href=\"#Verify%20Option\" class=\"name\">VerifyOption</a>, <a href=\"#Verify%20Pdf%20Text\" class=\"name\">VerifyPdfText</a>, <a href=\"#Verify%20Selected%20Option\" class=\"name\">VerifySelectedOption</a>,\n<a href=\"#Verify%20Table\" class=\"name\">VerifyTable</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given text.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 55}, {"name": "Verify Text Count", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "expected_count", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "str"], "typedocs": {"int": "integer", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_count: int | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Verify page contains given text given times.</p>\n<p>Keyword waits until timeout has passed. If timeout is not specified, it\nuses default timeout that can be adjusted with DefaultTimeout keyword.</p>\n<p>VerifyTextCount does not require for the text to be unique.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">     </span><span class=\"c\">3</span>\n</pre>\n<p>In the above example the test will wait until &quot;Canis&quot; exists on the page or default\ntimeout has passed.</p>\n<p>If you wish to increase the wait time</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">       </span><span class=\"c\">3</span><span class=\"p\">      </span><span class=\"c\">20</span><span class=\"p\">  </span><span class=\"c\"># Waits 20 seconds</span>\n</pre>\n<p>If you want to change default timeout</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">SetConfig</span><span class=\"p\">              </span><span class=\"c\">DefaultTimeout</span><span class=\"p\">   </span><span class=\"c\">2m</span><span class=\"p\">\n</span><span class=\"c\">VerifyTextCount</span><span class=\"p\">        </span><span class=\"c\">Canis</span><span class=\"p\">      </span><span class=\"c\">3</span><span class=\"p\">     </span><span class=\"c\"># Waits 2 minutes</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to be verified.</dd>\n<dt>expected_count <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How many times text must be shown on page</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we try to find text before failing. Default 10 (seconds)</dd>\n<dt>Accepted kwargs:</dt>\n<dd>css=False/off: Use this to bypass css search when finding elements\nby visible text</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If page does not contain text expected number of times</dd>\n</dl>\n<p>Uses . (dot) in the xpath to represent the text in the node. Using dot\ninstead of text() since text() does not handle cases where the text is\nin both the a parent node and in its child node.</p>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Element%20Count\" class=\"name\">GetElementCount</a>, <a href=\"#Get%20Text%20Count\" class=\"name\">GetTextCount</a></p>\n</div>\n</div>\n", "shortdoc": "Verify page contains given text given times.", "tags": ["Text", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 221}, {"name": "Verify Texts", "args": [{"name": "texts_to_verify", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["list[str]", "str"], "typedocs": {"list": "list", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "texts_to_verify: list[str] | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>VerifyAll</cite> instead.</p>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `VerifyAll` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1291, "deprecated": true}, {"name": "Verify Title", "args": [{"name": "title", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verifies that current page's title matches expected title.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyTitle</span><span class=\"p\">      </span><span class=\"c\">Google</span><span class=\"p\">\n</span><span class=\"c\">VerifyTitle</span><span class=\"p\">      </span><span class=\"c\">Google</span><span class=\"p\">     </span><span class=\"c\">timeout=3</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>title <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The expected title</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for title to change before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the expected title differs from actual page title</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>, <a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Url\" class=\"name\">VerifyUrl</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that current page's title matches expected title.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 404}, {"name": "Verify Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: int | float | str = 0"}], "doc": "<div class=\"document\">\n<p>Verifies that current page url/location matches expected url.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<blockquote>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">VerifyUrl</span><span class=\"p\">      </span><span class=\"c\">https://www.google.com</span><span class=\"p\">\n</span><span class=\"c\">VerifyUrl</span><span class=\"p\">      </span><span class=\"c\">https://www.google.com</span><span class=\"p\">     </span><span class=\"c\">timeout=5</span>\n</pre>\n</blockquote>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>url <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>The expected url</dd>\n<dt>timeout <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str | int</span></dt>\n<dd>How long we wait for url to change before failing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"raises\">\n<h1>Raises</h1>\n<dl class=\"docutils\">\n<dt>QWebValueError</dt>\n<dd>If the expected url differs from current url</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Get%20Title\" class=\"name\">GetTitle</a>, <a href=\"#Get%20Url\" class=\"name\">GetUrl</a>, <a href=\"#Verify%20Title\" class=\"name\">VerifyTitle</a></p>\n</div>\n</div>\n", "shortdoc": "Verifies that current page url/location matches expected url.", "tags": ["Browser", "Verification"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\window.py", "lineno": 339}, {"name": "Version", "args": [{"name": "distribution_name", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "distribution_name"}], "doc": "<div class=\"document\">\n<p>Get the version string for the named package.</p>\n<table class=\"docutils field-list\" frame=\"void\" rules=\"none\">\n<col class=\"field-name\" />\n<col class=\"field-body\" />\n<tbody valign=\"top\">\n<tr class=\"field\"><th class=\"field-name\" colspan=\"2\">param distribution_name:</th></tr>\n<tr class=\"field\"><td>&nbsp;</td><td class=\"field-body\">The name of the distribution package to query.</td>\n</tr>\n<tr class=\"field\"><th class=\"field-name\">return:</th><td class=\"field-body\">The version string for the package as defined in the package's\n&quot;Version&quot; metadata key.</td>\n</tr>\n</tbody>\n</table>\n</div>\n", "shortdoc": "Get the version string for the named package.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\.pyenv\\pyenv-win\\versions\\3.9.12\\lib\\importlib\\metadata.py", "lineno": 562}, {"name": "Write Text", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "kwargs", "type": null, "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<div class=\"document\">\n<p>Type text with single-character keys.</p>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>text <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Text to type.</dd>\n<dt>Accepted kwargs:</dt>\n<dd>delay = Time to wait (seconds) before typing.</dd>\n</dl>\n</div>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">WriteText</span><span class=\"p\">    </span><span class=\"c\">Hello World!</span>\n</pre>\n</div>\n<div class=\"section\" id=\"related-keywords\">\n<h1>Related keywords</h1>\n<p><a href=\"#Press%20Key\" class=\"name\">PressKey</a>, <a href=\"#Type%20Text\" class=\"name\">TypeText</a></p>\n</div>\n</div>\n", "shortdoc": "Type text with single-character keys.", "tags": ["input", "Interaction", "Text"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\text.py", "lineno": 1263}, {"name": "Xhr Timeout", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "types": ["int", "float", "str"], "typedocs": {"int": "integer", "float": "float", "str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: int | float | str"}], "doc": "<div class=\"document\">\n<p><em>DEPRECATED!!</em> Use keyword <cite>SetConfig  XHRTimeout</cite> instead.</p>\n<p>Set default timeout for XHR (How log we wait page to be loaded).</p>\n<p>Timeout can be overridden by entering it manually</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">XHRTimeout</span><span class=\"p\">        </span><span class=\"c\">60</span>\n</pre>\n</div>\n</div>\n", "shortdoc": "*DEPRECATED!!* Use keyword `SetConfig  XHRTimeout` instead.", "tags": [], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\search_strategy.py", "lineno": 121, "deprecated": true}, {"name": "Zip Files", "args": [{"name": "name_of_zip", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_of_zip: str"}, {"name": "files_to_zip", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "files_to_zip: str"}], "doc": "<div class=\"document\">\n<p>Zip files.</p>\n<div class=\"section\" id=\"examples\">\n<h1>Examples</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file</span><span class=\"p\">      </span><span class=\"c\">rabbit.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_2</span><span class=\"p\">    </span><span class=\"c\">dog.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_3</span><span class=\"p\">    </span><span class=\"c\">rabbit.txt, dog.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_4</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/secrets/cat.txt</span><span class=\"p\">\n</span><span class=\"c\">ZipFiles</span><span class=\"p\">           </span><span class=\"c\">my_zip_file_5</span><span class=\"p\">    </span><span class=\"c\">C:/Users/pace/secrets/cat.txt, C:/automation/kangaroo.txt</span>\n</pre>\n</div>\n<div class=\"section\" id=\"parameters\">\n<h1>Parameters</h1>\n<dl class=\"docutils\">\n<dt>name_of_zip <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Name of the zip file created.</dd>\n<dt>files_to_zip <span class=\"classifier-delimiter\">:</span> <span class=\"classifier\">str</span></dt>\n<dd>Files to be zipped, separated by &quot;,&quot; in case of multiple files.</dd>\n</dl>\n</div>\n</div>\n", "shortdoc": "Zip files.", "tags": ["File", "Interaction"], "source": "C:\\Users\\TuomasKoukkari\\Documents\\qweb\\QWeb\\keywords\\file.py", "lineno": 368}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Get Timeout", "Set Active Area Function", "Set Config", "Set Wait Function"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["Case Insensitive", "Check Input Value", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Default Document", "Drop Down", "Get Input Value", "Is Icon", "List Cookies", "Log Screenshot", "Scan Click", "Skim Click", "Use Table", "Verify File Text", "Verify Icon", "Verify Links", "Verify No File Text", "Verify No Pdf Text", "Verify Pdf Text"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["Type Texts", "Verify Input Values"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Capture Icon", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Default Timeout", "Drag Drop", "Drop Down", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Press Key", "Right Click", "Run Block", "Save File", "Scan Click", "Scroll", "Scroll Text", "Scroll To", "Skim Click", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use List", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Element", "Verify Element Text", "Verify File Download", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify List", "Verify No Element", "Verify No Item", "Verify No Option", "Verify No Text", "Verify Option", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Xhr Timeout"], "accepts": ["string", "Real"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["Capture Icon", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Default Timeout", "Drag Drop", "Drop Down", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Col Header", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get List", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Press Key", "Right Click", "Run Block", "Save File", "Scan Click", "Scroll", "Scroll Text", "Scroll To", "Set Window Size", "Skim Click", "Switch Browser", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use List", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Col Header", "Verify Element", "Verify Element Text", "Verify File Download", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify Length", "Verify List", "Verify No Element", "Verify No Item", "Verify No List", "Verify No Option", "Verify No Text", "Verify Option", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Xhr Timeout"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Verify All", "Verify Any", "Verify Texts"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["Click Icon", "Click Item Until", "Click Item While", "Click Text", "Click Until", "Click While", "Execute Javascript", "Get Attribute", "Get Col Header", "Get Config", "Get List", "Get Webelement", "Is Icon", "Open Browser", "Remove File", "Reset Config", "Save File", "Scan Click", "Scroll To", "Skim Click", "Swipe Down", "Swipe Left", "Swipe Right", "Swipe Up", "Use List", "Verify Attribute", "Verify Col Header", "Verify Icon", "Verify List", "Verify No List"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Appstate", "Capture Icon", "Case Insensitive", "Check Input Value", "Click Cell", "Click Checkbox", "Click Element", "Click Icon", "Click Item", "Click Item Until", "Click Item While", "Click List", "Click Text", "Click Until", "Click While", "Close Alert", "Copy Text", "Css Selectors", "Debug On", "Default Document", "Default Timeout", "Drag Drop", "Drop Down", "Execute Javascript", "Get Alert Text", "Get Attribute", "Get Cell Text", "Get Config", "Get Drop Down Values", "Get Element Count", "Get Input Value", "Get List", "Get Selected", "Get Table Row", "Get Text", "Get Text Count", "Get Webelement", "Go To", "Hover Element", "Hover Item", "Hover Text", "Is Alert", "Is Cookie", "Is Element", "Is Icon", "Is Item", "Is No Item", "Is No Text", "Is Text", "Log Screenshot", "Move Files", "Open Browser", "Press Key", "Remove File", "Reset Config", "Right Click", "Run Block", "Save File", "Scan Click", "Screenshot Type", "Scroll", "Scroll Text", "Scroll To", "Search Direction", "Set Config", "Set Input Handler", "Set Line Break", "Set Search Strategy", "Skim Click", "Swipe Down", "Swipe Left", "Swipe Right", "Swipe Up", "Switch Browser", "Switch Window", "Type Alert", "Type Secret", "Type Secret3", "Type Text", "Type Texts", "Upload File", "Use File", "Use Frame", "Use List", "Use Pdf", "Use Table", "Verify Alert Text", "Verify All", "Verify Any", "Verify App", "Verify Attribute", "Verify Checkbox", "Verify Checkbox Status", "Verify Checkbox Value", "Verify Col Header", "Verify Element", "Verify Element Text", "Verify File", "Verify File Download", "Verify File Text", "Verify Icon", "Verify Input Element", "Verify Input Status", "Verify Input Value", "Verify Input Values", "Verify Item", "Verify Length", "Verify Links", "Verify List", "Verify No Element", "Verify No File Text", "Verify No Item", "Verify No List", "Verify No Option", "Verify No Pdf Text", "Verify No Text", "Verify Option", "Verify Pdf Text", "Verify Selected Option", "Verify Table", "Verify Text", "Verify Text Count", "Verify Texts", "Verify Title", "Verify Url", "Write Text", "Xhr Timeout", "Zip Files"], "accepts": ["Any"]}]}
 </script>
 <title></title>
 </head>