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

changeset 15
db83e46b35da
child 37
1b089e0fba1e
equal deleted inserted replaced
14:e3cb581b4653 15:db83e46b35da
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1>
24 <p>
25 Module implementing a dialog for entering the create parameters.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#CreateParametersDialog">CreateParametersDialog</a></td>
35 <td>Class implementing a dialog for entering the create parameters.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a>
44 <h2>CreateParametersDialog</h2>
45 <p>
46 Class implementing a dialog for entering the create parameters.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_CreateParametersDialog
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="#CreateParametersDialog.__init__">CreateParametersDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td>
65 <td>Private slot to update the dialog.</td>
66 </tr><tr>
67 <td><a href="#CreateParametersDialog.getData">getData</a></td>
68 <td>Public method to get the data.</td>
69 </tr><tr>
70 <td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
71 <td>Private slot to handle changes of the site name.</td>
72 </tr><tr>
73 <td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td>
74 <td>Private slot to handle changes of the selected scaffold.</td>
75 </tr>
76 </table>
77 <h3>Static Methods</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a>
82 <h4>CreateParametersDialog (Constructor)</h4>
83 <b>CreateParametersDialog</b>(<i>project, parent=None</i>)
84 <p>
85 Constructor
86 </p><dl>
87 <dt><i>project</i></dt>
88 <dd>
89 reference to the project object (Project)
90 </dd><dt><i>parent</i></dt>
91 <dd>
92 reference to the parent widget (QWidget)
93 </dd>
94 </dl><a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a>
95 <h4>CreateParametersDialog.__updateUi</h4>
96 <b>__updateUi</b>(<i></i>)
97 <p>
98 Private slot to update the dialog.
99 </p><a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a>
100 <h4>CreateParametersDialog.getData</h4>
101 <b>getData</b>(<i></i>)
102 <p>
103 Public method to get the data.
104 </p><dl>
105 <dt>Returns:</dt>
106 <dd>
107 tuple giving the scaffold (string), the project name (string),
108 a flag indicating to overwrite existing files (boolean) and a flag
109 indicating to simulate the creation (boolean)
110 </dd>
111 </dl><a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a>
112 <h4>CreateParametersDialog.on_nameEdit_textChanged</h4>
113 <b>on_nameEdit_textChanged</b>(<i>text</i>)
114 <p>
115 Private slot to handle changes of the site name.
116 </p><dl>
117 <dt><i>text</i></dt>
118 <dd>
119 text of the site entry (string)
120 </dd>
121 </dl><a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a>
122 <h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4>
123 <b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>)
124 <p>
125 Private slot to handle changes of the selected scaffold.
126 </p><dl>
127 <dt><i>text</i></dt>
128 <dd>
129 text of the combo box (string)
130 </dd>
131 </dl>
132 <div align="right"><a href="#top">Up</a></div>
133 <hr />
134 </body></html>

eric ide

mercurial