Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog</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.vcsGit.GitArchiveDataDialog</h1>
23 <p>
24 Module implementing a dialog to enter the data for the creation of an archive.
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="#GitArchiveDataDialog">GitArchiveDataDialog</a></td>
34 <td>Class implementing a dialog to enter the data for the creation of an archive.</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="GitArchiveDataDialog" ID="GitArchiveDataDialog"></a>
43 <h2>GitArchiveDataDialog</h2>
44 <p>
45 Class implementing a dialog to enter the data for the creation of an
46 archive.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_GitArchiveDataDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#GitArchiveDataDialog.__init__">GitArchiveDataDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#GitArchiveDataDialog.__updateOK">__updateOK</a></td>
65 <td>Private slot to update the OK button.</td>
66 </tr><tr>
67 <td><a href="#GitArchiveDataDialog.getData">getData</a></td>
68 <td>Public method to retrieve the entered data.</td>
69 </tr><tr>
70 <td><a href="#GitArchiveDataDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
71 <td>Private slot to handle changes of the Branch select button.</td>
72 </tr><tr>
73 <td><a href="#GitArchiveDataDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
74 <td>Private slot to handle changes of the Branch combo.</td>
75 </tr><tr>
76 <td><a href="#GitArchiveDataDialog.on_fileButton_clicked">on_fileButton_clicked</a></td>
77 <td>Private slot to select a file via a file selection dialog.</td>
78 </tr><tr>
79 <td><a href="#GitArchiveDataDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td>
80 <td>Private slot to handle changes of the file edit.</td>
81 </tr><tr>
82 <td><a href="#GitArchiveDataDialog.on_revButton_toggled">on_revButton_toggled</a></td>
83 <td>Private slot to handle changes of the rev select button.</td>
84 </tr><tr>
85 <td><a href="#GitArchiveDataDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td>
86 <td>Private slot to handle changes of the rev edit.</td>
87 </tr><tr>
88 <td><a href="#GitArchiveDataDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
89 <td>Private slot to handle changes of the Tag select button.</td>
90 </tr><tr>
91 <td><a href="#GitArchiveDataDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
92 <td>Private slot to handle changes of the Tag combo.</td>
93 </tr>
94 </table>
95 <h3>Static Methods</h3>
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99 <a NAME="GitArchiveDataDialog.__init__" ID="GitArchiveDataDialog.__init__"></a>
100 <h4>GitArchiveDataDialog (Constructor)</h4>
101 <b>GitArchiveDataDialog</b>(<i>tagsList, branchesList, formatsList, parent=None</i>)
102 <p>
103 Constructor
104 </p><dl>
105 <dt><i>tagsList</i></dt>
106 <dd>
107 list of tags (list of strings)
108 </dd><dt><i>branchesList</i></dt>
109 <dd>
110 list of branches (list of strings)
111 </dd><dt><i>formatsList</i></dt>
112 <dd>
113 list of archive formats (list of strings)
114 </dd><dt><i>parent</i></dt>
115 <dd>
116 reference to the parent widget (QWidget)
117 </dd>
118 </dl><a NAME="GitArchiveDataDialog.__updateOK" ID="GitArchiveDataDialog.__updateOK"></a>
119 <h4>GitArchiveDataDialog.__updateOK</h4>
120 <b>__updateOK</b>(<i></i>)
121 <p>
122 Private slot to update the OK button.
123 </p><a NAME="GitArchiveDataDialog.getData" ID="GitArchiveDataDialog.getData"></a>
124 <h4>GitArchiveDataDialog.getData</h4>
125 <b>getData</b>(<i></i>)
126 <p>
127 Public method to retrieve the entered data.
128 </p><dl>
129 <dt>Returns:</dt>
130 <dd>
131 tuple of selected revision (string), archive format (string),
132 archive file (string) and prefix (string)
133 </dd>
134 </dl><a NAME="GitArchiveDataDialog.on_branchButton_toggled" ID="GitArchiveDataDialog.on_branchButton_toggled"></a>
135 <h4>GitArchiveDataDialog.on_branchButton_toggled</h4>
136 <b>on_branchButton_toggled</b>(<i>checked</i>)
137 <p>
138 Private slot to handle changes of the Branch select button.
139 </p><dl>
140 <dt><i>checked</i></dt>
141 <dd>
142 state of the button (boolean)
143 </dd>
144 </dl><a NAME="GitArchiveDataDialog.on_branchCombo_editTextChanged" ID="GitArchiveDataDialog.on_branchCombo_editTextChanged"></a>
145 <h4>GitArchiveDataDialog.on_branchCombo_editTextChanged</h4>
146 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
147 <p>
148 Private slot to handle changes of the Branch combo.
149 </p><dl>
150 <dt><i>txt</i></dt>
151 <dd>
152 text of the combo (string)
153 </dd>
154 </dl><a NAME="GitArchiveDataDialog.on_fileButton_clicked" ID="GitArchiveDataDialog.on_fileButton_clicked"></a>
155 <h4>GitArchiveDataDialog.on_fileButton_clicked</h4>
156 <b>on_fileButton_clicked</b>(<i></i>)
157 <p>
158 Private slot to select a file via a file selection dialog.
159 </p><a NAME="GitArchiveDataDialog.on_fileEdit_textChanged" ID="GitArchiveDataDialog.on_fileEdit_textChanged"></a>
160 <h4>GitArchiveDataDialog.on_fileEdit_textChanged</h4>
161 <b>on_fileEdit_textChanged</b>(<i>txt</i>)
162 <p>
163 Private slot to handle changes of the file edit.
164 </p><dl>
165 <dt><i>txt</i></dt>
166 <dd>
167 text of the edit (string)
168 </dd>
169 </dl><a NAME="GitArchiveDataDialog.on_revButton_toggled" ID="GitArchiveDataDialog.on_revButton_toggled"></a>
170 <h4>GitArchiveDataDialog.on_revButton_toggled</h4>
171 <b>on_revButton_toggled</b>(<i>checked</i>)
172 <p>
173 Private slot to handle changes of the rev select button.
174 </p><dl>
175 <dt><i>checked</i></dt>
176 <dd>
177 state of the button (boolean)
178 </dd>
179 </dl><a NAME="GitArchiveDataDialog.on_revEdit_textChanged" ID="GitArchiveDataDialog.on_revEdit_textChanged"></a>
180 <h4>GitArchiveDataDialog.on_revEdit_textChanged</h4>
181 <b>on_revEdit_textChanged</b>(<i>txt</i>)
182 <p>
183 Private slot to handle changes of the rev edit.
184 </p><dl>
185 <dt><i>txt</i></dt>
186 <dd>
187 text of the edit (string)
188 </dd>
189 </dl><a NAME="GitArchiveDataDialog.on_tagButton_toggled" ID="GitArchiveDataDialog.on_tagButton_toggled"></a>
190 <h4>GitArchiveDataDialog.on_tagButton_toggled</h4>
191 <b>on_tagButton_toggled</b>(<i>checked</i>)
192 <p>
193 Private slot to handle changes of the Tag select button.
194 </p><dl>
195 <dt><i>checked</i></dt>
196 <dd>
197 state of the button (boolean)
198 </dd>
199 </dl><a NAME="GitArchiveDataDialog.on_tagCombo_editTextChanged" ID="GitArchiveDataDialog.on_tagCombo_editTextChanged"></a>
200 <h4>GitArchiveDataDialog.on_tagCombo_editTextChanged</h4>
201 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
202 <p>
203 Private slot to handle changes of the Tag combo.
204 </p><dl>
205 <dt><i>txt</i></dt>
206 <dd>
207 text of the combo (string)
208 </dd>
209 </dl>
210 <div align="right"><a href="#top">Up</a></div>
211 <hr />
212 </body></html>

eric ide

mercurial