src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter the commit message. 11 Module implementing a dialog to enter the commit message.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HgCommitDialog">HgCommitDialog</a></td> 22 <td><a href="#HgCommitDialog">HgCommitDialog</a></td>
25 <td>Class implementing a dialog to enter the commit message.</td> 23 <td>Class implementing a dialog to enter the commit message.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HgCommitDialog" ID="HgCommitDialog"></a> 34 <a NAME="HgCommitDialog" ID="HgCommitDialog"></a>
36 <h2>HgCommitDialog</h2> 35 <h2>HgCommitDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter the commit message. 37 Class implementing a dialog to enter the commit message.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>accepted()</dt> 43 <dt>accepted()</dt>
45 <dd> 44 <dd>
51 </dd> 50 </dd>
52 </dl> 51 </dl>
53 <h3>Derived from</h3> 52 <h3>Derived from</h3>
54 QWidget, Ui_HgCommitDialog 53 QWidget, Ui_HgCommitDialog
55 <h3>Class Attributes</h3> 54 <h3>Class Attributes</h3>
56 55 <table>
57 <table> 56 <tr><td>None</td></tr>
58 <tr><td>None</td></tr> 57 </table>
59 </table> 58
60 <h3>Class Methods</h3> 59 <h3>Class Methods</h3>
61 60 <table>
62 <table> 61 <tr><td>None</td></tr>
63 <tr><td>None</td></tr> 62 </table>
64 </table> 63
65 <h3>Methods</h3> 64 <h3>Methods</h3>
66 65 <table>
67 <table>
68
69 <tr> 66 <tr>
70 <td><a href="#HgCommitDialog.__init__">HgCommitDialog</a></td> 67 <td><a href="#HgCommitDialog.__init__">HgCommitDialog</a></td>
71 <td>Constructor</td> 68 <td>Constructor</td>
72 </tr> 69 </tr>
73 <tr> 70 <tr>
93 <tr> 90 <tr>
94 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> 91 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td>
95 <td>Protected method called when the dialog is about to be shown.</td> 92 <td>Protected method called when the dialog is about to be shown.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> 102 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a>
105 <h4>HgCommitDialog (Constructor)</h4> 103 <h4>HgCommitDialog (Constructor)</h4>
106 <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>) 104 <b>HgCommitDialog</b>(<i>vcs, msg, mq, merge, parent=None</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>vcs</i> (Hg)</dt> 111 <dt><i>vcs</i> (Hg)</dt>
114 <dd> 112 <dd>
115 reference to the vcs object 113 reference to the vcs object
132 </dd> 130 </dd>
133 </dl> 131 </dl>
134 <a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> 132 <a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a>
135 <h4>HgCommitDialog.getCommitData</h4> 133 <h4>HgCommitDialog.getCommitData</h4>
136 <b>getCommitData</b>(<i></i>) 134 <b>getCommitData</b>(<i></i>)
137
138 <p> 135 <p>
139 Public method to retrieve the entered data for the commit. 136 Public method to retrieve the entered data for the commit.
140 </p> 137 </p>
138
141 <dl> 139 <dl>
142 <dt>Return:</dt> 140 <dt>Return:</dt>
143 <dd> 141 <dd>
144 tuple containing the log message, a flag indicating to amend 142 tuple containing the log message, a flag indicating to amend
145 the last commit, a flag indicating to commit subrepositories as 143 the last commit, a flag indicating to commit subrepositories as
153 </dd> 151 </dd>
154 </dl> 152 </dl>
155 <a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> 153 <a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a>
156 <h4>HgCommitDialog.on_buttonBox_accepted</h4> 154 <h4>HgCommitDialog.on_buttonBox_accepted</h4>
157 <b>on_buttonBox_accepted</b>(<i></i>) 155 <b>on_buttonBox_accepted</b>(<i></i>)
158
159 <p> 156 <p>
160 Private slot called by the buttonBox accepted signal. 157 Private slot called by the buttonBox accepted signal.
161 </p> 158 </p>
159
162 <a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> 160 <a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a>
163 <h4>HgCommitDialog.on_buttonBox_clicked</h4> 161 <h4>HgCommitDialog.on_buttonBox_clicked</h4>
164 <b>on_buttonBox_clicked</b>(<i>button</i>) 162 <b>on_buttonBox_clicked</b>(<i>button</i>)
165
166 <p> 163 <p>
167 Private slot called by a button of the button box clicked. 164 Private slot called by a button of the button box clicked.
168 </p> 165 </p>
166
169 <dl> 167 <dl>
170 168
171 <dt><i>button</i> (QAbstractButton)</dt> 169 <dt><i>button</i> (QAbstractButton)</dt>
172 <dd> 170 <dd>
173 button that was clicked 171 button that was clicked
174 </dd> 172 </dd>
175 </dl> 173 </dl>
176 <a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> 174 <a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a>
177 <h4>HgCommitDialog.on_buttonBox_rejected</h4> 175 <h4>HgCommitDialog.on_buttonBox_rejected</h4>
178 <b>on_buttonBox_rejected</b>(<i></i>) 176 <b>on_buttonBox_rejected</b>(<i></i>)
179
180 <p> 177 <p>
181 Private slot called by the buttonBox rejected signal. 178 Private slot called by the buttonBox rejected signal.
182 </p> 179 </p>
180
183 <a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> 181 <a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a>
184 <h4>HgCommitDialog.on_recentComboBox_activated</h4> 182 <h4>HgCommitDialog.on_recentComboBox_activated</h4>
185 <b>on_recentComboBox_activated</b>(<i>index</i>) 183 <b>on_recentComboBox_activated</b>(<i>index</i>)
186
187 <p> 184 <p>
188 Private slot to select a commit message from recent ones. 185 Private slot to select a commit message from recent ones.
189 </p> 186 </p>
187
190 <dl> 188 <dl>
191 189
192 <dt><i>index</i> (int)</dt> 190 <dt><i>index</i> (int)</dt>
193 <dd> 191 <dd>
194 index of the selected entry 192 index of the selected entry
195 </dd> 193 </dd>
196 </dl> 194 </dl>
197 <a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> 195 <a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a>
198 <h4>HgCommitDialog.showEvent</h4> 196 <h4>HgCommitDialog.showEvent</h4>
199 <b>showEvent</b>(<i>evt</i>) 197 <b>showEvent</b>(<i>evt</i>)
200
201 <p> 198 <p>
202 Protected method called when the dialog is about to be shown. 199 Protected method called when the dialog is about to be shown.
203 </p> 200 </p>
201
204 <dl> 202 <dl>
205 203
206 <dt><i>evt</i> (QShowEvent)</dt> 204 <dt><i>evt</i> (QShowEvent)</dt>
207 <dd> 205 <dd>
208 the event 206 the event

eric ide

mercurial