Skip to content

Commit 519dd78

Browse files
dtmilanodtmilano
committed
Added documentation
- Added Epydoc documentation - Added examples - Fixed issue when no focused window is detected - Added helper static method connectToDeviceOrExit to simplify script creation
1 parent 9dd829b commit 519dd78

37 files changed

Lines changed: 6840 additions & 58 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Compiled classes #
22
####################
33
*$py.class
4+
*.pyc
45

56
# Mac files #
67
#############

‎AndroidViewClient/doc/api-objects.txt‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
com.dtmilano.android com.dtmilano.android-module.html
2+
com.dtmilano.android.__package__ com.dtmilano.android-module.html#__package__
3+
com.dtmilano.android.viewclient com.dtmilano.android.viewclient-module.html
4+
com.dtmilano.android.viewclient.TEXT_PROPERTY com.dtmilano.android.viewclient-module.html#TEXT_PROPERTY
5+
com.dtmilano.android.viewclient.__nd com.dtmilano.android.viewclient-module.html#__nd
6+
com.dtmilano.android.viewclient.WS com.dtmilano.android.viewclient-module.html#WS
7+
com.dtmilano.android.viewclient.DEBUG_COORDS com.dtmilano.android.viewclient-module.html#DEBUG_COORDS
8+
com.dtmilano.android.viewclient.DEBUG_GETATTR com.dtmilano.android.viewclient-module.html#DEBUG_GETATTR
9+
com.dtmilano.android.viewclient.VIEW_SERVER_PORT com.dtmilano.android.viewclient-module.html#VIEW_SERVER_PORT
10+
com.dtmilano.android.viewclient.LAYOUT_TOP_MARGIN_PROPERTY com.dtmilano.android.viewclient-module.html#LAYOUT_TOP_MARGIN_PROPERTY
11+
com.dtmilano.android.viewclient.DEBUG_TREE com.dtmilano.android.viewclient-module.html#DEBUG_TREE
12+
com.dtmilano.android.viewclient.os_name com.dtmilano.android.viewclient-module.html#os_name
13+
com.dtmilano.android.viewclient.__ns com.dtmilano.android.viewclient-module.html#__ns
14+
com.dtmilano.android.viewclient.GET_VISIBILITY_PROPERTY com.dtmilano.android.viewclient-module.html#GET_VISIBILITY_PROPERTY
15+
com.dtmilano.android.viewclient.ADB com.dtmilano.android.viewclient-module.html#ADB
16+
com.dtmilano.android.viewclient.DEBUG_STATUSBAR com.dtmilano.android.viewclient-module.html#DEBUG_STATUSBAR
17+
com.dtmilano.android.viewclient.OFFSET com.dtmilano.android.viewclient-module.html#OFFSET
18+
com.dtmilano.android.viewclient.DEBUG com.dtmilano.android.viewclient-module.html#DEBUG
19+
com.dtmilano.android.viewclient.ANDROID_HOME com.dtmilano.android.viewclient-module.html#ANDROID_HOME
20+
com.dtmilano.android.viewclient.VIEW_SERVER_HOST com.dtmilano.android.viewclient-module.html#VIEW_SERVER_HOST
21+
com.dtmilano.android.viewclient.DEBUG_RECEIVED com.dtmilano.android.viewclient-module.html#DEBUG_RECEIVED
22+
com.dtmilano.android.viewclient.__nh com.dtmilano.android.viewclient-module.html#__nh
23+
com.dtmilano.android.viewclient.DEBUG_TOUCH com.dtmilano.android.viewclient-module.html#DEBUG_TOUCH
24+
com.dtmilano.android.viewclient.EditText com.dtmilano.android.viewclient.EditText-class.html
25+
com.dtmilano.android.viewclient.View.getClass com.dtmilano.android.viewclient.View-class.html#getClass
26+
com.dtmilano.android.viewclient.View.getCoords com.dtmilano.android.viewclient.View-class.html#getCoords
27+
com.dtmilano.android.viewclient.View.__str__ com.dtmilano.android.viewclient.View-class.html#__str__
28+
com.dtmilano.android.viewclient.View.getText com.dtmilano.android.viewclient.View-class.html#getText
29+
com.dtmilano.android.viewclient.View.getWidth com.dtmilano.android.viewclient.View-class.html#getWidth
30+
com.dtmilano.android.viewclient.View.getY com.dtmilano.android.viewclient.View-class.html#getY
31+
com.dtmilano.android.viewclient.View.__getattr__ com.dtmilano.android.viewclient.View-class.html#__getattr__
32+
com.dtmilano.android.viewclient.View.touch com.dtmilano.android.viewclient.View-class.html#touch
33+
com.dtmilano.android.viewclient.View.__init__ com.dtmilano.android.viewclient.View-class.html#__init__
34+
com.dtmilano.android.viewclient.View.getUniqueId com.dtmilano.android.viewclient.View-class.html#getUniqueId
35+
com.dtmilano.android.viewclient.View.getHeight com.dtmilano.android.viewclient.View-class.html#getHeight
36+
com.dtmilano.android.viewclient.View.factory com.dtmilano.android.viewclient.View-class.html#factory
37+
com.dtmilano.android.viewclient.View.getId com.dtmilano.android.viewclient.View-class.html#getId
38+
com.dtmilano.android.viewclient.View.add com.dtmilano.android.viewclient.View-class.html#add
39+
com.dtmilano.android.viewclient.View.__call__ com.dtmilano.android.viewclient.View-class.html#__call__
40+
com.dtmilano.android.viewclient.View.__smallStr__ com.dtmilano.android.viewclient.View-class.html#__smallStr__
41+
com.dtmilano.android.viewclient.View.allPossibleNamesWithColon com.dtmilano.android.viewclient.View-class.html#allPossibleNamesWithColon
42+
com.dtmilano.android.viewclient.View.__getitem__ com.dtmilano.android.viewclient.View-class.html#__getitem__
43+
com.dtmilano.android.viewclient.View.intersection com.dtmilano.android.viewclient.View-class.html#intersection
44+
com.dtmilano.android.viewclient.View.getXY com.dtmilano.android.viewclient.View-class.html#getXY
45+
com.dtmilano.android.viewclient.View.getX com.dtmilano.android.viewclient.View-class.html#getX
46+
com.dtmilano.android.viewclient.View.__tinyStr__ com.dtmilano.android.viewclient.View-class.html#__tinyStr__
47+
com.dtmilano.android.viewclient.View.getVisibility com.dtmilano.android.viewclient.View-class.html#getVisibility
48+
com.dtmilano.android.viewclient.TextView com.dtmilano.android.viewclient.TextView-class.html
49+
com.dtmilano.android.viewclient.View.getClass com.dtmilano.android.viewclient.View-class.html#getClass
50+
com.dtmilano.android.viewclient.View.getCoords com.dtmilano.android.viewclient.View-class.html#getCoords
51+
com.dtmilano.android.viewclient.View.__str__ com.dtmilano.android.viewclient.View-class.html#__str__
52+
com.dtmilano.android.viewclient.View.getText com.dtmilano.android.viewclient.View-class.html#getText
53+
com.dtmilano.android.viewclient.View.getWidth com.dtmilano.android.viewclient.View-class.html#getWidth
54+
com.dtmilano.android.viewclient.View.getY com.dtmilano.android.viewclient.View-class.html#getY
55+
com.dtmilano.android.viewclient.View.__getattr__ com.dtmilano.android.viewclient.View-class.html#__getattr__
56+
com.dtmilano.android.viewclient.View.touch com.dtmilano.android.viewclient.View-class.html#touch
57+
com.dtmilano.android.viewclient.View.__init__ com.dtmilano.android.viewclient.View-class.html#__init__
58+
com.dtmilano.android.viewclient.View.getUniqueId com.dtmilano.android.viewclient.View-class.html#getUniqueId
59+
com.dtmilano.android.viewclient.View.getHeight com.dtmilano.android.viewclient.View-class.html#getHeight
60+
com.dtmilano.android.viewclient.View.factory com.dtmilano.android.viewclient.View-class.html#factory
61+
com.dtmilano.android.viewclient.View.getId com.dtmilano.android.viewclient.View-class.html#getId
62+
com.dtmilano.android.viewclient.View.add com.dtmilano.android.viewclient.View-class.html#add
63+
com.dtmilano.android.viewclient.View.__call__ com.dtmilano.android.viewclient.View-class.html#__call__
64+
com.dtmilano.android.viewclient.View.__smallStr__ com.dtmilano.android.viewclient.View-class.html#__smallStr__
65+
com.dtmilano.android.viewclient.View.allPossibleNamesWithColon com.dtmilano.android.viewclient.View-class.html#allPossibleNamesWithColon
66+
com.dtmilano.android.viewclient.View.__getitem__ com.dtmilano.android.viewclient.View-class.html#__getitem__
67+
com.dtmilano.android.viewclient.View.intersection com.dtmilano.android.viewclient.View-class.html#intersection
68+
com.dtmilano.android.viewclient.View.getXY com.dtmilano.android.viewclient.View-class.html#getXY
69+
com.dtmilano.android.viewclient.View.getX com.dtmilano.android.viewclient.View-class.html#getX
70+
com.dtmilano.android.viewclient.View.__tinyStr__ com.dtmilano.android.viewclient.View-class.html#__tinyStr__
71+
com.dtmilano.android.viewclient.View.getVisibility com.dtmilano.android.viewclient.View-class.html#getVisibility
72+
com.dtmilano.android.viewclient.View com.dtmilano.android.viewclient.View-class.html
73+
com.dtmilano.android.viewclient.View.getClass com.dtmilano.android.viewclient.View-class.html#getClass
74+
com.dtmilano.android.viewclient.View.__obtainVwVh com.dtmilano.android.viewclient.View-class.html#__obtainVwVh
75+
com.dtmilano.android.viewclient.View.getCoords com.dtmilano.android.viewclient.View-class.html#getCoords
76+
com.dtmilano.android.viewclient.View.__str__ com.dtmilano.android.viewclient.View-class.html#__str__
77+
com.dtmilano.android.viewclient.View.getText com.dtmilano.android.viewclient.View-class.html#getText
78+
com.dtmilano.android.viewclient.View.getWidth com.dtmilano.android.viewclient.View-class.html#getWidth
79+
com.dtmilano.android.viewclient.View.getY com.dtmilano.android.viewclient.View-class.html#getY
80+
com.dtmilano.android.viewclient.View.getId com.dtmilano.android.viewclient.View-class.html#getId
81+
com.dtmilano.android.viewclient.View.touch com.dtmilano.android.viewclient.View-class.html#touch
82+
com.dtmilano.android.viewclient.View.__init__ com.dtmilano.android.viewclient.View-class.html#__init__
83+
com.dtmilano.android.viewclient.View.getUniqueId com.dtmilano.android.viewclient.View-class.html#getUniqueId
84+
com.dtmilano.android.viewclient.View.__obtainVxVy com.dtmilano.android.viewclient.View-class.html#__obtainVxVy
85+
com.dtmilano.android.viewclient.View.getHeight com.dtmilano.android.viewclient.View-class.html#getHeight
86+
com.dtmilano.android.viewclient.View.factory com.dtmilano.android.viewclient.View-class.html#factory
87+
com.dtmilano.android.viewclient.View.__getattr__ com.dtmilano.android.viewclient.View-class.html#__getattr__
88+
com.dtmilano.android.viewclient.View.add com.dtmilano.android.viewclient.View-class.html#add
89+
com.dtmilano.android.viewclient.View.__dumpWindowsInformation com.dtmilano.android.viewclient.View-class.html#__dumpWindowsInformation
90+
com.dtmilano.android.viewclient.View.__call__ com.dtmilano.android.viewclient.View-class.html#__call__
91+
com.dtmilano.android.viewclient.View.__smallStr__ com.dtmilano.android.viewclient.View-class.html#__smallStr__
92+
com.dtmilano.android.viewclient.View.allPossibleNamesWithColon com.dtmilano.android.viewclient.View-class.html#allPossibleNamesWithColon
93+
com.dtmilano.android.viewclient.View.__getitem__ com.dtmilano.android.viewclient.View-class.html#__getitem__
94+
com.dtmilano.android.viewclient.View.intersection com.dtmilano.android.viewclient.View-class.html#intersection
95+
com.dtmilano.android.viewclient.View.getXY com.dtmilano.android.viewclient.View-class.html#getXY
96+
com.dtmilano.android.viewclient.View.getX com.dtmilano.android.viewclient.View-class.html#getX
97+
com.dtmilano.android.viewclient.View.__obtainStatusBarDimensionsIfVisible com.dtmilano.android.viewclient.View-class.html#__obtainStatusBarDimensionsIfVisible
98+
com.dtmilano.android.viewclient.View.__tinyStr__ com.dtmilano.android.viewclient.View-class.html#__tinyStr__
99+
com.dtmilano.android.viewclient.View.getVisibility com.dtmilano.android.viewclient.View-class.html#getVisibility
100+
com.dtmilano.android.viewclient.ViewClient com.dtmilano.android.viewclient.ViewClient-class.html
101+
com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTree com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTree
102+
com.dtmilano.android.viewclient.ViewClient.traverse com.dtmilano.android.viewclient.ViewClient-class.html#traverse
103+
com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CIT com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CIT
104+
com.dtmilano.android.viewclient.ViewClient.dump com.dtmilano.android.viewclient.ViewClient-class.html#dump
105+
com.dtmilano.android.viewclient.ViewClient.findViewWithAttribute com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithAttribute
106+
com.dtmilano.android.viewclient.ViewClient.findViewByTag com.dtmilano.android.viewclient.ViewClient-class.html#findViewByTag
107+
com.dtmilano.android.viewclient.ViewClient.device com.dtmilano.android.viewclient.ViewClient-class.html#device
108+
com.dtmilano.android.viewclient.ViewClient.findViewWithAttributeThatMatches com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithAttributeThatMatches
109+
com.dtmilano.android.viewclient.ViewClient.__init__ com.dtmilano.android.viewclient.ViewClient-class.html#__init__
110+
com.dtmilano.android.viewclient.ViewClient.findViewById com.dtmilano.android.viewclient.ViewClient-class.html#findViewById
111+
com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTreeThatMatches com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTreeThatMatches
112+
com.dtmilano.android.viewclient.ViewClient.setViews com.dtmilano.android.viewclient.ViewClient-class.html#setViews
113+
com.dtmilano.android.viewclient.ViewClient.findViewWithText com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithText
114+
com.dtmilano.android.viewclient.ViewClient.__splitAttrs com.dtmilano.android.viewclient.ViewClient-class.html#__splitAttrs
115+
com.dtmilano.android.viewclient.ViewClient.assertServiceResponse com.dtmilano.android.viewclient.ViewClient-class.html#assertServiceResponse
116+
com.dtmilano.android.viewclient.ViewClient.__getFocusedWindowPosition com.dtmilano.android.viewclient.ViewClient-class.html#__getFocusedWindowPosition
117+
com.dtmilano.android.viewclient.ViewClient.parseTree com.dtmilano.android.viewclient.ViewClient-class.html#parseTree
118+
com.dtmilano.android.viewclient.ViewClient.connectToDeviceOrExit com.dtmilano.android.viewclient.ViewClient-class.html#connectToDeviceOrExit
119+
com.dtmilano.android.viewclient.ViewClient.serviceResponse com.dtmilano.android.viewclient.ViewClient-class.html#serviceResponse
120+
com.dtmilano.android.viewclient.ViewClient.getRoot com.dtmilano.android.viewclient.ViewClient-class.html#getRoot
121+
com.dtmilano.android.viewclient.ViewClient.traverseShowClassIdAndText com.dtmilano.android.viewclient.ViewClient-class.html#traverseShowClassIdAndText
122+
com.dtmilano.android.viewclient.ViewClient.getViewIds com.dtmilano.android.viewclient.ViewClient-class.html#getViewIds
123+
com.dtmilano.android.viewclient.ViewClient.viewsById com.dtmilano.android.viewclient.ViewClient-class.html#viewsById
124+
com.dtmilano.android.viewclient.ViewClient.root com.dtmilano.android.viewclient.ViewClient-class.html#root
125+
com.dtmilano.android.viewclient.ViewClient.display com.dtmilano.android.viewclient.ViewClient-class.html#display
126+
com.dtmilano.android.viewclient.Window com.dtmilano.android.viewclient.Window-class.html
127+
com.dtmilano.android.viewclient.Window.__str__ com.dtmilano.android.viewclient.Window-class.html#__str__
128+
com.dtmilano.android.viewclient.Window.__init__ com.dtmilano.android.viewclient.Window-class.html#__init__

