232 </dd> |
230 </dd> |
233 </dl> |
231 </dl> |
234 <a NAME="GitWorktreeDialog.__readStderr" ID="GitWorktreeDialog.__readStderr"></a> |
232 <a NAME="GitWorktreeDialog.__readStderr" ID="GitWorktreeDialog.__readStderr"></a> |
235 <h4>GitWorktreeDialog.__readStderr</h4> |
233 <h4>GitWorktreeDialog.__readStderr</h4> |
236 <b>__readStderr</b>(<i></i>) |
234 <b>__readStderr</b>(<i></i>) |
237 |
|
238 <p> |
235 <p> |
239 Private slot to handle the readyReadStandardError signal. |
236 Private slot to handle the readyReadStandardError signal. |
240 </p> |
237 </p> |
241 <p> |
238 <p> |
242 It reads the error output of the process and inserts it into the |
239 It reads the error output of the process and inserts it into the |
243 error pane. |
240 error pane. |
244 </p> |
241 </p> |
|
242 |
245 <a NAME="GitWorktreeDialog.__readStdout" ID="GitWorktreeDialog.__readStdout"></a> |
243 <a NAME="GitWorktreeDialog.__readStdout" ID="GitWorktreeDialog.__readStdout"></a> |
246 <h4>GitWorktreeDialog.__readStdout</h4> |
244 <h4>GitWorktreeDialog.__readStdout</h4> |
247 <b>__readStdout</b>(<i></i>) |
245 <b>__readStdout</b>(<i></i>) |
248 |
|
249 <p> |
246 <p> |
250 Private slot to handle the readyReadStandardOutput signal. |
247 Private slot to handle the readyReadStandardOutput signal. |
251 </p> |
248 </p> |
252 <p> |
249 <p> |
253 It reads the output of the process, formats it and inserts it into |
250 It reads the output of the process, formats it and inserts it into |
254 the contents pane. |
251 the contents pane. |
255 </p> |
252 </p> |
|
253 |
256 <a NAME="GitWorktreeDialog.__refreshButtonClicked" ID="GitWorktreeDialog.__refreshButtonClicked"></a> |
254 <a NAME="GitWorktreeDialog.__refreshButtonClicked" ID="GitWorktreeDialog.__refreshButtonClicked"></a> |
257 <h4>GitWorktreeDialog.__refreshButtonClicked</h4> |
255 <h4>GitWorktreeDialog.__refreshButtonClicked</h4> |
258 <b>__refreshButtonClicked</b>(<i></i>) |
256 <b>__refreshButtonClicked</b>(<i></i>) |
259 |
|
260 <p> |
257 <p> |
261 Private slot to refresh the worktree display. |
258 Private slot to refresh the worktree display. |
262 </p> |
259 </p> |
|
260 |
263 <a NAME="GitWorktreeDialog.__resizeColumns" ID="GitWorktreeDialog.__resizeColumns"></a> |
261 <a NAME="GitWorktreeDialog.__resizeColumns" ID="GitWorktreeDialog.__resizeColumns"></a> |
264 <h4>GitWorktreeDialog.__resizeColumns</h4> |
262 <h4>GitWorktreeDialog.__resizeColumns</h4> |
265 <b>__resizeColumns</b>(<i></i>) |
263 <b>__resizeColumns</b>(<i></i>) |
266 |
|
267 <p> |
264 <p> |
268 Private method to resize the list columns. |
265 Private method to resize the list columns. |
269 </p> |
266 </p> |
|
267 |
270 <a NAME="GitWorktreeDialog.__resort" ID="GitWorktreeDialog.__resort"></a> |
268 <a NAME="GitWorktreeDialog.__resort" ID="GitWorktreeDialog.__resort"></a> |
271 <h4>GitWorktreeDialog.__resort</h4> |
269 <h4>GitWorktreeDialog.__resort</h4> |
272 <b>__resort</b>(<i></i>) |
270 <b>__resort</b>(<i></i>) |
273 |
|
274 <p> |
271 <p> |
275 Private method to resort the tree. |
272 Private method to resort the tree. |
276 </p> |
273 </p> |
|
274 |
277 <a NAME="GitWorktreeDialog.__showActionsMenu" ID="GitWorktreeDialog.__showActionsMenu"></a> |
275 <a NAME="GitWorktreeDialog.__showActionsMenu" ID="GitWorktreeDialog.__showActionsMenu"></a> |
278 <h4>GitWorktreeDialog.__showActionsMenu</h4> |
276 <h4>GitWorktreeDialog.__showActionsMenu</h4> |
279 <b>__showActionsMenu</b>(<i></i>) |
277 <b>__showActionsMenu</b>(<i></i>) |
280 |
|
281 <p> |
278 <p> |
282 Private slot to prepare the actions button menu before it is shown. |
279 Private slot to prepare the actions button menu before it is shown. |
283 </p> |
280 </p> |
|
281 |
284 <a NAME="GitWorktreeDialog.__worktreeAdd" ID="GitWorktreeDialog.__worktreeAdd"></a> |
282 <a NAME="GitWorktreeDialog.__worktreeAdd" ID="GitWorktreeDialog.__worktreeAdd"></a> |
285 <h4>GitWorktreeDialog.__worktreeAdd</h4> |
283 <h4>GitWorktreeDialog.__worktreeAdd</h4> |
286 <b>__worktreeAdd</b>(<i></i>) |
284 <b>__worktreeAdd</b>(<i></i>) |
287 |
|
288 <p> |
285 <p> |
289 Private slot to add a linked worktree. |
286 Private slot to add a linked worktree. |
290 </p> |
287 </p> |
|
288 |
291 <a NAME="GitWorktreeDialog.__worktreeLock" ID="GitWorktreeDialog.__worktreeLock"></a> |
289 <a NAME="GitWorktreeDialog.__worktreeLock" ID="GitWorktreeDialog.__worktreeLock"></a> |
292 <h4>GitWorktreeDialog.__worktreeLock</h4> |
290 <h4>GitWorktreeDialog.__worktreeLock</h4> |
293 <b>__worktreeLock</b>(<i></i>) |
291 <b>__worktreeLock</b>(<i></i>) |
294 |
|
295 <p> |
292 <p> |
296 Private slot to lock a worktree. |
293 Private slot to lock a worktree. |
297 </p> |
294 </p> |
|
295 |
298 <a NAME="GitWorktreeDialog.__worktreeMove" ID="GitWorktreeDialog.__worktreeMove"></a> |
296 <a NAME="GitWorktreeDialog.__worktreeMove" ID="GitWorktreeDialog.__worktreeMove"></a> |
299 <h4>GitWorktreeDialog.__worktreeMove</h4> |
297 <h4>GitWorktreeDialog.__worktreeMove</h4> |
300 <b>__worktreeMove</b>(<i></i>) |
298 <b>__worktreeMove</b>(<i></i>) |
301 |
|
302 <p> |
299 <p> |
303 Private slot to move a worktree to a new location. |
300 Private slot to move a worktree to a new location. |
304 </p> |
301 </p> |
|
302 |
305 <a NAME="GitWorktreeDialog.__worktreePrune" ID="GitWorktreeDialog.__worktreePrune"></a> |
303 <a NAME="GitWorktreeDialog.__worktreePrune" ID="GitWorktreeDialog.__worktreePrune"></a> |
306 <h4>GitWorktreeDialog.__worktreePrune</h4> |
304 <h4>GitWorktreeDialog.__worktreePrune</h4> |
307 <b>__worktreePrune</b>(<i></i>) |
305 <b>__worktreePrune</b>(<i></i>) |
308 |
|
309 <p> |
306 <p> |
310 Private slot to prune worktree information. |
307 Private slot to prune worktree information. |
311 </p> |
308 </p> |
|
309 |
312 <a NAME="GitWorktreeDialog.__worktreeRemove" ID="GitWorktreeDialog.__worktreeRemove"></a> |
310 <a NAME="GitWorktreeDialog.__worktreeRemove" ID="GitWorktreeDialog.__worktreeRemove"></a> |
313 <h4>GitWorktreeDialog.__worktreeRemove</h4> |
311 <h4>GitWorktreeDialog.__worktreeRemove</h4> |
314 <b>__worktreeRemove</b>(<i>force=False</i>) |
312 <b>__worktreeRemove</b>(<i>force=False</i>) |
315 |
|
316 <p> |
313 <p> |
317 Private slot to remove a linked worktree. |
314 Private slot to remove a linked worktree. |
318 </p> |
315 </p> |
|
316 |
319 <dl> |
317 <dl> |
320 |
318 |
321 <dt><i>force</i> (bool (optional)</dt> |
319 <dt><i>force</i> (bool (optional)</dt> |
322 <dd> |
320 <dd> |
323 flag indicating a forceful remove (defaults to False) |
321 flag indicating a forceful remove (defaults to False) |
324 </dd> |
322 </dd> |
325 </dl> |
323 </dl> |
326 <a NAME="GitWorktreeDialog.__worktreeRemoveForced" ID="GitWorktreeDialog.__worktreeRemoveForced"></a> |
324 <a NAME="GitWorktreeDialog.__worktreeRemoveForced" ID="GitWorktreeDialog.__worktreeRemoveForced"></a> |
327 <h4>GitWorktreeDialog.__worktreeRemoveForced</h4> |
325 <h4>GitWorktreeDialog.__worktreeRemoveForced</h4> |
328 <b>__worktreeRemoveForced</b>(<i></i>) |
326 <b>__worktreeRemoveForced</b>(<i></i>) |
329 |
|
330 <p> |
327 <p> |
331 Private slot to remove a linked worktree forcefully. |
328 Private slot to remove a linked worktree forcefully. |
332 </p> |
329 </p> |
|
330 |
333 <a NAME="GitWorktreeDialog.__worktreeRepair" ID="GitWorktreeDialog.__worktreeRepair"></a> |
331 <a NAME="GitWorktreeDialog.__worktreeRepair" ID="GitWorktreeDialog.__worktreeRepair"></a> |
334 <h4>GitWorktreeDialog.__worktreeRepair</h4> |
332 <h4>GitWorktreeDialog.__worktreeRepair</h4> |
335 <b>__worktreeRepair</b>(<i>worktreePaths=None</i>) |
333 <b>__worktreeRepair</b>(<i>worktreePaths=None</i>) |
336 |
|
337 <p> |
334 <p> |
338 Private slot to repair worktree administrative files. |
335 Private slot to repair worktree administrative files. |
339 </p> |
336 </p> |
|
337 |
340 <dl> |
338 <dl> |
341 |
339 |
342 <dt><i>worktreePaths</i> (list of str (optional))</dt> |
340 <dt><i>worktreePaths</i> (list of str (optional))</dt> |
343 <dd> |
341 <dd> |
344 list of worktree paths to be repaired (defaults to None) |
342 list of worktree paths to be repaired (defaults to None) |
345 </dd> |
343 </dd> |
346 </dl> |
344 </dl> |
347 <a NAME="GitWorktreeDialog.__worktreeRepairMultiple" ID="GitWorktreeDialog.__worktreeRepairMultiple"></a> |
345 <a NAME="GitWorktreeDialog.__worktreeRepairMultiple" ID="GitWorktreeDialog.__worktreeRepairMultiple"></a> |
348 <h4>GitWorktreeDialog.__worktreeRepairMultiple</h4> |
346 <h4>GitWorktreeDialog.__worktreeRepairMultiple</h4> |
349 <b>__worktreeRepairMultiple</b>(<i></i>) |
347 <b>__worktreeRepairMultiple</b>(<i></i>) |
350 |
|
351 <p> |
348 <p> |
352 Private slot to repair worktree administrative files for multiple worktree |
349 Private slot to repair worktree administrative files for multiple worktree |
353 paths. |
350 paths. |
354 </p> |
351 </p> |
|
352 |
355 <a NAME="GitWorktreeDialog.__worktreeUnlock" ID="GitWorktreeDialog.__worktreeUnlock"></a> |
353 <a NAME="GitWorktreeDialog.__worktreeUnlock" ID="GitWorktreeDialog.__worktreeUnlock"></a> |
356 <h4>GitWorktreeDialog.__worktreeUnlock</h4> |
354 <h4>GitWorktreeDialog.__worktreeUnlock</h4> |
357 <b>__worktreeUnlock</b>(<i></i>) |
355 <b>__worktreeUnlock</b>(<i></i>) |
358 |
|
359 <p> |
356 <p> |
360 Private slot to unlock a worktree. |
357 Private slot to unlock a worktree. |
361 </p> |
358 </p> |
|
359 |
362 <a NAME="GitWorktreeDialog.closeEvent" ID="GitWorktreeDialog.closeEvent"></a> |
360 <a NAME="GitWorktreeDialog.closeEvent" ID="GitWorktreeDialog.closeEvent"></a> |
363 <h4>GitWorktreeDialog.closeEvent</h4> |
361 <h4>GitWorktreeDialog.closeEvent</h4> |
364 <b>closeEvent</b>(<i>e</i>) |
362 <b>closeEvent</b>(<i>e</i>) |
365 |
|
366 <p> |
363 <p> |
367 Protected slot implementing a close event handler. |
364 Protected slot implementing a close event handler. |
368 </p> |
365 </p> |
|
366 |
369 <dl> |
367 <dl> |
370 |
368 |
371 <dt><i>e</i> (QCloseEvent)</dt> |
369 <dt><i>e</i> (QCloseEvent)</dt> |
372 <dd> |
370 <dd> |
373 close event |
371 close event |
374 </dd> |
372 </dd> |
375 </dl> |
373 </dl> |
376 <a NAME="GitWorktreeDialog.on_buttonBox_clicked" ID="GitWorktreeDialog.on_buttonBox_clicked"></a> |
374 <a NAME="GitWorktreeDialog.on_buttonBox_clicked" ID="GitWorktreeDialog.on_buttonBox_clicked"></a> |
377 <h4>GitWorktreeDialog.on_buttonBox_clicked</h4> |
375 <h4>GitWorktreeDialog.on_buttonBox_clicked</h4> |
378 <b>on_buttonBox_clicked</b>(<i>button</i>) |
376 <b>on_buttonBox_clicked</b>(<i>button</i>) |
379 |
|
380 <p> |
377 <p> |
381 Private slot called by a button of the button box clicked. |
378 Private slot called by a button of the button box clicked. |
382 </p> |
379 </p> |
|
380 |
383 <dl> |
381 <dl> |
384 |
382 |
385 <dt><i>button</i> (QAbstractButton)</dt> |
383 <dt><i>button</i> (QAbstractButton)</dt> |
386 <dd> |
384 <dd> |
387 button that was clicked |
385 button that was clicked |
388 </dd> |
386 </dd> |
389 </dl> |
387 </dl> |
390 <a NAME="GitWorktreeDialog.on_expireCheckBox_toggled" ID="GitWorktreeDialog.on_expireCheckBox_toggled"></a> |
388 <a NAME="GitWorktreeDialog.on_expireCheckBox_toggled" ID="GitWorktreeDialog.on_expireCheckBox_toggled"></a> |
391 <h4>GitWorktreeDialog.on_expireCheckBox_toggled</h4> |
389 <h4>GitWorktreeDialog.on_expireCheckBox_toggled</h4> |
392 <b>on_expireCheckBox_toggled</b>(<i>checked</i>) |
390 <b>on_expireCheckBox_toggled</b>(<i>checked</i>) |
393 |
|
394 <p> |
391 <p> |
395 Private slot to handle a change of the expire checkbox. |
392 Private slot to handle a change of the expire checkbox. |
396 </p> |
393 </p> |
|
394 |
397 <dl> |
395 <dl> |
398 |
396 |
399 <dt><i>checked</i> (bool)</dt> |
397 <dt><i>checked</i> (bool)</dt> |
400 <dd> |
398 <dd> |
401 state of the checkbox |
399 state of the checkbox |
402 </dd> |
400 </dd> |
403 </dl> |
401 </dl> |
404 <a NAME="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged" ID="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged"></a> |
402 <a NAME="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged" ID="GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged"></a> |
405 <h4>GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged</h4> |
403 <h4>GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged</h4> |
406 <b>on_expireDateTimeEdit_dateTimeChanged</b>(<i>dateTime</i>) |
404 <b>on_expireDateTimeEdit_dateTimeChanged</b>(<i>dateTime</i>) |
407 |
|
408 <p> |
405 <p> |
409 Private slot to handle a change of the expire date and time. |
406 Private slot to handle a change of the expire date and time. |
410 </p> |
407 </p> |
|
408 |
411 <dl> |
409 <dl> |
412 |
410 |
413 <dt><i>dateTime</i> (QDateTime)</dt> |
411 <dt><i>dateTime</i> (QDateTime)</dt> |
414 <dd> |
412 <dd> |
415 DESCRIPTION |
413 DESCRIPTION |
416 </dd> |
414 </dd> |
417 </dl> |
415 </dl> |
418 <a NAME="GitWorktreeDialog.show" ID="GitWorktreeDialog.show"></a> |
416 <a NAME="GitWorktreeDialog.show" ID="GitWorktreeDialog.show"></a> |
419 <h4>GitWorktreeDialog.show</h4> |
417 <h4>GitWorktreeDialog.show</h4> |
420 <b>show</b>(<i></i>) |
418 <b>show</b>(<i></i>) |
421 |
|
422 <p> |
419 <p> |
423 Public slot to show the dialog. |
420 Public slot to show the dialog. |
424 </p> |
421 </p> |
|
422 |
425 <a NAME="GitWorktreeDialog.start" ID="GitWorktreeDialog.start"></a> |
423 <a NAME="GitWorktreeDialog.start" ID="GitWorktreeDialog.start"></a> |
426 <h4>GitWorktreeDialog.start</h4> |
424 <h4>GitWorktreeDialog.start</h4> |
427 <b>start</b>(<i>projectDir</i>) |
425 <b>start</b>(<i>projectDir</i>) |
428 |
|
429 <p> |
426 <p> |
430 Public slot to start the git worktree list command. |
427 Public slot to start the git worktree list command. |
431 </p> |
428 </p> |
|
429 |
432 <dl> |
430 <dl> |
433 |
431 |
434 <dt><i>projectDir</i> (str)</dt> |
432 <dt><i>projectDir</i> (str)</dt> |
435 <dd> |
433 <dd> |
436 name of the project directory |
434 name of the project directory |