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