|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper</title> |
|
6 <style> |
|
7 body { |
|
8 background: #EDECE6; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #85774A; } |
|
14 h2 { color: white; background: #85774A; } |
|
15 h3 { color: white; background: #9D936E; } |
|
16 h4 { color: white; background: #9D936E; } |
|
17 |
|
18 a { color: #BA6D36; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper</h1> |
|
24 <p> |
|
25 Module implementing the purge extension project helper. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#PurgeProjectHelper">PurgeProjectHelper</a></td> |
|
35 <td>Class implementing the purge extension project helper.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="PurgeProjectHelper" ID="PurgeProjectHelper"></a> |
|
44 <h2>PurgeProjectHelper</h2> |
|
45 <p> |
|
46 Class implementing the purge extension project helper. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 QObject |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#PurgeProjectHelper.__init__">PurgeProjectHelper</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#PurgeProjectHelper.__hgPurge">__hgPurge</a></td> |
|
61 <td>Private slot used to remove files not tracked by Mercurial.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#PurgeProjectHelper.__hgPurgeAll">__hgPurgeAll</a></td> |
|
64 <td>Private slot used to remove all files not tracked by Mercurial.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#PurgeProjectHelper.__hgPurgeAllList">__hgPurgeAllList</a></td> |
|
67 <td>Private slot used to list all files not tracked by Mercurial.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#PurgeProjectHelper.__hgPurgeList">__hgPurgeList</a></td> |
|
70 <td>Private slot used to list files not tracked by Mercurial.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#PurgeProjectHelper.getActions">getActions</a></td> |
|
73 <td>Public method to get a list of all actions.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#PurgeProjectHelper.initActions">initActions</a></td> |
|
76 <td>Public method to generate the action objects.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#PurgeProjectHelper.initMenu">initMenu</a></td> |
|
79 <td>Public method to generate the extension menu.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#PurgeProjectHelper.setObjects">setObjects</a></td> |
|
82 <td>Public method to set references to the vcs and project objects.</td> |
|
83 </tr> |
|
84 </table> |
|
85 <a NAME="PurgeProjectHelper.__init__" ID="PurgeProjectHelper.__init__"></a> |
|
86 <h4>PurgeProjectHelper (Constructor)</h4> |
|
87 <b>PurgeProjectHelper</b>(<i></i>) |
|
88 <p> |
|
89 Constructor |
|
90 </p><a NAME="PurgeProjectHelper.__hgPurge" ID="PurgeProjectHelper.__hgPurge"></a> |
|
91 <h4>PurgeProjectHelper.__hgPurge</h4> |
|
92 <b>__hgPurge</b>(<i></i>) |
|
93 <p> |
|
94 Private slot used to remove files not tracked by Mercurial. |
|
95 </p><a NAME="PurgeProjectHelper.__hgPurgeAll" ID="PurgeProjectHelper.__hgPurgeAll"></a> |
|
96 <h4>PurgeProjectHelper.__hgPurgeAll</h4> |
|
97 <b>__hgPurgeAll</b>(<i></i>) |
|
98 <p> |
|
99 Private slot used to remove all files not tracked by Mercurial. |
|
100 </p><a NAME="PurgeProjectHelper.__hgPurgeAllList" ID="PurgeProjectHelper.__hgPurgeAllList"></a> |
|
101 <h4>PurgeProjectHelper.__hgPurgeAllList</h4> |
|
102 <b>__hgPurgeAllList</b>(<i></i>) |
|
103 <p> |
|
104 Private slot used to list all files not tracked by Mercurial. |
|
105 </p><a NAME="PurgeProjectHelper.__hgPurgeList" ID="PurgeProjectHelper.__hgPurgeList"></a> |
|
106 <h4>PurgeProjectHelper.__hgPurgeList</h4> |
|
107 <b>__hgPurgeList</b>(<i></i>) |
|
108 <p> |
|
109 Private slot used to list files not tracked by Mercurial. |
|
110 </p><a NAME="PurgeProjectHelper.getActions" ID="PurgeProjectHelper.getActions"></a> |
|
111 <h4>PurgeProjectHelper.getActions</h4> |
|
112 <b>getActions</b>(<i></i>) |
|
113 <p> |
|
114 Public method to get a list of all actions. |
|
115 </p><dl> |
|
116 <dt>Returns:</dt> |
|
117 <dd> |
|
118 list of all actions (list of E5Action) |
|
119 </dd> |
|
120 </dl><a NAME="PurgeProjectHelper.initActions" ID="PurgeProjectHelper.initActions"></a> |
|
121 <h4>PurgeProjectHelper.initActions</h4> |
|
122 <b>initActions</b>(<i></i>) |
|
123 <p> |
|
124 Public method to generate the action objects. |
|
125 </p><a NAME="PurgeProjectHelper.initMenu" ID="PurgeProjectHelper.initMenu"></a> |
|
126 <h4>PurgeProjectHelper.initMenu</h4> |
|
127 <b>initMenu</b>(<i>mainMenu</i>) |
|
128 <p> |
|
129 Public method to generate the extension menu. |
|
130 </p><dl> |
|
131 <dt><i>mainMenu</i></dt> |
|
132 <dd> |
|
133 reference to the main menu (QMenu) |
|
134 </dd> |
|
135 </dl><dl> |
|
136 <dt>Returns:</dt> |
|
137 <dd> |
|
138 populated menu (QMenu) |
|
139 </dd> |
|
140 </dl><a NAME="PurgeProjectHelper.setObjects" ID="PurgeProjectHelper.setObjects"></a> |
|
141 <h4>PurgeProjectHelper.setObjects</h4> |
|
142 <b>setObjects</b>(<i>vcsObject, projectObject</i>) |
|
143 <p> |
|
144 Public method to set references to the vcs and project objects. |
|
145 </p><dl> |
|
146 <dt><i>vcsObject</i></dt> |
|
147 <dd> |
|
148 reference to the vcs object |
|
149 </dd><dt><i>projectObject</i></dt> |
|
150 <dd> |
|
151 reference to the project object |
|
152 </dd> |
|
153 </dl> |
|
154 <div align="right"><a href="#top">Up</a></div> |
|
155 <hr /> |
|
156 </body></html> |