Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html
- changeset 6942
- 2602857055c5
- parent 6020
- baf6da1ae288
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitCommitDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitCommitDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the commit message. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#GitCommitDialog">GitCommitDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter the commit message.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="GitCommitDialog" ID="GitCommitDialog"></a> | |
| 43 <h2>GitCommitDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter the commit message. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>accepted()</dt> | |
| 49 <dd> | |
| 50 emitted, if the dialog was accepted | |
| 51 </dd><dt>rejected()</dt> | |
| 52 <dd> | |
| 53 emitted, if the dialog was rejected | |
| 54 </dd> | |
| 55 </dl> | |
| 56 <h3>Derived from</h3> | |
| 57 QWidget, Ui_GitCommitDialog | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#GitCommitDialog.__init__">GitCommitDialog</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#GitCommitDialog.amend">amend</a></td> | |
| 73 <td>Public method to retrieve the state of the amend flag.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#GitCommitDialog.logMessage">logMessage</a></td> | |
| 76 <td>Public method to retrieve the log message.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#GitCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> | |
| 79 <td>Private slot called by the buttonBox accepted signal.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#GitCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 82 <td>Private slot called by a button of the button box clicked.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#GitCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> | |
| 85 <td>Private slot called by the buttonBox rejected signal.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#GitCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> | |
| 88 <td>Private slot to select a commit message from recent ones.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#GitCommitDialog.resetAuthor">resetAuthor</a></td> | |
| 91 <td>Public method to retrieve the state of the reset author flag.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#GitCommitDialog.showEvent">showEvent</a></td> | |
| 94 <td>Protected method called when the dialog is about to be shown.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#GitCommitDialog.stagedOnly">stagedOnly</a></td> | |
| 97 <td>Public method to retrieve the state of the staged only flag.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 <table> | |
| 102 <tr><td>None</td></tr> | |
| 103 </table> | |
| 104 <a NAME="GitCommitDialog.__init__" ID="GitCommitDialog.__init__"></a> | |
| 105 <h4>GitCommitDialog (Constructor)</h4> | |
| 106 <b>GitCommitDialog</b>(<i>vcs, msg, amend, commitAll, parent=None</i>) | |
| 107 <p> | |
| 108 Constructor | |
| 109 </p><dl> | |
| 110 <dt><i>vcs</i></dt> | |
| 111 <dd> | |
| 112 reference to the vcs object | |
| 113 </dd><dt><i>msg</i></dt> | |
| 114 <dd> | |
| 115 initial message (string) | |
| 116 </dd><dt><i>amend</i></dt> | |
| 117 <dd> | |
| 118 flag indicating to amend the HEAD commit (boolean) | |
| 119 </dd><dt><i>commitAll</i></dt> | |
| 120 <dd> | |
| 121 flag indicating to commit all local changes (boolean) | |
| 122 </dd><dt><i>parent</i></dt> | |
| 123 <dd> | |
| 124 parent widget (QWidget) | |
| 125 </dd> | |
| 126 </dl><a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a> | |
| 127 <h4>GitCommitDialog.amend</h4> | |
| 128 <b>amend</b>(<i></i>) | |
| 129 <p> | |
| 130 Public method to retrieve the state of the amend flag. | |
| 131 </p><dl> | |
| 132 <dt>Returns:</dt> | |
| 133 <dd> | |
| 134 state of the amend flag (boolean) | |
| 135 </dd> | |
| 136 </dl><a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a> | |
| 137 <h4>GitCommitDialog.logMessage</h4> | |
| 138 <b>logMessage</b>(<i></i>) | |
| 139 <p> | |
| 140 Public method to retrieve the log message. | |
| 141 </p><dl> | |
| 142 <dt>Returns:</dt> | |
| 143 <dd> | |
| 144 the log message (string) | |
| 145 </dd> | |
| 146 </dl><a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a> | |
| 147 <h4>GitCommitDialog.on_buttonBox_accepted</h4> | |
| 148 <b>on_buttonBox_accepted</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot called by the buttonBox accepted signal. | |
| 151 </p><a NAME="GitCommitDialog.on_buttonBox_clicked" ID="GitCommitDialog.on_buttonBox_clicked"></a> | |
| 152 <h4>GitCommitDialog.on_buttonBox_clicked</h4> | |
| 153 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 154 <p> | |
| 155 Private slot called by a button of the button box clicked. | |
| 156 </p><dl> | |
| 157 <dt><i>button</i></dt> | |
| 158 <dd> | |
| 159 button that was clicked (QAbstractButton) | |
| 160 </dd> | |
| 161 </dl><a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a> | |
| 162 <h4>GitCommitDialog.on_buttonBox_rejected</h4> | |
| 163 <b>on_buttonBox_rejected</b>(<i></i>) | |
| 164 <p> | |
| 165 Private slot called by the buttonBox rejected signal. | |
| 166 </p><a NAME="GitCommitDialog.on_recentComboBox_activated" ID="GitCommitDialog.on_recentComboBox_activated"></a> | |
| 167 <h4>GitCommitDialog.on_recentComboBox_activated</h4> | |
| 168 <b>on_recentComboBox_activated</b>(<i>txt</i>) | |
| 169 <p> | |
| 170 Private slot to select a commit message from recent ones. | |
| 171 </p><dl> | |
| 172 <dt><i>txt</i></dt> | |
| 173 <dd> | |
| 174 text of the selected entry (string) | |
| 175 </dd> | |
| 176 </dl><a NAME="GitCommitDialog.resetAuthor" ID="GitCommitDialog.resetAuthor"></a> | |
| 177 <h4>GitCommitDialog.resetAuthor</h4> | |
| 178 <b>resetAuthor</b>(<i></i>) | |
| 179 <p> | |
| 180 Public method to retrieve the state of the reset author flag. | |
| 181 </p><dl> | |
| 182 <dt>Returns:</dt> | |
| 183 <dd> | |
| 184 state of the reset author flag (boolean) | |
| 185 </dd> | |
| 186 </dl><a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a> | |
| 187 <h4>GitCommitDialog.showEvent</h4> | |
| 188 <b>showEvent</b>(<i>evt</i>) | |
| 189 <p> | |
| 190 Protected method called when the dialog is about to be shown. | |
| 191 </p><dl> | |
| 192 <dt><i>evt</i></dt> | |
| 193 <dd> | |
| 194 the event (QShowEvent) | |
| 195 </dd> | |
| 196 </dl><a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a> | |
| 197 <h4>GitCommitDialog.stagedOnly</h4> | |
| 198 <b>stagedOnly</b>(<i></i>) | |
| 199 <p> | |
| 200 Public method to retrieve the state of the staged only flag. | |
| 201 </p><dl> | |
| 202 <dt>Returns:</dt> | |
| 203 <dd> | |
| 204 state of the staged only flag (boolean) | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <div align="right"><a href="#top">Up</a></div> | |
| 208 <hr /> | |
| 209 </body></html> |
