~ubuntu-sdk-team/ubuntu-ui-toolkit/generatedApDocs

{"body": "<div class=\"section\" id=\"ubuntuuitoolkit-package\">\n<h1>ubuntuuitoolkit Package<a class=\"headerlink\" href=\"#ubuntuuitoolkit-package\" title=\"Permalink to this headline\">\u00b6</a></h1>\n<div class=\"section\" id=\"module-ubuntuuitoolkit\">\n<span id=\"custom-proxy-object-module\"></span><h2><tt class=\"xref py py-mod docutils literal\"><span class=\"pre\">custom</span> <span class=\"pre\">proxy</span> <span class=\"pre\">object</span></tt> Module<a class=\"headerlink\" href=\"#module-ubuntuuitoolkit\" title=\"Permalink to this headline\">\u00b6</a></h2>\n<p>Ubuntu UI Toolkit Autopilot tests and helpers.</p>\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.AppHeader\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">AppHeader</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>AppHeader Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.click_action_button\">\n<tt class=\"descname\">click_action_button</tt><big>(</big><em>action_object_name</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.click_action_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Click an action button of the header.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>object_name</strong> &#8211; The QML objectName property of the action</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">If there is no action button with that object\nname.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.click_back_button\">\n<tt class=\"descname\">click_back_button</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.click_back_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.click_custom_back_button\">\n<tt class=\"descname\">click_custom_back_button</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.click_custom_back_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.ensure_visible\">\n<tt class=\"descname\">ensure_visible</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.ensure_visible\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.get_selected_section_index\">\n<tt class=\"descname\">get_selected_section_index</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.get_selected_section_index\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.switch_to_next_tab\">\n<tt class=\"descname\">switch_to_next_tab</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.switch_to_next_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the next tab.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the main view has no tabs.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.switch_to_section_by_index\">\n<tt class=\"descname\">switch_to_section_by_index</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.switch_to_section_by_index\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Select a section in the header divider</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>index</strong> &#8211; The index of the section to select</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitEmulatorException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">If the selection index is out of\nrange or useDeprecatedToolbar is set.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.switch_to_tab_by_index\">\n<tt class=\"descname\">switch_to_tab_by_index</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.switch_to_tab_by_index\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open a tab. This only supports the new tabs in the header</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>index</strong> &#8211; The index of the tab to open.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">If the tab index is out\nof range or useDeprecatedToolbar is set.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.AppHeader.wait_for_animation\">\n<tt class=\"descname\">wait_for_animation</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.AppHeader.wait_for_animation\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n</dd></dl>\n\n<dl class=\"function\">\n<dt id=\"ubuntuuitoolkit.check_autopilot_version\">\n<tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">check_autopilot_version</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.check_autopilot_version\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Check that the Autopilot installed version matches the one required.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the installed Autopilot version does&#8217;t\nmatch the required by the custom proxy objects.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.CheckBox\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">CheckBox</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.CheckBox\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>CheckBox Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.CheckBox.change_state\">\n<tt class=\"descname\">change_state</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.CheckBox.change_state\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Change the state of a CheckBox.</p>\n<p>If it is checked, it will be unchecked. If it is unchecked, it will be\nchecked.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>time_out</strong> &#8211; number of seconds to wait for the CheckBox state\nto change. Default is 10.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.CheckBox.check\">\n<tt class=\"descname\">check</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.CheckBox.check\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Check a CheckBox, if its not already checked.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>timeout</strong> &#8211; number of seconds to wait for the CheckBox to be\nchecked. Default is 10.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.CheckBox.uncheck\">\n<tt class=\"descname\">uncheck</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.CheckBox.uncheck\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Uncheck a CheckBox, if its not already unchecked.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>timeout</strong> &#8211; number of seconds to wait for the CheckBox to be\nunchecked. Default is 10.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"function\">\n<dt id=\"ubuntuuitoolkit.get_keyboard\">\n<tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">get_keyboard</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.get_keyboard\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the keyboard device.</p>\n</dd></dl>\n\n<dl class=\"function\">\n<dt id=\"ubuntuuitoolkit.get_pointing_device\">\n<tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">get_pointing_device</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.get_pointing_device\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the pointing device depending on the platform.</p>\n<p>If the platform is <cite>Desktop</cite>, the pointing device will be a <cite>Mouse</cite>.\nIf not, the pointing device will be <cite>Touch</cite>.</p>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.Header\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">Header</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Header\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._header.AppHeader</span></tt></p>\n<p>Autopilot helper for the deprecated Header.</p>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.Dialog\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">Dialog</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Dialog\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>Autopilot helper for the Dialog component.</p>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.UCListItem\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">UCListItem</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UCListItem\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>Base class to emulate swipe for leading and trailing actions.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UCListItem.toggle_selected\">\n<tt class=\"descname\">toggle_selected</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UCListItem.toggle_selected\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Toggles selected state of the ListItem.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UCListItem.trigger_leading_action\">\n<tt class=\"descname\">trigger_leading_action</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UCListItem.trigger_leading_action\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Swipe the item in from left to right to open leading actions\nand click on the button representing the requested action.</p>\n<dl class=\"docutils\">\n<dt>parameters: action_objectName - object name of the action to be</dt>\n<dd>triggered.\nwait_function - a custom wait function to wait till the\naction is triggered</dd>\n</dl>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UCListItem.trigger_trailing_action\">\n<tt class=\"descname\">trigger_trailing_action</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UCListItem.trigger_trailing_action\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Swipe the item in from right to left to open trailing actions\nand click on the button representing the requested action.</p>\n<dl class=\"docutils\">\n<dt>parameters: action_objectName - object name of the action to be</dt>\n<dd>triggered.\nwait_function - a custom wait function to wait till the\naction is triggered</dd>\n</dl>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.MainView\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">MainView</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>MainView Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.click_action_button\">\n<tt class=\"descname\">click_action_button</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.click_action_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Click the specified button.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>action_object_name</strong> &#8211; the objectName of the action to trigger.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">The requested button is not available.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.close_toolbar\">\n<tt class=\"descname\">close_toolbar</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.close_toolbar\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Close the toolbar if it is opened.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the main view has no toolbar.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.get_action_selection_popover\">\n<tt class=\"descname\">get_action_selection_popover</tt><big>(</big><em>object_name</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.get_action_selection_popover\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return an ActionSelectionPopover custom proxy object.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>object_name</strong> &#8211; The QML objectName property of the popover.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.get_header\">\n<tt class=\"descname\">get_header</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.get_header\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the AppHeader custom proxy object of the MainView.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.get_tabs\">\n<tt class=\"descname\">get_tabs</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.get_tabs\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the Tabs custom proxy object of the MainView.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the main view has no tabs.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.get_text_input_context_menu\">\n<tt class=\"descname\">get_text_input_context_menu</tt><big>(</big><em>object_name</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.get_text_input_context_menu\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return a TextInputContextMenu emulator.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>object_name</strong> &#8211; The QML objectName property of the popover.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.get_toolbar\">\n<tt class=\"descname\">get_toolbar</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.get_toolbar\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the Toolbar custom proxy object of the MainView.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the main view has no toolbar.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.go_back\">\n<tt class=\"descname\">go_back</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.go_back\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Go to the previous page.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.open_toolbar\">\n<tt class=\"descname\">open_toolbar</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.open_toolbar\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the toolbar if it is not already opened.</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-odd field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The toolbar.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">If the main view has no toolbar.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.switch_to_next_tab\">\n<tt class=\"descname\">switch_to_next_tab</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.switch_to_next_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the next tab.</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-odd field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The newly opened tab.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.switch_to_previous_tab\">\n<tt class=\"descname\">switch_to_previous_tab</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.switch_to_previous_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the previous tab.</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-odd field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The newly opened tab.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.switch_to_tab\">\n<tt class=\"descname\">switch_to_tab</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.switch_to_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open a tab.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>object_name</strong> &#8211; The QML objectName property of the tab.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The newly opened tab.</td>\n</tr>\n<tr class=\"field-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If there is no tab with that object\nname.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.MainView.switch_to_tab_by_index\">\n<tt class=\"descname\">switch_to_tab_by_index</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.switch_to_tab_by_index\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open a tab.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>index</strong> &#8211; The index of the tab to open.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The newly opened tab.</td>\n</tr>\n<tr class=\"field-odd field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the tab index\nis out of range.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"classmethod\">\n<dt id=\"ubuntuuitoolkit.MainView.validate_dbus_object\">\n<em class=\"property\">classmethod </em><tt class=\"descname\">validate_dbus_object</tt><big>(</big><em>path</em>, <em>state</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.MainView.validate_dbus_object\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.OptionSelector\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">OptionSelector</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>OptionSelector Autopilot custom proxy object</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.OptionSelector.get_current_label\">\n<tt class=\"descname\">get_current_label</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector.get_current_label\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>gets the text of the currently selected item</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.OptionSelector.get_option_count\">\n<tt class=\"descname\">get_option_count</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector.get_option_count\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Gets the number of items in the option selector</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.OptionSelector.get_selected_index\">\n<tt class=\"descname\">get_selected_index</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector.get_selected_index\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Gets the current selected index of the QQuickListView</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.OptionSelector.get_selected_text\">\n<tt class=\"descname\">get_selected_text</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector.get_selected_text\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>gets the text of the currently selected item</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.OptionSelector.select_option\">\n<tt class=\"descname\">select_option</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.OptionSelector.select_option\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Select delegate in option selector</p>\n<dl class=\"docutils\">\n<dt>Example usage::</dt>\n<dd>select_option(objectName=&#8221;myOptionSelectorDelegate&#8221;)\nselect_option(&#8216;Label&#8217;, text=&#8221;some_text_here&#8221;)</dd>\n</dl>\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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>kwargs</strong> &#8211; keywords used to find property(s) of delegate in\noption selector</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">QQuickFlickable</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._flickable.Scrollable</span></tt></p>\n<dl class=\"attribute\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.margin_to_swipe_from_bottom\">\n<tt class=\"descname\">margin_to_swipe_from_bottom</tt><em class=\"property\"> = 16.0</em><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.margin_to_swipe_from_bottom\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"attribute\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.margin_to_swipe_from_top\">\n<tt class=\"descname\">margin_to_swipe_from_top</tt><em class=\"property\"> = 8.0</em><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.margin_to_swipe_from_top\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.pull_to_refresh\">\n<tt class=\"descname\">pull_to_refresh</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.pull_to_refresh\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Pulls the flickable down and triggers a refresh on it.</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-odd field\"><th class=\"field-name\" colspan=\"2\">Raises <a class=\"reference internal\" href=\"#ubuntuuitoolkit.ToolkitException\" title=\"ubuntuuitoolkit.ToolkitException\">ubuntuuitoolkit.ToolkitException</a>:</th></tr>\n<tr class=\"field-odd field\"><td>&nbsp;</td><td class=\"field-body\">If the flickable has no pull\nto release functionality.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.swipe_child_into_view\">\n<tt class=\"descname\">swipe_child_into_view</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.swipe_child_into_view\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Make the child visible.</p>\n<p>Currently it works only when the object needs to be swiped vertically.\nTODO implement horizontal swiping. &#8211;elopio - 2014-03-21</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.swipe_to_bottom\">\n<tt class=\"descname\">swipe_to_bottom</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.swipe_to_bottom\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.swipe_to_show_more_above\">\n<tt class=\"descname\">swipe_to_show_more_above</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.swipe_to_show_more_above\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.swipe_to_show_more_below\">\n<tt class=\"descname\">swipe_to_show_more_below</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.swipe_to_show_more_below\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickFlickable.swipe_to_top\">\n<tt class=\"descname\">swipe_to_top</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickFlickable.swipe_to_top\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.QQuickGridView\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">QQuickGridView</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickGridView\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._flickable.QQuickFlickable</span></tt></p>\n<p>Autopilot helper for the QQuickGridView component.</p>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.QQuickListView\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">QQuickListView</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickListView\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._flickable.QQuickFlickable</span></tt></p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickListView.click_element\">\n<tt class=\"descname\">click_element</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickListView.click_element\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Click an element from the list.</p>\n<p>It swipes the element into view if it&#8217;s center is not visible.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><ul class=\"first last simple\">\n<li><strong>objectName</strong> &#8211; The objectName property of the element to click.</li>\n<li><strong>direction</strong> &#8211; The direction where the element is, it can be\neither &#8216;above&#8217; or &#8216;below&#8217;. Default value is None, which means we\ndon&#8217;t know where the object is and we will need to search the full\nlist.</li>\n</ul>\n</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickListView.drag_item\">\n<tt class=\"descname\">drag_item</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickListView.drag_item\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.QQuickListView.enable_select_mode\">\n<tt class=\"descname\">enable_select_mode</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.QQuickListView.enable_select_mode\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Default implementation to enable select mode. Performs a long tap\nover the first list item in the ListView. The delegates must be\nthe new ListItem components.</p>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.TabBar\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">TabBar</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TabBar\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>TabBar Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.TabBar.switch_to_next_tab\">\n<tt class=\"descname\">switch_to_next_tab</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TabBar.switch_to_next_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the next tab.</p>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.Tabs\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">Tabs</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Tabs\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>Tabs Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Tabs.get_current_tab\">\n<tt class=\"descname\">get_current_tab</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Tabs.get_current_tab\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the currently selected tab.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Tabs.get_number_of_tabs\">\n<tt class=\"descname\">get_number_of_tabs</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Tabs.get_number_of_tabs\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return the number of tabs.</p>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.TextArea\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">TextArea</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextArea\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._textfield.TextField</span></tt></p>\n<p>TextArea autopilot emulator.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.TextArea.clear\">\n<tt class=\"descname\">clear</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextArea.clear\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Clear the text area.</p>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.TextField\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">TextField</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextField\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>TextField Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.TextField.clear\">\n<tt class=\"descname\">clear</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextField.clear\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Clear the text field.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.TextField.is_empty\">\n<tt class=\"descname\">is_empty</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextField.is_empty\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Return True if the text field is empty. False otherwise.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.TextField.write\">\n<tt class=\"descname\">write</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.TextField.write\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Write into the text field.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><ul class=\"first last simple\">\n<li><strong>text</strong> &#8211; The text to write.</li>\n<li><strong>clear</strong> &#8211; If True, the text field will be cleared before\nwriting the text. If False, the text will be appended at the end\nof the text field. Default is True.</li>\n</ul>\n</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.Toolbar\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">Toolbar</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Toolbar\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase</span></tt></p>\n<p>Toolbar Autopilot custom proxy object.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Toolbar.click_back_button\">\n<tt class=\"descname\">click_back_button</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Toolbar.click_back_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Click the back button of the toolbar.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Toolbar.click_button\">\n<tt class=\"descname\">click_button</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Toolbar.click_button\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Click a button of the toolbar.</p>\n<p>The toolbar should be opened before clicking the button, or an\nexception will be raised. If the toolbar is closed for some reason\n(e.g., timer finishes) after moving the mouse cursor and before\nclicking the button, it is re-opened automatically by this function.</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-odd field\"><th class=\"field-name\">Parameters:</th><td class=\"field-body\"><strong>object_name</strong> &#8211; The QML objectName property of the button.</td>\n</tr>\n<tr class=\"field-even field\"><th class=\"field-name\" colspan=\"2\">Raises ToolkitException:</th></tr>\n<tr class=\"field-even field\"><td>&nbsp;</td><td class=\"field-body\">If there is no button with that object\nname.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Toolbar.close\">\n<tt class=\"descname\">close</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Toolbar.close\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Close the toolbar if it&#8217;s opened.</p>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.Toolbar.open\">\n<tt class=\"descname\">open</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.Toolbar.open\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Open the toolbar if it&#8217;s not already opened.</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-odd field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">The toolbar.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"exception\">\n<dt id=\"ubuntuuitoolkit.ToolkitException\">\n<em class=\"property\">exception </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">ToolkitException</tt><a class=\"headerlink\" href=\"#ubuntuuitoolkit.ToolkitException\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">exceptions.Exception</span></tt></p>\n<p>Exception raised when there is an error with the custom proxy object.</p>\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.UbuntuListView11\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">UbuntuListView11</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuListView11\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">ubuntuuitoolkit._custom_proxy_objects._qquicklistview.QQuickListView</span></tt></p>\n<p>Autopilot helper for the UbuntuListView 1.1.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuListView11.manual_refresh_nowait\">\n<tt class=\"descname\">manual_refresh_nowait</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuListView11.manual_refresh_nowait\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuListView11.manual_refresh_wait\">\n<tt class=\"descname\">manual_refresh_wait</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuListView11.manual_refresh_wait\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuListView11.pull_to_refresh_enabled\">\n<tt class=\"descname\">pull_to_refresh_enabled</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuListView11.pull_to_refresh_enabled\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuListView11.wait_refresh_completed\">\n<tt class=\"descname\">wait_refresh_completed</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuListView11.wait_refresh_completed\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n</dd></dl>\n\n<dl class=\"class\">\n<dt id=\"ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase\">\n<em class=\"property\">class </em><tt class=\"descclassname\">ubuntuuitoolkit.</tt><tt class=\"descname\">UbuntuUIToolkitCustomProxyObjectBase</tt><big>(</big><em>*args</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Bases: <tt class=\"xref py py-class docutils literal\"><span class=\"pre\">autopilot.introspection.dbus.CustomEmulatorBase</span></tt></p>\n<p>A base class for all the Ubuntu UI Toolkit custom proxy objects.</p>\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase.is_flickable\">\n<tt class=\"descname\">is_flickable</tt><big>(</big><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase.is_flickable\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Check if the object is flickable.</p>\n<p>If the object has a flicking attribute, we consider it as a flickable.</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-odd field\"><th class=\"field-name\">Returns:</th><td class=\"field-body\">True if the object is flickable. False otherwise.</td>\n</tr>\n</tbody>\n</table>\n</dd></dl>\n\n<dl class=\"method\">\n<dt id=\"ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase.swipe_into_view\">\n<tt class=\"descname\">swipe_into_view</tt><big>(</big><em>instance</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class=\"headerlink\" href=\"#ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase.swipe_into_view\" title=\"Permalink to this definition\">\u00b6</a></dt>\n<dd><p>Make the object visible.</p>\n<p>Currently it works only when the object needs to be swiped vertically.\nTODO implement horizontal swiping. &#8211;elopio - 2014-03-21</p>\n</dd></dl>\n\n</dd></dl>\n\n</div>\n</div>\n", "display_toc": true, "title": "ubuntuuitoolkit Package", "sourcename": "ubuntuuitoolkit.txt", "customsidebar": null, "current_page_name": "ubuntuuitoolkit", "next": null, "rellinks": [["genindex", "General Index", "I", "index"], ["py-modindex", "Python Module Index", "", "modules"], ["index", "Welcome to ubuntu-ui-toolkit-autopilot&#8217;s documentation!", "P", "previous"]], "meta": {}, "parents": [], "sidebars": null, "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">ubuntuuitoolkit Package</a><ul>\n<li><a class=\"reference internal\" href=\"#module-ubuntuuitoolkit\"><tt class=\"docutils literal\"><span class=\"pre\">custom</span> <span class=\"pre\">proxy</span> <span class=\"pre\">object</span></tt> Module</a></li>\n</ul>\n</li>\n</ul>\n", "prev": {"link": "../", "title": "Welcome to ubuntu-ui-toolkit-autopilot&#8217;s documentation!"}, "metatags": ""}