Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog</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.GitCommitDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the commit message. | |
| 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="#GitCommitDialog">GitCommitDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the commit message.</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="GitCommitDialog" ID="GitCommitDialog"></a> | |
| 36 <h2>GitCommitDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the commit message. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>accepted()</dt> | |
| 45 <dd> | |
| 46 emitted, if the dialog was accepted | |
| 47 </dd> | |
| 48 <dt>rejected()</dt> | |
| 49 <dd> | |
| 50 emitted, if the dialog was rejected | |
| 51 </dd> | |
| 52 </dl> | |
| 53 <h3>Derived from</h3> | |
| 54 QWidget, Ui_GitCommitDialog | |
| 55 <h3>Class Attributes</h3> | |
| 56 | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Class Methods</h3> | |
| 61 | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Methods</h3> | |
| 66 | |
| 67 <table> | |
| 68 | |
| 69 <tr> | |
| 70 <td><a href="#GitCommitDialog.__init__">GitCommitDialog</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitCommitDialog.amend">amend</a></td> | |
| 75 <td>Public method to retrieve the state of the amend flag.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitCommitDialog.logMessage">logMessage</a></td> | |
| 79 <td>Public method to retrieve the log message.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> | |
| 83 <td>Private slot called by the buttonBox accepted signal.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 87 <td>Private slot called by a button of the button box clicked.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> | |
| 91 <td>Private slot called by the buttonBox rejected signal.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> | |
| 95 <td>Private slot to select a commit message from recent ones.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GitCommitDialog.resetAuthor">resetAuthor</a></td> | |
| 99 <td>Public method to retrieve the state of the reset author flag.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GitCommitDialog.showEvent">showEvent</a></td> | |
| 103 <td>Protected method called when the dialog is about to be shown.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GitCommitDialog.stagedOnly">stagedOnly</a></td> | |
| 107 <td>Public method to retrieve the state of the staged only flag.</td> | |
| 108 </tr> | |
| 109 </table> | |
| 110 <h3>Static Methods</h3> | |
| 111 | |
| 112 <table> | |
| 113 <tr><td>None</td></tr> | |
| 114 </table> | |
| 115 | |
| 116 <a NAME="GitCommitDialog.__init__" ID="GitCommitDialog.__init__"></a> | |
| 117 <h4>GitCommitDialog (Constructor)</h4> | |
| 118 <b>GitCommitDialog</b>(<i>vcs, msg, amend, commitAll, parent=None</i>) | |
| 119 | |
| 120 <p> | |
| 121 Constructor | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>vcs</i></dt> | |
| 126 <dd> | |
| 127 reference to the vcs object | |
| 128 </dd> | |
| 129 <dt><i>msg</i></dt> | |
| 130 <dd> | |
| 131 initial message (string) | |
| 132 </dd> | |
| 133 <dt><i>amend</i></dt> | |
| 134 <dd> | |
| 135 flag indicating to amend the HEAD commit (boolean) | |
| 136 </dd> | |
| 137 <dt><i>commitAll</i></dt> | |
| 138 <dd> | |
| 139 flag indicating to commit all local changes (boolean) | |
| 140 </dd> | |
| 141 <dt><i>parent</i></dt> | |
| 142 <dd> | |
| 143 parent widget (QWidget) | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a> | |
| 147 <h4>GitCommitDialog.amend</h4> | |
| 148 <b>amend</b>(<i></i>) | |
| 149 | |
| 150 <p> | |
| 151 Public method to retrieve the state of the amend flag. | |
| 152 </p> | |
| 153 <dl> | |
| 154 <dt>Return:</dt> | |
| 155 <dd> | |
| 156 state of the amend flag (boolean) | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a> | |
| 160 <h4>GitCommitDialog.logMessage</h4> | |
| 161 <b>logMessage</b>(<i></i>) | |
| 162 | |
| 163 <p> | |
| 164 Public method to retrieve the log message. | |
| 165 </p> | |
| 166 <dl> | |
| 167 <dt>Return:</dt> | |
| 168 <dd> | |
| 169 the log message (string) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a> | |
| 173 <h4>GitCommitDialog.on_buttonBox_accepted</h4> | |
| 174 <b>on_buttonBox_accepted</b>(<i></i>) | |
| 175 | |
| 176 <p> | |
| 177 Private slot called by the buttonBox accepted signal. | |
| 178 </p> | |
| 179 <a NAME="GitCommitDialog.on_buttonBox_clicked" ID="GitCommitDialog.on_buttonBox_clicked"></a> | |
| 180 <h4>GitCommitDialog.on_buttonBox_clicked</h4> | |
| 181 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 182 | |
| 183 <p> | |
| 184 Private slot called by a button of the button box clicked. | |
| 185 </p> | |
| 186 <dl> | |
| 187 | |
| 188 <dt><i>button</i></dt> | |
| 189 <dd> | |
| 190 button that was clicked (QAbstractButton) | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a> | |
| 194 <h4>GitCommitDialog.on_buttonBox_rejected</h4> | |
| 195 <b>on_buttonBox_rejected</b>(<i></i>) | |
| 196 | |
| 197 <p> | |
| 198 Private slot called by the buttonBox rejected signal. | |
| 199 </p> | |
| 200 <a NAME="GitCommitDialog.on_recentComboBox_activated" ID="GitCommitDialog.on_recentComboBox_activated"></a> | |
| 201 <h4>GitCommitDialog.on_recentComboBox_activated</h4> | |
| 202 <b>on_recentComboBox_activated</b>(<i>index</i>) | |
| 203 | |
| 204 <p> | |
| 205 Private slot to select a commit message from recent ones. | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>index</i> (int)</dt> | |
| 210 <dd> | |
| 211 index of the selected entry | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <a NAME="GitCommitDialog.resetAuthor" ID="GitCommitDialog.resetAuthor"></a> | |
| 215 <h4>GitCommitDialog.resetAuthor</h4> | |
| 216 <b>resetAuthor</b>(<i></i>) | |
| 217 | |
| 218 <p> | |
| 219 Public method to retrieve the state of the reset author flag. | |
| 220 </p> | |
| 221 <dl> | |
| 222 <dt>Return:</dt> | |
| 223 <dd> | |
| 224 state of the reset author flag (boolean) | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a> | |
| 228 <h4>GitCommitDialog.showEvent</h4> | |
| 229 <b>showEvent</b>(<i>evt</i>) | |
| 230 | |
| 231 <p> | |
| 232 Protected method called when the dialog is about to be shown. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>evt</i></dt> | |
| 237 <dd> | |
| 238 the event (QShowEvent) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a> | |
| 242 <h4>GitCommitDialog.stagedOnly</h4> | |
| 243 <b>stagedOnly</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Public method to retrieve the state of the staged only flag. | |
| 247 </p> | |
| 248 <dl> | |
| 249 <dt>Return:</dt> | |
| 250 <dd> | |
| 251 state of the staged only flag (boolean) | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <div align="right"><a href="#top">Up</a></div> | |
| 255 <hr /> | |
| 256 </body></html> |
