Update docs for 0.5.4.

gerrit-rws · Oct 29, 2015 · 94f4191 · 94f4191
1 parent 57f6f68
commit 94f4191
Show file tree

Hide file tree

Showing 60 changed files with 487 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,10 @@ pywinauto
 ============
 
 [![Join the chat at https://gitter.im/pywinauto/pywinauto](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pywinauto/pywinauto?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-pywinauto (c) Mark Mc Mahon
+
+Current 0.5.x maintainance is lead by © Intel Corporation, 2015
+
+pywinauto (c) Mark Mc Mahon and [Contributors](https://github.com/pywinauto/pywinauto/graphs/contributors), 2006-2015
 
 pywinauto is a set of python modules to automate the Microsoft Windows GUI. 
 At it’s simplest it allows you to send mouse and keyboard actions to windows 

diff --git a/doc_src/HISTORY.TXT b/doc_src/HISTORY.TXT
@@ -2,6 +2,22 @@
 Change Log
 ==========
 
+0.5.4 Bug fixes and partial MFC Menu Bar support
+--------------------------------------------------------------------
+30-October-2015
+ * Fix bugs and inconsistencies:
+
+   - Add `where="check"` possible value to the ListViewWrapper.Click/ClickInput` methods.
+
+   - Add `CheckByClickInput` and `UncheckByClickInput` methods for a plain check box.
+
+   - Fix crash while waiting for the window start.
+
+ * Add partial MFC Menu Bar support. The menu bar can be interpreted as a toolbar. Items are clickable by index through experimental `MenuBarClickInput` method of the `ToolbarWrapper`.
+
+ * Python 3.5 is supported.
+
+
 0.5.3 Better Unicode support for SetEditText/TypeKeys and menu items
 --------------------------------------------------------------------
 25-September-2015

diff --git a/doc_src/conf.py b/doc_src/conf.py
@@ -65,9 +65,9 @@
 # built documents.
 #
 # The short X.Y version.
-#version = '0.5.3'
+#version = '0.5.4'
 # The full version, including alpha/beta/rc tags.
-#release = '0.5.3'
+#release = '0.5.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc_src/index.txt b/doc_src/index.txt
@@ -1,9 +1,12 @@
 ====================
 What is pywinauto
 ====================
-(0.5.x releases are maintained by Intel Corporation, 2015)
 
-© Mark Mc Mahon
+0.6+ development is on the roadmap of the Open Source community (https://github.com/pywinauto)
+
+Current 0.5.x maintainance is lead by © Intel Corporation, 2015
+
+© Mark Mc Mahon, 2006-2014
 
 Released under the LGPL v2.1 or later
 
@@ -89,14 +92,16 @@ Some similar tools for comparison
 ---------------------------------
 * Python tools
 
-  - PyAutoGui (https://github.com/asweigart/pyautogui)
-  - AXUI (https://github.com/xcgspring/AXUI)
-  - winGuiAuto (http://www.brunningonline.net/simon/blog/archives/winGuiAuto.py.html)
+  - PyAutoGui (https://github.com/asweigart/pyautogui) - it's a cross-platform but there is no windows/controls manipulation at all.
+  - AXUI (https://github.com/xcgspring/AXUI) - this is one of the wrappers around UI Automation API.
+  - winGuiAuto (http://www.brunningonline.net/simon/blog/archives/winGuiAuto.py.html) - another module using Win32 API.
 
 * Other scripting language tools
 
   - Perl Win32::GuiTest  (http://winguitest.sourceforge.net/)
   - Ruby Win32-Autogui (https://github.com/robertwahler/win32-autogui)
+  - Ruby RAutomation (https://github.com/jarmo/RAutomation) - there are 3 adapters: Win32 API, UIA, AutoIt.
+  - C# Winium.Desktop (https://github.com/2gis/Winium.Desktop)
   - others (http://www.opensourcetesting.org/functional.php)
 
 * Other free tools

diff --git a/pywinauto/__init__.py b/pywinauto/__init__.py
@@ -26,7 +26,7 @@
 """
 from __future__ import absolute_import
 
-__version__ = "0.5.3"
+__version__ = "0.5.4"
 
 from . import findwindows
 WindowAmbiguousError = findwindows.WindowAmbiguousError

diff --git a/pywinauto/docs/.buildinfo b/pywinauto/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 39c2f0662734f90001ecf50e7963a505
+config: 8e20465619f43b2c75c600029c6e7bdd
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/pywinauto/docs/HISTORY.html b/pywinauto/docs/HISTORY.html
diff --git a/pywinauto/docs/HowTo.html b/pywinauto/docs/HowTo.html
diff --git a/pywinauto/docs/TODO.html b/pywinauto/docs/TODO.html
diff --git a/pywinauto/docs/_sources/HISTORY.txt b/pywinauto/docs/_sources/HISTORY.txt
@@ -2,8 +2,24 @@
 Change Log
 ==========
 
+0.5.4 Bug fixes and partial MFC Menu Bar support
+--------------------------------------------------------------------
+30-October-2015
+ * Fix bugs and inconsistencies:
+
+   - Add `where="check"` possible value to the ListViewWrapper.Click/ClickInput` methods.
+
+   - Add `CheckByClickInput` and `UncheckByClickInput` methods for a plain check box.
+
+   - Fix crash while waiting for the window start.
+
+ * Add partial MFC Menu Bar support. The menu bar can be interpreted as a toolbar. Items are clickable by index through experimental `MenuBarClickInput` method of the `ToolbarWrapper`.
+
+ * Python 3.5 is supported.
+
+
 0.5.3 Better Unicode support for SetEditText/TypeKeys and menu items
-------------------------------------------------------------------
+--------------------------------------------------------------------
 25-September-2015
  * Better backward compatibility with pywinauto 0.4.2:
 

diff --git a/pywinauto/docs/_sources/code/pywinauto.application.txt b/pywinauto/docs/_sources/code/pywinauto.application.txt
@@ -1,27 +1,7 @@
-pywinauto.application
----------------------
-
- .. automodule:: pywinauto.application
-
-    .. autoclass:: pywinauto.application.Application
-        :undoc-members:
-        :show-inheritance:
-        :members: __getattr__, __getitem__, active_, connect_, kill_, start_, top_window_, window_, windows_, is64bit, CPUUsage, WaitCPUUsageLower 
-
-    .. autoclass:: pywinauto.application.WindowSpecification
-        :members: ChildWindow, Exists, PrintControlIdentifiers, Wait, WaitNot, WrapperObject
-
-        .. automethod:: pywinauto.application.WindowSpecification.__getitem__
-        .. automethod:: pywinauto.application.WindowSpecification.__getattr__
-
-    .. autofunction:: pywinauto.application.process_from_module
-
-    .. autofunction:: pywinauto.application.process_module
-
-    Exceptions
-    ==========
-    .. autoclass:: pywinauto.application.AppNotConnected
-    .. autoclass:: pywinauto.application.AppStartError
-    .. autoclass:: pywinauto.application.AssertValidProcess
-    .. autoclass:: pywinauto.application.ProcessNotFoundError
+pywinauto.application module
+----------------------------
 
+.. automodule:: pywinauto.application
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/pywinauto/docs/_sources/code/pywinauto.controls.common_controls.txt b/pywinauto/docs/_sources/code/pywinauto.controls.common_controls.txt
@@ -1,12 +1,7 @@
 pywinauto.controls.common_controls
 ----------------------------------
+
  .. automodule:: pywinauto.controls.common_controls
     :members:
+    :undoc-members:
     :show-inheritance:
-
- .. autoclass:: pywinauto.controls.common_controls._treeview_element
-    :members:
-
- .. autoclass:: pywinauto.controls.common_controls._toolbar_button
-    :members:
-
diff --git a/pywinauto/docs/_sources/controls_overview.txt b/pywinauto/docs/_sources/controls_overview.txt
@@ -2,7 +2,7 @@
 Methods available to each different control type
 ============================================================
 
-Windows has many controls, buttons, lists, etc
+Windows have many controls, buttons, lists, etc
 
 
 All Controls
@@ -426,7 +426,7 @@ TreeView
 .. _TreeViewElement.Next: code/pywinauto.controls.common_controls.html#pywinauto.controls.common_controls._treeview_element.Next
 .. _TreeViewElement.Rectangle: code/pywinauto.controls.common_controls.html#pywinauto.controls.common_controls._treeview_element.Rectangle
 .. _TreeViewElement.State: code/pywinauto.controls.common_controls.html#pywinauto.controls.common_controls._treeview_element.State
-.. _TreeViewElement.SubElements: code/pywinauto.controlscommon_controls.html#pywinauto.controls.common_controls._treeview_element.SubElements
+.. _TreeViewElement.SubElements: code/pywinauto.controls.common_controls.html#pywinauto.controls.common_controls._treeview_element.SubElements
 .. _TreeViewElement.Text: code/pywinauto.controls.common_controls.html#pywinauto.controls.common_controls._treeview_element.Text
 
 

diff --git a/pywinauto/docs/_sources/index.txt b/pywinauto/docs/_sources/index.txt
diff --git a/pywinauto/docs/_sources/wait_long_operations.txt b/pywinauto/docs/_sources/wait_long_operations.txt
@@ -9,7 +9,7 @@ timeout). There are few methods/functions that could help you to make
 your code easier and more reliable.
 
 Application methods
-------------
+-------------------
 
   * WaitCPUUsageLower_ (new in pywinauto 0.5.2)
 
@@ -25,7 +25,8 @@ Example: ::
 
 
 WindowSpecification methods
-------------
+---------------------------
+
 These methods are available to all controls.
 
   * Wait_
@@ -39,7 +40,8 @@ It's just a description namely a couple of criteria to search the window. The ``
 can guarantee that the target control exists or even visible, enabled and/or active.
 
 Functions in ``timings`` module
-------------
+-------------------------------
+
 There are also low-level methods useful for any Python code.
 
   * WaitUntil_
@@ -54,7 +56,8 @@ There are also low-level methods useful for any Python code.
 
 
 Identify controls
-------------
+-----------------
+
 The methods to help you to find a needed control.
 
   * PrintControlIdentifiers_

diff --git a/pywinauto/docs/code/code.html b/pywinauto/docs/code/code.html
diff --git a/pywinauto/docs/code/pywinauto.RemoteMemoryBlock.html b/pywinauto/docs/code/pywinauto.RemoteMemoryBlock.html
diff --git a/pywinauto/docs/code/pywinauto.SendKeysCtypes.html b/pywinauto/docs/code/pywinauto.SendKeysCtypes.html
diff --git a/pywinauto/docs/code/pywinauto.XMLHelpers.html b/pywinauto/docs/code/pywinauto.XMLHelpers.html
diff --git a/pywinauto/docs/code/pywinauto.actionlogger.html b/pywinauto/docs/code/pywinauto.actionlogger.html
diff --git a/pywinauto/docs/code/pywinauto.application.html b/pywinauto/docs/code/pywinauto.application.html
diff --git a/pywinauto/docs/code/pywinauto.clipboard.html b/pywinauto/docs/code/pywinauto.clipboard.html
diff --git a/pywinauto/docs/code/pywinauto.controlproperties.html b/pywinauto/docs/code/pywinauto.controlproperties.html
diff --git a/pywinauto/docs/code/pywinauto.controls.HwndWrapper.html b/pywinauto/docs/code/pywinauto.controls.HwndWrapper.html
diff --git a/pywinauto/docs/code/pywinauto.controls.common_controls.html b/pywinauto/docs/code/pywinauto.controls.common_controls.html
diff --git a/pywinauto/docs/code/pywinauto.controls.menuwrapper.html b/pywinauto/docs/code/pywinauto.controls.menuwrapper.html
diff --git a/pywinauto/docs/code/pywinauto.controls.win32_controls.html b/pywinauto/docs/code/pywinauto.controls.win32_controls.html
diff --git a/pywinauto/docs/code/pywinauto.findbestmatch.html b/pywinauto/docs/code/pywinauto.findbestmatch.html
diff --git a/pywinauto/docs/code/pywinauto.findwindows.html b/pywinauto/docs/code/pywinauto.findwindows.html
diff --git a/pywinauto/docs/code/pywinauto.fuzzydict.html b/pywinauto/docs/code/pywinauto.fuzzydict.html
diff --git a/pywinauto/docs/code/pywinauto.handleprops.html b/pywinauto/docs/code/pywinauto.handleprops.html
diff --git a/pywinauto/docs/code/pywinauto.six.html b/pywinauto/docs/code/pywinauto.six.html
diff --git a/pywinauto/docs/code/pywinauto.sysinfo.html b/pywinauto/docs/code/pywinauto.sysinfo.html
diff --git a/pywinauto/docs/code/pywinauto.taskbar.html b/pywinauto/docs/code/pywinauto.taskbar.html
diff --git a/pywinauto/docs/code/pywinauto.tests.allcontrols.html b/pywinauto/docs/code/pywinauto.tests.allcontrols.html
diff --git a/pywinauto/docs/code/pywinauto.tests.asianhotkey.html b/pywinauto/docs/code/pywinauto.tests.asianhotkey.html
diff --git a/pywinauto/docs/code/pywinauto.tests.comboboxdroppedheight.html b/pywinauto/docs/code/pywinauto.tests.comboboxdroppedheight.html
diff --git a/pywinauto/docs/code/pywinauto.tests.comparetoreffont.html b/pywinauto/docs/code/pywinauto.tests.comparetoreffont.html
diff --git a/pywinauto/docs/code/pywinauto.tests.leadtrailspaces.html b/pywinauto/docs/code/pywinauto.tests.leadtrailspaces.html
diff --git a/pywinauto/docs/code/pywinauto.tests.miscvalues.html b/pywinauto/docs/code/pywinauto.tests.miscvalues.html
diff --git a/pywinauto/docs/code/pywinauto.tests.missalignment.html b/pywinauto/docs/code/pywinauto.tests.missalignment.html
diff --git a/pywinauto/docs/code/pywinauto.tests.missingextrastring.html b/pywinauto/docs/code/pywinauto.tests.missingextrastring.html
diff --git a/pywinauto/docs/code/pywinauto.tests.overlapping.html b/pywinauto/docs/code/pywinauto.tests.overlapping.html
diff --git a/pywinauto/docs/code/pywinauto.tests.repeatedhotkey.html b/pywinauto/docs/code/pywinauto.tests.repeatedhotkey.html
diff --git a/pywinauto/docs/code/pywinauto.tests.translation.html b/pywinauto/docs/code/pywinauto.tests.translation.html
diff --git a/pywinauto/docs/code/pywinauto.tests.truncation.html b/pywinauto/docs/code/pywinauto.tests.truncation.html
diff --git a/pywinauto/docs/code/pywinauto.timings.html b/pywinauto/docs/code/pywinauto.timings.html
diff --git a/pywinauto/docs/contents.html b/pywinauto/docs/contents.html
diff --git a/pywinauto/docs/controls_overview.html b/pywinauto/docs/controls_overview.html
diff --git a/pywinauto/docs/credits.html b/pywinauto/docs/credits.html
diff --git a/pywinauto/docs/dev_notes.html b/pywinauto/docs/dev_notes.html