ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html

branch
eric7
changeset 148
dcbd3a96f03c
parent 147
eb28b4b6f7f5
child 157
ddbc0e38ea1b
equal deleted inserted replaced
147:eb28b4b6f7f5 148:dcbd3a96f03c
55 <h3>Derived from</h3> 55 <h3>Derived from</h3>
56 QDialog, Ui_CreateParametersDialog 56 QDialog, Ui_CreateParametersDialog
57 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58 58
59 <table> 59 <table>
60 <tr><td>None</td></tr> 60 <tr><td>PyramidStarter</td></tr><tr><td>PyramidStarterGH</td></tr>
61 </table> 61 </table>
62 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63 63
64 <table> 64 <table>
65 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
71 <tr> 71 <tr>
72 <td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td> 72 <td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td>
73 <td>Constructor</td> 73 <td>Constructor</td>
74 </tr> 74 </tr>
75 <tr> 75 <tr>
76 <td><a href="#CreateParametersDialog.__prepareScaffoldString">__prepareScaffoldString</a></td>
77 <td>Private method to prepare a scaffold string for the combo box.</td>
78 </tr>
79 <tr>
80 <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> 76 <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td>
81 <td>Private slot to update the dialog.</td> 77 <td>Private slot to update the dialog.</td>
82 </tr> 78 </tr>
83 <tr> 79 <tr>
84 <td><a href="#CreateParametersDialog.getData">getData</a></td> 80 <td><a href="#CreateParametersDialog.getData">getData</a></td>
85 <td>Public method to get the data.</td> 81 <td>Public method to get the data.</td>
86 </tr> 82 </tr>
87 <tr> 83 <tr>
88 <td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> 84 <td><a href="#CreateParametersDialog.on_templateCombo_currentTextChanged">on_templateCombo_currentTextChanged</a></td>
89 <td>Private slot to handle changes of the site name.</td>
90 </tr>
91 <tr>
92 <td><a href="#CreateParametersDialog.on_scaffoldCombo_currentTextChanged">on_scaffoldCombo_currentTextChanged</a></td>
93 <td>Private slot to handle changes of the selected scaffold.</td> 85 <td>Private slot to handle changes of the selected scaffold.</td>
94 </tr> 86 </tr>
95 </table> 87 </table>
96 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
97 89
99 <tr><td>None</td></tr> 91 <tr><td>None</td></tr>
100 </table> 92 </table>
101 93
102 <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> 94 <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a>
103 <h4>CreateParametersDialog (Constructor)</h4> 95 <h4>CreateParametersDialog (Constructor)</h4>
104 <b>CreateParametersDialog</b>(<i>project, parent=None</i>) 96 <b>CreateParametersDialog</b>(<i>parent=None</i>)
105 97
106 <p> 98 <p>
107 Constructor 99 Constructor
108 </p> 100 </p>
109 <dl> 101 <dl>
110 102
111 <dt><i>project</i> (Project)</dt>
112 <dd>
113 reference to the project object
114 </dd>
115 <dt><i>parent</i> (QWidget)</dt> 103 <dt><i>parent</i> (QWidget)</dt>
116 <dd> 104 <dd>
117 reference to the parent widget 105 reference to the parent widget
118 </dd>
119 </dl>
120 <a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a>
121 <h4>CreateParametersDialog.__prepareScaffoldString</h4>
122 <b>__prepareScaffoldString</b>(<i>line</i>)
123
124 <p>
125 Private method to prepare a scaffold string for the combo box.
126 </p>
127 <dl>
128
129 <dt><i>line</i> (str)</dt>
130 <dd>
131 output line containing the scaffold name and some
132 explanatory text
133 </dd>
134 </dl>
135 <dl>
136 <dt>Return:</dt>
137 <dd>
138 prepared scaffold text
139 </dd>
140 </dl>
141 <dl>
142 <dt>Return Type:</dt>
143 <dd>
144 str
145 </dd> 106 </dd>
146 </dl> 107 </dl>
147 <a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> 108 <a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a>
148 <h4>CreateParametersDialog.__updateUi</h4> 109 <h4>CreateParametersDialog.__updateUi</h4>
149 <b>__updateUi</b>(<i></i>) 110 <b>__updateUi</b>(<i></i>)
159 Public method to get the data. 120 Public method to get the data.
160 </p> 121 </p>
161 <dl> 122 <dl>
162 <dt>Return:</dt> 123 <dt>Return:</dt>
163 <dd> 124 <dd>
164 tuple giving the scaffold, the project name, a flag indicating 125 tuple giving the template name, an optional template version,
165 to overwrite existing files and a flag indicating to simulate the 126 a flag indicating to overwrite existing files and a dictionary
166 creation 127 containing additional context data
167 </dd> 128 </dd>
168 </dl> 129 </dl>
169 <dl> 130 <dl>
170 <dt>Return Type:</dt> 131 <dt>Return Type:</dt>
171 <dd> 132 <dd>
172 tuple of (str, str, bool, bool) 133 tuple of (str, str, bool)
173 </dd> 134 </dd>
174 </dl> 135 </dl>
175 <a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> 136 <a NAME="CreateParametersDialog.on_templateCombo_currentTextChanged" ID="CreateParametersDialog.on_templateCombo_currentTextChanged"></a>
176 <h4>CreateParametersDialog.on_nameEdit_textChanged</h4> 137 <h4>CreateParametersDialog.on_templateCombo_currentTextChanged</h4>
177 <b>on_nameEdit_textChanged</b>(<i>text</i>) 138 <b>on_templateCombo_currentTextChanged</b>(<i>text</i>)
178
179 <p>
180 Private slot to handle changes of the site name.
181 </p>
182 <dl>
183
184 <dt><i>text</i> (str)</dt>
185 <dd>
186 text of the site entry
187 </dd>
188 </dl>
189 <a NAME="CreateParametersDialog.on_scaffoldCombo_currentTextChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentTextChanged"></a>
190 <h4>CreateParametersDialog.on_scaffoldCombo_currentTextChanged</h4>
191 <b>on_scaffoldCombo_currentTextChanged</b>(<i>text</i>)
192 139
193 <p> 140 <p>
194 Private slot to handle changes of the selected scaffold. 141 Private slot to handle changes of the selected scaffold.
195 </p> 142 </p>
196 <dl> 143 <dl>

eric ide

mercurial