Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper</h1>
24
23 <p> 25 <p>
24 Module implementing the shelve extension project helper. 26 Module implementing the shelve extension project helper.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#ShelveProjectHelper">ShelveProjectHelper</a></td> 38 <td><a href="#ShelveProjectHelper">ShelveProjectHelper</a></td>
34 <td>Class implementing the shelve extension project helper.</td> 39 <td>Class implementing the shelve extension project helper.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="ShelveProjectHelper" ID="ShelveProjectHelper"></a> 49 <a NAME="ShelveProjectHelper" ID="ShelveProjectHelper"></a>
43 <h2>ShelveProjectHelper</h2> 50 <h2>ShelveProjectHelper</h2>
51
44 <p> 52 <p>
45 Class implementing the shelve extension project helper. 53 Class implementing the shelve extension project helper.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 HgExtensionProjectHelper 56 HgExtensionProjectHelper
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td> 72 <td><a href="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ShelveProjectHelper.__hgCleanupShelves">__hgCleanupShelves</a></td> 76 <td><a href="#ShelveProjectHelper.__hgCleanupShelves">__hgCleanupShelves</a></td>
64 <td>Private slot to delete all shelves.</td> 77 <td>Private slot to delete all shelves.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ShelveProjectHelper.__hgDeleteShelves">__hgDeleteShelves</a></td> 80 <td><a href="#ShelveProjectHelper.__hgDeleteShelves">__hgDeleteShelves</a></td>
67 <td>Private slot to delete selected shelves.</td> 81 <td>Private slot to delete selected shelves.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#ShelveProjectHelper.__hgShelve">__hgShelve</a></td> 84 <td><a href="#ShelveProjectHelper.__hgShelve">__hgShelve</a></td>
70 <td>Private slot used to shelve all current changes.</td> 85 <td>Private slot used to shelve all current changes.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#ShelveProjectHelper.__hgShelveBrowser">__hgShelveBrowser</a></td> 88 <td><a href="#ShelveProjectHelper.__hgShelveBrowser">__hgShelveBrowser</a></td>
73 <td>Private slot to show the shelve browser dialog.</td> 89 <td>Private slot to show the shelve browser dialog.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ShelveProjectHelper.__hgUnshelve">__hgUnshelve</a></td> 92 <td><a href="#ShelveProjectHelper.__hgUnshelve">__hgUnshelve</a></td>
76 <td>Private slot used to restore a shelved change.</td> 93 <td>Private slot used to restore a shelved change.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ShelveProjectHelper.__hgUnshelveAbort">__hgUnshelveAbort</a></td> 96 <td><a href="#ShelveProjectHelper.__hgUnshelveAbort">__hgUnshelveAbort</a></td>
79 <td>Private slot used to abort an ongoing restore operation.</td> 97 <td>Private slot used to abort an ongoing restore operation.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ShelveProjectHelper.__hgUnshelveContinue">__hgUnshelveContinue</a></td> 100 <td><a href="#ShelveProjectHelper.__hgUnshelveContinue">__hgUnshelveContinue</a></td>
82 <td>Private slot used to continue an ongoing restore operation.</td> 101 <td>Private slot used to continue an ongoing restore operation.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#ShelveProjectHelper.__reopenProject">__reopenProject</a></td> 104 <td><a href="#ShelveProjectHelper.__reopenProject">__reopenProject</a></td>
85 <td>Private method to reopen the project if needed and wanted.</td> 105 <td>Private method to reopen the project if needed and wanted.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#ShelveProjectHelper.initActions">initActions</a></td> 108 <td><a href="#ShelveProjectHelper.initActions">initActions</a></td>
88 <td>Public method to generate the action objects.</td> 109 <td>Public method to generate the action objects.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#ShelveProjectHelper.initMenu">initMenu</a></td> 112 <td><a href="#ShelveProjectHelper.initMenu">initMenu</a></td>
91 <td>Public method to generate the extension menu.</td> 113 <td>Public method to generate the extension menu.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td> 116 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td>
94 <td>Public method to get the menu title.</td> 117 <td>Public method to get the menu title.</td>
95 </tr> 118 </tr>
96 </table> 119 </table>
97 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
98 <table> 121
99 <tr><td>None</td></tr> 122 <table>
100 </table> 123 <tr><td>None</td></tr>
124 </table>
125
101 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a> 126 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a>
102 <h4>ShelveProjectHelper (Constructor)</h4> 127 <h4>ShelveProjectHelper (Constructor)</h4>
103 <b>ShelveProjectHelper</b>(<i></i>) 128 <b>ShelveProjectHelper</b>(<i></i>)
129
104 <p> 130 <p>
105 Constructor 131 Constructor
106 </p><a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a> 132 </p>
133 <a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a>
107 <h4>ShelveProjectHelper.__hgCleanupShelves</h4> 134 <h4>ShelveProjectHelper.__hgCleanupShelves</h4>
108 <b>__hgCleanupShelves</b>(<i></i>) 135 <b>__hgCleanupShelves</b>(<i></i>)
136
109 <p> 137 <p>
110 Private slot to delete all shelves. 138 Private slot to delete all shelves.
111 </p><a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a> 139 </p>
140 <a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a>
112 <h4>ShelveProjectHelper.__hgDeleteShelves</h4> 141 <h4>ShelveProjectHelper.__hgDeleteShelves</h4>
113 <b>__hgDeleteShelves</b>(<i></i>) 142 <b>__hgDeleteShelves</b>(<i></i>)
143
114 <p> 144 <p>
115 Private slot to delete selected shelves. 145 Private slot to delete selected shelves.
116 </p><a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a> 146 </p>
147 <a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a>
117 <h4>ShelveProjectHelper.__hgShelve</h4> 148 <h4>ShelveProjectHelper.__hgShelve</h4>
118 <b>__hgShelve</b>(<i></i>) 149 <b>__hgShelve</b>(<i></i>)
150
119 <p> 151 <p>
120 Private slot used to shelve all current changes. 152 Private slot used to shelve all current changes.
121 </p><a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a> 153 </p>
154 <a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a>
122 <h4>ShelveProjectHelper.__hgShelveBrowser</h4> 155 <h4>ShelveProjectHelper.__hgShelveBrowser</h4>
123 <b>__hgShelveBrowser</b>(<i></i>) 156 <b>__hgShelveBrowser</b>(<i></i>)
157
124 <p> 158 <p>
125 Private slot to show the shelve browser dialog. 159 Private slot to show the shelve browser dialog.
126 </p><a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a> 160 </p>
161 <a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a>
127 <h4>ShelveProjectHelper.__hgUnshelve</h4> 162 <h4>ShelveProjectHelper.__hgUnshelve</h4>
128 <b>__hgUnshelve</b>(<i></i>) 163 <b>__hgUnshelve</b>(<i></i>)
164
129 <p> 165 <p>
130 Private slot used to restore a shelved change. 166 Private slot used to restore a shelved change.
131 </p><a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a> 167 </p>
168 <a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a>
132 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4> 169 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4>
133 <b>__hgUnshelveAbort</b>(<i></i>) 170 <b>__hgUnshelveAbort</b>(<i></i>)
171
134 <p> 172 <p>
135 Private slot used to abort an ongoing restore operation. 173 Private slot used to abort an ongoing restore operation.
136 </p><a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a> 174 </p>
175 <a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a>
137 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4> 176 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4>
138 <b>__hgUnshelveContinue</b>(<i></i>) 177 <b>__hgUnshelveContinue</b>(<i></i>)
178
139 <p> 179 <p>
140 Private slot used to continue an ongoing restore operation. 180 Private slot used to continue an ongoing restore operation.
141 </p><a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a> 181 </p>
182 <a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a>
142 <h4>ShelveProjectHelper.__reopenProject</h4> 183 <h4>ShelveProjectHelper.__reopenProject</h4>
143 <b>__reopenProject</b>(<i>shouldReopen, title</i>) 184 <b>__reopenProject</b>(<i>shouldReopen, title</i>)
185
144 <p> 186 <p>
145 Private method to reopen the project if needed and wanted. 187 Private method to reopen the project if needed and wanted.
146 </p><dl> 188 </p>
189 <dl>
190
147 <dt><i>shouldReopen</i></dt> 191 <dt><i>shouldReopen</i></dt>
148 <dd> 192 <dd>
149 flag indicating that the project should 193 flag indicating that the project should
150 be reopened (boolean) 194 be reopened (boolean)
151 </dd><dt><i>title</i></dt> 195 </dd>
196 <dt><i>title</i></dt>
152 <dd> 197 <dd>
153 title of the message box (string) 198 title of the message box (string)
154 </dd> 199 </dd>
155 </dl><a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a> 200 </dl>
201 <a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a>
156 <h4>ShelveProjectHelper.initActions</h4> 202 <h4>ShelveProjectHelper.initActions</h4>
157 <b>initActions</b>(<i></i>) 203 <b>initActions</b>(<i></i>)
204
158 <p> 205 <p>
159 Public method to generate the action objects. 206 Public method to generate the action objects.
160 </p><a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a> 207 </p>
208 <a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a>
161 <h4>ShelveProjectHelper.initMenu</h4> 209 <h4>ShelveProjectHelper.initMenu</h4>
162 <b>initMenu</b>(<i>mainMenu</i>) 210 <b>initMenu</b>(<i>mainMenu</i>)
211
163 <p> 212 <p>
164 Public method to generate the extension menu. 213 Public method to generate the extension menu.
165 </p><dl> 214 </p>
215 <dl>
216
166 <dt><i>mainMenu</i></dt> 217 <dt><i>mainMenu</i></dt>
167 <dd> 218 <dd>
168 reference to the main menu (QMenu) 219 reference to the main menu (QMenu)
169 </dd> 220 </dd>
170 </dl><dl> 221 </dl>
222 <dl>
171 <dt>Returns:</dt> 223 <dt>Returns:</dt>
172 <dd> 224 <dd>
173 populated menu (QMenu) 225 populated menu (QMenu)
174 </dd> 226 </dd>
175 </dl><a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a> 227 </dl>
228 <a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a>
176 <h4>ShelveProjectHelper.menuTitle</h4> 229 <h4>ShelveProjectHelper.menuTitle</h4>
177 <b>menuTitle</b>(<i></i>) 230 <b>menuTitle</b>(<i></i>)
231
178 <p> 232 <p>
179 Public method to get the menu title. 233 Public method to get the menu title.
180 </p><dl> 234 </p>
235 <dl>
181 <dt>Returns:</dt> 236 <dt>Returns:</dt>
182 <dd> 237 <dd>
183 title of the menu (string) 238 title of the menu (string)
184 </dd> 239 </dd>
185 </dl> 240 </dl>

Mercurial Repository: eric

eric ide

mercurial