src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 11068
15f0385e0471
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper</h1>
10
11 <p> 10 <p>
12 Module implementing the shelve extension project helper. 11 Module implementing the shelve extension project helper.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#LargefilesProjectHelper">LargefilesProjectHelper</a></td> 22 <td><a href="#LargefilesProjectHelper">LargefilesProjectHelper</a></td>
25 <td>Class implementing the queues extension project helper.</td> 23 <td>Class implementing the queues extension project helper.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="LargefilesProjectHelper" ID="LargefilesProjectHelper"></a> 34 <a NAME="LargefilesProjectHelper" ID="LargefilesProjectHelper"></a>
36 <h2>LargefilesProjectHelper</h2> 35 <h2>LargefilesProjectHelper</h2>
37
38 <p> 36 <p>
39 Class implementing the queues extension project helper. 37 Class implementing the queues extension project helper.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 HgExtensionProjectHelper 41 HgExtensionProjectHelper
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#LargefilesProjectHelper.__init__">LargefilesProjectHelper</a></td> 55 <td><a href="#LargefilesProjectHelper.__init__">LargefilesProjectHelper</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
89 <tr> 86 <tr>
90 <td><a href="#LargefilesProjectHelper.shutdown">shutdown</a></td> 87 <td><a href="#LargefilesProjectHelper.shutdown">shutdown</a></td>
91 <td>Public method to perform shutdown actions.</td> 88 <td>Public method to perform shutdown actions.</td>
92 </tr> 89 </tr>
93 </table> 90 </table>
91
94 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
95 93 <table>
96 <table> 94 <tr><td>None</td></tr>
97 <tr><td>None</td></tr> 95 </table>
98 </table> 96
99 97
100 <a NAME="LargefilesProjectHelper.__init__" ID="LargefilesProjectHelper.__init__"></a> 98 <a NAME="LargefilesProjectHelper.__init__" ID="LargefilesProjectHelper.__init__"></a>
101 <h4>LargefilesProjectHelper (Constructor)</h4> 99 <h4>LargefilesProjectHelper (Constructor)</h4>
102 <b>LargefilesProjectHelper</b>(<i></i>) 100 <b>LargefilesProjectHelper</b>(<i></i>)
103
104 <p> 101 <p>
105 Constructor 102 Constructor
106 </p> 103 </p>
104
107 <a NAME="LargefilesProjectHelper.__hgLfPull" ID="LargefilesProjectHelper.__hgLfPull"></a> 105 <a NAME="LargefilesProjectHelper.__hgLfPull" ID="LargefilesProjectHelper.__hgLfPull"></a>
108 <h4>LargefilesProjectHelper.__hgLfPull</h4> 106 <h4>LargefilesProjectHelper.__hgLfPull</h4>
109 <b>__hgLfPull</b>(<i></i>) 107 <b>__hgLfPull</b>(<i></i>)
110
111 <p> 108 <p>
112 Private slot to pull missing large files into the local repository. 109 Private slot to pull missing large files into the local repository.
113 </p> 110 </p>
111
114 <a NAME="LargefilesProjectHelper.__hgLfSummary" ID="LargefilesProjectHelper.__hgLfSummary"></a> 112 <a NAME="LargefilesProjectHelper.__hgLfSummary" ID="LargefilesProjectHelper.__hgLfSummary"></a>
115 <h4>LargefilesProjectHelper.__hgLfSummary</h4> 113 <h4>LargefilesProjectHelper.__hgLfSummary</h4>
116 <b>__hgLfSummary</b>(<i></i>) 114 <b>__hgLfSummary</b>(<i></i>)
117
118 <p> 115 <p>
119 Private slot to show a working directory summary. 116 Private slot to show a working directory summary.
120 </p> 117 </p>
118
121 <a NAME="LargefilesProjectHelper.__hgLfVerify" ID="LargefilesProjectHelper.__hgLfVerify"></a> 119 <a NAME="LargefilesProjectHelper.__hgLfVerify" ID="LargefilesProjectHelper.__hgLfVerify"></a>
122 <h4>LargefilesProjectHelper.__hgLfVerify</h4> 120 <h4>LargefilesProjectHelper.__hgLfVerify</h4>
123 <b>__hgLfVerify</b>(<i>mode</i>) 121 <b>__hgLfVerify</b>(<i>mode</i>)
124
125 <p> 122 <p>
126 Private slot to verify large files integrity. 123 Private slot to verify large files integrity.
127 </p> 124 </p>
125
128 <dl> 126 <dl>
129 127
130 <dt><i>mode</i> (str)</dt> 128 <dt><i>mode</i> (str)</dt>
131 <dd> 129 <dd>
132 verify mode (one of 'large', 'lfa' or 'lfc') 130 verify mode (one of 'large', 'lfa' or 'lfc')
140 </dd> 138 </dd>
141 </dl> 139 </dl>
142 <a NAME="LargefilesProjectHelper.__hgLfconvert" ID="LargefilesProjectHelper.__hgLfconvert"></a> 140 <a NAME="LargefilesProjectHelper.__hgLfconvert" ID="LargefilesProjectHelper.__hgLfconvert"></a>
143 <h4>LargefilesProjectHelper.__hgLfconvert</h4> 141 <h4>LargefilesProjectHelper.__hgLfconvert</h4>
144 <b>__hgLfconvert</b>(<i>direction</i>) 142 <b>__hgLfconvert</b>(<i>direction</i>)
145
146 <p> 143 <p>
147 Private slot to convert the repository format of the current project. 144 Private slot to convert the repository format of the current project.
148 </p> 145 </p>
146
149 <dl> 147 <dl>
150 148
151 <dt><i>direction</i> (str)</dt> 149 <dt><i>direction</i> (str)</dt>
152 <dd> 150 <dd>
153 direction of the conversion (one of 'largefiles' or 'normal') 151 direction of the conversion (one of 'largefiles' or 'normal')
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="LargefilesProjectHelper.initActions" ID="LargefilesProjectHelper.initActions"></a> 162 <a NAME="LargefilesProjectHelper.initActions" ID="LargefilesProjectHelper.initActions"></a>
165 <h4>LargefilesProjectHelper.initActions</h4> 163 <h4>LargefilesProjectHelper.initActions</h4>
166 <b>initActions</b>(<i></i>) 164 <b>initActions</b>(<i></i>)
167
168 <p> 165 <p>
169 Public method to generate the action objects. 166 Public method to generate the action objects.
170 </p> 167 </p>
168
171 <a NAME="LargefilesProjectHelper.initMenu" ID="LargefilesProjectHelper.initMenu"></a> 169 <a NAME="LargefilesProjectHelper.initMenu" ID="LargefilesProjectHelper.initMenu"></a>
172 <h4>LargefilesProjectHelper.initMenu</h4> 170 <h4>LargefilesProjectHelper.initMenu</h4>
173 <b>initMenu</b>(<i>mainMenu</i>) 171 <b>initMenu</b>(<i>mainMenu</i>)
174
175 <p> 172 <p>
176 Public method to generate the extension menu. 173 Public method to generate the extension menu.
177 </p> 174 </p>
175
178 <dl> 176 <dl>
179 177
180 <dt><i>mainMenu</i> (QMenu)</dt> 178 <dt><i>mainMenu</i> (QMenu)</dt>
181 <dd> 179 <dd>
182 reference to the main menu 180 reference to the main menu
195 </dd> 193 </dd>
196 </dl> 194 </dl>
197 <a NAME="LargefilesProjectHelper.menuTitle" ID="LargefilesProjectHelper.menuTitle"></a> 195 <a NAME="LargefilesProjectHelper.menuTitle" ID="LargefilesProjectHelper.menuTitle"></a>
198 <h4>LargefilesProjectHelper.menuTitle</h4> 196 <h4>LargefilesProjectHelper.menuTitle</h4>
199 <b>menuTitle</b>(<i></i>) 197 <b>menuTitle</b>(<i></i>)
200
201 <p> 198 <p>
202 Public method to get the menu title. 199 Public method to get the menu title.
203 </p> 200 </p>
201
204 <dl> 202 <dl>
205 <dt>Return:</dt> 203 <dt>Return:</dt>
206 <dd> 204 <dd>
207 title of the menu 205 title of the menu
208 </dd> 206 </dd>
214 </dd> 212 </dd>
215 </dl> 213 </dl>
216 <a NAME="LargefilesProjectHelper.shutdown" ID="LargefilesProjectHelper.shutdown"></a> 214 <a NAME="LargefilesProjectHelper.shutdown" ID="LargefilesProjectHelper.shutdown"></a>
217 <h4>LargefilesProjectHelper.shutdown</h4> 215 <h4>LargefilesProjectHelper.shutdown</h4>
218 <b>shutdown</b>(<i></i>) 216 <b>shutdown</b>(<i></i>)
219
220 <p> 217 <p>
221 Public method to perform shutdown actions. 218 Public method to perform shutdown actions.
222 </p> 219 </p>
223 <p> 220 <p>
224 Note: Derived class may implement this method if needed. 221 Note: Derived class may implement this method if needed.
225 </p> 222 </p>
223
226 <div align="right"><a href="#top">Up</a></div> 224 <div align="right"><a href="#top">Up</a></div>
227 <hr /> 225 <hr />
228 </body></html> 226 </body></html>

eric ide

mercurial