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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.DebuggerPropertiesFile</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.DebuggerPropertiesFile</h1>
10
11 <p>
12 Module implementing a class representing the project debugger properties
13 JSON file.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>Project</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#DebuggerPropertiesFile">DebuggerPropertiesFile</a></td>
26 <td>Class representing the project debugger properties JSON file.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="DebuggerPropertiesFile" ID="DebuggerPropertiesFile"></a>
37 <h2>DebuggerPropertiesFile</h2>
38
39 <p>
40 Class representing the project debugger properties JSON file.
41 </p>
42 <h3>Derived from</h3>
43 QObject
44 <h3>Class Attributes</h3>
45
46 <table>
47 <tr><td>None</td></tr>
48 </table>
49 <h3>Class Methods</h3>
50
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55
56 <table>
57
58 <tr>
59 <td><a href="#DebuggerPropertiesFile.__init__">DebuggerPropertiesFile</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#DebuggerPropertiesFile.readFile">readFile</a></td>
64 <td>Public method to read the project debugger properties data from a project debugger properties JSON file.</td>
65 </tr>
66 <tr>
67 <td><a href="#DebuggerPropertiesFile.writeFile">writeFile</a></td>
68 <td>Public method to write the project debugger properties data to a project debugger properties JSON file.</td>
69 </tr>
70 </table>
71 <h3>Static Methods</h3>
72
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76
77 <a NAME="DebuggerPropertiesFile.__init__" ID="DebuggerPropertiesFile.__init__"></a>
78 <h4>DebuggerPropertiesFile (Constructor)</h4>
79 <b>DebuggerPropertiesFile</b>(<i>project: Project, parent: QObject = None</i>)
80
81 <p>
82 Constructor
83 </p>
84 <dl>
85
86 <dt><i>project</i> (Project)</dt>
87 <dd>
88 reference to the project object
89 </dd>
90 <dt><i>parent</i> (QObject (optional))</dt>
91 <dd>
92 reference to the parent object (defaults to None)
93 </dd>
94 </dl>
95 <a NAME="DebuggerPropertiesFile.readFile" ID="DebuggerPropertiesFile.readFile"></a>
96 <h4>DebuggerPropertiesFile.readFile</h4>
97 <b>readFile</b>(<i>filename: str</i>)
98
99 <p>
100 Public method to read the project debugger properties data from a
101 project debugger properties JSON file.
102 </p>
103 <dl>
104
105 <dt><i>filename</i> (str)</dt>
106 <dd>
107 name of the project file
108 </dd>
109 </dl>
110 <dl>
111 <dt>Return:</dt>
112 <dd>
113 flag indicating a successful read
114 </dd>
115 </dl>
116 <dl>
117 <dt>Return Type:</dt>
118 <dd>
119 bool
120 </dd>
121 </dl>
122 <a NAME="DebuggerPropertiesFile.writeFile" ID="DebuggerPropertiesFile.writeFile"></a>
123 <h4>DebuggerPropertiesFile.writeFile</h4>
124 <b>writeFile</b>(<i>filename: str</i>)
125
126 <p>
127 Public method to write the project debugger properties data to a
128 project debugger properties JSON file.
129 </p>
130 <dl>
131
132 <dt><i>filename</i> (str)</dt>
133 <dd>
134 name of the user project file
135 </dd>
136 </dl>
137 <dl>
138 <dt>Return:</dt>
139 <dd>
140 flag indicating a successful write
141 </dd>
142 </dl>
143 <dl>
144 <dt>Return Type:</dt>
145 <dd>
146 bool
147 </dd>
148 </dl>
149 <div align="right"><a href="#top">Up</a></div>
150 <hr />
151 </body></html>

eric ide

mercurial