Repository: incubator-senssoft-userale-pyqt5 Updated Branches: refs/heads/gh-pages 7d2c001cf -> b336a4c65
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-userale-pyqt5/blob/b336a4c6/userale.html ---------------------------------------------------------------------- diff --git a/userale.html b/userale.html index a1df634..8d4baa4 100644 --- a/userale.html +++ b/userale.html @@ -8,7 +8,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>ALE Library — UserAle 1.0.4 documentation</title> + <title>ALE Library — Apache UserALE.PyQt5 0.1.5 documentation</title> @@ -30,7 +30,7 @@ - <link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/> + <link rel="top" title="Apache UserALE.PyQt5 0.1.5 documentation" href="index.html"/> <link rel="next" title="Authors" href="authors.html"/> <link rel="prev" title="Quickstart Guide" href="quickstart.html"/> @@ -50,7 +50,7 @@ - <a href="index.html" class="icon icon-home"> UserAle + <a href="index.html" class="icon icon-home"> Apache UserALE.PyQt5 @@ -60,7 +60,7 @@ <div class="version"> - 1.0.4 + 0.1.5 </div> @@ -87,13 +87,13 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">ALE Library</a><ul> -<li class="toctree-l2"><a class="reference internal" href="#module-userale.ale">UserAle</a></li> +<li class="toctree-l2"><a class="reference internal" href="#module-userale.ale">Apache UserALE.PyQt5</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li> -<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li> +<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to Apache UserALE.PyQt5</a></li> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> </ul> @@ -109,7 +109,7 @@ <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">UserAle</a> + <a href="index.html">Apache UserALE.PyQt5</a> </nav> @@ -140,26 +140,27 @@ <div class="section" id="ale-library"> <span id="api"></span><h1>ALE Library<a class="headerlink" href="#ale-library" title="Permalink to this headline">¶</a></h1> -<p>UserALE intercepts all application events by letting the developer install an event filter in their PyQT5 application to generate detailed user logs. UserAle does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).</p> +<p>Apache UserALE.PyQt5 intercepts all application events by letting the developer install an event filter in their PyQt5 application to generate detailed user logs. Apache UserALE.PyQt5 does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).</p> <div class="section" id="module-userale.ale"> -<span id="userale"></span><h2>UserAle<a class="headerlink" href="#module-userale.ale" title="Permalink to this headline">¶</a></h2> +<span id="apache-userale-pyqt5"></span><h2>Apache UserALE.PyQt5<a class="headerlink" href="#module-userale.ale" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="userale.ale.Ale"> -<em class="property">class </em><code class="descclassname">userale.ale.</code><code class="descname">Ale</code><span class="sig-paren">(</span><em>output='userale.log'</em>, <em>interval=5000</em>, <em>user=None</em>, <em>session=None</em>, <em>toolname=None</em>, <em>toolversion=None</em>, <em>keylog=False</em>, <em>resolution=500</em>, <em>shutoff=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">userale.ale.</code><code class="descname">Ale</code><span class="sig-paren">(</span><em>output='userale.log'</em>, <em>user=None</em>, <em>session=None</em>, <em>toolname=None</em>, <em>toolversion=None</em>, <em>keylog=False</em>, <em>interval=5000</em>, <em>resolution=100</em>, <em>shutoff=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">PyQt5.QtCore.QObject</span></code></p> +<p>ALE Library</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 last simple"> <li><strong>output</strong> – [str] The file or url path to which logs will be sent</li> -<li><strong>interval</strong> – [int] The minimum time interval in ms betweeen batch transmission of logs</li> <li><strong>user</strong> – [str] Identifier for the user of the application</li> <li><strong>session</strong> – [str] Session tag to track same user with multiple sessions. If a session is not provided, one will be created</li> <li><strong>toolname</strong> – [str] The application name</li> <li><strong>toolversion</strong> – [str] The application version</li> <li><strong>keylog</strong> – [bool] Should detailed key logs be recorded. Default is False</li> -<li><strong>resolution</strong> – [int] Delay in ms between instances of high frequency logs like movemoves, scrolls, etc</li> +<li><strong>interval</strong> – [int] The minimum time interval in ms between batch transmission of logs. Default is 5000ms.</li> +<li><strong>resolution</strong> – [int] Delay in ms between instances of high frequency logs like mousemoves, scrolls, etc. Default is 100ms (10Hz).</li> <li><strong>shutoff</strong> – [list] Turn off logging for specific events</li> </ul> </td> @@ -179,11 +180,30 @@ <span class="s1">'session'</span><span class="p">:</span> <span class="s1">'5ee42ccc-852c-44d9-a937-28d7901e4ead'</span><span class="p">,</span> <span class="s1">'toolName'</span><span class="p">:</span> <span class="s1">'myApplication'</span><span class="p">,</span> <span class="s1">'toolVersion'</span><span class="p">:</span> <span class="s1">'3.5.0'</span><span class="p">,</span> - <span class="s1">'useraleVersion'</span><span class="p">:</span> <span class="s1">'1.0.0'</span> + <span class="s1">'useraleVersion'</span><span class="p">:</span> <span class="s1">'0.1.0'</span> <span class="p">}</span> </pre></div> </div> <dl class="method"> +<dt id="userale.ale.Ale.aggregate"> +<code class="descname">aggregate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.aggregate" title="Permalink to this definition">¶</a></dt> +<dd><p>Sample high frequency logs at self.resolution. High frequency logs are consolidated down to a single log event +to be emitted later</p> +</dd></dl> + +<dl class="method"> +<dt id="userale.ale.Ale.cleanup"> +<code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.cleanup" title="Permalink to this definition">¶</a></dt> +<dd><p>Clean up any dangling logs in self.logs or self.hlogs</p> +</dd></dl> + +<dl class="method"> +<dt id="userale.ale.Ale.dump"> +<code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.dump" title="Permalink to this definition">¶</a></dt> +<dd><p>Write log data to file</p> +</dd></dl> + +<dl class="method"> <dt id="userale.ale.Ale.eventFilter"> <code class="descname">eventFilter</code><span class="sig-paren">(</span><em>object</em>, <em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.eventFilter" title="Permalink to this definition">¶</a></dt> <dd><table class="docutils field-list" frame="void" rules="none"> @@ -196,12 +216,12 @@ </ul> </td> </tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">[bool] Return true in order to filter the event out (stop it from being handled further). Otherwise return false.</p> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">[bool] Propagate filter up if other objects needs to be handled</p> </td> </tr> </tbody> </table> -<p>Filters events for the watched object (in this case, QApplication)</p> +<p>Filters events for the watched widget.</p> </dd></dl> <dl class="method"> @@ -211,11 +231,11 @@ <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">[str] String representation of the time the event was triggered.</td> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">[str] String representation of the time the event was captured.</td> </tr> </tbody> </table> -<p>Capture the time the event was captured.</p> +<p>Capture the time the event was captured in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC)</p> </dd></dl> <dl class="method"> @@ -243,12 +263,11 @@ <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>object</strong> – [QObject] The base class for all Qt objects.</td> </tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">[list] List of QObjects up to the child object.</td> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">[list] List of QObjects.</td> </tr> </tbody> </table> -<p>Fetch the entire path up the root of the tree for a leaf node object. -Recursive operation.</p> +<p>Generate the entire object hierachy from root to leaf node.</p> </dd></dl> <dl class="method"> @@ -264,7 +283,23 @@ Recursive operation.</p> </tr> </tbody> </table> -<p>Get target object’s name (object defined by user or object’s meta class name)</p> +<p>Get target object’s name (object defined by user or object’s meta class name).</p> +</dd></dl> + +<dl class="method"> +<dt id="userale.ale.Ale.getSender"> +<code class="descname">getSender</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.getSender" title="Permalink to this definition">¶</a></dt> +<dd><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>object</strong> – [QObject] The object being watched.</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">[QObject] The QObject</td> +</tr> +</tbody> +</table> +<p>Fetch the QObject who triggered the event</p> </dd></dl> <dl class="method"> @@ -399,6 +434,22 @@ Recursive operation.</p> <p>Returns the userale log representing all scroll events.</p> </dd></dl> +<dl class="method"> +<dt id="userale.ale.Ale.timerEvent"> +<code class="descname">timerEvent</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#userale.ale.Ale.timerEvent" title="Permalink to this definition">¶</a></dt> +<dd><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>object</strong> – [list] List of events</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">[void] Emit events to file</td> +</tr> +</tbody> +</table> +<p>Routinely dump data to file or send over the network</p> +</dd></dl> + </dd></dl> </div> @@ -423,7 +474,7 @@ Recursive operation.</p> <div role="contentinfo"> <p> - © Copyright 2016, The Charles Stark Draper Laboratory.. + © Copyright 2016, Apache Software License. </p> </div> @@ -445,7 +496,7 @@ Recursive operation.</p> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'1.0.4', + VERSION:'0.1.5', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true
