src/eric7/Documentation/Source/eric7.Project.PropertiesDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9175
21e2be5f0b41
child 9610
b45bccbdf331
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.PropertiesDialog</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.Project.PropertiesDialog</h1>
10
11 <p>
12 Module implementing the project properties dialog.
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="#PropertiesDialog">PropertiesDialog</a></td>
25 <td>Class implementing the project properties dialog.</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="PropertiesDialog" ID="PropertiesDialog"></a>
36 <h2>PropertiesDialog</h2>
37
38 <p>
39 Class implementing the project properties dialog.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_PropertiesDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#PropertiesDialog.__init__">PropertiesDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#PropertiesDialog.__populateLicenseComboBox">__populateLicenseComboBox</a></td>
63 <td>Private method to populate the license selector with the list of trove license types.</td>
64 </tr>
65 <tr>
66 <td><a href="#PropertiesDialog.getPPath">getPPath</a></td>
67 <td>Public method to get the project path.</td>
68 </tr>
69 <tr>
70 <td><a href="#PropertiesDialog.getProjectType">getProjectType</a></td>
71 <td>Public method to get the selected project type.</td>
72 </tr>
73 <tr>
74 <td><a href="#PropertiesDialog.on_dirPicker_textChanged">on_dirPicker_textChanged</a></td>
75 <td>Private slot to handle a change of the project directory.</td>
76 </tr>
77 <tr>
78 <td><a href="#PropertiesDialog.on_languageComboBox_currentTextChanged">on_languageComboBox_currentTextChanged</a></td>
79 <td>Private slot handling the selection of a programming language.</td>
80 </tr>
81 <tr>
82 <td><a href="#PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog">on_mainscriptPicker_aboutToShowPathPickerDialog</a></td>
83 <td>Private slot to perform actions before the main script selection dialog is shown.</td>
84 </tr>
85 <tr>
86 <td><a href="#PropertiesDialog.on_mainscriptPicker_pathSelected">on_mainscriptPicker_pathSelected</a></td>
87 <td>Private slot to check the selected main script name.</td>
88 </tr>
89 <tr>
90 <td><a href="#PropertiesDialog.on_makeButton_clicked">on_makeButton_clicked</a></td>
91 <td>Private slot to display the make properties dialog.</td>
92 </tr>
93 <tr>
94 <td><a href="#PropertiesDialog.on_spellPropertiesButton_clicked">on_spellPropertiesButton_clicked</a></td>
95 <td>Private slot to display the spelling properties dialog.</td>
96 </tr>
97 <tr>
98 <td><a href="#PropertiesDialog.on_transPropertiesButton_clicked">on_transPropertiesButton_clicked</a></td>
99 <td>Private slot to display the translations properties dialog.</td>
100 </tr>
101 <tr>
102 <td><a href="#PropertiesDialog.on_vcsInfoButton_clicked">on_vcsInfoButton_clicked</a></td>
103 <td>Private slot to display a vcs information dialog.</td>
104 </tr>
105 <tr>
106 <td><a href="#PropertiesDialog.storeData">storeData</a></td>
107 <td>Public method to store the entered/modified data.</td>
108 </tr>
109 </table>
110 <h3>Static Methods</h3>
111
112 <table>
113 <tr><td>None</td></tr>
114 </table>
115
116 <a NAME="PropertiesDialog.__init__" ID="PropertiesDialog.__init__"></a>
117 <h4>PropertiesDialog (Constructor)</h4>
118 <b>PropertiesDialog</b>(<i>project, new=True, parent=None, name=None</i>)
119
120 <p>
121 Constructor
122 </p>
123 <dl>
124
125 <dt><i>project</i></dt>
126 <dd>
127 reference to the project object
128 </dd>
129 <dt><i>new</i></dt>
130 <dd>
131 flag indicating the generation of a new project
132 </dd>
133 <dt><i>parent</i></dt>
134 <dd>
135 parent widget of this dialog (QWidget)
136 </dd>
137 <dt><i>name</i></dt>
138 <dd>
139 name of this dialog (string)
140 </dd>
141 </dl>
142 <a NAME="PropertiesDialog.__populateLicenseComboBox" ID="PropertiesDialog.__populateLicenseComboBox"></a>
143 <h4>PropertiesDialog.__populateLicenseComboBox</h4>
144 <b>__populateLicenseComboBox</b>(<i></i>)
145
146 <p>
147 Private method to populate the license selector with the list of trove
148 license types.
149 </p>
150 <a NAME="PropertiesDialog.getPPath" ID="PropertiesDialog.getPPath"></a>
151 <h4>PropertiesDialog.getPPath</h4>
152 <b>getPPath</b>(<i></i>)
153
154 <p>
155 Public method to get the project path.
156 </p>
157 <dl>
158 <dt>Return:</dt>
159 <dd>
160 data of the project directory edit (string)
161 </dd>
162 </dl>
163 <a NAME="PropertiesDialog.getProjectType" ID="PropertiesDialog.getProjectType"></a>
164 <h4>PropertiesDialog.getProjectType</h4>
165 <b>getProjectType</b>(<i></i>)
166
167 <p>
168 Public method to get the selected project type.
169 </p>
170 <dl>
171 <dt>Return:</dt>
172 <dd>
173 selected UI type (string)
174 </dd>
175 </dl>
176 <a NAME="PropertiesDialog.on_dirPicker_textChanged" ID="PropertiesDialog.on_dirPicker_textChanged"></a>
177 <h4>PropertiesDialog.on_dirPicker_textChanged</h4>
178 <b>on_dirPicker_textChanged</b>(<i>txt</i>)
179
180 <p>
181 Private slot to handle a change of the project directory.
182 </p>
183 <dl>
184
185 <dt><i>txt</i></dt>
186 <dd>
187 name of the project directory (string)
188 </dd>
189 </dl>
190 <a NAME="PropertiesDialog.on_languageComboBox_currentTextChanged" ID="PropertiesDialog.on_languageComboBox_currentTextChanged"></a>
191 <h4>PropertiesDialog.on_languageComboBox_currentTextChanged</h4>
192 <b>on_languageComboBox_currentTextChanged</b>(<i>language</i>)
193
194 <p>
195 Private slot handling the selection of a programming language.
196 </p>
197 <dl>
198
199 <dt><i>language</i> (str)</dt>
200 <dd>
201 text of the current item
202 </dd>
203 </dl>
204 <a NAME="PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog" ID="PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog"></a>
205 <h4>PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog</h4>
206 <b>on_mainscriptPicker_aboutToShowPathPickerDialog</b>(<i></i>)
207
208 <p>
209 Private slot to perform actions before the main script selection dialog
210 is shown.
211 </p>
212 <a NAME="PropertiesDialog.on_mainscriptPicker_pathSelected" ID="PropertiesDialog.on_mainscriptPicker_pathSelected"></a>
213 <h4>PropertiesDialog.on_mainscriptPicker_pathSelected</h4>
214 <b>on_mainscriptPicker_pathSelected</b>(<i>script</i>)
215
216 <p>
217 Private slot to check the selected main script name.
218 </p>
219 <dl>
220
221 <dt><i>script</i> (str)</dt>
222 <dd>
223 name of the main script
224 </dd>
225 </dl>
226 <a NAME="PropertiesDialog.on_makeButton_clicked" ID="PropertiesDialog.on_makeButton_clicked"></a>
227 <h4>PropertiesDialog.on_makeButton_clicked</h4>
228 <b>on_makeButton_clicked</b>(<i></i>)
229
230 <p>
231 Private slot to display the make properties dialog.
232 </p>
233 <a NAME="PropertiesDialog.on_spellPropertiesButton_clicked" ID="PropertiesDialog.on_spellPropertiesButton_clicked"></a>
234 <h4>PropertiesDialog.on_spellPropertiesButton_clicked</h4>
235 <b>on_spellPropertiesButton_clicked</b>(<i></i>)
236
237 <p>
238 Private slot to display the spelling properties dialog.
239 </p>
240 <a NAME="PropertiesDialog.on_transPropertiesButton_clicked" ID="PropertiesDialog.on_transPropertiesButton_clicked"></a>
241 <h4>PropertiesDialog.on_transPropertiesButton_clicked</h4>
242 <b>on_transPropertiesButton_clicked</b>(<i></i>)
243
244 <p>
245 Private slot to display the translations properties dialog.
246 </p>
247 <a NAME="PropertiesDialog.on_vcsInfoButton_clicked" ID="PropertiesDialog.on_vcsInfoButton_clicked"></a>
248 <h4>PropertiesDialog.on_vcsInfoButton_clicked</h4>
249 <b>on_vcsInfoButton_clicked</b>(<i></i>)
250
251 <p>
252 Private slot to display a vcs information dialog.
253 </p>
254 <a NAME="PropertiesDialog.storeData" ID="PropertiesDialog.storeData"></a>
255 <h4>PropertiesDialog.storeData</h4>
256 <b>storeData</b>(<i></i>)
257
258 <p>
259 Public method to store the entered/modified data.
260 </p>
261 <div align="right"><a href="#top">Up</a></div>
262 <hr />
263 </body></html>

eric ide

mercurial