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.HisteditExtension.histedit</h1> |
23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.histedit</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the histedit extension interface. |
26 Module implementing the histedit extension interface. |
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="#Histedit">Histedit</a></td> |
38 <td><a href="#Histedit">Histedit</a></td> |
34 <td>Class implementing the histedit extension interface.</td> |
39 <td>Class implementing the histedit extension interface.</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="Histedit" ID="Histedit"></a> |
49 <a NAME="Histedit" ID="Histedit"></a> |
43 <h2>Histedit</h2> |
50 <h2>Histedit</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing the histedit extension interface. |
53 Class implementing the histedit extension interface. |
46 </p> |
54 </p> |
47 <h3>Derived from</h3> |
55 <h3>Derived from</h3> |
48 HgExtension |
56 HgExtension |
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="#Histedit.__init__">Histedit</a></td> |
72 <td><a href="#Histedit.__init__">Histedit</a></td> |
61 <td>Constructor</td> |
73 <td>Constructor</td> |
62 </tr><tr> |
74 </tr> |
|
75 <tr> |
63 <td><a href="#Histedit.hgHisteditAbort">hgHisteditAbort</a></td> |
76 <td><a href="#Histedit.hgHisteditAbort">hgHisteditAbort</a></td> |
64 <td>Public method to abort an interrupted histedit session.</td> |
77 <td>Public method to abort an interrupted histedit session.</td> |
65 </tr><tr> |
78 </tr> |
|
79 <tr> |
66 <td><a href="#Histedit.hgHisteditContinue">hgHisteditContinue</a></td> |
80 <td><a href="#Histedit.hgHisteditContinue">hgHisteditContinue</a></td> |
67 <td>Public method to continue an interrupted histedit session.</td> |
81 <td>Public method to continue an interrupted histedit session.</td> |
68 </tr><tr> |
82 </tr> |
|
83 <tr> |
69 <td><a href="#Histedit.hgHisteditEditPlan">hgHisteditEditPlan</a></td> |
84 <td><a href="#Histedit.hgHisteditEditPlan">hgHisteditEditPlan</a></td> |
70 <td>Public method to edit the remaining actions list of an interrupted histedit session.</td> |
85 <td>Public method to edit the remaining actions list of an interrupted histedit session.</td> |
71 </tr><tr> |
86 </tr> |
|
87 <tr> |
72 <td><a href="#Histedit.hgHisteditStart">hgHisteditStart</a></td> |
88 <td><a href="#Histedit.hgHisteditStart">hgHisteditStart</a></td> |
73 <td>Public method to start a histedit session.</td> |
89 <td>Public method to start a histedit session.</td> |
74 </tr> |
90 </tr> |
75 </table> |
91 </table> |
76 <h3>Static Methods</h3> |
92 <h3>Static Methods</h3> |
77 <table> |
93 |
78 <tr><td>None</td></tr> |
94 <table> |
79 </table> |
95 <tr><td>None</td></tr> |
|
96 </table> |
|
97 |
80 <a NAME="Histedit.__init__" ID="Histedit.__init__"></a> |
98 <a NAME="Histedit.__init__" ID="Histedit.__init__"></a> |
81 <h4>Histedit (Constructor)</h4> |
99 <h4>Histedit (Constructor)</h4> |
82 <b>Histedit</b>(<i>vcs</i>) |
100 <b>Histedit</b>(<i>vcs</i>) |
|
101 |
83 <p> |
102 <p> |
84 Constructor |
103 Constructor |
85 </p><dl> |
104 </p> |
|
105 <dl> |
|
106 |
86 <dt><i>vcs</i> (Hg)</dt> |
107 <dt><i>vcs</i> (Hg)</dt> |
87 <dd> |
108 <dd> |
88 reference to the Mercurial vcs object |
109 reference to the Mercurial vcs object |
89 </dd> |
110 </dd> |
90 </dl><a NAME="Histedit.hgHisteditAbort" ID="Histedit.hgHisteditAbort"></a> |
111 </dl> |
|
112 <a NAME="Histedit.hgHisteditAbort" ID="Histedit.hgHisteditAbort"></a> |
91 <h4>Histedit.hgHisteditAbort</h4> |
113 <h4>Histedit.hgHisteditAbort</h4> |
92 <b>hgHisteditAbort</b>(<i>name</i>) |
114 <b>hgHisteditAbort</b>(<i>name</i>) |
|
115 |
93 <p> |
116 <p> |
94 Public method to abort an interrupted histedit session. |
117 Public method to abort an interrupted histedit session. |
95 </p><dl> |
118 </p> |
96 <dt><i>name</i> (str)</dt> |
119 <dl> |
97 <dd> |
120 |
98 file/directory name |
121 <dt><i>name</i> (str)</dt> |
99 </dd> |
122 <dd> |
100 </dl><dl> |
123 file/directory name |
101 <dt>Returns:</dt> |
124 </dd> |
102 <dd> |
125 </dl> |
103 flag indicating that the project should be reread |
126 <dl> |
104 </dd> |
127 <dt>Returns:</dt> |
105 </dl><dl> |
128 <dd> |
106 <dt>Return Type:</dt> |
129 flag indicating that the project should be reread |
107 <dd> |
130 </dd> |
108 bool |
131 </dl> |
109 </dd> |
132 <dl> |
110 </dl><a NAME="Histedit.hgHisteditContinue" ID="Histedit.hgHisteditContinue"></a> |
133 <dt>Return Type:</dt> |
|
134 <dd> |
|
135 bool |
|
136 </dd> |
|
137 </dl> |
|
138 <a NAME="Histedit.hgHisteditContinue" ID="Histedit.hgHisteditContinue"></a> |
111 <h4>Histedit.hgHisteditContinue</h4> |
139 <h4>Histedit.hgHisteditContinue</h4> |
112 <b>hgHisteditContinue</b>(<i>name</i>) |
140 <b>hgHisteditContinue</b>(<i>name</i>) |
|
141 |
113 <p> |
142 <p> |
114 Public method to continue an interrupted histedit session. |
143 Public method to continue an interrupted histedit session. |
115 </p><dl> |
144 </p> |
116 <dt><i>name</i> (str)</dt> |
145 <dl> |
117 <dd> |
146 |
118 file/directory name |
147 <dt><i>name</i> (str)</dt> |
119 </dd> |
148 <dd> |
120 </dl><dl> |
149 file/directory name |
121 <dt>Returns:</dt> |
150 </dd> |
122 <dd> |
151 </dl> |
123 flag indicating that the project should be reread |
152 <dl> |
124 </dd> |
153 <dt>Returns:</dt> |
125 </dl><dl> |
154 <dd> |
126 <dt>Return Type:</dt> |
155 flag indicating that the project should be reread |
127 <dd> |
156 </dd> |
128 bool |
157 </dl> |
129 </dd> |
158 <dl> |
130 </dl><a NAME="Histedit.hgHisteditEditPlan" ID="Histedit.hgHisteditEditPlan"></a> |
159 <dt>Return Type:</dt> |
|
160 <dd> |
|
161 bool |
|
162 </dd> |
|
163 </dl> |
|
164 <a NAME="Histedit.hgHisteditEditPlan" ID="Histedit.hgHisteditEditPlan"></a> |
131 <h4>Histedit.hgHisteditEditPlan</h4> |
165 <h4>Histedit.hgHisteditEditPlan</h4> |
132 <b>hgHisteditEditPlan</b>(<i>name</i>) |
166 <b>hgHisteditEditPlan</b>(<i>name</i>) |
|
167 |
133 <p> |
168 <p> |
134 Public method to edit the remaining actions list of an interrupted |
169 Public method to edit the remaining actions list of an interrupted |
135 histedit session. |
170 histedit session. |
136 </p><dl> |
171 </p> |
137 <dt><i>name</i> (str)</dt> |
172 <dl> |
138 <dd> |
173 |
139 file/directory name |
174 <dt><i>name</i> (str)</dt> |
140 </dd> |
175 <dd> |
141 </dl><dl> |
176 file/directory name |
142 <dt>Returns:</dt> |
177 </dd> |
143 <dd> |
178 </dl> |
144 flag indicating that the project should be reread |
179 <dl> |
145 </dd> |
180 <dt>Returns:</dt> |
146 </dl><dl> |
181 <dd> |
147 <dt>Return Type:</dt> |
182 flag indicating that the project should be reread |
148 <dd> |
183 </dd> |
149 bool |
184 </dl> |
150 </dd> |
185 <dl> |
151 </dl><a NAME="Histedit.hgHisteditStart" ID="Histedit.hgHisteditStart"></a> |
186 <dt>Return Type:</dt> |
|
187 <dd> |
|
188 bool |
|
189 </dd> |
|
190 </dl> |
|
191 <a NAME="Histedit.hgHisteditStart" ID="Histedit.hgHisteditStart"></a> |
152 <h4>Histedit.hgHisteditStart</h4> |
192 <h4>Histedit.hgHisteditStart</h4> |
153 <b>hgHisteditStart</b>(<i>name, rev=""</i>) |
193 <b>hgHisteditStart</b>(<i>name, rev=""</i>) |
|
194 |
154 <p> |
195 <p> |
155 Public method to start a histedit session. |
196 Public method to start a histedit session. |
156 </p><dl> |
197 </p> |
157 <dt><i>name</i> (str)</dt> |
198 <dl> |
158 <dd> |
199 |
159 file/directory name |
200 <dt><i>name</i> (str)</dt> |
160 </dd><dt><i>rev=</i> (str)</dt> |
201 <dd> |
|
202 file/directory name |
|
203 </dd> |
|
204 <dt><i>rev=</i> (str)</dt> |
161 <dd> |
205 <dd> |
162 revision to start histedit at |
206 revision to start histedit at |
163 </dd> |
207 </dd> |
164 </dl><dl> |
208 </dl> |
165 <dt>Returns:</dt> |
209 <dl> |
166 <dd> |
210 <dt>Returns:</dt> |
167 flag indicating that the project should be reread |
211 <dd> |
168 </dd> |
212 flag indicating that the project should be reread |
169 </dl><dl> |
213 </dd> |
|
214 </dl> |
|
215 <dl> |
170 <dt>Return Type:</dt> |
216 <dt>Return Type:</dt> |
171 <dd> |
217 <dd> |
172 bool |
218 bool |
173 </dd> |
219 </dd> |
174 </dl> |
220 </dl> |