Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the shelve extension project helper. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#LargefilesProjectHelper">LargefilesProjectHelper</a></td> | |
| 25 <td>Class implementing the queues extension project helper.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="LargefilesProjectHelper" ID="LargefilesProjectHelper"></a> | |
| 36 <h2>LargefilesProjectHelper</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the queues extension project helper. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HgExtensionProjectHelper | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#LargefilesProjectHelper.__init__">LargefilesProjectHelper</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#LargefilesProjectHelper.__hgLfPull">__hgLfPull</a></td> | |
| 63 <td>Private slot to pull missing large files into the local repository.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#LargefilesProjectHelper.__hgLfSummary">__hgLfSummary</a></td> | |
| 67 <td>Private slot to show a working directory summary.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#LargefilesProjectHelper.__hgLfVerify">__hgLfVerify</a></td> | |
| 71 <td>Private slot to verify large files integrity.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#LargefilesProjectHelper.__hgLfconvert">__hgLfconvert</a></td> | |
| 75 <td>Private slot to convert the repository format of the current project.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#LargefilesProjectHelper.initActions">initActions</a></td> | |
| 79 <td>Public method to generate the action objects.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#LargefilesProjectHelper.initMenu">initMenu</a></td> | |
| 83 <td>Public method to generate the extension menu.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#LargefilesProjectHelper.menuTitle">menuTitle</a></td> | |
| 87 <td>Public method to get the menu title.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#LargefilesProjectHelper.shutdown">shutdown</a></td> | |
| 91 <td>Public method to perform shutdown actions.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="LargefilesProjectHelper.__init__" ID="LargefilesProjectHelper.__init__"></a> | |
| 101 <h4>LargefilesProjectHelper (Constructor)</h4> | |
| 102 <b>LargefilesProjectHelper</b>(<i></i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <a NAME="LargefilesProjectHelper.__hgLfPull" ID="LargefilesProjectHelper.__hgLfPull"></a> | |
| 108 <h4>LargefilesProjectHelper.__hgLfPull</h4> | |
| 109 <b>__hgLfPull</b>(<i></i>) | |
| 110 | |
| 111 <p> | |
| 112 Private slot to pull missing large files into the local repository. | |
| 113 </p> | |
| 114 <a NAME="LargefilesProjectHelper.__hgLfSummary" ID="LargefilesProjectHelper.__hgLfSummary"></a> | |
| 115 <h4>LargefilesProjectHelper.__hgLfSummary</h4> | |
| 116 <b>__hgLfSummary</b>(<i></i>) | |
| 117 | |
| 118 <p> | |
| 119 Private slot to show a working directory summary. | |
| 120 </p> | |
| 121 <a NAME="LargefilesProjectHelper.__hgLfVerify" ID="LargefilesProjectHelper.__hgLfVerify"></a> | |
| 122 <h4>LargefilesProjectHelper.__hgLfVerify</h4> | |
| 123 <b>__hgLfVerify</b>(<i>mode</i>) | |
| 124 | |
| 125 <p> | |
| 126 Private slot to verify large files integrity. | |
| 127 </p> | |
| 128 <dl> | |
| 129 | |
| 130 <dt><i>mode</i></dt> | |
| 131 <dd> | |
| 132 verify mode (string; one of 'large', 'lfa' or 'lfc') | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <dl> | |
| 136 | |
| 137 <dt>Raises <b>ValueError</b>:</dt> | |
| 138 <dd> | |
| 139 raised to indicate a bad value for the | |
| 140 'mode' parameter. | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="LargefilesProjectHelper.__hgLfconvert" ID="LargefilesProjectHelper.__hgLfconvert"></a> | |
| 144 <h4>LargefilesProjectHelper.__hgLfconvert</h4> | |
| 145 <b>__hgLfconvert</b>(<i>direction</i>) | |
| 146 | |
| 147 <p> | |
| 148 Private slot to convert the repository format of the current project. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>direction</i></dt> | |
| 153 <dd> | |
| 154 direction of the conversion (string; one of | |
| 155 'largefiles' or 'normal') | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <dl> | |
| 159 | |
| 160 <dt>Raises <b>ValueError</b>:</dt> | |
| 161 <dd> | |
| 162 raised to indicate a bad value for the | |
| 163 'direction' parameter. | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="LargefilesProjectHelper.initActions" ID="LargefilesProjectHelper.initActions"></a> | |
| 167 <h4>LargefilesProjectHelper.initActions</h4> | |
| 168 <b>initActions</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Public method to generate the action objects. | |
| 172 </p> | |
| 173 <a NAME="LargefilesProjectHelper.initMenu" ID="LargefilesProjectHelper.initMenu"></a> | |
| 174 <h4>LargefilesProjectHelper.initMenu</h4> | |
| 175 <b>initMenu</b>(<i>mainMenu</i>) | |
| 176 | |
| 177 <p> | |
| 178 Public method to generate the extension menu. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>mainMenu</i></dt> | |
| 183 <dd> | |
| 184 reference to the main menu (QMenu) | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <dl> | |
| 188 <dt>Return:</dt> | |
| 189 <dd> | |
| 190 populated menu (QMenu) | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="LargefilesProjectHelper.menuTitle" ID="LargefilesProjectHelper.menuTitle"></a> | |
| 194 <h4>LargefilesProjectHelper.menuTitle</h4> | |
| 195 <b>menuTitle</b>(<i></i>) | |
| 196 | |
| 197 <p> | |
| 198 Public method to get the menu title. | |
| 199 </p> | |
| 200 <dl> | |
| 201 <dt>Return:</dt> | |
| 202 <dd> | |
| 203 title of the menu (string) | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <a NAME="LargefilesProjectHelper.shutdown" ID="LargefilesProjectHelper.shutdown"></a> | |
| 207 <h4>LargefilesProjectHelper.shutdown</h4> | |
| 208 <b>shutdown</b>(<i></i>) | |
| 209 | |
| 210 <p> | |
| 211 Public method to perform shutdown actions. | |
| 212 </p> | |
| 213 <p> | |
| 214 Note: Derived class may implement this method if needed. | |
| 215 </p> | |
| 216 <div align="right"><a href="#top">Up</a></div> | |
| 217 <hr /> | |
| 218 </body></html> |
