src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog</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.vcsGit.GitArchiveDataDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the data for the creation of an archive.
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="#GitArchiveDataDialog">GitArchiveDataDialog</a></td>
25 <td>Class implementing a dialog to enter the data for the creation of an archive.</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="GitArchiveDataDialog" ID="GitArchiveDataDialog"></a>
36 <h2>GitArchiveDataDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the data for the creation of an
40 archive.
41 </p>
42 <h3>Derived from</h3>
43 QDialog, Ui_GitArchiveDataDialog
44 <h3>Class Attributes</h3>
45
46 <table>
47 <tr><td>None</td></tr>
48 </table>
49 <h3>Class Methods</h3>
50
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55
56 <table>
57
58 <tr>
59 <td><a href="#GitArchiveDataDialog.__init__">GitArchiveDataDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#GitArchiveDataDialog.__updateOK">__updateOK</a></td>
64 <td>Private slot to update the OK button.</td>
65 </tr>
66 <tr>
67 <td><a href="#GitArchiveDataDialog.getData">getData</a></td>
68 <td>Public method to retrieve the entered data.</td>
69 </tr>
70 <tr>
71 <td><a href="#GitArchiveDataDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
72 <td>Private slot to handle changes of the Branch select button.</td>
73 </tr>
74 <tr>
75 <td><a href="#GitArchiveDataDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
76 <td>Private slot to handle changes of the Branch combo.</td>
77 </tr>
78 <tr>
79 <td><a href="#GitArchiveDataDialog.on_fileButton_clicked">on_fileButton_clicked</a></td>
80 <td>Private slot to select a file via a file selection dialog.</td>
81 </tr>
82 <tr>
83 <td><a href="#GitArchiveDataDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td>
84 <td>Private slot to handle changes of the file edit.</td>
85 </tr>
86 <tr>
87 <td><a href="#GitArchiveDataDialog.on_revButton_toggled">on_revButton_toggled</a></td>
88 <td>Private slot to handle changes of the rev select button.</td>
89 </tr>
90 <tr>
91 <td><a href="#GitArchiveDataDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td>
92 <td>Private slot to handle changes of the rev edit.</td>
93 </tr>
94 <tr>
95 <td><a href="#GitArchiveDataDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
96 <td>Private slot to handle changes of the Tag select button.</td>
97 </tr>
98 <tr>
99 <td><a href="#GitArchiveDataDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
100 <td>Private slot to handle changes of the Tag combo.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108
109 <a NAME="GitArchiveDataDialog.__init__" ID="GitArchiveDataDialog.__init__"></a>
110 <h4>GitArchiveDataDialog (Constructor)</h4>
111 <b>GitArchiveDataDialog</b>(<i>tagsList, branchesList, formatsList, parent=None</i>)
112
113 <p>
114 Constructor
115 </p>
116 <dl>
117
118 <dt><i>tagsList</i></dt>
119 <dd>
120 list of tags (list of strings)
121 </dd>
122 <dt><i>branchesList</i></dt>
123 <dd>
124 list of branches (list of strings)
125 </dd>
126 <dt><i>formatsList</i></dt>
127 <dd>
128 list of archive formats (list of strings)
129 </dd>
130 <dt><i>parent</i></dt>
131 <dd>
132 reference to the parent widget (QWidget)
133 </dd>
134 </dl>
135 <a NAME="GitArchiveDataDialog.__updateOK" ID="GitArchiveDataDialog.__updateOK"></a>
136 <h4>GitArchiveDataDialog.__updateOK</h4>
137 <b>__updateOK</b>(<i></i>)
138
139 <p>
140 Private slot to update the OK button.
141 </p>
142 <a NAME="GitArchiveDataDialog.getData" ID="GitArchiveDataDialog.getData"></a>
143 <h4>GitArchiveDataDialog.getData</h4>
144 <b>getData</b>(<i></i>)
145
146 <p>
147 Public method to retrieve the entered data.
148 </p>
149 <dl>
150 <dt>Return:</dt>
151 <dd>
152 tuple of selected revision (string), archive format (string),
153 archive file (string) and prefix (string)
154 </dd>
155 </dl>
156 <a NAME="GitArchiveDataDialog.on_branchButton_toggled" ID="GitArchiveDataDialog.on_branchButton_toggled"></a>
157 <h4>GitArchiveDataDialog.on_branchButton_toggled</h4>
158 <b>on_branchButton_toggled</b>(<i>checked</i>)
159
160 <p>
161 Private slot to handle changes of the Branch select button.
162 </p>
163 <dl>
164
165 <dt><i>checked</i></dt>
166 <dd>
167 state of the button (boolean)
168 </dd>
169 </dl>
170 <a NAME="GitArchiveDataDialog.on_branchCombo_editTextChanged" ID="GitArchiveDataDialog.on_branchCombo_editTextChanged"></a>
171 <h4>GitArchiveDataDialog.on_branchCombo_editTextChanged</h4>
172 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
173
174 <p>
175 Private slot to handle changes of the Branch combo.
176 </p>
177 <dl>
178
179 <dt><i>txt</i></dt>
180 <dd>
181 text of the combo (string)
182 </dd>
183 </dl>
184 <a NAME="GitArchiveDataDialog.on_fileButton_clicked" ID="GitArchiveDataDialog.on_fileButton_clicked"></a>
185 <h4>GitArchiveDataDialog.on_fileButton_clicked</h4>
186 <b>on_fileButton_clicked</b>(<i></i>)
187
188 <p>
189 Private slot to select a file via a file selection dialog.
190 </p>
191 <a NAME="GitArchiveDataDialog.on_fileEdit_textChanged" ID="GitArchiveDataDialog.on_fileEdit_textChanged"></a>
192 <h4>GitArchiveDataDialog.on_fileEdit_textChanged</h4>
193 <b>on_fileEdit_textChanged</b>(<i>txt</i>)
194
195 <p>
196 Private slot to handle changes of the file edit.
197 </p>
198 <dl>
199
200 <dt><i>txt</i></dt>
201 <dd>
202 text of the edit (string)
203 </dd>
204 </dl>
205 <a NAME="GitArchiveDataDialog.on_revButton_toggled" ID="GitArchiveDataDialog.on_revButton_toggled"></a>
206 <h4>GitArchiveDataDialog.on_revButton_toggled</h4>
207 <b>on_revButton_toggled</b>(<i>checked</i>)
208
209 <p>
210 Private slot to handle changes of the rev select button.
211 </p>
212 <dl>
213
214 <dt><i>checked</i></dt>
215 <dd>
216 state of the button (boolean)
217 </dd>
218 </dl>
219 <a NAME="GitArchiveDataDialog.on_revEdit_textChanged" ID="GitArchiveDataDialog.on_revEdit_textChanged"></a>
220 <h4>GitArchiveDataDialog.on_revEdit_textChanged</h4>
221 <b>on_revEdit_textChanged</b>(<i>txt</i>)
222
223 <p>
224 Private slot to handle changes of the rev edit.
225 </p>
226 <dl>
227
228 <dt><i>txt</i></dt>
229 <dd>
230 text of the edit (string)
231 </dd>
232 </dl>
233 <a NAME="GitArchiveDataDialog.on_tagButton_toggled" ID="GitArchiveDataDialog.on_tagButton_toggled"></a>
234 <h4>GitArchiveDataDialog.on_tagButton_toggled</h4>
235 <b>on_tagButton_toggled</b>(<i>checked</i>)
236
237 <p>
238 Private slot to handle changes of the Tag select button.
239 </p>
240 <dl>
241
242 <dt><i>checked</i></dt>
243 <dd>
244 state of the button (boolean)
245 </dd>
246 </dl>
247 <a NAME="GitArchiveDataDialog.on_tagCombo_editTextChanged" ID="GitArchiveDataDialog.on_tagCombo_editTextChanged"></a>
248 <h4>GitArchiveDataDialog.on_tagCombo_editTextChanged</h4>
249 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
250
251 <p>
252 Private slot to handle changes of the Tag combo.
253 </p>
254 <dl>
255
256 <dt><i>txt</i></dt>
257 <dd>
258 text of the combo (string)
259 </dd>
260 </dl>
261 <div align="right"><a href="#top">Up</a></div>
262 <hr />
263 </body></html>

eric ide

mercurial