|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric4.Utilities.AutoSaver</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric4.Utilities.AutoSaver</h1> |
|
24 <p> |
|
25 Module implementing an auto saver class. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#AutoSaver">AutoSaver</a></td> |
|
35 <td>Class implementing the auto saver.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="AutoSaver" ID="AutoSaver"></a> |
|
44 <h2>AutoSaver</h2> |
|
45 <p> |
|
46 Class implementing the auto saver. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 QObject |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>AUTOSAVE_IN</td></tr><tr><td>MAXWAIT</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#AutoSaver.__init__">AutoSaver</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#AutoSaver.changeOccurred">changeOccurred</a></td> |
|
61 <td>Public slot handling a change.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#AutoSaver.saveIfNeccessary">saveIfNeccessary</a></td> |
|
64 <td>Public method to activate the save operation.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#AutoSaver.timerEvent">timerEvent</a></td> |
|
67 <td>Protected method handling timer events.</td> |
|
68 </tr> |
|
69 </table> |
|
70 <a NAME="AutoSaver.__init__" ID="AutoSaver.__init__"></a> |
|
71 <h4>AutoSaver (Constructor)</h4> |
|
72 <b>AutoSaver</b>(<i>parent, save</i>) |
|
73 <p> |
|
74 Constructor |
|
75 </p><dl> |
|
76 <dt><i>parent</i></dt> |
|
77 <dd> |
|
78 reference to the parent object (QObject) |
|
79 </dd><dt><i>save</i></dt> |
|
80 <dd> |
|
81 slot to be called to perform the save operation |
|
82 </dd> |
|
83 </dl><a NAME="AutoSaver.changeOccurred" ID="AutoSaver.changeOccurred"></a> |
|
84 <h4>AutoSaver.changeOccurred</h4> |
|
85 <b>changeOccurred</b>(<i></i>) |
|
86 <p> |
|
87 Public slot handling a change. |
|
88 </p><a NAME="AutoSaver.saveIfNeccessary" ID="AutoSaver.saveIfNeccessary"></a> |
|
89 <h4>AutoSaver.saveIfNeccessary</h4> |
|
90 <b>saveIfNeccessary</b>(<i></i>) |
|
91 <p> |
|
92 Public method to activate the save operation. |
|
93 </p><a NAME="AutoSaver.timerEvent" ID="AutoSaver.timerEvent"></a> |
|
94 <h4>AutoSaver.timerEvent</h4> |
|
95 <b>timerEvent</b>(<i>evt</i>) |
|
96 <p> |
|
97 Protected method handling timer events. |
|
98 </p><dl> |
|
99 <dt><i>evt</i></dt> |
|
100 <dd> |
|
101 reference to the timer event (QTimerEvent) |
|
102 </dd> |
|
103 </dl> |
|
104 <div align="right"><a href="#top">Up</a></div> |
|
105 <hr /> |
|
106 </body></html> |