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

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.ProjectFile</h1> 9 <h1>eric7.Project.ProjectFile</h1>
10
11 <p> 10 <p>
12 Module implementing a class representing the project JSON file. 11 Module implementing a class representing the project JSON file.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>Project</td></tr> 16 <tr><td>Project</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ProjectFile">ProjectFile</a></td> 22 <td><a href="#ProjectFile">ProjectFile</a></td>
25 <td>Class representing the project JSON file.</td> 23 <td>Class representing the project JSON file.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ProjectFile" ID="ProjectFile"></a> 34 <a NAME="ProjectFile" ID="ProjectFile"></a>
36 <h2>ProjectFile</h2> 35 <h2>ProjectFile</h2>
37
38 <p> 36 <p>
39 Class representing the project JSON file. 37 Class representing the project JSON file.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QObject 41 QObject
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#ProjectFile.__init__">ProjectFile</a></td> 55 <td><a href="#ProjectFile.__init__">ProjectFile</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
65 <tr> 62 <tr>
66 <td><a href="#ProjectFile.writeFile">writeFile</a></td> 63 <td><a href="#ProjectFile.writeFile">writeFile</a></td>
67 <td>Public method to write the project data to a project JSON file.</td> 64 <td>Public method to write the project data to a project JSON file.</td>
68 </tr> 65 </tr>
69 </table> 66 </table>
67
70 <h3>Static Methods</h3> 68 <h3>Static Methods</h3>
71
72 <table> 69 <table>
73 <tr><td>None</td></tr> 70 <tr><td>None</td></tr>
74 </table> 71 </table>
75 72
73
76 <a NAME="ProjectFile.__init__" ID="ProjectFile.__init__"></a> 74 <a NAME="ProjectFile.__init__" ID="ProjectFile.__init__"></a>
77 <h4>ProjectFile (Constructor)</h4> 75 <h4>ProjectFile (Constructor)</h4>
78 <b>ProjectFile</b>(<i>project: Project, parent: QObject = None</i>) 76 <b>ProjectFile</b>(<i>project: Project, parent: QObject = None</i>)
79
80 <p> 77 <p>
81 Constructor 78 Constructor
82 </p> 79 </p>
80
83 <dl> 81 <dl>
84 82
85 <dt><i>project</i> (Project)</dt> 83 <dt><i>project</i> (Project)</dt>
86 <dd> 84 <dd>
87 reference to the project object 85 reference to the project object
92 </dd> 90 </dd>
93 </dl> 91 </dl>
94 <a NAME="ProjectFile.readFile" ID="ProjectFile.readFile"></a> 92 <a NAME="ProjectFile.readFile" ID="ProjectFile.readFile"></a>
95 <h4>ProjectFile.readFile</h4> 93 <h4>ProjectFile.readFile</h4>
96 <b>readFile</b>(<i>filename: str</i>) 94 <b>readFile</b>(<i>filename: str</i>)
97
98 <p> 95 <p>
99 Public method to read the project data from a project JSON file. 96 Public method to read the project data from a project JSON file.
100 </p> 97 </p>
98
101 <dl> 99 <dl>
102 100
103 <dt><i>filename</i> (str)</dt> 101 <dt><i>filename</i> (str)</dt>
104 <dd> 102 <dd>
105 name of the project file 103 name of the project file
118 </dd> 116 </dd>
119 </dl> 117 </dl>
120 <a NAME="ProjectFile.writeFile" ID="ProjectFile.writeFile"></a> 118 <a NAME="ProjectFile.writeFile" ID="ProjectFile.writeFile"></a>
121 <h4>ProjectFile.writeFile</h4> 119 <h4>ProjectFile.writeFile</h4>
122 <b>writeFile</b>(<i>filename: str</i>) 120 <b>writeFile</b>(<i>filename: str</i>)
123
124 <p> 121 <p>
125 Public method to write the project data to a project JSON file. 122 Public method to write the project data to a project JSON file.
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>filename</i> (str)</dt> 127 <dt><i>filename</i> (str)</dt>
130 <dd> 128 <dd>
131 name of the project file 129 name of the project file

eric ide

mercurial