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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog</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="#SvnCommitDialog">SvnCommitDialog</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="SvnCommitDialog" ID="SvnCommitDialog"></a>
43 <h2>SvnCommitDialog</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_SvnCommitDialog
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="#SvnCommitDialog.__init__">SvnCommitDialog</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td>
73 <td>Public method to retrieve the changelists data.</td>
74 </tr><tr>
75 <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td>
76 <td>Public method to check, if the user entered some changelists.</td>
77 </tr><tr>
78 <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td>
79 <td>Public method to retrieve the log message.</td>
80 </tr><tr>
81 <td><a href="#SvnCommitDialog.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="#SvnCommitDialog.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="#SvnCommitDialog.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="#SvnCommitDialog.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="#SvnCommitDialog.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="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a>
102 <h4>SvnCommitDialog (Constructor)</h4>
103 <b>SvnCommitDialog</b>(<i>changelists, parent=None</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>changelists</i></dt>
108 <dd>
109 list of available change lists (list of strings)
110 </dd><dt><i>parent</i></dt>
111 <dd>
112 parent widget (QWidget)
113 </dd>
114 </dl><a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a>
115 <h4>SvnCommitDialog.changelistsData</h4>
116 <b>changelistsData</b>(<i></i>)
117 <p>
118 Public method to retrieve the changelists data.
119 </p><dl>
120 <dt>Returns:</dt>
121 <dd>
122 tuple containing the changelists (list of strings) and a flag
123 indicating to keep changelists (boolean)
124 </dd>
125 </dl><a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a>
126 <h4>SvnCommitDialog.hasChangelists</h4>
127 <b>hasChangelists</b>(<i></i>)
128 <p>
129 Public method to check, if the user entered some changelists.
130 </p><dl>
131 <dt>Returns:</dt>
132 <dd>
133 flag indicating availability of changelists (boolean)
134 </dd>
135 </dl><a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a>
136 <h4>SvnCommitDialog.logMessage</h4>
137 <b>logMessage</b>(<i></i>)
138 <p>
139 Public method to retrieve the log message.
140 </p><p>
141 This method has the side effect of saving the 20 most recent
142 commit messages for reuse.
143 </p><dl>
144 <dt>Returns:</dt>
145 <dd>
146 the log message (string)
147 </dd>
148 </dl><a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a>
149 <h4>SvnCommitDialog.on_buttonBox_accepted</h4>
150 <b>on_buttonBox_accepted</b>(<i></i>)
151 <p>
152 Private slot called by the buttonBox accepted signal.
153 </p><a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a>
154 <h4>SvnCommitDialog.on_buttonBox_clicked</h4>
155 <b>on_buttonBox_clicked</b>(<i>button</i>)
156 <p>
157 Private slot called by a button of the button box clicked.
158 </p><dl>
159 <dt><i>button</i></dt>
160 <dd>
161 button that was clicked (QAbstractButton)
162 </dd>
163 </dl><a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a>
164 <h4>SvnCommitDialog.on_buttonBox_rejected</h4>
165 <b>on_buttonBox_rejected</b>(<i></i>)
166 <p>
167 Private slot called by the buttonBox rejected signal.
168 </p><a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a>
169 <h4>SvnCommitDialog.on_recentComboBox_activated</h4>
170 <b>on_recentComboBox_activated</b>(<i>txt</i>)
171 <p>
172 Private slot to select a commit message from recent ones.
173 </p><dl>
174 <dt><i>txt</i></dt>
175 <dd>
176 selected recent commit message (string)
177 </dd>
178 </dl><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a>
179 <h4>SvnCommitDialog.showEvent</h4>
180 <b>showEvent</b>(<i>evt</i>)
181 <p>
182 Protected method called when the dialog is about to be shown.
183 </p><dl>
184 <dt><i>evt</i></dt>
185 <dd>
186 the event (QShowEvent)
187 </dd>
188 </dl>
189 <div align="right"><a href="#top">Up</a></div>
190 <hr />
191 </body></html>

eric ide

mercurial