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

changeset 15
db83e46b35da
child 37
1b089e0fba1e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html	Thu Aug 30 14:27:35 2012 +0200
@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1>
+<p>
+Module implementing a dialog for entering the create parameters.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#CreateParametersDialog">CreateParametersDialog</a></td>
+<td>Class implementing a dialog for entering the create parameters.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a>
+<h2>CreateParametersDialog</h2>
+<p>
+    Class implementing a dialog for entering the create parameters.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_CreateParametersDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td>
+<td>Private slot to update the dialog.</td>
+</tr><tr>
+<td><a href="#CreateParametersDialog.getData">getData</a></td>
+<td>Public method to get the data.</td>
+</tr><tr>
+<td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
+<td>Private slot to handle changes of the site name.</td>
+</tr><tr>
+<td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td>
+<td>Private slot to handle changes of the selected scaffold.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a>
+<h4>CreateParametersDialog (Constructor)</h4>
+<b>CreateParametersDialog</b>(<i>project, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>project</i></dt>
+<dd>
+reference to the project object (Project)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a>
+<h4>CreateParametersDialog.__updateUi</h4>
+<b>__updateUi</b>(<i></i>)
+<p>
+        Private slot to update the dialog.
+</p><a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a>
+<h4>CreateParametersDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple giving the scaffold (string), the project name (string),
+            a flag indicating to overwrite existing files (boolean) and a flag
+            indicating to simulate the creation (boolean)
+</dd>
+</dl><a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a>
+<h4>CreateParametersDialog.on_nameEdit_textChanged</h4>
+<b>on_nameEdit_textChanged</b>(<i>text</i>)
+<p>
+        Private slot to handle changes of the site name.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text of the site entry (string)
+</dd>
+</dl><a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a>
+<h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4>
+<b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>)
+<p>
+        Private slot to handle changes of the selected scaffold.
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text of the combo box (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial