20 </style> |
20 </style> |
21 </head> |
21 </head> |
22 <body><a NAME="top" ID="top"></a> |
22 <body><a NAME="top" ID="top"></a> |
23 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog</h1> |
23 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog</h1> |
24 <p> |
24 <p> |
25 Module implementing a dialog to enter the commit message. |
25 Module implementing a dialog to enter the commit message. |
26 </p> |
26 </p> |
27 <h3>Global Attributes</h3> |
27 <h3>Global Attributes</h3> |
28 <table> |
28 <table> |
29 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
30 </table> |
30 </table> |
31 <h3>Classes</h3> |
31 <h3>Classes</h3> |
32 <table> |
32 <table> |
33 <tr> |
33 <tr> |
34 <td><a href="#SvnCommitDialog">SvnCommitDialog</a></td> |
34 <td><a href="#SvnCommitDialog">SvnCommitDialog</a></td> |
35 <td>Class implementing a dialog to enter the commit message.</td> |
35 <td>Class implementing a dialog to enter the commit message.</td> |
36 </tr> |
36 </tr> |
37 </table> |
37 </table> |
38 <h3>Functions</h3> |
38 <h3>Functions</h3> |
39 <table> |
39 <table> |
40 <tr><td>None</td></tr> |
40 <tr><td>None</td></tr> |
41 </table> |
41 </table> |
42 <hr /><hr /> |
42 <hr /><hr /> |
43 <a NAME="SvnCommitDialog" ID="SvnCommitDialog"></a> |
43 <a NAME="SvnCommitDialog" ID="SvnCommitDialog"></a> |
44 <h2>SvnCommitDialog</h2> |
44 <h2>SvnCommitDialog</h2> |
45 <p> |
45 <p> |
46 Class implementing a dialog to enter the commit message. |
46 Class implementing a dialog to enter the commit message. |
47 </p><h4>Signals</h4> |
47 </p><h4>Signals</h4> |
48 <dl> |
48 <dl> |
49 <dt>accepted()</dt> |
49 <dt>accepted()</dt> |
50 <dd> |
50 <dd> |
51 emitted, if the dialog was accepted |
51 emitted, if the dialog was accepted |
52 </dd><dt>rejected()</dt> |
52 </dd><dt>rejected()</dt> |
53 <dd> |
53 <dd> |
54 emitted, if the dialog was rejected |
54 emitted, if the dialog was rejected |
55 </dd> |
55 </dd> |
56 </dl> |
56 </dl> |
57 <h3>Derived from</h3> |
57 <h3>Derived from</h3> |
58 QWidget, Ui_SvnCommitDialog |
58 QWidget, Ui_SvnCommitDialog |
59 <h3>Class Attributes</h3> |
59 <h3>Class Attributes</h3> |
62 </table> |
62 </table> |
63 <h3>Methods</h3> |
63 <h3>Methods</h3> |
64 <table> |
64 <table> |
65 <tr> |
65 <tr> |
66 <td><a href="#SvnCommitDialog.__init__">SvnCommitDialog</a></td> |
66 <td><a href="#SvnCommitDialog.__init__">SvnCommitDialog</a></td> |
67 <td>Constructor</td> |
67 <td>Constructor</td> |
68 </tr><tr> |
68 </tr><tr> |
69 <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> |
69 <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> |
70 <td>Public method to retrieve the changelists data.</td> |
70 <td>Public method to retrieve the changelists data.</td> |
71 </tr><tr> |
71 </tr><tr> |
72 <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> |
72 <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> |
73 <td>Public method to check, if the user entered some changelists.</td> |
73 <td>Public method to check, if the user entered some changelists.</td> |
74 </tr><tr> |
74 </tr><tr> |
75 <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> |
75 <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> |
76 <td>Public method to retrieve the log message.</td> |
76 <td>Public method to retrieve the log message.</td> |
77 </tr><tr> |
77 </tr><tr> |
78 <td><a href="#SvnCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
78 <td><a href="#SvnCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
79 <td>Private slot called by the buttonBox accepted signal.</td> |
79 <td>Private slot called by the buttonBox accepted signal.</td> |
80 </tr><tr> |
80 </tr><tr> |
81 <td><a href="#SvnCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
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> |
82 <td>Private slot called by a button of the button box clicked.</td> |
83 </tr><tr> |
83 </tr><tr> |
84 <td><a href="#SvnCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> |
84 <td><a href="#SvnCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> |
85 <td>Private slot called by the buttonBox rejected signal.</td> |
85 <td>Private slot called by the buttonBox rejected signal.</td> |
86 </tr><tr> |
86 </tr><tr> |
87 <td><a href="#SvnCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> |
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> |
88 <td>Private slot to select a commit message from recent ones.</td> |
89 </tr><tr> |
89 </tr><tr> |
90 <td><a href="#SvnCommitDialog.showEvent">showEvent</a></td> |
90 <td><a href="#SvnCommitDialog.showEvent">showEvent</a></td> |
91 <td>Public method called when the dialog is about to be shown.</td> |
91 <td>Public method called when the dialog is about to be shown.</td> |
92 </tr> |
92 </tr> |
93 </table> |
93 </table> |
94 <a NAME="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a> |
94 <a NAME="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a> |
95 <h4>SvnCommitDialog (Constructor)</h4> |
95 <h4>SvnCommitDialog (Constructor)</h4> |
96 <b>SvnCommitDialog</b>(<i>parent = None</i>) |
96 <b>SvnCommitDialog</b>(<i>parent = None</i>) |
97 <p> |
97 <p> |
98 Constructor |
98 Constructor |
99 </p><dl> |
99 </p><dl> |
100 <dt><i>parent</i></dt> |
100 <dt><i>parent</i></dt> |
101 <dd> |
101 <dd> |
102 parent widget (QWidget) |
102 parent widget (QWidget) |
103 </dd> |
103 </dd> |
104 </dl><a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> |
104 </dl><a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> |
105 <h4>SvnCommitDialog.changelistsData</h4> |
105 <h4>SvnCommitDialog.changelistsData</h4> |
106 <b>changelistsData</b>(<i></i>) |
106 <b>changelistsData</b>(<i></i>) |
107 <p> |
107 <p> |
108 Public method to retrieve the changelists data. |
108 Public method to retrieve the changelists data. |
109 </p><dl> |
109 </p><dl> |
110 <dt>Returns:</dt> |
110 <dt>Returns:</dt> |
111 <dd> |
111 <dd> |
112 tuple containing the changelists (list of strings) and a flag |
112 tuple containing the changelists (list of strings) and a flag |
113 indicating to keep changelists (boolean) |
113 indicating to keep changelists (boolean) |
114 </dd> |
114 </dd> |
115 </dl><a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> |
115 </dl><a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> |
116 <h4>SvnCommitDialog.hasChangelists</h4> |
116 <h4>SvnCommitDialog.hasChangelists</h4> |
117 <b>hasChangelists</b>(<i></i>) |
117 <b>hasChangelists</b>(<i></i>) |
118 <p> |
118 <p> |
119 Public method to check, if the user entered some changelists. |
119 Public method to check, if the user entered some changelists. |
120 </p><dl> |
120 </p><dl> |
121 <dt>Returns:</dt> |
121 <dt>Returns:</dt> |
122 <dd> |
122 <dd> |
123 flag indicating availability of changelists (boolean) |
123 flag indicating availability of changelists (boolean) |
124 </dd> |
124 </dd> |
125 </dl><a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> |
125 </dl><a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> |
126 <h4>SvnCommitDialog.logMessage</h4> |
126 <h4>SvnCommitDialog.logMessage</h4> |
127 <b>logMessage</b>(<i></i>) |
127 <b>logMessage</b>(<i></i>) |
128 <p> |
128 <p> |
129 Public method to retrieve the log message. |
129 Public method to retrieve the log message. |
130 </p><p> |
130 </p><p> |
131 This method has the side effect of saving the 20 most recent |
131 This method has the side effect of saving the 20 most recent |
132 commit messages for reuse. |
132 commit messages for reuse. |
133 </p><dl> |
133 </p><dl> |
134 <dt>Returns:</dt> |
134 <dt>Returns:</dt> |
135 <dd> |
135 <dd> |
136 the log message (string) |
136 the log message (string) |
137 </dd> |
137 </dd> |
138 </dl><a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> |
138 </dl><a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> |
139 <h4>SvnCommitDialog.on_buttonBox_accepted</h4> |
139 <h4>SvnCommitDialog.on_buttonBox_accepted</h4> |
140 <b>on_buttonBox_accepted</b>(<i></i>) |
140 <b>on_buttonBox_accepted</b>(<i></i>) |
141 <p> |
141 <p> |
142 Private slot called by the buttonBox accepted signal. |
142 Private slot called by the buttonBox accepted signal. |
143 </p><a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a> |
143 </p><a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a> |
144 <h4>SvnCommitDialog.on_buttonBox_clicked</h4> |
144 <h4>SvnCommitDialog.on_buttonBox_clicked</h4> |
145 <b>on_buttonBox_clicked</b>(<i>button</i>) |
145 <b>on_buttonBox_clicked</b>(<i>button</i>) |
146 <p> |
146 <p> |
147 Private slot called by a button of the button box clicked. |
147 Private slot called by a button of the button box clicked. |
148 </p><dl> |
148 </p><dl> |
149 <dt><i>button</i></dt> |
149 <dt><i>button</i></dt> |
150 <dd> |
150 <dd> |
151 button that was clicked (QAbstractButton) |
151 button that was clicked (QAbstractButton) |
152 </dd> |
152 </dd> |
153 </dl><a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> |
153 </dl><a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> |
154 <h4>SvnCommitDialog.on_buttonBox_rejected</h4> |
154 <h4>SvnCommitDialog.on_buttonBox_rejected</h4> |
155 <b>on_buttonBox_rejected</b>(<i></i>) |
155 <b>on_buttonBox_rejected</b>(<i></i>) |
156 <p> |
156 <p> |
157 Private slot called by the buttonBox rejected signal. |
157 Private slot called by the buttonBox rejected signal. |
158 </p><a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a> |
158 </p><a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a> |
159 <h4>SvnCommitDialog.on_recentComboBox_activated</h4> |
159 <h4>SvnCommitDialog.on_recentComboBox_activated</h4> |
160 <b>on_recentComboBox_activated</b>(<i>txt</i>) |
160 <b>on_recentComboBox_activated</b>(<i>txt</i>) |
161 <p> |
161 <p> |
162 Private slot to select a commit message from recent ones. |
162 Private slot to select a commit message from recent ones. |
163 </p><dl> |
163 </p><dl> |
164 <dt><i>txt</i></dt> |
164 <dt><i>txt</i></dt> |
165 <dd> |
165 <dd> |
166 selected recent commit message (string) |
166 selected recent commit message (string) |
167 </dd> |
167 </dd> |
168 </dl><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> |
168 </dl><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> |
169 <h4>SvnCommitDialog.showEvent</h4> |
169 <h4>SvnCommitDialog.showEvent</h4> |
170 <b>showEvent</b>(<i>evt</i>) |
170 <b>showEvent</b>(<i>evt</i>) |
171 <p> |
171 <p> |
172 Public method called when the dialog is about to be shown. |
172 Public method called when the dialog is about to be shown. |
173 </p><dl> |
173 </p><dl> |
174 <dt><i>evt</i></dt> |
174 <dt><i>evt</i></dt> |
175 <dd> |
175 <dd> |
176 the event (QShowEvent) |
176 the event (QShowEvent) |
177 </dd> |
177 </dd> |
178 </dl> |
178 </dl> |
179 <div align="right"><a href="#top">Up</a></div> |
179 <div align="right"><a href="#top">Up</a></div> |
180 <hr /> |
180 <hr /> |
181 </body></html> |
181 </body></html> |