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

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

eric ide

mercurial