‎AndroidViewClient/doc/class-tree.html‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?xml version="1.0" encoding="ascii"?>
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5+
<head>
6+
<title>Class Hierarchy</title>
7+
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8+
<script type="text/javascript" src="epydoc.js"></script>
9+
</head>
10+
11+
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12+
alink="#204080">
13+
<!-- ==================== NAVIGATION BAR ==================== -->
14+
<table class="navbar" border="0" width="100%" cellpadding="0"
15+
bgcolor="#a0c0ff" cellspacing="0">
16+
<tr valign="middle">
17+
<!-- Home link -->
18+
<th>&nbsp;&nbsp;&nbsp;<a
19+
href="com.dtmilano.android-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20+
21+
<!-- Tree link -->
22+
<th bgcolor="#70b0f0" class="navbar-select"
23+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
24+
25+
<!-- Index link -->
26+
<th>&nbsp;&nbsp;&nbsp;<a
27+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28+
29+
<!-- Help link -->
30+
<th>&nbsp;&nbsp;&nbsp;<a
31+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32+
33+
<!-- Project homepage -->
34+
<th class="navbar" align="right" width="100%">
35+
<table border="0" cellpadding="0" cellspacing="0">
36+
<tr><th class="navbar" align="center"
37+
><a class="navbar" target="_top" href="http://dtmilano.com/viewclient">Project Homepage</a></th>
38+
</tr></table></th>
39+
</tr>
40+
</table>
41+
<table width="100%" cellpadding="0" cellspacing="0">
42+
<tr valign="top">
43+
<td width="100%">&nbsp;</td>
44+
<td>
45+
<table cellpadding="0" cellspacing="0">
46+
<!-- hide/show private -->
47+
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48+
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49+
<tr><td align="right"><span class="options"
50+
>[<a href="frames.html" target="_top">frames</a
51+
>]&nbsp;|&nbsp;<a href="class-tree.html"
52+
target="_top">no&nbsp;frames</a>]</span></td></tr>
53+
</table>
54+
</td>
55+
</tr>
56+
</table>
57+
<center><b>
58+
[ <a href="module-tree.html">Module Hierarchy</a>
59+
| <a href="class-tree.html">Class Hierarchy</a> ]
60+
</b></center><br />
61+
<h1 class="epydoc">Class Hierarchy</h1>
62+
<ul class="nomargin-top">
63+
<li> <strong class="uidlink"><a href="com.dtmilano.android.viewclient.View-class.html">com.dtmilano.android.viewclient.View</a></strong>:
64+
<em class="summary">View class</em>
65+
</li>
66+
<li> <strong class="uidlink"><a href="com.dtmilano.android.viewclient.ViewClient-class.html">com.dtmilano.android.viewclient.ViewClient</a></strong>:
67+
<em class="summary">ViewClient is a <i>ViewServer</i> client.</em>
68+
</li>
69+
<li> <strong class="uidlink"><a href="com.dtmilano.android.viewclient.Window-class.html">com.dtmilano.android.viewclient.Window</a></strong>:
70+
<em class="summary">Window class</em>
71+
</li>
72+
</ul>
73+
<!-- ==================== NAVIGATION BAR ==================== -->
74+
<table class="navbar" border="0" width="100%" cellpadding="0"
75+
bgcolor="#a0c0ff" cellspacing="0">
76+
<tr valign="middle">
77+
<!-- Home link -->
78+
<th>&nbsp;&nbsp;&nbsp;<a
79+
href="com.dtmilano.android-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
80+
81+
<!-- Tree link -->
82+
<th bgcolor="#70b0f0" class="navbar-select"
83+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
84+
85+
<!-- Index link -->
86+
<th>&nbsp;&nbsp;&nbsp;<a
87+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
88+
89+
<!-- Help link -->
90+
<th>&nbsp;&nbsp;&nbsp;<a
91+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
92+
93+
<!-- Project homepage -->
94+
<th class="navbar" align="right" width="100%">
95+
<table border="0" cellpadding="0" cellspacing="0">
96+
<tr><th class="navbar" align="center"
97+
><a class="navbar" target="_top" href="http://dtmilano.com/viewclient">Project Homepage</a></th>
98+
</tr></table></th>
99+
</tr>
100+
</table>
101+
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
102+
<tr>
103+
<td align="left" class="footer">
104+
Generated by Epydoc 3.0.1 on Wed Sep 12 23:55:45 2012
105+
</td>
106+
<td align="right" class="footer">
107+
<a target="mainFrame" href="http://epydoc.sourceforge.net"
108+
>http://epydoc.sourceforge.net</a>
109+
</td>
110+
</tr>
111+
</table>
112+
113+
<script type="text/javascript">
114+
<!--
115+
// Private objects are initially displayed (because if
116+
// javascript is turned off then we want them to be
117+
// visible); but by default, we want to hide them. So hide
118+
// them unless we have a cookie that says to show them.
119+
checkCookie();
120+
// -->
121+
</script>
122+
</body>
123+
</html>

0 commit comments

Comments
 (0)