Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html
- changeset 7273
- 391d6b7b1eff
- parent 7156
- c1b6bc83fc76
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</h1> | 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog to enter the commit message. | 26 Module implementing a dialog to enter the commit message. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#HgCommitDialog">HgCommitDialog</a></td> | 38 <td><a href="#HgCommitDialog">HgCommitDialog</a></td> |
| 34 <td>Class implementing a dialog to enter the commit message.</td> | 39 <td>Class implementing a dialog to enter the commit message.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="HgCommitDialog" ID="HgCommitDialog"></a> | 49 <a NAME="HgCommitDialog" ID="HgCommitDialog"></a> |
| 43 <h2>HgCommitDialog</h2> | 50 <h2>HgCommitDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog to enter the commit message. | 53 Class implementing a dialog to enter the commit message. |
| 46 </p><h3>Signals</h3> | 54 </p> |
| 47 <dl> | 55 <h3>Signals</h3> |
| 56 <dl> | |
| 57 | |
| 48 <dt>accepted()</dt> | 58 <dt>accepted()</dt> |
| 49 <dd> | 59 <dd> |
| 50 emitted, if the dialog was accepted | 60 emitted, if the dialog was accepted |
| 51 </dd><dt>rejected()</dt> | 61 </dd> |
| 62 <dt>rejected()</dt> | |
| 52 <dd> | 63 <dd> |
| 53 emitted, if the dialog was rejected | 64 emitted, if the dialog was rejected |
| 54 </dd> | 65 </dd> |
| 55 </dl> | 66 </dl> |
| 56 <h3>Derived from</h3> | 67 <h3>Derived from</h3> |
| 57 QWidget, Ui_HgCommitDialog | 68 QWidget, Ui_HgCommitDialog |
| 58 <h3>Class Attributes</h3> | 69 <h3>Class Attributes</h3> |
| 70 | |
| 59 <table> | 71 <table> |
| 60 <tr><td>None</td></tr> | 72 <tr><td>None</td></tr> |
| 61 </table> | 73 </table> |
| 62 <h3>Class Methods</h3> | 74 <h3>Class Methods</h3> |
| 75 | |
| 63 <table> | 76 <table> |
| 64 <tr><td>None</td></tr> | 77 <tr><td>None</td></tr> |
| 65 </table> | 78 </table> |
| 66 <h3>Methods</h3> | 79 <h3>Methods</h3> |
| 67 <table> | 80 |
| 81 <table> | |
| 82 | |
| 68 <tr> | 83 <tr> |
| 69 <td><a href="#HgCommitDialog.__init__">HgCommitDialog</a></td> | 84 <td><a href="#HgCommitDialog.__init__">HgCommitDialog</a></td> |
| 70 <td>Constructor</td> | 85 <td>Constructor</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#HgCommitDialog.getCommitData">getCommitData</a></td> | 88 <td><a href="#HgCommitDialog.getCommitData">getCommitData</a></td> |
| 73 <td>Public method to retrieve the entered data for the commit.</td> | 89 <td>Public method to retrieve the entered data for the commit.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> | 92 <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
| 76 <td>Private slot called by the buttonBox accepted signal.</td> | 93 <td>Private slot called by the buttonBox accepted signal.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 96 <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 79 <td>Private slot called by a button of the button box clicked.</td> | 97 <td>Private slot called by a button of the button box clicked.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> | 100 <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> |
| 82 <td>Private slot called by the buttonBox rejected signal.</td> | 101 <td>Private slot called by the buttonBox rejected signal.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#HgCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> | 104 <td><a href="#HgCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> |
| 85 <td>Private slot to select a commit message from recent ones.</td> | 105 <td>Private slot to select a commit message from recent ones.</td> |
| 86 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 87 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> | 108 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> |
| 88 <td>Protected method called when the dialog is about to be shown.</td> | 109 <td>Protected method called when the dialog is about to be shown.</td> |
| 89 </tr> | 110 </tr> |
| 90 </table> | 111 </table> |
| 91 <h3>Static Methods</h3> | 112 <h3>Static Methods</h3> |
| 92 <table> | 113 |
| 93 <tr><td>None</td></tr> | 114 <table> |
| 94 </table> | 115 <tr><td>None</td></tr> |
| 116 </table> | |
| 117 | |
| 95 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> | 118 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> |
| 96 <h4>HgCommitDialog (Constructor)</h4> | 119 <h4>HgCommitDialog (Constructor)</h4> |
| 97 <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>) | 120 <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>) |
| 121 | |
| 98 <p> | 122 <p> |
| 99 Constructor | 123 Constructor |
| 100 </p><dl> | 124 </p> |
| 125 <dl> | |
| 126 | |
| 101 <dt><i>vcs</i></dt> | 127 <dt><i>vcs</i></dt> |
| 102 <dd> | 128 <dd> |
| 103 reference to the vcs object | 129 reference to the vcs object |
| 104 </dd><dt><i>msg</i></dt> | 130 </dd> |
| 131 <dt><i>msg</i></dt> | |
| 105 <dd> | 132 <dd> |
| 106 initial message (string) | 133 initial message (string) |
| 107 </dd><dt><i>mq</i></dt> | 134 </dd> |
| 135 <dt><i>mq</i></dt> | |
| 108 <dd> | 136 <dd> |
| 109 flag indicating a queue commit (boolean) | 137 flag indicating a queue commit (boolean) |
| 110 </dd><dt><i>merge</i></dt> | 138 </dd> |
| 139 <dt><i>merge</i></dt> | |
| 111 <dd> | 140 <dd> |
| 112 flag indicating a merge commit (boolean) | 141 flag indicating a merge commit (boolean) |
| 113 </dd><dt><i>parent</i></dt> | 142 </dd> |
| 143 <dt><i>parent</i></dt> | |
| 114 <dd> | 144 <dd> |
| 115 parent widget (QWidget) | 145 parent widget (QWidget) |
| 116 </dd> | 146 </dd> |
| 117 </dl><a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> | 147 </dl> |
| 148 <a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> | |
| 118 <h4>HgCommitDialog.getCommitData</h4> | 149 <h4>HgCommitDialog.getCommitData</h4> |
| 119 <b>getCommitData</b>(<i></i>) | 150 <b>getCommitData</b>(<i></i>) |
| 151 | |
| 120 <p> | 152 <p> |
| 121 Public method to retrieve the entered data for the commit. | 153 Public method to retrieve the entered data for the commit. |
| 122 </p><dl> | 154 </p> |
| 155 <dl> | |
| 123 <dt>Returns:</dt> | 156 <dt>Returns:</dt> |
| 124 <dd> | 157 <dd> |
| 125 tuple containing the log message, a flag indicating to amend | 158 tuple containing the log message, a flag indicating to amend |
| 126 the last commit, a flag indicating to commit subrepositories as | 159 the last commit, a flag indicating to commit subrepositories as |
| 127 well, name of the author and date/time of the commit | 160 well, name of the author and date/time of the commit |
| 128 </dd> | 161 </dd> |
| 129 </dl><dl> | 162 </dl> |
| 163 <dl> | |
| 130 <dt>Return Type:</dt> | 164 <dt>Return Type:</dt> |
| 131 <dd> | 165 <dd> |
| 132 tuple of str, bool, bool, str, str | 166 tuple of str, bool, bool, str, str |
| 133 </dd> | 167 </dd> |
| 134 </dl><a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> | 168 </dl> |
| 169 <a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> | |
| 135 <h4>HgCommitDialog.on_buttonBox_accepted</h4> | 170 <h4>HgCommitDialog.on_buttonBox_accepted</h4> |
| 136 <b>on_buttonBox_accepted</b>(<i></i>) | 171 <b>on_buttonBox_accepted</b>(<i></i>) |
| 172 | |
| 137 <p> | 173 <p> |
| 138 Private slot called by the buttonBox accepted signal. | 174 Private slot called by the buttonBox accepted signal. |
| 139 </p><a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> | 175 </p> |
| 176 <a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> | |
| 140 <h4>HgCommitDialog.on_buttonBox_clicked</h4> | 177 <h4>HgCommitDialog.on_buttonBox_clicked</h4> |
| 141 <b>on_buttonBox_clicked</b>(<i>button</i>) | 178 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 179 | |
| 142 <p> | 180 <p> |
| 143 Private slot called by a button of the button box clicked. | 181 Private slot called by a button of the button box clicked. |
| 144 </p><dl> | 182 </p> |
| 183 <dl> | |
| 184 | |
| 145 <dt><i>button</i></dt> | 185 <dt><i>button</i></dt> |
| 146 <dd> | 186 <dd> |
| 147 button that was clicked (QAbstractButton) | 187 button that was clicked (QAbstractButton) |
| 148 </dd> | 188 </dd> |
| 149 </dl><a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> | 189 </dl> |
| 190 <a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> | |
| 150 <h4>HgCommitDialog.on_buttonBox_rejected</h4> | 191 <h4>HgCommitDialog.on_buttonBox_rejected</h4> |
| 151 <b>on_buttonBox_rejected</b>(<i></i>) | 192 <b>on_buttonBox_rejected</b>(<i></i>) |
| 193 | |
| 152 <p> | 194 <p> |
| 153 Private slot called by the buttonBox rejected signal. | 195 Private slot called by the buttonBox rejected signal. |
| 154 </p><a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> | 196 </p> |
| 197 <a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> | |
| 155 <h4>HgCommitDialog.on_recentComboBox_activated</h4> | 198 <h4>HgCommitDialog.on_recentComboBox_activated</h4> |
| 156 <b>on_recentComboBox_activated</b>(<i>txt</i>) | 199 <b>on_recentComboBox_activated</b>(<i>txt</i>) |
| 200 | |
| 157 <p> | 201 <p> |
| 158 Private slot to select a commit message from recent ones. | 202 Private slot to select a commit message from recent ones. |
| 159 </p><dl> | 203 </p> |
| 204 <dl> | |
| 205 | |
| 160 <dt><i>txt</i></dt> | 206 <dt><i>txt</i></dt> |
| 161 <dd> | 207 <dd> |
| 162 text of the selected entry (string) | 208 text of the selected entry (string) |
| 163 </dd> | 209 </dd> |
| 164 </dl><a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> | 210 </dl> |
| 211 <a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> | |
| 165 <h4>HgCommitDialog.showEvent</h4> | 212 <h4>HgCommitDialog.showEvent</h4> |
| 166 <b>showEvent</b>(<i>evt</i>) | 213 <b>showEvent</b>(<i>evt</i>) |
| 214 | |
| 167 <p> | 215 <p> |
| 168 Protected method called when the dialog is about to be shown. | 216 Protected method called when the dialog is about to be shown. |
| 169 </p><dl> | 217 </p> |
| 218 <dl> | |
| 219 | |
| 170 <dt><i>evt</i></dt> | 220 <dt><i>evt</i></dt> |
| 171 <dd> | 221 <dd> |
| 172 the event (QShowEvent) | 222 the event (QShowEvent) |
| 173 </dd> | 223 </dd> |
| 174 </dl> | 224 </dl> |
