TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>Plugin_Time_Tracker.PluginTimeTracker</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>Plugin_Time_Tracker.PluginTimeTracker</h1>
<p>
Module implementing the Time Tracker plugin.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>timeTrackerPluginObject</td></tr><tr><td>version</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td>
<td>Class implementing the Eric assistant plugin.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td>
<td>Module function to create the Time Tracker configuration page.</td>
</tr><tr>
<td><a href="#getConfigData">getConfigData</a></td>
<td>Module function returning data as required by the configuration dialog.</td>
</tr><tr>
<td><a href="#prepareUninstall">prepareUninstall</a></td>
<td>Module function to prepare for an uninstallation.</td>
</tr>
</table>
<hr /><hr />
<a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a>
<h2>TimeTrackerPlugin</h2>
<p>
    Class implementing the Eric assistant plugin.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>PreferencesKey</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.__checkVersions">__checkVersions</a></td>
<td>Private function to check that the eric5 version is ok.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.getPreferences">getPreferences</a></td>
<td>Public method to retrieve the various settings.</td>
</tr><tr>
<td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td>
<td>Public method to store the various settings.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a>
<h4>TimeTrackerPlugin (Constructor)</h4>
<b>TimeTrackerPlugin</b>(<i>ui</i>)
<p>
        Constructor
</p><dl>
<dt><i>ui</i></dt>
<dd>
reference to the user interface object (UI.UserInterface)
</dd>
</dl><a NAME="TimeTrackerPlugin.__checkVersions" ID="TimeTrackerPlugin.__checkVersions"></a>
<h4>TimeTrackerPlugin.__checkVersions</h4>
<b>__checkVersions</b>(<i></i>)
<p>
        Private function to check that the eric5 version is ok.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating version is ok (boolean)
</dd>
</dl><a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a>
<h4>TimeTrackerPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
<p>
        Private slot to (re)initialize the plugin.
</p><a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a>
<h4>TimeTrackerPlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)
<p>
        Private method to load the translation file.
</p><a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a>
<h4>TimeTrackerPlugin.activate</h4>
<b>activate</b>(<i></i>)
<p>
        Public method to activate this plugin.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple of None and activation status (boolean)
</dd>
</dl><a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a>
<h4>TimeTrackerPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
        Public method to deactivate this plugin.
</p><a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a>
<h4>TimeTrackerPlugin.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
<p>
        Public method to retrieve the various settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
the key of the value to get
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the requested setting
</dd>
</dl><a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a>
<h4>TimeTrackerPlugin.setPreferences</h4>
<b>setPreferences</b>(<i>key, value</i>)
<p>
        Public method to store the various settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
the key of the setting to be set (string)
</dd><dt><i>value</i></dt>
<dd>
the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a>
<h2>createTimeTrackerPage</h2>
<b>createTimeTrackerPage</b>(<i>configDlg</i>)
<p>
    Module function to create the Time Tracker configuration page.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the configuration page
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getConfigData" ID="getConfigData"></a>
<h2>getConfigData</h2>
<b>getConfigData</b>(<i></i>)
<p>
    Module function returning data as required by the configuration dialog.
</p><dl>
<dt>Returns:</dt>
<dd>
dictionary containing the relevant data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
<p>
    Module function to prepare for an uninstallation.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>