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

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

eric ide

mercurial