Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.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.vcsMercurial.HgCommitDialog</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.vcsMercurial.HgCommitDialog</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="#HgCommitDialog">HgCommitDialog</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="HgCommitDialog" ID="HgCommitDialog"></a> | |
| 36 <h2>HgCommitDialog</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_HgCommitDialog | |
| 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="#HgCommitDialog.__init__">HgCommitDialog</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HgCommitDialog.getCommitData">getCommitData</a></td> | |
| 75 <td>Public method to retrieve the entered data for the commit.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> | |
| 79 <td>Private slot called by the buttonBox accepted signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 83 <td>Private slot called by a button of the button box clicked.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> | |
| 87 <td>Private slot called by the buttonBox rejected signal.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HgCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> | |
| 91 <td>Private slot to select a commit message from recent ones.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> | |
| 95 <td>Protected method called when the dialog is about to be shown.</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="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> | |
| 105 <h4>HgCommitDialog (Constructor)</h4> | |
| 106 <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>vcs</i></dt> | |
| 114 <dd> | |
| 115 reference to the vcs object | |
| 116 </dd> | |
| 117 <dt><i>msg</i></dt> | |
| 118 <dd> | |
| 119 initial message (string) | |
| 120 </dd> | |
| 121 <dt><i>mq</i></dt> | |
| 122 <dd> | |
| 123 flag indicating a queue commit (boolean) | |
| 124 </dd> | |
| 125 <dt><i>merge</i></dt> | |
| 126 <dd> | |
| 127 flag indicating a merge commit (boolean) | |
| 128 </dd> | |
| 129 <dt><i>parent</i></dt> | |
| 130 <dd> | |
| 131 parent widget (QWidget) | |
| 132 </dd> | |
| 133 </dl> | |
| 134 <a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> | |
| 135 <h4>HgCommitDialog.getCommitData</h4> | |
| 136 <b>getCommitData</b>(<i></i>) | |
| 137 | |
| 138 <p> | |
| 139 Public method to retrieve the entered data for the commit. | |
| 140 </p> | |
| 141 <dl> | |
| 142 <dt>Return:</dt> | |
| 143 <dd> | |
| 144 tuple containing the log message, a flag indicating to amend | |
| 145 the last commit, a flag indicating to commit subrepositories as | |
| 146 well, name of the author and date/time of the commit | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <dl> | |
| 150 <dt>Return Type:</dt> | |
| 151 <dd> | |
| 152 tuple of str, bool, bool, str, str | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> | |
| 156 <h4>HgCommitDialog.on_buttonBox_accepted</h4> | |
| 157 <b>on_buttonBox_accepted</b>(<i></i>) | |
| 158 | |
| 159 <p> | |
| 160 Private slot called by the buttonBox accepted signal. | |
| 161 </p> | |
| 162 <a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> | |
| 163 <h4>HgCommitDialog.on_buttonBox_clicked</h4> | |
| 164 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private slot called by a button of the button box clicked. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>button</i></dt> | |
| 172 <dd> | |
| 173 button that was clicked (QAbstractButton) | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> | |
| 177 <h4>HgCommitDialog.on_buttonBox_rejected</h4> | |
| 178 <b>on_buttonBox_rejected</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Private slot called by the buttonBox rejected signal. | |
| 182 </p> | |
| 183 <a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> | |
| 184 <h4>HgCommitDialog.on_recentComboBox_activated</h4> | |
| 185 <b>on_recentComboBox_activated</b>(<i>index</i>) | |
| 186 | |
| 187 <p> | |
| 188 Private slot to select a commit message from recent ones. | |
| 189 </p> | |
| 190 <dl> | |
| 191 | |
| 192 <dt><i>index</i> (int)</dt> | |
| 193 <dd> | |
| 194 index of the selected entry | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> | |
| 198 <h4>HgCommitDialog.showEvent</h4> | |
| 199 <b>showEvent</b>(<i>evt</i>) | |
| 200 | |
| 201 <p> | |
| 202 Protected method called when the dialog is about to be shown. | |
| 203 </p> | |
| 204 <dl> | |
| 205 | |
| 206 <dt><i>evt</i></dt> | |
| 207 <dd> | |
| 208 the event (QShowEvent) | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <div align="right"><a href="#top">Up</a></div> | |
| 212 <hr /> | |
| 213 </body></html> |
