/usr/share/doc/python-autopilot/html/api/process.html is in python-autopilot 1.4.1+15.10.20150911-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>autopilot.process - Process Control — Autopilot 1.4.1+15.10.20150911-0 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/otto.css" type="text/css" />
<link rel="stylesheet" href="../_static/centertext.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.4.1+15.10.20150911-0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Autopilot 1.4.1+15.10.20150911-0 documentation" href="../index.html" />
<link rel="up" title="Autopilot API Documentation" href="index.html" />
<link rel="next" title="autopilot.testcase - Base class for all Autopilot Test Cases" href="testcase.html" />
<link rel="prev" title="autopilot.platform - Functions for platform detection" href="platform.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="testcase.html" title="autopilot.testcase - Base class for all Autopilot Test Cases"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="platform.html" title="autopilot.platform - Functions for platform detection"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.4.1+15.10.20150911-0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Autopilot API Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-autopilot.process">
<span id="autopilot-process-process-control"></span><h1><code class="docutils literal"><span class="pre">autopilot.process</span></code> - Process Control<a class="headerlink" href="#module-autopilot.process" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="autopilot.process.ProcessManager">
<em class="property">class </em><code class="descclassname">autopilot.process.</code><code class="descname">ProcessManager</code><a class="reference internal" href="../_modules/autopilot/process.html#ProcessManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.ProcessManager" title="Permalink to this definition">¶</a></dt>
<dd><p>A simple process manager class.</p>
<p>The process manager is used to handle processes, windows and applications.
This class should not be instantiated directly however. To get an instance
of the keyboard class, call <a class="reference internal" href="#autopilot.process.ProcessManager.create" title="autopilot.process.ProcessManager.create"><code class="xref py py-meth docutils literal"><span class="pre">create</span></code></a> instead.</p>
<dl class="attribute">
<dt id="autopilot.process.ProcessManager.KNOWN_APPS">
<code class="descname">KNOWN_APPS</code><em class="property"> = {'Remmina': {'process-name': 'remmina', 'desktop-file': 'remmina.desktop'}, 'Calculator': {'process-name': 'gnome-calculator', 'desktop-file': 'gnome-calculator.desktop'}, 'Terminal': {'process-name': 'gnome-terminal', 'desktop-file': 'gnome-terminal.desktop'}, 'Text Editor': {'process-name': 'gedit', 'desktop-file': 'gedit.desktop'}, 'System Settings': {'process-name': 'gnome-control-center', 'desktop-file': 'gnome-control-center.desktop'}, 'Mahjongg': {'process-name': 'gnome-mahjongg', 'desktop-file': 'gnome-mahjongg.desktop'}, 'Character Map': {'process-name': 'gucharmap', 'desktop-file': 'gucharmap.desktop'}}</em><a class="headerlink" href="#autopilot.process.ProcessManager.KNOWN_APPS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="autopilot.process.ProcessManager.create">
<em class="property">static </em><code class="descname">create</code><span class="sig-paren">(</span><em>preferred_backend=''</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an instance of the <a class="reference internal" href="#autopilot.process.ProcessManager" title="autopilot.process.ProcessManager"><code class="xref py py-class docutils literal"><span class="pre">ProcessManager</span></code></a> class.</p>
<p>For more infomration on picking specific backends, see
<a class="reference internal" href="../tutorial/advanced_autopilot.html#tut-picking-backends"><span>Advanced Backend Picking</span></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>preferred_backend</strong> – <p>A string containing a hint as to which
backend you would like. Possible backends are:</p>
<ul>
<li><dl class="first docutils">
<dt><code class="docutils literal"><span class="pre">BAMF</span></code> - Get process information using the BAMF Application</dt>
<dd>Matching Framework.</dd>
</dl>
</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">RuntimeError if autopilot cannot instantate any of the
possible backends.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body">RuntimeError if the preferred_backend is specified and is not
one of the possible backends for this device class.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">BackendException</span></code> if the preferred_backend
is set, but that backend could not be instantiated.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="autopilot.process.ProcessManager.register_known_application">
<em class="property">classmethod </em><code class="descname">register_known_application</code><span class="sig-paren">(</span><em>name</em>, <em>desktop_file</em>, <em>process_name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.register_known_application" title="Permalink to this definition">¶</a></dt>
<dd><p>Register an application with autopilot.</p>
<p>After calling this method, you may call <a class="reference internal" href="#autopilot.process.ProcessManager.start_app" title="autopilot.process.ProcessManager.start_app"><code class="xref py py-meth docutils literal"><span class="pre">start_app</span></code></a> or
<a class="reference internal" href="#autopilot.process.ProcessManager.start_app_window" title="autopilot.process.ProcessManager.start_app_window"><code class="xref py py-meth docutils literal"><span class="pre">start_app_window</span></code></a> with the <cite>name</cite> parameter to start this
application.
You need only call this once within a test run - the application will
remain registerred until the test run ends.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – The name to be used when launching the application.</li>
<li><strong>desktop_file</strong> – The filename (without path component) of the
desktop file used to launch the application.</li>
<li><strong>process_name</strong> – The name of the executable process that gets run.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>KeyError</strong> if application has been registered already</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="autopilot.process.ProcessManager.unregister_known_application">
<em class="property">classmethod </em><code class="descname">unregister_known_application</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.unregister_known_application" title="Permalink to this definition">¶</a></dt>
<dd><p>Unregister an application with the known_apps dictionary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – The name to be used when launching the application.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>KeyError</strong> if the application has not been registered.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.start_app">
<code class="descname">start_app</code><span class="sig-paren">(</span><em>app_name</em>, <em>files=[]</em>, <em>locale=None</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.start_app" title="Permalink to this definition">¶</a></dt>
<dd><p>Start one of the known applications, and kill it on tear down.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This method will clear all instances of this application
on tearDown, not just the one opened by this method! We recommend that
you use the <a class="reference internal" href="#autopilot.process.ProcessManager.start_app_window" title="autopilot.process.ProcessManager.start_app_window"><code class="xref py py-meth docutils literal"><span class="pre">start_app_window</span></code></a> method instead, as it is
generally safer.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>app_name</strong> – The application name. <em>This name must either already
be registered as one of the built-in applications that are supported
by autopilot, or must have been registered using</em>
<a class="reference internal" href="#autopilot.process.ProcessManager.register_known_application" title="autopilot.process.ProcessManager.register_known_application"><code class="xref py py-meth docutils literal"><span class="pre">register_known_application</span></code></a> <em>beforehand.</em></li>
<li><strong>files</strong> – (Optional) A list of paths to open with the
given application. <em>Not all applications support opening files in this
way.</em></li>
<li><strong>locale</strong> – (Optional) The locale will to set when the application
is launched. <em>If you want to launch an application without any
localisation being applied, set this parameter to ‘C’.</em></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <a class="reference internal" href="#autopilot.process.Application" title="autopilot.process.Application"><code class="xref py py-class docutils literal"><span class="pre">Application</span></code></a> instance.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.start_app_window">
<code class="descname">start_app_window</code><span class="sig-paren">(</span><em>app_name</em>, <em>files=[]</em>, <em>locale=None</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.start_app_window" title="Permalink to this definition">¶</a></dt>
<dd><p>Open a single window for one of the known applications, and close it
at the end of the test.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>app_name</strong> – The application name. <em>This name must either already
be registered as one of the built-in applications that are supported
by autopilot, or must have been registered with</em>
<a class="reference internal" href="#autopilot.process.ProcessManager.register_known_application" title="autopilot.process.ProcessManager.register_known_application"><code class="xref py py-meth docutils literal"><span class="pre">register_known_application</span></code></a> <em>beforehand.</em></li>
<li><strong>files</strong> – (Optional) Should be a list of paths to open with the
given application. <em>Not all applications support opening files in this
way.</em></li>
<li><strong>locale</strong> – (Optional) The locale will to set when the application
is launched. <em>If you want to launch an application without any
localisation being applied, set this parameter to ‘C’.</em></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>AssertionError</strong> if no window was opened, or more than one
window was opened.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <a class="reference internal" href="#autopilot.process.Window" title="autopilot.process.Window"><code class="xref py py-class docutils literal"><span class="pre">Window</span></code></a> instance.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.get_open_windows_by_application">
<code class="descname">get_open_windows_by_application</code><span class="sig-paren">(</span><em>app_name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.get_open_windows_by_application" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of ~autopilot.process.Window` instances
for the given application name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>app_name</strong> – The name of one of the well-known applications.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of <a class="reference internal" href="#autopilot.process.Window" title="autopilot.process.Window"><code class="xref py py-class docutils literal"><span class="pre">Window</span></code></a>
instances.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.close_all_app">
<code class="descname">close_all_app</code><span class="sig-paren">(</span><em>app_name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.close_all_app" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.get_app_instances">
<code class="descname">get_app_instances</code><span class="sig-paren">(</span><em>app_name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.get_app_instances" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.app_is_running">
<code class="descname">app_is_running</code><span class="sig-paren">(</span><em>app_name</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.app_is_running" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.get_running_applications">
<code class="descname">get_running_applications</code><span class="sig-paren">(</span><em>user_visible_only=True</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.get_running_applications" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of the currently running applications.</p>
<p>If user_visible_only is True (the default), only applications
visible to the user in the switcher will be returned.</p>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.get_running_applications_by_desktop_file">
<code class="descname">get_running_applications_by_desktop_file</code><span class="sig-paren">(</span><em>desktop_file</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.get_running_applications_by_desktop_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of applications with the desktop file <em>desktop_file</em>.</p>
<p>This method will return an empty list if no applications
are found with the specified desktop file.</p>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.get_open_windows">
<code class="descname">get_open_windows</code><span class="sig-paren">(</span><em>user_visible_only=True</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.get_open_windows" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of currently open windows.</p>
<p>If <em>user_visible_only</em> is True (the default), only applications visible
to the user in the switcher will be returned.</p>
<p>The result is sorted to be in stacking order.</p>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.wait_until_application_is_running">
<code class="descname">wait_until_application_is_running</code><span class="sig-paren">(</span><em>desktop_file</em>, <em>timeout</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.wait_until_application_is_running" title="Permalink to this definition">¶</a></dt>
<dd><p>Wait until a given application is running.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>desktop_file</strong> (<em>string</em>) – The name of the application desktop file.</li>
<li><strong>timeout</strong> (<em>integer</em>) – The maximum time to wait, in seconds. <em>If set
to something less than 0, this method will wait forever.</em></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">true once the application is found, or false if the
application was not found until the timeout was reached.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.ProcessManager.launch_application">
<code class="descname">launch_application</code><span class="sig-paren">(</span><em>desktop_file</em>, <em>files=[]</em>, <em>wait=True</em><span class="sig-paren">)</span><a class="headerlink" href="#autopilot.process.ProcessManager.launch_application" title="Permalink to this definition">¶</a></dt>
<dd><p>Launch an application by specifying a desktop file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>files</strong> (<em>List of strings</em>) – List of files to pass to the application. <em>Not all
apps support this.</em></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If <cite>wait</cite> is True, this method will wait up to 10 seconds for
the application to appear.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>TypeError</strong> on invalid <em>files</em> parameter.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Gobject process object.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="autopilot.process.Application">
<em class="property">class </em><code class="descclassname">autopilot.process.</code><code class="descname">Application</code><a class="reference internal" href="../_modules/autopilot/process.html#Application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.Application" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="autopilot.process.Application.desktop_file">
<code class="descname">desktop_file</code><a class="headerlink" href="#autopilot.process.Application.desktop_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the application desktop file.</p>
<p>This returns just the filename, not the full path.
If the application no longer exists, this returns an empty string.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Application.name">
<code class="descname">name</code><a class="headerlink" href="#autopilot.process.Application.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the application name.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This may change according to the current locale. If you want
a unique string to match applications against, use desktop_file
instead.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Application.icon">
<code class="descname">icon</code><a class="headerlink" href="#autopilot.process.Application.icon" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the application icon.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The name of the icon.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Application.is_active">
<code class="descname">is_active</code><a class="headerlink" href="#autopilot.process.Application.is_active" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the application active (i.e. has keyboard focus)?</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Application.is_urgent">
<code class="descname">is_urgent</code><a class="headerlink" href="#autopilot.process.Application.is_urgent" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the application currently signalling urgency?</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Application.user_visible">
<code class="descname">user_visible</code><a class="headerlink" href="#autopilot.process.Application.user_visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this application visible to the user?</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Some applications (such as the panel) are hidden to the user
but may still be returned.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.Application.get_windows">
<code class="descname">get_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/process.html#Application.get_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.Application.get_windows" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of the application windows.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="autopilot.process.Window">
<em class="property">class </em><code class="descclassname">autopilot.process.</code><code class="descname">Window</code><a class="reference internal" href="../_modules/autopilot/process.html#Window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.Window" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="autopilot.process.Window.x_id">
<code class="descname">x_id</code><a class="headerlink" href="#autopilot.process.Window.x_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the X11 Window Id.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.x_win">
<code class="descname">x_win</code><a class="headerlink" href="#autopilot.process.Window.x_win" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the X11 window object of the underlying window.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.get_wm_state">
<code class="descname">get_wm_state</code><a class="headerlink" href="#autopilot.process.Window.get_wm_state" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the state of the underlying window.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.name">
<code class="descname">name</code><a class="headerlink" href="#autopilot.process.Window.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the window name.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This may change according to the current locale. If you want
a unique string to match windows against, use the x_id instead.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.title">
<code class="descname">title</code><a class="headerlink" href="#autopilot.process.Window.title" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the window title.</p>
<p>This may be different from the application name.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This may change depending on the current locale.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.geometry">
<code class="descname">geometry</code><a class="headerlink" href="#autopilot.process.Window.geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the geometry for this window.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Tuple containing (x, y, width, height).</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.is_maximized">
<code class="descname">is_maximized</code><a class="headerlink" href="#autopilot.process.Window.is_maximized" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the window maximized?</p>
<p>Maximized in this case means both maximized vertically and
horizontally. If a window is only maximized in one direction it is not
considered maximized.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.application">
<code class="descname">application</code><a class="headerlink" href="#autopilot.process.Window.application" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the application that owns this window.</p>
<p>This method may return None if the window does not have an associated
application. The ‘desktop’ window is one such example.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.user_visible">
<code class="descname">user_visible</code><a class="headerlink" href="#autopilot.process.Window.user_visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this window visible to the user in the switcher?</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.is_hidden">
<code class="descname">is_hidden</code><a class="headerlink" href="#autopilot.process.Window.is_hidden" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this window hidden?</p>
<p>Windows are hidden when the ‘Show Desktop’ mode is activated.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.is_focused">
<code class="descname">is_focused</code><a class="headerlink" href="#autopilot.process.Window.is_focused" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this window focused?</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.is_valid">
<code class="descname">is_valid</code><a class="headerlink" href="#autopilot.process.Window.is_valid" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this window object valid?</p>
<p>Invalid windows are caused by windows closing during the construction
of this object instance.</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.monitor">
<code class="descname">monitor</code><a class="headerlink" href="#autopilot.process.Window.monitor" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the monitor to which the windows belongs to</p>
</dd></dl>
<dl class="attribute">
<dt id="autopilot.process.Window.closed">
<code class="descname">closed</code><a class="headerlink" href="#autopilot.process.Window.closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the window has been closed</p>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.Window.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/process.html#Window.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.Window.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close the window.</p>
</dd></dl>
<dl class="method">
<dt id="autopilot.process.Window.set_focus">
<code class="descname">set_focus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/process.html#Window.set_focus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.process.Window.set_focus" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/otto-64.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="platform.html"
title="previous chapter"><code class="docutils literal"><span class="pre">autopilot.platform</span></code> - Functions for platform detection</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="testcase.html"
title="next chapter"><code class="docutils literal"><span class="pre">autopilot.testcase</span></code> - Base class for all Autopilot Test Cases</a></p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="testcase.html" title="autopilot.testcase - Base class for all Autopilot Test Cases"
>next</a> |</li>
<li class="right" >
<a href="platform.html" title="autopilot.platform - Functions for platform detection"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.4.1+15.10.20150911-0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Autopilot API Documentation</a> »</li>
</ul>
</div>
<div class="footer">
<div class=center_text>
<a href="../faq/contribute.html">Learn how you can contribute!</a> / <a href="https://bugs.launchpad.net/autopilot/+filebug">File a bug</a>
<br/>
</div>
© Copyright 2012-2013, Canonical.
</div>
</body>
</html>
|