--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Utilities.AutoSaver.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,94 @@ +<?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>eric5.Utilities.AutoSaver</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Utilities.AutoSaver</h1> +<p> +Module implementing an auto saver class. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#AutoSaver">AutoSaver</a></td> +<td>Class implementing the auto saver.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="AutoSaver" ID="AutoSaver"></a> +<h2>AutoSaver</h2> +<p> + Class implementing the auto saver. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>AUTOSAVE_IN</td></tr><tr><td>MAXWAIT</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#AutoSaver.__init__">AutoSaver</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#AutoSaver.changeOccurred">changeOccurred</a></td> +<td>Public slot handling a change.</td> +</tr><tr> +<td><a href="#AutoSaver.saveIfNeccessary">saveIfNeccessary</a></td> +<td>Public method to activate the save operation.</td> +</tr><tr> +<td><a href="#AutoSaver.timerEvent">timerEvent</a></td> +<td>Protected method handling timer events.</td> +</tr> +</table> +<a NAME="AutoSaver.__init__" ID="AutoSaver.__init__"></a> +<h4>AutoSaver (Constructor)</h4> +<b>AutoSaver</b>(<i>parent, save</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd><dt><i>save</i></dt> +<dd> +slot to be called to perform the save operation +</dd> +</dl><a NAME="AutoSaver.changeOccurred" ID="AutoSaver.changeOccurred"></a> +<h4>AutoSaver.changeOccurred</h4> +<b>changeOccurred</b>(<i></i>) +<p> + Public slot handling a change. +</p><a NAME="AutoSaver.saveIfNeccessary" ID="AutoSaver.saveIfNeccessary"></a> +<h4>AutoSaver.saveIfNeccessary</h4> +<b>saveIfNeccessary</b>(<i></i>) +<p> + Public method to activate the save operation. +</p><a NAME="AutoSaver.timerEvent" ID="AutoSaver.timerEvent"></a> +<h4>AutoSaver.timerEvent</h4> +<b>timerEvent</b>(<i>evt</i>) +<p> + Protected method handling timer events. +</p><dl> +<dt><i>evt</i></dt> +<dd> +reference to the timer event (QTimerEvent) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file