Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</h1>
24 <p>
25 Module implementing a dialog to enter the commit message.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#SvnCommitDialog">SvnCommitDialog</a></td>
35 <td>Class implementing a dialog to enter the commit message.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="SvnCommitDialog" ID="SvnCommitDialog"></a>
44 <h2>SvnCommitDialog</h2>
45 <p>
46 Class implementing a dialog to enter the commit message.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>accepted()</dt>
50 <dd>
51 emitted, if the dialog was accepted
52 </dd><dt>rejected()</dt>
53 <dd>
54 emitted, if the dialog was rejected
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QWidget, Ui_SvnCommitDialog
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#SvnCommitDialog.__init__">SvnCommitDialog</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td>
70 <td>Public method to retrieve the changelists data.</td>
71 </tr><tr>
72 <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td>
73 <td>Public method to check, if the user entered some changelists.</td>
74 </tr><tr>
75 <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td>
76 <td>Public method to retrieve the log message.</td>
77 </tr><tr>
78 <td><a href="#SvnCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
79 <td>Private slot called by the buttonBox accepted signal.</td>
80 </tr><tr>
81 <td><a href="#SvnCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
82 <td>Private slot called by a button of the button box clicked.</td>
83 </tr><tr>
84 <td><a href="#SvnCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
85 <td>Private slot called by the buttonBox rejected signal.</td>
86 </tr><tr>
87 <td><a href="#SvnCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td>
88 <td>Private slot to select a commit message from recent ones.</td>
89 </tr><tr>
90 <td><a href="#SvnCommitDialog.showEvent">showEvent</a></td>
91 <td>Public method called when the dialog is about to be shown.</td>
92 </tr>
93 </table>
94 <a NAME="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a>
95 <h4>SvnCommitDialog (Constructor)</h4>
96 <b>SvnCommitDialog</b>(<i>vcs, parent = None</i>)
97 <p>
98 Constructor
99 </p><dl>
100 <dt><i>vcs</i></dt>
101 <dd>
102 reference to the vcs object
103 </dd><dt><i>parent</i></dt>
104 <dd>
105 parent widget (QWidget)
106 </dd>
107 </dl><a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a>
108 <h4>SvnCommitDialog.changelistsData</h4>
109 <b>changelistsData</b>(<i></i>)
110 <p>
111 Public method to retrieve the changelists data.
112 </p><dl>
113 <dt>Returns:</dt>
114 <dd>
115 tuple containing the changelists (QStringList) and a flag
116 indicating to keep changelists (boolean)
117 </dd>
118 </dl><a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a>
119 <h4>SvnCommitDialog.hasChangelists</h4>
120 <b>hasChangelists</b>(<i></i>)
121 <p>
122 Public method to check, if the user entered some changelists.
123 </p><dl>
124 <dt>Returns:</dt>
125 <dd>
126 flag indicating availability of changelists (boolean)
127 </dd>
128 </dl><a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a>
129 <h4>SvnCommitDialog.logMessage</h4>
130 <b>logMessage</b>(<i></i>)
131 <p>
132 Public method to retrieve the log message.
133 </p><dl>
134 <dt>Returns:</dt>
135 <dd>
136 the log message (QString)
137 </dd>
138 </dl><a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a>
139 <h4>SvnCommitDialog.on_buttonBox_accepted</h4>
140 <b>on_buttonBox_accepted</b>(<i></i>)
141 <p>
142 Private slot called by the buttonBox accepted signal.
143 </p><a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a>
144 <h4>SvnCommitDialog.on_buttonBox_clicked</h4>
145 <b>on_buttonBox_clicked</b>(<i>button</i>)
146 <p>
147 Private slot called by a button of the button box clicked.
148 </p><dl>
149 <dt><i>button</i></dt>
150 <dd>
151 button that was clicked (QAbstractButton)
152 </dd>
153 </dl><a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a>
154 <h4>SvnCommitDialog.on_buttonBox_rejected</h4>
155 <b>on_buttonBox_rejected</b>(<i></i>)
156 <p>
157 Private slot called by the buttonBox rejected signal.
158 </p><a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a>
159 <h4>SvnCommitDialog.on_recentComboBox_activated</h4>
160 <b>on_recentComboBox_activated</b>(<i>txt</i>)
161 <p>
162 Private slot to select a commit message from recent ones.
163 </p><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a>
164 <h4>SvnCommitDialog.showEvent</h4>
165 <b>showEvent</b>(<i>evt</i>)
166 <p>
167 Public method called when the dialog is about to be shown.
168 </p><dl>
169 <dt><i>evt</i></dt>
170 <dd>
171 the event (QShowEvent)
172 </dd>
173 </dl>
174 <div align="right"><a href="#top">Up</a></div>
175 <hr />
176 </body></html>

eric ide

mercurial