|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog</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.vcsMercurial.HgCommitDialog</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="#HgCommitDialog">HgCommitDialog</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="HgCommitDialog" ID="HgCommitDialog"></a> |
|
43 <h2>HgCommitDialog</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_HgCommitDialog |
|
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="#HgCommitDialog.__init__">HgCommitDialog</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HgCommitDialog.amend">amend</a></td> |
|
73 <td>Public method to retrieve the state of the amend flag.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#HgCommitDialog.commitSubrepositories">commitSubrepositories</a></td> |
|
76 <td>Public method to retrieve the state of the commit sub-repositories flag.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#HgCommitDialog.logMessage">logMessage</a></td> |
|
79 <td>Public method to retrieve the log message.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#HgCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
|
82 <td>Private slot called by the buttonBox accepted signal.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#HgCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
85 <td>Private slot called by a button of the button box clicked.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#HgCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> |
|
88 <td>Private slot called by the buttonBox rejected signal.</td> |
|
89 </tr><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><tr> |
|
93 <td><a href="#HgCommitDialog.showEvent">showEvent</a></td> |
|
94 <td>Protected method called when the dialog is about to be shown.</td> |
|
95 </tr> |
|
96 </table> |
|
97 <h3>Static Methods</h3> |
|
98 <table> |
|
99 <tr><td>None</td></tr> |
|
100 </table> |
|
101 <a NAME="HgCommitDialog.__init__" ID="HgCommitDialog.__init__"></a> |
|
102 <h4>HgCommitDialog (Constructor)</h4> |
|
103 <b>HgCommitDialog</b>(<i>vcs, msg, mq, parent=None</i>) |
|
104 <p> |
|
105 Constructor |
|
106 </p><dl> |
|
107 <dt><i>vcs</i></dt> |
|
108 <dd> |
|
109 reference to the vcs object |
|
110 </dd><dt><i>msg</i></dt> |
|
111 <dd> |
|
112 initial message (string) |
|
113 </dd><dt><i>mq</i></dt> |
|
114 <dd> |
|
115 flag indicating a queue commit (boolean) |
|
116 </dd><dt><i>parent</i></dt> |
|
117 <dd> |
|
118 parent widget (QWidget) |
|
119 </dd> |
|
120 </dl><a NAME="HgCommitDialog.amend" ID="HgCommitDialog.amend"></a> |
|
121 <h4>HgCommitDialog.amend</h4> |
|
122 <b>amend</b>(<i></i>) |
|
123 <p> |
|
124 Public method to retrieve the state of the amend flag. |
|
125 </p><dl> |
|
126 <dt>Returns:</dt> |
|
127 <dd> |
|
128 state of the amend flag (boolean) |
|
129 </dd> |
|
130 </dl><a NAME="HgCommitDialog.commitSubrepositories" ID="HgCommitDialog.commitSubrepositories"></a> |
|
131 <h4>HgCommitDialog.commitSubrepositories</h4> |
|
132 <b>commitSubrepositories</b>(<i></i>) |
|
133 <p> |
|
134 Public method to retrieve the state of the commit sub-repositories |
|
135 flag. |
|
136 </p><dl> |
|
137 <dt>Returns:</dt> |
|
138 <dd> |
|
139 state of the sub-repositories flag (boolean) |
|
140 </dd> |
|
141 </dl><a NAME="HgCommitDialog.logMessage" ID="HgCommitDialog.logMessage"></a> |
|
142 <h4>HgCommitDialog.logMessage</h4> |
|
143 <b>logMessage</b>(<i></i>) |
|
144 <p> |
|
145 Public method to retrieve the log message. |
|
146 </p><dl> |
|
147 <dt>Returns:</dt> |
|
148 <dd> |
|
149 the log message (string) |
|
150 </dd> |
|
151 </dl><a NAME="HgCommitDialog.on_buttonBox_accepted" ID="HgCommitDialog.on_buttonBox_accepted"></a> |
|
152 <h4>HgCommitDialog.on_buttonBox_accepted</h4> |
|
153 <b>on_buttonBox_accepted</b>(<i></i>) |
|
154 <p> |
|
155 Private slot called by the buttonBox accepted signal. |
|
156 </p><a NAME="HgCommitDialog.on_buttonBox_clicked" ID="HgCommitDialog.on_buttonBox_clicked"></a> |
|
157 <h4>HgCommitDialog.on_buttonBox_clicked</h4> |
|
158 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
159 <p> |
|
160 Private slot called by a button of the button box clicked. |
|
161 </p><dl> |
|
162 <dt><i>button</i></dt> |
|
163 <dd> |
|
164 button that was clicked (QAbstractButton) |
|
165 </dd> |
|
166 </dl><a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> |
|
167 <h4>HgCommitDialog.on_buttonBox_rejected</h4> |
|
168 <b>on_buttonBox_rejected</b>(<i></i>) |
|
169 <p> |
|
170 Private slot called by the buttonBox rejected signal. |
|
171 </p><a NAME="HgCommitDialog.on_recentComboBox_activated" ID="HgCommitDialog.on_recentComboBox_activated"></a> |
|
172 <h4>HgCommitDialog.on_recentComboBox_activated</h4> |
|
173 <b>on_recentComboBox_activated</b>(<i>txt</i>) |
|
174 <p> |
|
175 Private slot to select a commit message from recent ones. |
|
176 </p><dl> |
|
177 <dt><i>txt</i></dt> |
|
178 <dd> |
|
179 text of the selected entry (string) |
|
180 </dd> |
|
181 </dl><a NAME="HgCommitDialog.showEvent" ID="HgCommitDialog.showEvent"></a> |
|
182 <h4>HgCommitDialog.showEvent</h4> |
|
183 <b>showEvent</b>(<i>evt</i>) |
|
184 <p> |
|
185 Protected method called when the dialog is about to be shown. |
|
186 </p><dl> |
|
187 <dt><i>evt</i></dt> |
|
188 <dd> |
|
189 the event (QShowEvent) |
|
190 </dd> |
|
191 </dl> |
|
192 <div align="right"><a href="#top">Up</a></div> |
|
193 <hr /> |
|
194 </body></html> |