|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</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> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a dialog to enter the commit message. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#SvnCommitDialog">SvnCommitDialog</a></td> |
|
39 <td>Class implementing a dialog to enter the commit message.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="SvnCommitDialog" ID="SvnCommitDialog"></a> |
|
50 <h2>SvnCommitDialog</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a dialog to enter the commit message. |
|
54 </p> |
|
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
|
58 <dt>accepted()</dt> |
|
59 <dd> |
|
60 emitted, if the dialog was accepted |
|
61 </dd> |
|
62 <dt>rejected()</dt> |
|
63 <dd> |
|
64 emitted, if the dialog was rejected |
|
65 </dd> |
|
66 </dl> |
|
67 <h3>Derived from</h3> |
|
68 QWidget, Ui_SvnCommitDialog |
|
69 <h3>Class Attributes</h3> |
|
70 |
|
71 <table> |
|
72 <tr><td>None</td></tr> |
|
73 </table> |
|
74 <h3>Class Methods</h3> |
|
75 |
|
76 <table> |
|
77 <tr><td>None</td></tr> |
|
78 </table> |
|
79 <h3>Methods</h3> |
|
80 |
|
81 <table> |
|
82 |
|
83 <tr> |
|
84 <td><a href="#SvnCommitDialog.__init__">SvnCommitDialog</a></td> |
|
85 <td>Constructor</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> |
|
89 <td>Public method to retrieve the changelists data.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> |
|
93 <td>Public method to check, if the user entered some changelists.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> |
|
97 <td>Public method to retrieve the log message.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#SvnCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
|
101 <td>Private slot called by the buttonBox accepted signal.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#SvnCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
105 <td>Private slot called by a button of the button box clicked.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#SvnCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> |
|
109 <td>Private slot called by the buttonBox rejected signal.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#SvnCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> |
|
113 <td>Private slot to select a commit message from recent ones.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#SvnCommitDialog.showEvent">showEvent</a></td> |
|
117 <td>Protected method called when the dialog is about to be shown.</td> |
|
118 </tr> |
|
119 </table> |
|
120 <h3>Static Methods</h3> |
|
121 |
|
122 <table> |
|
123 <tr><td>None</td></tr> |
|
124 </table> |
|
125 |
|
126 <a NAME="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a> |
|
127 <h4>SvnCommitDialog (Constructor)</h4> |
|
128 <b>SvnCommitDialog</b>(<i>vcs, parent=None</i>) |
|
129 |
|
130 <p> |
|
131 Constructor |
|
132 </p> |
|
133 <dl> |
|
134 |
|
135 <dt><i>vcs</i></dt> |
|
136 <dd> |
|
137 reference to the vcs object |
|
138 </dd> |
|
139 <dt><i>parent</i></dt> |
|
140 <dd> |
|
141 parent widget (QWidget) |
|
142 </dd> |
|
143 </dl> |
|
144 <a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> |
|
145 <h4>SvnCommitDialog.changelistsData</h4> |
|
146 <b>changelistsData</b>(<i></i>) |
|
147 |
|
148 <p> |
|
149 Public method to retrieve the changelists data. |
|
150 </p> |
|
151 <dl> |
|
152 <dt>Return:</dt> |
|
153 <dd> |
|
154 tuple containing the changelists (list of strings) and a flag |
|
155 indicating to keep changelists (boolean) |
|
156 </dd> |
|
157 </dl> |
|
158 <a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> |
|
159 <h4>SvnCommitDialog.hasChangelists</h4> |
|
160 <b>hasChangelists</b>(<i></i>) |
|
161 |
|
162 <p> |
|
163 Public method to check, if the user entered some changelists. |
|
164 </p> |
|
165 <dl> |
|
166 <dt>Return:</dt> |
|
167 <dd> |
|
168 flag indicating availability of changelists (boolean) |
|
169 </dd> |
|
170 </dl> |
|
171 <a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> |
|
172 <h4>SvnCommitDialog.logMessage</h4> |
|
173 <b>logMessage</b>(<i></i>) |
|
174 |
|
175 <p> |
|
176 Public method to retrieve the log message. |
|
177 </p> |
|
178 <dl> |
|
179 <dt>Return:</dt> |
|
180 <dd> |
|
181 the log message (string) |
|
182 </dd> |
|
183 </dl> |
|
184 <a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> |
|
185 <h4>SvnCommitDialog.on_buttonBox_accepted</h4> |
|
186 <b>on_buttonBox_accepted</b>(<i></i>) |
|
187 |
|
188 <p> |
|
189 Private slot called by the buttonBox accepted signal. |
|
190 </p> |
|
191 <a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a> |
|
192 <h4>SvnCommitDialog.on_buttonBox_clicked</h4> |
|
193 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
194 |
|
195 <p> |
|
196 Private slot called by a button of the button box clicked. |
|
197 </p> |
|
198 <dl> |
|
199 |
|
200 <dt><i>button</i></dt> |
|
201 <dd> |
|
202 button that was clicked (QAbstractButton) |
|
203 </dd> |
|
204 </dl> |
|
205 <a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> |
|
206 <h4>SvnCommitDialog.on_buttonBox_rejected</h4> |
|
207 <b>on_buttonBox_rejected</b>(<i></i>) |
|
208 |
|
209 <p> |
|
210 Private slot called by the buttonBox rejected signal. |
|
211 </p> |
|
212 <a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a> |
|
213 <h4>SvnCommitDialog.on_recentComboBox_activated</h4> |
|
214 <b>on_recentComboBox_activated</b>(<i>index</i>) |
|
215 |
|
216 <p> |
|
217 Private slot to select a commit message from recent ones. |
|
218 </p> |
|
219 <dl> |
|
220 |
|
221 <dt><i>index</i> (int)</dt> |
|
222 <dd> |
|
223 index of the selected entry |
|
224 </dd> |
|
225 </dl> |
|
226 <a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> |
|
227 <h4>SvnCommitDialog.showEvent</h4> |
|
228 <b>showEvent</b>(<i>evt</i>) |
|
229 |
|
230 <p> |
|
231 Protected method called when the dialog is about to be shown. |
|
232 </p> |
|
233 <dl> |
|
234 |
|
235 <dt><i>evt</i></dt> |
|
236 <dd> |
|
237 the event (QShowEvent) |
|
238 </dd> |
|
239 </dl> |
|
240 <div align="right"><a href="#top">Up</a></div> |
|
241 <hr /> |
|
242 </body></html> |