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

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
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.ShelveExtension.ProjectHelper</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.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="#ShelveProjectHelper">ShelveProjectHelper</a></td> 22 <td><a href="#ShelveProjectHelper">ShelveProjectHelper</a></td>
25 <td>Class implementing the shelve extension project helper.</td> 23 <td>Class implementing the shelve 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="ShelveProjectHelper" ID="ShelveProjectHelper"></a> 34 <a NAME="ShelveProjectHelper" ID="ShelveProjectHelper"></a>
36 <h2>ShelveProjectHelper</h2> 35 <h2>ShelveProjectHelper</h2>
37
38 <p> 36 <p>
39 Class implementing the shelve extension project helper. 37 Class implementing the shelve 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="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td> 55 <td><a href="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
101 <tr> 98 <tr>
102 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td> 99 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td>
103 <td>Public method to get the menu title.</td> 100 <td>Public method to get the menu title.</td>
104 </tr> 101 </tr>
105 </table> 102 </table>
103
106 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
107 105 <table>
108 <table> 106 <tr><td>None</td></tr>
109 <tr><td>None</td></tr> 107 </table>
110 </table> 108
111 109
112 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a> 110 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a>
113 <h4>ShelveProjectHelper (Constructor)</h4> 111 <h4>ShelveProjectHelper (Constructor)</h4>
114 <b>ShelveProjectHelper</b>(<i></i>) 112 <b>ShelveProjectHelper</b>(<i></i>)
115
116 <p> 113 <p>
117 Constructor 114 Constructor
118 </p> 115 </p>
116
119 <a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a> 117 <a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a>
120 <h4>ShelveProjectHelper.__hgCleanupShelves</h4> 118 <h4>ShelveProjectHelper.__hgCleanupShelves</h4>
121 <b>__hgCleanupShelves</b>(<i></i>) 119 <b>__hgCleanupShelves</b>(<i></i>)
122
123 <p> 120 <p>
124 Private slot to delete all shelves. 121 Private slot to delete all shelves.
125 </p> 122 </p>
123
126 <a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a> 124 <a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a>
127 <h4>ShelveProjectHelper.__hgDeleteShelves</h4> 125 <h4>ShelveProjectHelper.__hgDeleteShelves</h4>
128 <b>__hgDeleteShelves</b>(<i></i>) 126 <b>__hgDeleteShelves</b>(<i></i>)
129
130 <p> 127 <p>
131 Private slot to delete selected shelves. 128 Private slot to delete selected shelves.
132 </p> 129 </p>
130
133 <a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a> 131 <a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a>
134 <h4>ShelveProjectHelper.__hgShelve</h4> 132 <h4>ShelveProjectHelper.__hgShelve</h4>
135 <b>__hgShelve</b>(<i></i>) 133 <b>__hgShelve</b>(<i></i>)
136
137 <p> 134 <p>
138 Private slot used to shelve all current changes. 135 Private slot used to shelve all current changes.
139 </p> 136 </p>
137
140 <a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a> 138 <a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a>
141 <h4>ShelveProjectHelper.__hgShelveBrowser</h4> 139 <h4>ShelveProjectHelper.__hgShelveBrowser</h4>
142 <b>__hgShelveBrowser</b>(<i></i>) 140 <b>__hgShelveBrowser</b>(<i></i>)
143
144 <p> 141 <p>
145 Private slot to show the shelve browser dialog. 142 Private slot to show the shelve browser dialog.
146 </p> 143 </p>
144
147 <a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a> 145 <a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a>
148 <h4>ShelveProjectHelper.__hgUnshelve</h4> 146 <h4>ShelveProjectHelper.__hgUnshelve</h4>
149 <b>__hgUnshelve</b>(<i></i>) 147 <b>__hgUnshelve</b>(<i></i>)
150
151 <p> 148 <p>
152 Private slot used to restore a shelved change. 149 Private slot used to restore a shelved change.
153 </p> 150 </p>
151
154 <a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a> 152 <a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a>
155 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4> 153 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4>
156 <b>__hgUnshelveAbort</b>(<i></i>) 154 <b>__hgUnshelveAbort</b>(<i></i>)
157
158 <p> 155 <p>
159 Private slot used to abort an ongoing restore operation. 156 Private slot used to abort an ongoing restore operation.
160 </p> 157 </p>
158
161 <a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a> 159 <a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a>
162 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4> 160 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4>
163 <b>__hgUnshelveContinue</b>(<i></i>) 161 <b>__hgUnshelveContinue</b>(<i></i>)
164
165 <p> 162 <p>
166 Private slot used to continue an ongoing restore operation. 163 Private slot used to continue an ongoing restore operation.
167 </p> 164 </p>
165
168 <a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a> 166 <a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a>
169 <h4>ShelveProjectHelper.__reopenProject</h4> 167 <h4>ShelveProjectHelper.__reopenProject</h4>
170 <b>__reopenProject</b>(<i>shouldReopen, title</i>) 168 <b>__reopenProject</b>(<i>shouldReopen, title</i>)
171
172 <p> 169 <p>
173 Private method to reopen the project if needed and wanted. 170 Private method to reopen the project if needed and wanted.
174 </p> 171 </p>
172
175 <dl> 173 <dl>
176 174
177 <dt><i>shouldReopen</i> (bool)</dt> 175 <dt><i>shouldReopen</i> (bool)</dt>
178 <dd> 176 <dd>
179 flag indicating that the project should 177 flag indicating that the project should
185 </dd> 183 </dd>
186 </dl> 184 </dl>
187 <a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a> 185 <a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a>
188 <h4>ShelveProjectHelper.initActions</h4> 186 <h4>ShelveProjectHelper.initActions</h4>
189 <b>initActions</b>(<i></i>) 187 <b>initActions</b>(<i></i>)
190
191 <p> 188 <p>
192 Public method to generate the action objects. 189 Public method to generate the action objects.
193 </p> 190 </p>
191
194 <a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a> 192 <a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a>
195 <h4>ShelveProjectHelper.initMenu</h4> 193 <h4>ShelveProjectHelper.initMenu</h4>
196 <b>initMenu</b>(<i>mainMenu</i>) 194 <b>initMenu</b>(<i>mainMenu</i>)
197
198 <p> 195 <p>
199 Public method to generate the extension menu. 196 Public method to generate the extension menu.
200 </p> 197 </p>
198
201 <dl> 199 <dl>
202 200
203 <dt><i>mainMenu</i> (QMenu)</dt> 201 <dt><i>mainMenu</i> (QMenu)</dt>
204 <dd> 202 <dd>
205 reference to the main menu 203 reference to the main menu
218 </dd> 216 </dd>
219 </dl> 217 </dl>
220 <a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a> 218 <a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a>
221 <h4>ShelveProjectHelper.menuTitle</h4> 219 <h4>ShelveProjectHelper.menuTitle</h4>
222 <b>menuTitle</b>(<i></i>) 220 <b>menuTitle</b>(<i></i>)
223
224 <p> 221 <p>
225 Public method to get the menu title. 222 Public method to get the menu title.
226 </p> 223 </p>
224
227 <dl> 225 <dl>
228 <dt>Return:</dt> 226 <dt>Return:</dt>
229 <dd> 227 <dd>
230 title of the menu 228 title of the menu
231 </dd> 229 </dd>

eric ide

mercurial