eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsPySvn.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.vcsPySvn.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>changelists, parent=None</i>)
129
130 <p>
131 Constructor
132 </p>
133 <dl>
134
135 <dt><i>changelists</i></dt>
136 <dd>
137 list of available change lists (list of strings)
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 <p>
179 This method has the side effect of saving the 20 most recent
180 commit messages for reuse.
181 </p>
182 <dl>
183 <dt>Return:</dt>
184 <dd>
185 the log message (string)
186 </dd>
187 </dl>
188 <a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a>
189 <h4>SvnCommitDialog.on_buttonBox_accepted</h4>
190 <b>on_buttonBox_accepted</b>(<i></i>)
191
192 <p>
193 Private slot called by the buttonBox accepted signal.
194 </p>
195 <a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a>
196 <h4>SvnCommitDialog.on_buttonBox_clicked</h4>
197 <b>on_buttonBox_clicked</b>(<i>button</i>)
198
199 <p>
200 Private slot called by a button of the button box clicked.
201 </p>
202 <dl>
203
204 <dt><i>button</i></dt>
205 <dd>
206 button that was clicked (QAbstractButton)
207 </dd>
208 </dl>
209 <a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a>
210 <h4>SvnCommitDialog.on_buttonBox_rejected</h4>
211 <b>on_buttonBox_rejected</b>(<i></i>)
212
213 <p>
214 Private slot called by the buttonBox rejected signal.
215 </p>
216 <a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a>
217 <h4>SvnCommitDialog.on_recentComboBox_activated</h4>
218 <b>on_recentComboBox_activated</b>(<i>index</i>)
219
220 <p>
221 Private slot to select a commit message from recent ones.
222 </p>
223 <dl>
224
225 <dt><i>index</i> (int)</dt>
226 <dd>
227 index of the selected entry
228 </dd>
229 </dl>
230 <a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a>
231 <h4>SvnCommitDialog.showEvent</h4>
232 <b>showEvent</b>(<i>evt</i>)
233
234 <p>
235 Protected method called when the dialog is about to be shown.
236 </p>
237 <dl>
238
239 <dt><i>evt</i></dt>
240 <dd>
241 the event (QShowEvent)
242 </dd>
243 </dl>
244 <div align="right"><a href="#top">Up</a></div>
245 <hr />
246 </body></html>

eric ide

mercurial