|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper</h1> |
|
23 <p> |
|
24 Module implementing the shelve extension project helper. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#LargefilesProjectHelper">LargefilesProjectHelper</a></td> |
|
34 <td>Class implementing the queues extension project helper.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="LargefilesProjectHelper" ID="LargefilesProjectHelper"></a> |
|
43 <h2>LargefilesProjectHelper</h2> |
|
44 <p> |
|
45 Class implementing the queues extension project helper. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 HgExtensionProjectHelper |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#LargefilesProjectHelper.__init__">LargefilesProjectHelper</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#LargefilesProjectHelper.__hgLfPull">__hgLfPull</a></td> |
|
64 <td>Private slot to pull missing large files into the local repository.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#LargefilesProjectHelper.__hgLfSummary">__hgLfSummary</a></td> |
|
67 <td>Private slot to show a working directory summary.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#LargefilesProjectHelper.__hgLfVerify">__hgLfVerify</a></td> |
|
70 <td>Private slot to verify large files integrity.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#LargefilesProjectHelper.__hgLfconvert">__hgLfconvert</a></td> |
|
73 <td>Private slot to convert the repository format of the current project.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#LargefilesProjectHelper.initActions">initActions</a></td> |
|
76 <td>Public method to generate the action objects.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#LargefilesProjectHelper.initMenu">initMenu</a></td> |
|
79 <td>Public method to generate the extension menu.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#LargefilesProjectHelper.menuTitle">menuTitle</a></td> |
|
82 <td>Public method to get the menu title.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#LargefilesProjectHelper.shutdown">shutdown</a></td> |
|
85 <td>Public method to perform shutdown actions.</td> |
|
86 </tr> |
|
87 </table> |
|
88 <h3>Static Methods</h3> |
|
89 <table> |
|
90 <tr><td>None</td></tr> |
|
91 </table> |
|
92 <a NAME="LargefilesProjectHelper.__init__" ID="LargefilesProjectHelper.__init__"></a> |
|
93 <h4>LargefilesProjectHelper (Constructor)</h4> |
|
94 <b>LargefilesProjectHelper</b>(<i></i>) |
|
95 <p> |
|
96 Constructor |
|
97 </p><a NAME="LargefilesProjectHelper.__hgLfPull" ID="LargefilesProjectHelper.__hgLfPull"></a> |
|
98 <h4>LargefilesProjectHelper.__hgLfPull</h4> |
|
99 <b>__hgLfPull</b>(<i></i>) |
|
100 <p> |
|
101 Private slot to pull missing large files into the local repository. |
|
102 </p><a NAME="LargefilesProjectHelper.__hgLfSummary" ID="LargefilesProjectHelper.__hgLfSummary"></a> |
|
103 <h4>LargefilesProjectHelper.__hgLfSummary</h4> |
|
104 <b>__hgLfSummary</b>(<i></i>) |
|
105 <p> |
|
106 Private slot to show a working directory summary. |
|
107 </p><a NAME="LargefilesProjectHelper.__hgLfVerify" ID="LargefilesProjectHelper.__hgLfVerify"></a> |
|
108 <h4>LargefilesProjectHelper.__hgLfVerify</h4> |
|
109 <b>__hgLfVerify</b>(<i>mode</i>) |
|
110 <p> |
|
111 Private slot to verify large files integrity. |
|
112 </p><dl> |
|
113 <dt><i>mode</i></dt> |
|
114 <dd> |
|
115 verify mode (string; one of 'large', 'lfa' or 'lfc') |
|
116 </dd> |
|
117 </dl><a NAME="LargefilesProjectHelper.__hgLfconvert" ID="LargefilesProjectHelper.__hgLfconvert"></a> |
|
118 <h4>LargefilesProjectHelper.__hgLfconvert</h4> |
|
119 <b>__hgLfconvert</b>(<i>direction</i>) |
|
120 <p> |
|
121 Private slot to convert the repository format of the current project. |
|
122 </p><dl> |
|
123 <dt><i>direction</i></dt> |
|
124 <dd> |
|
125 direction of the conversion (string; one of |
|
126 'largefiles' or 'normal') |
|
127 </dd> |
|
128 </dl><a NAME="LargefilesProjectHelper.initActions" ID="LargefilesProjectHelper.initActions"></a> |
|
129 <h4>LargefilesProjectHelper.initActions</h4> |
|
130 <b>initActions</b>(<i></i>) |
|
131 <p> |
|
132 Public method to generate the action objects. |
|
133 </p><a NAME="LargefilesProjectHelper.initMenu" ID="LargefilesProjectHelper.initMenu"></a> |
|
134 <h4>LargefilesProjectHelper.initMenu</h4> |
|
135 <b>initMenu</b>(<i>mainMenu</i>) |
|
136 <p> |
|
137 Public method to generate the extension menu. |
|
138 </p><dl> |
|
139 <dt><i>mainMenu</i></dt> |
|
140 <dd> |
|
141 reference to the main menu (QMenu) |
|
142 </dd> |
|
143 </dl><dl> |
|
144 <dt>Returns:</dt> |
|
145 <dd> |
|
146 populated menu (QMenu) |
|
147 </dd> |
|
148 </dl><a NAME="LargefilesProjectHelper.menuTitle" ID="LargefilesProjectHelper.menuTitle"></a> |
|
149 <h4>LargefilesProjectHelper.menuTitle</h4> |
|
150 <b>menuTitle</b>(<i></i>) |
|
151 <p> |
|
152 Public method to get the menu title. |
|
153 </p><dl> |
|
154 <dt>Returns:</dt> |
|
155 <dd> |
|
156 title of the menu (string) |
|
157 </dd> |
|
158 </dl><a NAME="LargefilesProjectHelper.shutdown" ID="LargefilesProjectHelper.shutdown"></a> |
|
159 <h4>LargefilesProjectHelper.shutdown</h4> |
|
160 <b>shutdown</b>(<i></i>) |
|
161 <p> |
|
162 Public method to perform shutdown actions. |
|
163 </p><p> |
|
164 Note: Derived class may implement this method if needed. |
|
165 </p> |
|
166 <div align="right"><a href="#top">Up</a></div> |
|
167 <hr /> |
|
168 </body></html> |