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