Documentation/Source/eric5.Project.Project.html

changeset 615
c8dd16cc69ce
parent 603
7f620c649182
child 765
e5cbb3f273eb
equal deleted inserted replaced
614:c873699a1181 615:c8dd16cc69ce
210 </tr><tr> 210 </tr><tr>
211 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td> 211 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td>
212 <td>Private method to read in the project debugger properties file (.e4d)</td> 212 <td>Private method to read in the project debugger properties file (.e4d)</td>
213 </tr><tr> 213 </tr><tr>
214 <td><a href="#Project.__readProject">__readProject</a></td> 214 <td><a href="#Project.__readProject">__readProject</a></td>
215 <td>Private method to read in a project (.e4p, .e4pz) file.</td> 215 <td>Private method to read in a project (.e4p) file.</td>
216 </tr><tr> 216 </tr><tr>
217 <td><a href="#Project.__readSession">__readSession</a></td> 217 <td><a href="#Project.__readSession">__readSession</a></td>
218 <td>Private method to read in the project session file (.e4s)</td> 218 <td>Private method to read in the project session file (.e4s)</td>
219 </tr><tr> 219 </tr><tr>
220 <td><a href="#Project.__readTasks">__readTasks</a></td> 220 <td><a href="#Project.__readTasks">__readTasks</a></td>
221 <td>Private method to read in the project tasks file (.e4t)</td> 221 <td>Private method to read in the project tasks file (.e4t)</td>
222 </tr><tr> 222 </tr><tr>
223 <td><a href="#Project.__readUserProperties">__readUserProperties</a></td> 223 <td><a href="#Project.__readUserProperties">__readUserProperties</a></td>
224 <td>Private method to read in the user specific project file (.e4q)</td> 224 <td>Private method to read in the user specific project file (.e4q)</td>
225 </tr><tr> 225 </tr><tr>
226 <td><a href="#Project.__readXMLDebugProperties">__readXMLDebugProperties</a></td>
227 <td>Public method to read the debugger properties from an XML file.</td>
228 </tr><tr>
229 <td><a href="#Project.__readXMLProject">__readXMLProject</a></td>
230 <td>Private method to read the project data from an XML file.</td>
231 </tr><tr>
232 <td><a href="#Project.__saveRecent">__saveRecent</a></td> 226 <td><a href="#Project.__saveRecent">__saveRecent</a></td>
233 <td>Private method to save the list of recently opened filenames.</td> 227 <td>Private method to save the list of recently opened filenames.</td>
234 </tr><tr> 228 </tr><tr>
235 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td> 229 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td>
236 <td>Private slot used to handle the search new files action.</td> 230 <td>Private slot used to handle the search new files action.</td>
300 </tr><tr> 294 </tr><tr>
301 <td><a href="#Project.__writeTasks">__writeTasks</a></td> 295 <td><a href="#Project.__writeTasks">__writeTasks</a></td>
302 <td>Private method to write the tasks data to an XML file (.e4t).</td> 296 <td>Private method to write the tasks data to an XML file (.e4t).</td>
303 </tr><tr> 297 </tr><tr>
304 <td><a href="#Project.__writeUserProperties">__writeUserProperties</a></td> 298 <td><a href="#Project.__writeUserProperties">__writeUserProperties</a></td>
305 <td>Private method to write the project data to an XML file.</td>
306 </tr><tr>
307 <td><a href="#Project.__writeXMLProject">__writeXMLProject</a></td>
308 <td>Private method to write the project data to an XML file.</td> 299 <td>Private method to write the project data to an XML file.</td>
309 </tr><tr> 300 </tr><tr>
310 <td><a href="#Project.addDirectory">addDirectory</a></td> 301 <td><a href="#Project.addDirectory">addDirectory</a></td>
311 <td>Public method used to add all files of a directory to the project.</td> 302 <td>Public method used to add all files of a directory to the project.</td>
312 </tr><tr> 303 </tr><tr>
833 </dd> 824 </dd>
834 </dl><a NAME="Project.__readProject" ID="Project.__readProject"></a> 825 </dl><a NAME="Project.__readProject" ID="Project.__readProject"></a>
835 <h4>Project.__readProject</h4> 826 <h4>Project.__readProject</h4>
836 <b>__readProject</b>(<i>fn</i>) 827 <b>__readProject</b>(<i>fn</i>)
837 <p> 828 <p>
838 Private method to read in a project (.e4p, .e4pz) file. 829 Private method to read in a project (.e4p) file.
839 </p><dl> 830 </p><dl>
840 <dt><i>fn</i></dt> 831 <dt><i>fn</i></dt>
841 <dd> 832 <dd>
842 filename of the project file to be read (string) 833 filename of the project file to be read (string)
843 </dd> 834 </dd>
868 </p><a NAME="Project.__readUserProperties" ID="Project.__readUserProperties"></a> 859 </p><a NAME="Project.__readUserProperties" ID="Project.__readUserProperties"></a>
869 <h4>Project.__readUserProperties</h4> 860 <h4>Project.__readUserProperties</h4>
870 <b>__readUserProperties</b>(<i></i>) 861 <b>__readUserProperties</b>(<i></i>)
871 <p> 862 <p>
872 Private method to read in the user specific project file (.e4q) 863 Private method to read in the user specific project file (.e4q)
873 </p><a NAME="Project.__readXMLDebugProperties" ID="Project.__readXMLDebugProperties"></a> 864 </p><a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
874 <h4>Project.__readXMLDebugProperties</h4>
875 <b>__readXMLDebugProperties</b>(<i>fn, validating, quiet</i>)
876 <p>
877 Public method to read the debugger properties from an XML file.
878 </p><dl>
879 <dt><i>fn</i></dt>
880 <dd>
881 filename of the project debugger properties file to be read
882 (string)
883 </dd><dt><i>validating</i></dt>
884 <dd>
885 flag indicating a validation of the XML file is
886 requested (boolean)
887 </dd><dt><i>quiet</i></dt>
888 <dd>
889 flag indicating quiet operations.
890 If this flag is true, no errors are reported.
891 </dd>
892 </dl><a NAME="Project.__readXMLProject" ID="Project.__readXMLProject"></a>
893 <h4>Project.__readXMLProject</h4>
894 <b>__readXMLProject</b>(<i>fn, validating</i>)
895 <p>
896 Private method to read the project data from an XML file.
897 </p><dl>
898 <dt><i>fn</i></dt>
899 <dd>
900 filename of the project file to be read (string)
901 </dd><dt><i>validating</i></dt>
902 <dd>
903 flag indicating a validation of the XML file is
904 requested (boolean)
905 </dd>
906 </dl><dl>
907 <dt>Returns:</dt>
908 <dd>
909 flag indicating success (boolean)
910 </dd>
911 </dl><a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
912 <h4>Project.__saveRecent</h4> 865 <h4>Project.__saveRecent</h4>
913 <b>__saveRecent</b>(<i></i>) 866 <b>__saveRecent</b>(<i></i>)
914 <p> 867 <p>
915 Private method to save the list of recently opened filenames. 868 Private method to save the list of recently opened filenames.
916 </p><a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a> 869 </p><a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a>
1019 <p> 972 <p>
1020 Private method to synchronize the list of recently opened projects 973 Private method to synchronize the list of recently opened projects
1021 with the central store. 974 with the central store.
1022 </p><a NAME="Project.__writeDebugProperties" ID="Project.__writeDebugProperties"></a> 975 </p><a NAME="Project.__writeDebugProperties" ID="Project.__writeDebugProperties"></a>
1023 <h4>Project.__writeDebugProperties</h4> 976 <h4>Project.__writeDebugProperties</h4>
1024 <b>__writeDebugProperties</b>(<i>quiet=0</i>) 977 <b>__writeDebugProperties</b>(<i>quiet = False</i>)
1025 <p> 978 <p>
1026 Private method to write the project debugger properties file (.e4d) 979 Private method to write the project debugger properties file (.e4d)
1027 </p><dl> 980 </p><dl>
1028 <dt><i>quiet</i></dt> 981 <dt><i>quiet</i></dt>
1029 <dd> 982 <dd>
1071 </p><a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a> 1024 </p><a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a>
1072 <h4>Project.__writeUserProperties</h4> 1025 <h4>Project.__writeUserProperties</h4>
1073 <b>__writeUserProperties</b>(<i></i>) 1026 <b>__writeUserProperties</b>(<i></i>)
1074 <p> 1027 <p>
1075 Private method to write the project data to an XML file. 1028 Private method to write the project data to an XML file.
1076 </p><a NAME="Project.__writeXMLProject" ID="Project.__writeXMLProject"></a> 1029 </p><a NAME="Project.addDirectory" ID="Project.addDirectory"></a>
1077 <h4>Project.__writeXMLProject</h4>
1078 <b>__writeXMLProject</b>(<i>fn = None</i>)
1079 <p>
1080 Private method to write the project data to an XML file.
1081 </p><dl>
1082 <dt><i>fn</i></dt>
1083 <dd>
1084 the filename of the project file (string)
1085 </dd>
1086 </dl><dl>
1087 <dt>Returns:</dt>
1088 <dd>
1089 flag indicating success (boolean)
1090 </dd>
1091 </dl><a NAME="Project.addDirectory" ID="Project.addDirectory"></a>
1092 <h4>Project.addDirectory</h4> 1030 <h4>Project.addDirectory</h4>
1093 <b>addDirectory</b>(<i>filter = None, startdir = None</i>) 1031 <b>addDirectory</b>(<i>filter = None, startdir = None</i>)
1094 <p> 1032 <p>
1095 Public method used to add all files of a directory to the project. 1033 Public method used to add all files of a directory to the project.
1096 </p><dl> 1034 </p><dl>

eric ide

mercurial