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.vcsGit.GitWorktreeAddDialog</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeAddDialog</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a dialog to enter the data for a 'git worktree add' operation. |
11 Module implementing a dialog to enter the data for a 'git worktree add' operation. |
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="#GitWorktreeAddDialog">GitWorktreeAddDialog</a></td> |
22 <td><a href="#GitWorktreeAddDialog">GitWorktreeAddDialog</a></td> |
25 <td>Class implementing a dialog to enter the data for a 'git worktree add' operation.</td> |
23 <td>Class implementing a dialog to enter the data for a 'git worktree add' operation.</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="GitWorktreeAddDialog" ID="GitWorktreeAddDialog"></a> |
34 <a NAME="GitWorktreeAddDialog" ID="GitWorktreeAddDialog"></a> |
36 <h2>GitWorktreeAddDialog</h2> |
35 <h2>GitWorktreeAddDialog</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing a dialog to enter the data for a 'git worktree add' operation. |
37 Class implementing a dialog to enter the data for a 'git worktree add' operation. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 QDialog, Ui_GitWorktreeAddDialog |
41 QDialog, Ui_GitWorktreeAddDialog |
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="#GitWorktreeAddDialog.__init__">GitWorktreeAddDialog</a></td> |
55 <td><a href="#GitWorktreeAddDialog.__init__">GitWorktreeAddDialog</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
93 <tr> |
90 <tr> |
94 <td><a href="#GitWorktreeAddDialog.on_worktreePathPicker_textChanged">on_worktreePathPicker_textChanged</a></td> |
91 <td><a href="#GitWorktreeAddDialog.on_worktreePathPicker_textChanged">on_worktreePathPicker_textChanged</a></td> |
95 <td>Private slot handling a change of the worktree path.</td> |
92 <td>Private slot handling a change of the worktree path.</td> |
96 </tr> |
93 </tr> |
97 </table> |
94 </table> |
|
95 |
98 <h3>Static Methods</h3> |
96 <h3>Static Methods</h3> |
99 |
97 <table> |
100 <table> |
98 <tr><td>None</td></tr> |
101 <tr><td>None</td></tr> |
99 </table> |
102 </table> |
100 |
103 |
101 |
104 <a NAME="GitWorktreeAddDialog.__init__" ID="GitWorktreeAddDialog.__init__"></a> |
102 <a NAME="GitWorktreeAddDialog.__init__" ID="GitWorktreeAddDialog.__init__"></a> |
105 <h4>GitWorktreeAddDialog (Constructor)</h4> |
103 <h4>GitWorktreeAddDialog (Constructor)</h4> |
106 <b>GitWorktreeAddDialog</b>(<i>parentDirectory, tagsList, branchesList, parent=None</i>) |
104 <b>GitWorktreeAddDialog</b>(<i>parentDirectory, tagsList, branchesList, parent=None</i>) |
107 |
|
108 <p> |
105 <p> |
109 Constructor |
106 Constructor |
110 </p> |
107 </p> |
|
108 |
111 <dl> |
109 <dl> |
112 |
110 |
113 <dt><i>parentDirectory</i> (str)</dt> |
111 <dt><i>parentDirectory</i> (str)</dt> |
114 <dd> |
112 <dd> |
115 path of the worktrees parent directory |
113 path of the worktrees parent directory |
128 </dd> |
126 </dd> |
129 </dl> |
127 </dl> |
130 <a NAME="GitWorktreeAddDialog.__updateOK" ID="GitWorktreeAddDialog.__updateOK"></a> |
128 <a NAME="GitWorktreeAddDialog.__updateOK" ID="GitWorktreeAddDialog.__updateOK"></a> |
131 <h4>GitWorktreeAddDialog.__updateOK</h4> |
129 <h4>GitWorktreeAddDialog.__updateOK</h4> |
132 <b>__updateOK</b>(<i></i>) |
130 <b>__updateOK</b>(<i></i>) |
133 |
|
134 <p> |
131 <p> |
135 Private method to set the enabled state of the OK button. |
132 Private method to set the enabled state of the OK button. |
136 </p> |
133 </p> |
|
134 |
137 <a NAME="GitWorktreeAddDialog.getParameters" ID="GitWorktreeAddDialog.getParameters"></a> |
135 <a NAME="GitWorktreeAddDialog.getParameters" ID="GitWorktreeAddDialog.getParameters"></a> |
138 <h4>GitWorktreeAddDialog.getParameters</h4> |
136 <h4>GitWorktreeAddDialog.getParameters</h4> |
139 <b>getParameters</b>(<i></i>) |
137 <b>getParameters</b>(<i></i>) |
140 |
|
141 <p> |
138 <p> |
142 Public method to get the entered parameters for the 'git worktree add' |
139 Public method to get the entered parameters for the 'git worktree add' |
143 operation. |
140 operation. |
144 </p> |
141 </p> |
|
142 |
145 <dl> |
143 <dl> |
146 <dt>Return:</dt> |
144 <dt>Return:</dt> |
147 <dd> |
145 <dd> |
148 dictionary containing the entered data. This dictionary has these keys. |
146 dictionary containing the entered data. This dictionary has these keys. |
149 <ul> |
147 <ul> |
166 </dd> |
164 </dd> |
167 </dl> |
165 </dl> |
168 <a NAME="GitWorktreeAddDialog.on_branchButton_toggled" ID="GitWorktreeAddDialog.on_branchButton_toggled"></a> |
166 <a NAME="GitWorktreeAddDialog.on_branchButton_toggled" ID="GitWorktreeAddDialog.on_branchButton_toggled"></a> |
169 <h4>GitWorktreeAddDialog.on_branchButton_toggled</h4> |
167 <h4>GitWorktreeAddDialog.on_branchButton_toggled</h4> |
170 <b>on_branchButton_toggled</b>(<i>checked</i>) |
168 <b>on_branchButton_toggled</b>(<i>checked</i>) |
171 |
|
172 <p> |
169 <p> |
173 Private slot to handle changes of the Branch select button. |
170 Private slot to handle changes of the Branch select button. |
174 </p> |
171 </p> |
|
172 |
175 <dl> |
173 <dl> |
176 |
174 |
177 <dt><i>checked</i> (bool)</dt> |
175 <dt><i>checked</i> (bool)</dt> |
178 <dd> |
176 <dd> |
179 state of the button |
177 state of the button |
180 </dd> |
178 </dd> |
181 </dl> |
179 </dl> |
182 <a NAME="GitWorktreeAddDialog.on_branchCombo_editTextChanged" ID="GitWorktreeAddDialog.on_branchCombo_editTextChanged"></a> |
180 <a NAME="GitWorktreeAddDialog.on_branchCombo_editTextChanged" ID="GitWorktreeAddDialog.on_branchCombo_editTextChanged"></a> |
183 <h4>GitWorktreeAddDialog.on_branchCombo_editTextChanged</h4> |
181 <h4>GitWorktreeAddDialog.on_branchCombo_editTextChanged</h4> |
184 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) |
182 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) |
185 |
|
186 <p> |
183 <p> |
187 Private slot to handle changes of the Branch combo. |
184 Private slot to handle changes of the Branch combo. |
188 </p> |
185 </p> |
|
186 |
189 <dl> |
187 <dl> |
190 |
188 |
191 <dt><i>txt</i> (str)</dt> |
189 <dt><i>txt</i> (str)</dt> |
192 <dd> |
190 <dd> |
193 text of the combo |
191 text of the combo |
194 </dd> |
192 </dd> |
195 </dl> |
193 </dl> |
196 <a NAME="GitWorktreeAddDialog.on_revButton_toggled" ID="GitWorktreeAddDialog.on_revButton_toggled"></a> |
194 <a NAME="GitWorktreeAddDialog.on_revButton_toggled" ID="GitWorktreeAddDialog.on_revButton_toggled"></a> |
197 <h4>GitWorktreeAddDialog.on_revButton_toggled</h4> |
195 <h4>GitWorktreeAddDialog.on_revButton_toggled</h4> |
198 <b>on_revButton_toggled</b>(<i>checked</i>) |
196 <b>on_revButton_toggled</b>(<i>checked</i>) |
199 |
|
200 <p> |
197 <p> |
201 Private slot to handle changes of the rev select button. |
198 Private slot to handle changes of the rev select button. |
202 </p> |
199 </p> |
|
200 |
203 <dl> |
201 <dl> |
204 |
202 |
205 <dt><i>checked</i> (bool)</dt> |
203 <dt><i>checked</i> (bool)</dt> |
206 <dd> |
204 <dd> |
207 state of the button |
205 state of the button |
208 </dd> |
206 </dd> |
209 </dl> |
207 </dl> |
210 <a NAME="GitWorktreeAddDialog.on_revEdit_textChanged" ID="GitWorktreeAddDialog.on_revEdit_textChanged"></a> |
208 <a NAME="GitWorktreeAddDialog.on_revEdit_textChanged" ID="GitWorktreeAddDialog.on_revEdit_textChanged"></a> |
211 <h4>GitWorktreeAddDialog.on_revEdit_textChanged</h4> |
209 <h4>GitWorktreeAddDialog.on_revEdit_textChanged</h4> |
212 <b>on_revEdit_textChanged</b>(<i>txt</i>) |
210 <b>on_revEdit_textChanged</b>(<i>txt</i>) |
213 |
|
214 <p> |
211 <p> |
215 Private slot to handle changes of the rev edit. |
212 Private slot to handle changes of the rev edit. |
216 </p> |
213 </p> |
|
214 |
217 <dl> |
215 <dl> |
218 |
216 |
219 <dt><i>txt</i> (str)</dt> |
217 <dt><i>txt</i> (str)</dt> |
220 <dd> |
218 <dd> |
221 text of the edit |
219 text of the edit |
222 </dd> |
220 </dd> |
223 </dl> |
221 </dl> |
224 <a NAME="GitWorktreeAddDialog.on_tagButton_toggled" ID="GitWorktreeAddDialog.on_tagButton_toggled"></a> |
222 <a NAME="GitWorktreeAddDialog.on_tagButton_toggled" ID="GitWorktreeAddDialog.on_tagButton_toggled"></a> |
225 <h4>GitWorktreeAddDialog.on_tagButton_toggled</h4> |
223 <h4>GitWorktreeAddDialog.on_tagButton_toggled</h4> |
226 <b>on_tagButton_toggled</b>(<i>checked</i>) |
224 <b>on_tagButton_toggled</b>(<i>checked</i>) |
227 |
|
228 <p> |
225 <p> |
229 Private slot to handle changes of the Tag select button. |
226 Private slot to handle changes of the Tag select button. |
230 </p> |
227 </p> |
|
228 |
231 <dl> |
229 <dl> |
232 |
230 |
233 <dt><i>checked</i> (bool)</dt> |
231 <dt><i>checked</i> (bool)</dt> |
234 <dd> |
232 <dd> |
235 state of the button |
233 state of the button |
236 </dd> |
234 </dd> |
237 </dl> |
235 </dl> |
238 <a NAME="GitWorktreeAddDialog.on_tagCombo_editTextChanged" ID="GitWorktreeAddDialog.on_tagCombo_editTextChanged"></a> |
236 <a NAME="GitWorktreeAddDialog.on_tagCombo_editTextChanged" ID="GitWorktreeAddDialog.on_tagCombo_editTextChanged"></a> |
239 <h4>GitWorktreeAddDialog.on_tagCombo_editTextChanged</h4> |
237 <h4>GitWorktreeAddDialog.on_tagCombo_editTextChanged</h4> |
240 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) |
238 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) |
241 |
|
242 <p> |
239 <p> |
243 Private slot to handle changes of the Tag combo. |
240 Private slot to handle changes of the Tag combo. |
244 </p> |
241 </p> |
|
242 |
245 <dl> |
243 <dl> |
246 |
244 |
247 <dt><i>txt</i> (str)</dt> |
245 <dt><i>txt</i> (str)</dt> |
248 <dd> |
246 <dd> |
249 text of the combo |
247 text of the combo |
250 </dd> |
248 </dd> |
251 </dl> |
249 </dl> |
252 <a NAME="GitWorktreeAddDialog.on_worktreePathPicker_textChanged" ID="GitWorktreeAddDialog.on_worktreePathPicker_textChanged"></a> |
250 <a NAME="GitWorktreeAddDialog.on_worktreePathPicker_textChanged" ID="GitWorktreeAddDialog.on_worktreePathPicker_textChanged"></a> |
253 <h4>GitWorktreeAddDialog.on_worktreePathPicker_textChanged</h4> |
251 <h4>GitWorktreeAddDialog.on_worktreePathPicker_textChanged</h4> |
254 <b>on_worktreePathPicker_textChanged</b>(<i>worktree</i>) |
252 <b>on_worktreePathPicker_textChanged</b>(<i>worktree</i>) |
255 |
|
256 <p> |
253 <p> |
257 Private slot handling a change of the worktree path. |
254 Private slot handling a change of the worktree path. |
258 </p> |
255 </p> |
|
256 |
259 <dl> |
257 <dl> |
260 |
258 |
261 <dt><i>worktree</i> (str)</dt> |
259 <dt><i>worktree</i> (str)</dt> |
262 <dd> |
260 <dd> |
263 entered worktree path |
261 entered worktree path |