src/eric7/Documentation/Source/eric7.Project.ProjectFile.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectFile.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,148 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Project.ProjectFile</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Project.ProjectFile</h1>
+
+<p>
+Module implementing a class representing the project JSON file.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>Project</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#ProjectFile">ProjectFile</a></td>
+<td>Class representing the project JSON file.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="ProjectFile" ID="ProjectFile"></a>
+<h2>ProjectFile</h2>
+
+<p>
+    Class representing the project JSON file.
+</p>
+<h3>Derived from</h3>
+QObject
+<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="#ProjectFile.__init__">ProjectFile</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#ProjectFile.readFile">readFile</a></td>
+<td>Public method to read the project data from a project JSON file.</td>
+</tr>
+<tr>
+<td><a href="#ProjectFile.writeFile">writeFile</a></td>
+<td>Public method to write the project data to a project JSON file.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="ProjectFile.__init__" ID="ProjectFile.__init__"></a>
+<h4>ProjectFile (Constructor)</h4>
+<b>ProjectFile</b>(<i>project: Project, parent: QObject = None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>parent</i> (QObject (optional))</dt>
+<dd>
+reference to the parent object (defaults to None)
+</dd>
+</dl>
+<a NAME="ProjectFile.readFile" ID="ProjectFile.readFile"></a>
+<h4>ProjectFile.readFile</h4>
+<b>readFile</b>(<i>filename: str</i>)
+
+<p>
+        Public method to read the project data from a project JSON file.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the project file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful read
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="ProjectFile.writeFile" ID="ProjectFile.writeFile"></a>
+<h4>ProjectFile.writeFile</h4>
+<b>writeFile</b>(<i>filename: str</i>)
+
+<p>
+        Public method to write the project data to a project JSON file.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the project file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful write
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial