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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Project.PropertiesDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,265 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Project.PropertiesDialog</title>
+<meta charset="UTF-8">
+<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>eric7.Project.PropertiesDialog</h1>
+
+<p>
+Module implementing the project properties dialog.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PropertiesDialog">PropertiesDialog</a></td>
+<td>Class implementing the project properties dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="PropertiesDialog" ID="PropertiesDialog"></a>
+<h2>PropertiesDialog</h2>
+
+<p>
+    Class implementing the project properties dialog.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PropertiesDialog
+<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="#PropertiesDialog.__init__">PropertiesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.getPPath">getPPath</a></td>
+<td>Public method to get the project path.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.getProjectType">getProjectType</a></td>
+<td>Public method to get the selected project type.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_dirPicker_textChanged">on_dirPicker_textChanged</a></td>
+<td>Private slot to handle a change of the project directory.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_languageComboBox_currentIndexChanged">on_languageComboBox_currentIndexChanged</a></td>
+<td>Private slot handling the selection of a programming language.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog">on_mainscriptPicker_aboutToShowPathPickerDialog</a></td>
+<td>Private slot to perform actions before the main script selection dialog is shown.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_mainscriptPicker_pathSelected">on_mainscriptPicker_pathSelected</a></td>
+<td>Private slot to check the selected main script name.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_makeButton_clicked">on_makeButton_clicked</a></td>
+<td>Private slot to display the make properties dialog.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_spellPropertiesButton_clicked">on_spellPropertiesButton_clicked</a></td>
+<td>Private slot to display the spelling properties dialog.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_transPropertiesButton_clicked">on_transPropertiesButton_clicked</a></td>
+<td>Private slot to display the translations properties dialog.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.on_vcsInfoButton_clicked">on_vcsInfoButton_clicked</a></td>
+<td>Private slot to display a vcs information dialog.</td>
+</tr>
+<tr>
+<td><a href="#PropertiesDialog.storeData">storeData</a></td>
+<td>Public method to store the entered/modified data.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PropertiesDialog.__init__" ID="PropertiesDialog.__init__"></a>
+<h4>PropertiesDialog (Constructor)</h4>
+<b>PropertiesDialog</b>(<i>project, new=True, parent=None, name=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>project</i></dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>new</i></dt>
+<dd>
+flag indicating the generation of a new project
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget of this dialog (QWidget)
+</dd>
+<dt><i>name</i></dt>
+<dd>
+name of this dialog (string)
+</dd>
+</dl>
+<a NAME="PropertiesDialog.getPPath" ID="PropertiesDialog.getPPath"></a>
+<h4>PropertiesDialog.getPPath</h4>
+<b>getPPath</b>(<i></i>)
+
+<p>
+        Public method to get the project path.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+data of the project directory edit (string)
+</dd>
+</dl>
+<a NAME="PropertiesDialog.getProjectType" ID="PropertiesDialog.getProjectType"></a>
+<h4>PropertiesDialog.getProjectType</h4>
+<b>getProjectType</b>(<i></i>)
+
+<p>
+        Public method to get the selected project type.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+selected UI type (string)
+</dd>
+</dl>
+<a NAME="PropertiesDialog.on_dirPicker_textChanged" ID="PropertiesDialog.on_dirPicker_textChanged"></a>
+<h4>PropertiesDialog.on_dirPicker_textChanged</h4>
+<b>on_dirPicker_textChanged</b>(<i>txt</i>)
+
+<p>
+        Private slot to handle a change of the project directory.
+</p>
+<dl>
+
+<dt><i>txt</i></dt>
+<dd>
+name of the project directory (string)
+</dd>
+</dl>
+<a NAME="PropertiesDialog.on_languageComboBox_currentIndexChanged" ID="PropertiesDialog.on_languageComboBox_currentIndexChanged"></a>
+<h4>PropertiesDialog.on_languageComboBox_currentIndexChanged</h4>
+<b>on_languageComboBox_currentIndexChanged</b>(<i>index</i>)
+
+<p>
+        Private slot handling the selection of a programming language.
+</p>
+<dl>
+
+<dt><i>index</i> (int)</dt>
+<dd>
+index of the current item
+</dd>
+</dl>
+<a NAME="PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog" ID="PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog"></a>
+<h4>PropertiesDialog.on_mainscriptPicker_aboutToShowPathPickerDialog</h4>
+<b>on_mainscriptPicker_aboutToShowPathPickerDialog</b>(<i></i>)
+
+<p>
+        Private slot to perform actions before the main script selection dialog
+        is shown.
+</p>
+<a NAME="PropertiesDialog.on_mainscriptPicker_pathSelected" ID="PropertiesDialog.on_mainscriptPicker_pathSelected"></a>
+<h4>PropertiesDialog.on_mainscriptPicker_pathSelected</h4>
+<b>on_mainscriptPicker_pathSelected</b>(<i>script</i>)
+
+<p>
+        Private slot to check the selected main script name.
+</p>
+<dl>
+
+<dt><i>script</i> (str)</dt>
+<dd>
+name of the main script
+</dd>
+</dl>
+<a NAME="PropertiesDialog.on_makeButton_clicked" ID="PropertiesDialog.on_makeButton_clicked"></a>
+<h4>PropertiesDialog.on_makeButton_clicked</h4>
+<b>on_makeButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to display the make properties dialog.
+</p>
+<a NAME="PropertiesDialog.on_spellPropertiesButton_clicked" ID="PropertiesDialog.on_spellPropertiesButton_clicked"></a>
+<h4>PropertiesDialog.on_spellPropertiesButton_clicked</h4>
+<b>on_spellPropertiesButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to display the spelling properties dialog.
+</p>
+<a NAME="PropertiesDialog.on_transPropertiesButton_clicked" ID="PropertiesDialog.on_transPropertiesButton_clicked"></a>
+<h4>PropertiesDialog.on_transPropertiesButton_clicked</h4>
+<b>on_transPropertiesButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to display the translations properties dialog.
+</p>
+<a NAME="PropertiesDialog.on_vcsInfoButton_clicked" ID="PropertiesDialog.on_vcsInfoButton_clicked"></a>
+<h4>PropertiesDialog.on_vcsInfoButton_clicked</h4>
+<b>on_vcsInfoButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to display a vcs information dialog.
+</p>
+<a NAME="PropertiesDialog.storeData" ID="PropertiesDialog.storeData"></a>
+<h4>PropertiesDialog.storeData</h4>
+<b>storeData</b>(<i></i>)
+
+<p>
+        Public method to store the entered/modified data.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial