Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Utilities.AutoSaver.html
eric6/Documentation/Source/eric6.Utilities.AutoSaver.html
- branch
- maintenance
- changeset 7286
- 7eb04391adf7
- parent 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 7226:babe80d84a3e | 7286:7eb04391adf7 |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Utilities.AutoSaver</h1> | 23 <h1>eric6.Utilities.AutoSaver</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing an auto saver class. | 26 Module implementing an auto saver class. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#AutoSaver">AutoSaver</a></td> | 38 <td><a href="#AutoSaver">AutoSaver</a></td> |
| 34 <td>Class implementing the auto saver.</td> | 39 <td>Class implementing the auto saver.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="AutoSaver" ID="AutoSaver"></a> | 49 <a NAME="AutoSaver" ID="AutoSaver"></a> |
| 43 <h2>AutoSaver</h2> | 50 <h2>AutoSaver</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the auto saver. | 53 Class implementing the auto saver. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QObject | 56 QObject |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>AUTOSAVE_IN</td></tr><tr><td>MAXWAIT</td></tr> | 60 <tr><td>AUTOSAVE_IN</td></tr><tr><td>MAXWAIT</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#AutoSaver.__init__">AutoSaver</a></td> | 72 <td><a href="#AutoSaver.__init__">AutoSaver</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#AutoSaver.changeOccurred">changeOccurred</a></td> | 76 <td><a href="#AutoSaver.changeOccurred">changeOccurred</a></td> |
| 64 <td>Public slot handling a change.</td> | 77 <td>Public slot handling a change.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#AutoSaver.saveIfNeccessary">saveIfNeccessary</a></td> | 80 <td><a href="#AutoSaver.saveIfNeccessary">saveIfNeccessary</a></td> |
| 67 <td>Public method to activate the save operation.</td> | 81 <td>Public method to activate the save operation.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#AutoSaver.timerEvent">timerEvent</a></td> | 84 <td><a href="#AutoSaver.timerEvent">timerEvent</a></td> |
| 70 <td>Protected method handling timer events.</td> | 85 <td>Protected method handling timer events.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="AutoSaver.__init__" ID="AutoSaver.__init__"></a> | 94 <a NAME="AutoSaver.__init__" ID="AutoSaver.__init__"></a> |
| 78 <h4>AutoSaver (Constructor)</h4> | 95 <h4>AutoSaver (Constructor)</h4> |
| 79 <b>AutoSaver</b>(<i>parent, save</i>) | 96 <b>AutoSaver</b>(<i>parent, save</i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 83 <dt><i>parent</i></dt> | 103 <dt><i>parent</i></dt> |
| 84 <dd> | 104 <dd> |
| 85 reference to the parent object (QObject) | 105 reference to the parent object (QObject) |
| 86 </dd><dt><i>save</i></dt> | 106 </dd> |
| 107 <dt><i>save</i></dt> | |
| 87 <dd> | 108 <dd> |
| 88 slot to be called to perform the save operation | 109 slot to be called to perform the save operation |
| 89 </dd> | 110 </dd> |
| 90 </dl><dl> | 111 </dl> |
| 112 <dl> | |
| 113 | |
| 91 <dt>Raises <b>RuntimeError</b>:</dt> | 114 <dt>Raises <b>RuntimeError</b>:</dt> |
| 92 <dd> | 115 <dd> |
| 93 raised, if no parent is given | 116 raised, if no parent is given |
| 94 </dd> | 117 </dd> |
| 95 </dl><a NAME="AutoSaver.changeOccurred" ID="AutoSaver.changeOccurred"></a> | 118 </dl> |
| 119 <a NAME="AutoSaver.changeOccurred" ID="AutoSaver.changeOccurred"></a> | |
| 96 <h4>AutoSaver.changeOccurred</h4> | 120 <h4>AutoSaver.changeOccurred</h4> |
| 97 <b>changeOccurred</b>(<i></i>) | 121 <b>changeOccurred</b>(<i></i>) |
| 122 | |
| 98 <p> | 123 <p> |
| 99 Public slot handling a change. | 124 Public slot handling a change. |
| 100 </p><a NAME="AutoSaver.saveIfNeccessary" ID="AutoSaver.saveIfNeccessary"></a> | 125 </p> |
| 126 <a NAME="AutoSaver.saveIfNeccessary" ID="AutoSaver.saveIfNeccessary"></a> | |
| 101 <h4>AutoSaver.saveIfNeccessary</h4> | 127 <h4>AutoSaver.saveIfNeccessary</h4> |
| 102 <b>saveIfNeccessary</b>(<i></i>) | 128 <b>saveIfNeccessary</b>(<i></i>) |
| 129 | |
| 103 <p> | 130 <p> |
| 104 Public method to activate the save operation. | 131 Public method to activate the save operation. |
| 105 </p><a NAME="AutoSaver.timerEvent" ID="AutoSaver.timerEvent"></a> | 132 </p> |
| 133 <a NAME="AutoSaver.timerEvent" ID="AutoSaver.timerEvent"></a> | |
| 106 <h4>AutoSaver.timerEvent</h4> | 134 <h4>AutoSaver.timerEvent</h4> |
| 107 <b>timerEvent</b>(<i>evt</i>) | 135 <b>timerEvent</b>(<i>evt</i>) |
| 136 | |
| 108 <p> | 137 <p> |
| 109 Protected method handling timer events. | 138 Protected method handling timer events. |
| 110 </p><dl> | 139 </p> |
| 140 <dl> | |
| 141 | |
| 111 <dt><i>evt</i></dt> | 142 <dt><i>evt</i></dt> |
| 112 <dd> | 143 <dd> |
| 113 reference to the timer event (QTimerEvent) | 144 reference to the timer event (QTimerEvent) |
| 114 </dd> | 145 </dd> |
| 115 </dl> | 146 </dl> |
