|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</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.ProjectBrowserHelper</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the largefiles extension project browser 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="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td> |
|
39 <td>Class implementing the largefiles extension project browser 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="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a> |
|
50 <h2>LargefilesProjectBrowserHelper</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the largefiles extension project browser helper. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 HgExtensionProjectBrowserHelper |
|
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="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#LargefilesProjectBrowserHelper.__hgAddLargefiles">__hgAddLargefiles</a></td> |
|
77 <td>Private slot to add the selected files as large files.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#LargefilesProjectBrowserHelper.initMenus">initMenus</a></td> |
|
81 <td>Public method to generate the extension menus.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#LargefilesProjectBrowserHelper.menuTitle">menuTitle</a></td> |
|
85 <td>Public method to get the menu title.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> |
|
89 <td>Public method to prepare the extension menu for display.</td> |
|
90 </tr> |
|
91 </table> |
|
92 <h3>Static Methods</h3> |
|
93 |
|
94 <table> |
|
95 <tr><td>None</td></tr> |
|
96 </table> |
|
97 |
|
98 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a> |
|
99 <h4>LargefilesProjectBrowserHelper (Constructor)</h4> |
|
100 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) |
|
101 |
|
102 <p> |
|
103 Constructor |
|
104 </p> |
|
105 <dl> |
|
106 |
|
107 <dt><i>vcsObject</i></dt> |
|
108 <dd> |
|
109 reference to the vcs object |
|
110 </dd> |
|
111 <dt><i>browserObject</i></dt> |
|
112 <dd> |
|
113 reference to the project browser object |
|
114 </dd> |
|
115 <dt><i>projectObject</i></dt> |
|
116 <dd> |
|
117 reference to the project object |
|
118 </dd> |
|
119 </dl> |
|
120 <a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> |
|
121 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4> |
|
122 <b>__hgAddLargefiles</b>(<i>mode</i>) |
|
123 |
|
124 <p> |
|
125 Private slot to add the selected files as large files. |
|
126 </p> |
|
127 <dl> |
|
128 |
|
129 <dt><i>mode</i></dt> |
|
130 <dd> |
|
131 add mode (string one of 'normal' or 'large') |
|
132 </dd> |
|
133 </dl> |
|
134 <a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> |
|
135 <h4>LargefilesProjectBrowserHelper.initMenus</h4> |
|
136 <b>initMenus</b>(<i></i>) |
|
137 |
|
138 <p> |
|
139 Public method to generate the extension menus. |
|
140 </p> |
|
141 <p> |
|
142 Note: Derived class must implement this method. |
|
143 </p> |
|
144 <dl> |
|
145 <dt>Return:</dt> |
|
146 <dd> |
|
147 dictionary of populated menu (dict of QMenu). The dict |
|
148 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' |
|
149 and 'dirMultiMenu'. |
|
150 </dd> |
|
151 </dl> |
|
152 <a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> |
|
153 <h4>LargefilesProjectBrowserHelper.menuTitle</h4> |
|
154 <b>menuTitle</b>(<i></i>) |
|
155 |
|
156 <p> |
|
157 Public method to get the menu title. |
|
158 </p> |
|
159 <p> |
|
160 Note: Derived class must implement this method. |
|
161 </p> |
|
162 <dl> |
|
163 <dt>Return:</dt> |
|
164 <dd> |
|
165 title of the menu (string) |
|
166 </dd> |
|
167 </dl> |
|
168 <a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> |
|
169 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4> |
|
170 <b>showExtensionMenu</b>(<i>key, controlled</i>) |
|
171 |
|
172 <p> |
|
173 Public method to prepare the extension menu for display. |
|
174 </p> |
|
175 <dl> |
|
176 |
|
177 <dt><i>key</i></dt> |
|
178 <dd> |
|
179 menu key (string, one of 'mainMenu', 'multiMenu', |
|
180 'backMenu', 'dirMenu' or 'dirMultiMenu') |
|
181 </dd> |
|
182 <dt><i>controlled</i></dt> |
|
183 <dd> |
|
184 flag indicating to prepare the menu for a |
|
185 version controlled entry or a non-version controlled entry |
|
186 (boolean) |
|
187 </dd> |
|
188 </dl> |
|
189 <div align="right"><a href="#top">Up</a></div> |
|
190 <hr /> |
|
191 </body></html> |