src/eric7/Documentation/Source/eric7.MultiProject.AddProjectDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9971
773ad1f1ed22
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.MultiProject.AddProjectDialog</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.MultiProject.AddProjectDialog</h1>
10
11 <p>
12 Module implementing the add project 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="#AddProjectDialog">AddProjectDialog</a></td>
25 <td>Class implementing the add project 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="AddProjectDialog" ID="AddProjectDialog"></a>
36 <h2>AddProjectDialog</h2>
37
38 <p>
39 Class implementing the add project dialog.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_AddProjectDialog
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="#AddProjectDialog.__init__">AddProjectDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#AddProjectDialog.__updateUi">__updateUi</a></td>
63 <td>Private method to update the dialog.</td>
64 </tr>
65 <tr>
66 <td><a href="#AddProjectDialog.getData">getData</a></td>
67 <td>Public slot to retrieve the dialogs data.</td>
68 </tr>
69 <tr>
70 <td><a href="#AddProjectDialog.on_filenamePicker_textChanged">on_filenamePicker_textChanged</a></td>
71 <td>Private slot called when the project filename has changed.</td>
72 </tr>
73 <tr>
74 <td><a href="#AddProjectDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
75 <td>Private slot called when the project name has changed.</td>
76 </tr>
77 </table>
78 <h3>Static Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83
84 <a NAME="AddProjectDialog.__init__" ID="AddProjectDialog.__init__"></a>
85 <h4>AddProjectDialog (Constructor)</h4>
86 <b>AddProjectDialog</b>(<i>parent=None, startdir="", project=None, categories=None, category=""</i>)
87
88 <p>
89 Constructor
90 </p>
91 <dl>
92
93 <dt><i>parent</i> (QWidget)</dt>
94 <dd>
95 parent widget of this dialog
96 </dd>
97 <dt><i>startdir</i> (str)</dt>
98 <dd>
99 start directory for the selection dialog
100 </dd>
101 <dt><i>project</i> (dict)</dt>
102 <dd>
103 dictionary containing project data
104 </dd>
105 <dt><i>categories</i> (list of str)</dt>
106 <dd>
107 list of already used categories
108 </dd>
109 <dt><i>category</i> (str)</dt>
110 <dd>
111 category to be preset
112 </dd>
113 </dl>
114 <a NAME="AddProjectDialog.__updateUi" ID="AddProjectDialog.__updateUi"></a>
115 <h4>AddProjectDialog.__updateUi</h4>
116 <b>__updateUi</b>(<i></i>)
117
118 <p>
119 Private method to update the dialog.
120 </p>
121 <a NAME="AddProjectDialog.getData" ID="AddProjectDialog.getData"></a>
122 <h4>AddProjectDialog.getData</h4>
123 <b>getData</b>(<i></i>)
124
125 <p>
126 Public slot to retrieve the dialogs data.
127 </p>
128 <dl>
129 <dt>Return:</dt>
130 <dd>
131 tuple of five values (string, string, boolean, string, string)
132 giving the project name, the name of the project file, a flag
133 telling whether the project shall be the main project, a short
134 description for the project and the project category
135 </dd>
136 </dl>
137 <a NAME="AddProjectDialog.on_filenamePicker_textChanged" ID="AddProjectDialog.on_filenamePicker_textChanged"></a>
138 <h4>AddProjectDialog.on_filenamePicker_textChanged</h4>
139 <b>on_filenamePicker_textChanged</b>(<i>txt</i>)
140
141 <p>
142 Private slot called when the project filename has changed.
143 </p>
144 <dl>
145
146 <dt><i>txt</i></dt>
147 <dd>
148 text of the edit (string)
149 </dd>
150 </dl>
151 <a NAME="AddProjectDialog.on_nameEdit_textChanged" ID="AddProjectDialog.on_nameEdit_textChanged"></a>
152 <h4>AddProjectDialog.on_nameEdit_textChanged</h4>
153 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
154
155 <p>
156 Private slot called when the project name has changed.
157 </p>
158 <dl>
159
160 <dt><i>txt</i></dt>
161 <dd>
162 text of the edit (string)
163 </dd>
164 </dl>
165 <div align="right"><a href="#top">Up</a></div>
166 <hr />
167 </body></html>

eric ide

mercurial