Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeAddDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeAddDialog.html
- branch
- eric7
- changeset 9620
- 9563c83ce83d
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9619:7033f25b1462 | 9620:9563c83ce83d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeAddDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeAddDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the data for a 'git worktree add' operation. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#GitWorktreeAddDialog">GitWorktreeAddDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the data for a 'git worktree add' operation.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="GitWorktreeAddDialog" ID="GitWorktreeAddDialog"></a> | |
| 36 <h2>GitWorktreeAddDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the data for a 'git worktree add' operation. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_GitWorktreeAddDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#GitWorktreeAddDialog.__init__">GitWorktreeAddDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitWorktreeAddDialog.__updateOK">__updateOK</a></td> | |
| 63 <td>Private method to set the enabled state of the OK button.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitWorktreeAddDialog.getParameters">getParameters</a></td> | |
| 67 <td>Public method to get the entered parameters for the 'git worktree add' operation.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitWorktreeAddDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> | |
| 71 <td>Private slot to handle changes of the Branch select button.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitWorktreeAddDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> | |
| 75 <td>Private slot to handle changes of the Branch combo.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitWorktreeAddDialog.on_revButton_toggled">on_revButton_toggled</a></td> | |
| 79 <td>Private slot to handle changes of the rev select button.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitWorktreeAddDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td> | |
| 83 <td>Private slot to handle changes of the rev edit.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitWorktreeAddDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> | |
| 87 <td>Private slot to handle changes of the Tag select button.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitWorktreeAddDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> | |
| 91 <td>Private slot to handle changes of the Tag combo.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitWorktreeAddDialog.on_worktreePathPicker_textChanged">on_worktreePathPicker_textChanged</a></td> | |
| 95 <td>Private slot handling a change of the worktree path.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="GitWorktreeAddDialog.__init__" ID="GitWorktreeAddDialog.__init__"></a> | |
| 105 <h4>GitWorktreeAddDialog (Constructor)</h4> | |
| 106 <b>GitWorktreeAddDialog</b>(<i>parentDirectory, tagsList, branchesList, parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>parentDirectory</i> (str)</dt> | |
| 114 <dd> | |
| 115 path of the worktrees parent directory | |
| 116 </dd> | |
| 117 <dt><i>tagsList</i> (list of str)</dt> | |
| 118 <dd> | |
| 119 list of tags | |
| 120 </dd> | |
| 121 <dt><i>branchesList</i> (list of str)</dt> | |
| 122 <dd> | |
| 123 list of branches | |
| 124 </dd> | |
| 125 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 126 <dd> | |
| 127 reference to the parent widget (defaults to None) | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="GitWorktreeAddDialog.__updateOK" ID="GitWorktreeAddDialog.__updateOK"></a> | |
| 131 <h4>GitWorktreeAddDialog.__updateOK</h4> | |
| 132 <b>__updateOK</b>(<i></i>) | |
| 133 | |
| 134 <p> | |
| 135 Private method to set the enabled state of the OK button. | |
| 136 </p> | |
| 137 <a NAME="GitWorktreeAddDialog.getParameters" ID="GitWorktreeAddDialog.getParameters"></a> | |
| 138 <h4>GitWorktreeAddDialog.getParameters</h4> | |
| 139 <b>getParameters</b>(<i></i>) | |
| 140 | |
| 141 <p> | |
| 142 Public method to get the entered parameters for the 'git worktree add' | |
| 143 operation. | |
| 144 </p> | |
| 145 <dl> | |
| 146 <dt>Return:</dt> | |
| 147 <dd> | |
| 148 dictionary containing the entered data. This dictionary has these keys. | |
| 149 <ul> | |
| 150 <li>path: path for the new worktree</li> | |
| 151 <li>branch: name for the worktree branch</li> | |
| 152 <li>force_branch: enforce creating the branch</li> | |
| 153 <li>lock: flag indicating to lock the worktree</li> | |
| 154 <li>lock_reason: optional reason string for the lock</li> | |
| 155 <li>detach: flag indicating to detach the HEAD in the new worktree</li> | |
| 156 <li>commit: commit to check out in the new worktree (branch, tag, commit ID | |
| 157 or empty for HEAD) </li> | |
| 158 <li>force: flag indicating to enforce the worktree creation</li> | |
| 159 </ul> | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return Type:</dt> | |
| 164 <dd> | |
| 165 dict | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="GitWorktreeAddDialog.on_branchButton_toggled" ID="GitWorktreeAddDialog.on_branchButton_toggled"></a> | |
| 169 <h4>GitWorktreeAddDialog.on_branchButton_toggled</h4> | |
| 170 <b>on_branchButton_toggled</b>(<i>checked</i>) | |
| 171 | |
| 172 <p> | |
| 173 Private slot to handle changes of the Branch select button. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>checked</i> (bool)</dt> | |
| 178 <dd> | |
| 179 state of the button | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="GitWorktreeAddDialog.on_branchCombo_editTextChanged" ID="GitWorktreeAddDialog.on_branchCombo_editTextChanged"></a> | |
| 183 <h4>GitWorktreeAddDialog.on_branchCombo_editTextChanged</h4> | |
| 184 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) | |
| 185 | |
| 186 <p> | |
| 187 Private slot to handle changes of the Branch combo. | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>txt</i> (str)</dt> | |
| 192 <dd> | |
| 193 text of the combo | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <a NAME="GitWorktreeAddDialog.on_revButton_toggled" ID="GitWorktreeAddDialog.on_revButton_toggled"></a> | |
| 197 <h4>GitWorktreeAddDialog.on_revButton_toggled</h4> | |
| 198 <b>on_revButton_toggled</b>(<i>checked</i>) | |
| 199 | |
| 200 <p> | |
| 201 Private slot to handle changes of the rev select button. | |
| 202 </p> | |
| 203 <dl> | |
| 204 | |
| 205 <dt><i>checked</i> (bool)</dt> | |
| 206 <dd> | |
| 207 state of the button | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="GitWorktreeAddDialog.on_revEdit_textChanged" ID="GitWorktreeAddDialog.on_revEdit_textChanged"></a> | |
| 211 <h4>GitWorktreeAddDialog.on_revEdit_textChanged</h4> | |
| 212 <b>on_revEdit_textChanged</b>(<i>txt</i>) | |
| 213 | |
| 214 <p> | |
| 215 Private slot to handle changes of the rev edit. | |
| 216 </p> | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>txt</i> (str)</dt> | |
| 220 <dd> | |
| 221 text of the edit | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="GitWorktreeAddDialog.on_tagButton_toggled" ID="GitWorktreeAddDialog.on_tagButton_toggled"></a> | |
| 225 <h4>GitWorktreeAddDialog.on_tagButton_toggled</h4> | |
| 226 <b>on_tagButton_toggled</b>(<i>checked</i>) | |
| 227 | |
| 228 <p> | |
| 229 Private slot to handle changes of the Tag select button. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>checked</i> (bool)</dt> | |
| 234 <dd> | |
| 235 state of the button | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="GitWorktreeAddDialog.on_tagCombo_editTextChanged" ID="GitWorktreeAddDialog.on_tagCombo_editTextChanged"></a> | |
| 239 <h4>GitWorktreeAddDialog.on_tagCombo_editTextChanged</h4> | |
| 240 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) | |
| 241 | |
| 242 <p> | |
| 243 Private slot to handle changes of the Tag combo. | |
| 244 </p> | |
| 245 <dl> | |
| 246 | |
| 247 <dt><i>txt</i> (str)</dt> | |
| 248 <dd> | |
| 249 text of the combo | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <a NAME="GitWorktreeAddDialog.on_worktreePathPicker_textChanged" ID="GitWorktreeAddDialog.on_worktreePathPicker_textChanged"></a> | |
| 253 <h4>GitWorktreeAddDialog.on_worktreePathPicker_textChanged</h4> | |
| 254 <b>on_worktreePathPicker_textChanged</b>(<i>worktree</i>) | |
| 255 | |
| 256 <p> | |
| 257 Private slot handling a change of the worktree path. | |
| 258 </p> | |
| 259 <dl> | |
| 260 | |
| 261 <dt><i>worktree</i> (str)</dt> | |
| 262 <dd> | |
| 263 entered worktree path | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <div align="right"><a href="#top">Up</a></div> | |
| 267 <hr /> | |
| 268 </body></html> |
