Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Project.Project.html

Documentation/Source/eric6.Project.Project.html

changeset 6260
581b0ed6ac47
parent 5972
8499df251632
child 6265
56bd09c4c297
equal deleted inserted replaced
6259:abbe684782af 6260:581b0ed6ac47
43 <h2>Project</h2> 43 <h2>Project</h2>
44 <p> 44 <p>
45 Class implementing the project management functionality. 45 Class implementing the project management functionality.
46 </p><h3>Signals</h3> 46 </p><h3>Signals</h3>
47 <dl> 47 <dl>
48 <dt>completeRepopulateItem(str)</dt> 48 <dt>appendStderr(str)</dt>
49 <dd>
50 emitted after something was received from
51 a QProcess on stderr
52 </dd><dt>appendStdout(str)</dt>
53 <dd>
54 emitted after something was received from
55 a QProcess on stdout
56 </dd><dt>completeRepopulateItem(str)</dt>
49 <dd> 57 <dd>
50 emitted after an item of the model was 58 emitted after an item of the model was
51 repopulated 59 repopulated
52 </dd><dt>designerFile(str)</dt> 60 </dd><dt>designerFile(str)</dt>
53 <dd> 61 <dd>
177 </dl> 185 </dl>
178 <h3>Derived from</h3> 186 <h3>Derived from</h3>
179 QObject 187 QObject
180 <h3>Class Attributes</h3> 188 <h3>Class Attributes</h3>
181 <table> 189 <table>
182 <tr><td>eols</td></tr> 190 <tr><td>DefaultMake</td></tr><tr><td>DefaultMakefile</td></tr><tr><td>eols</td></tr>
183 </table> 191 </table>
184 <h3>Class Methods</h3> 192 <h3>Class Methods</h3>
185 <table> 193 <table>
186 <tr><td>None</td></tr> 194 <tr><td>None</td></tr>
187 </table> 195 </table>
204 <td>Private method to check, if the files in a list exist.</td> 212 <td>Private method to check, if the files in a list exist.</td>
205 </tr><tr> 213 </tr><tr>
206 <td><a href="#Project.__checkProjectFileGroup">__checkProjectFileGroup</a></td> 214 <td><a href="#Project.__checkProjectFileGroup">__checkProjectFileGroup</a></td>
207 <td>Private method to check, if a file is in a specific file group of the project.</td> 215 <td>Private method to check, if a file is in a specific file group of the project.</td>
208 </tr><tr> 216 </tr><tr>
217 <td><a href="#Project.__cleanupMake">__cleanupMake</a></td>
218 <td>Private method to clean up make related stuff.</td>
219 </tr><tr>
209 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td> 220 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td>
210 <td>Private method to close all project related windows.</td> 221 <td>Private method to close all project related windows.</td>
211 </tr><tr> 222 </tr><tr>
212 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td> 223 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td>
213 <td>Private method to create a snapshot plugin version.</td> 224 <td>Private method to create a snapshot plugin version.</td>
222 <td>Private method to delete the session file.</td> 233 <td>Private method to delete the session file.</td>
223 </tr><tr> 234 </tr><tr>
224 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td> 235 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td>
225 <td>Private method to search for new files in the project directory.</td> 236 <td>Private method to search for new files in the project directory.</td>
226 </tr><tr> 237 </tr><tr>
238 <td><a href="#Project.__executeMake">__executeMake</a></td>
239 <td>Private method to execute a project specific make run.</td>
240 </tr><tr>
227 <td><a href="#Project.__initData">__initData</a></td> 241 <td><a href="#Project.__initData">__initData</a></td>
228 <td>Private method to initialize the project data part.</td> 242 <td>Private method to initialize the project data part.</td>
229 </tr><tr> 243 </tr><tr>
230 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td> 244 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td>
231 <td>Private method to initialize the debug properties.</td> 245 <td>Private method to initialize the debug properties.</td>
237 <td>Private slot to load a diagram from file.</td> 251 <td>Private slot to load a diagram from file.</td>
238 </tr><tr> 252 </tr><tr>
239 <td><a href="#Project.__loadRecent">__loadRecent</a></td> 253 <td><a href="#Project.__loadRecent">__loadRecent</a></td>
240 <td>Private method to load the recently opened project filenames.</td> 254 <td>Private method to load the recently opened project filenames.</td>
241 </tr><tr> 255 </tr><tr>
256 <td><a href="#Project.__makeFinished">__makeFinished</a></td>
257 <td>Private slot handling the make process finished signal.</td>
258 </tr><tr>
259 <td><a href="#Project.__makeReadStdErr">__makeReadStdErr</a></td>
260 <td>Private slot to process process output received via stderr.</td>
261 </tr><tr>
262 <td><a href="#Project.__makeReadStdOut">__makeReadStdOut</a></td>
263 <td>Private slot to process process output received via stdout.</td>
264 </tr><tr>
242 <td><a href="#Project.__openRecent">__openRecent</a></td> 265 <td><a href="#Project.__openRecent">__openRecent</a></td>
243 <td>Private method to open a project from the list of rencently opened projects.</td> 266 <td>Private method to open a project from the list of rencently opened projects.</td>
244 </tr><tr> 267 </tr><tr>
245 <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td> 268 <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td>
246 <td>Private slot to create eric6 plugin archives.</td> 269 <td>Private slot to create eric6 plugin archives.</td>
300 <td>Private slot called before the Debugger menu is shown.</td> 323 <td>Private slot called before the Debugger menu is shown.</td>
301 </tr><tr> 324 </tr><tr>
302 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td> 325 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
303 <td>Private slot called before the graphics menu is shown.</td> 326 <td>Private slot called before the graphics menu is shown.</td>
304 </tr><tr> 327 </tr><tr>
328 <td><a href="#Project.__showContextMenuMake">__showContextMenuMake</a></td>
329 <td>Private slot called before the make menu is shown.</td>
330 </tr><tr>
305 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td> 331 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td>
306 <td>Private slot called before the packagers menu is shown.</td> 332 <td>Private slot called before the packagers menu is shown.</td>
307 </tr><tr> 333 </tr><tr>
308 <td><a href="#Project.__showContextMenuRecent">__showContextMenuRecent</a></td> 334 <td><a href="#Project.__showContextMenuRecent">__showContextMenuRecent</a></td>
309 <td>Private method to set up the recent projects menu.</td> 335 <td>Private method to set up the recent projects menu.</td>
456 <td>Public slot to delete a file from the project directory.</td> 482 <td>Public slot to delete a file from the project directory.</td>
457 </tr><tr> 483 </tr><tr>
458 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td> 484 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td>
459 <td>Public slot to delete a translation from the project directory.</td> 485 <td>Public slot to delete a translation from the project directory.</td>
460 </tr><tr> 486 </tr><tr>
487 <td><a href="#Project.executeMake">executeMake</a></td>
488 <td>Public slot to execute a project specific make run (auto-run) (execute or question).</td>
489 </tr><tr>
461 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td> 490 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td>
462 <td>Public method to convert a project relative file path to an absolute file path.</td> 491 <td>Public method to convert a project relative file path to an absolute file path.</td>
463 </tr><tr> 492 </tr><tr>
464 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td> 493 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td>
465 <td>Public method to convert a project relative file path with universal separators to an absolute file path.</td> 494 <td>Public method to convert a project relative file path with universal separators to an absolute file path.</td>
573 <td>Public method to handle the application diagram context menu action.</td> 602 <td>Public method to handle the application diagram context menu action.</td>
574 </tr><tr> 603 </tr><tr>
575 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td> 604 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td>
576 <td>Public slot used to handle the preferencesChanged signal.</td> 605 <td>Public slot used to handle the preferencesChanged signal.</td>
577 </tr><tr> 606 </tr><tr>
607 <td><a href="#Project.hasDefaultMakeParameters">hasDefaultMakeParameters</a></td>
608 <td>Private method to test, if the project contains the default make parameters.</td>
609 </tr><tr>
578 <td><a href="#Project.hasEntry">hasEntry</a></td> 610 <td><a href="#Project.hasEntry">hasEntry</a></td>
579 <td>Public method to check the project for a file.</td> 611 <td>Public method to check the project for a file.</td>
580 </tr><tr> 612 </tr><tr>
581 <td><a href="#Project.hasProjectType">hasProjectType</a></td> 613 <td><a href="#Project.hasProjectType">hasProjectType</a></td>
582 <td>Public method to check, if a project type is already registered.</td> 614 <td>Public method to check, if a project type is already registered.</td>
602 <td><a href="#Project.isDirty">isDirty</a></td> 634 <td><a href="#Project.isDirty">isDirty</a></td>
603 <td>Public method to return the dirty state.</td> 635 <td>Public method to return the dirty state.</td>
604 </tr><tr> 636 </tr><tr>
605 <td><a href="#Project.isJavaScriptProject">isJavaScriptProject</a></td> 637 <td><a href="#Project.isJavaScriptProject">isJavaScriptProject</a></td>
606 <td>Public method to check, if this project is a JavaScript project.</td> 638 <td>Public method to check, if this project is a JavaScript project.</td>
639 </tr><tr>
640 <td><a href="#Project.isMakeEnabled">isMakeEnabled</a></td>
641 <td>Public method to test, if make is enabled for the project.</td>
607 </tr><tr> 642 </tr><tr>
608 <td><a href="#Project.isMixedLanguageProject">isMixedLanguageProject</a></td> 643 <td><a href="#Project.isMixedLanguageProject">isMixedLanguageProject</a></td>
609 <td>Public method to check, if this is a mixed language project.</td> 644 <td>Public method to check, if this is a mixed language project.</td>
610 </tr><tr> 645 </tr><tr>
611 <td><a href="#Project.isOpen">isOpen</a></td> 646 <td><a href="#Project.isOpen">isOpen</a></td>
838 </dl><dl> 873 </dl><dl>
839 <dt>Returns:</dt> 874 <dt>Returns:</dt>
840 <dd> 875 <dd>
841 flag indicating membership (boolean) 876 flag indicating membership (boolean)
842 </dd> 877 </dd>
843 </dl><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a> 878 </dl><a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a>
879 <h4>Project.__cleanupMake</h4>
880 <b>__cleanupMake</b>(<i></i>)
881 <p>
882 Private method to clean up make related stuff.
883 </p><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a>
844 <h4>Project.__closeAllWindows</h4> 884 <h4>Project.__closeAllWindows</h4>
845 <b>__closeAllWindows</b>(<i></i>) 885 <b>__closeAllWindows</b>(<i></i>)
846 <p> 886 <p>
847 Private method to close all project related windows. 887 Private method to close all project related windows.
848 </p><a NAME="Project.__createSnapshotSource" ID="Project.__createSnapshotSource"></a> 888 </p><a NAME="Project.__createSnapshotSource" ID="Project.__createSnapshotSource"></a>
905 </dd><dt><i>onUserDemand</i></dt> 945 </dd><dt><i>onUserDemand</i></dt>
906 <dd> 946 <dd>
907 flag indicating whether this method was 947 flag indicating whether this method was
908 requested by the user via a menu action (boolean) 948 requested by the user via a menu action (boolean)
909 </dd> 949 </dd>
950 </dl><a NAME="Project.__executeMake" ID="Project.__executeMake"></a>
951 <h4>Project.__executeMake</h4>
952 <b>__executeMake</b>(<i>questionOnly=False, interactive=True</i>)
953 <p>
954 Private method to execute a project specific make run.
955 </p><dl>
956 <dt><i>questionOnly</i> (bool)</dt>
957 <dd>
958 flag indicating to ask make for changes only
959 </dd><dt><i>interactive</i> (bool)</dt>
960 <dd>
961 flag indicating an interactive invocation (i.e.
962 through a menu action)
963 </dd>
910 </dl><a NAME="Project.__initData" ID="Project.__initData"></a> 964 </dl><a NAME="Project.__initData" ID="Project.__initData"></a>
911 <h4>Project.__initData</h4> 965 <h4>Project.__initData</h4>
912 <b>__initData</b>(<i></i>) 966 <b>__initData</b>(<i></i>)
913 <p> 967 <p>
914 Private method to initialize the project data part. 968 Private method to initialize the project data part.
930 </p><a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a> 984 </p><a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a>
931 <h4>Project.__loadRecent</h4> 985 <h4>Project.__loadRecent</h4>
932 <b>__loadRecent</b>(<i></i>) 986 <b>__loadRecent</b>(<i></i>)
933 <p> 987 <p>
934 Private method to load the recently opened project filenames. 988 Private method to load the recently opened project filenames.
989 </p><a NAME="Project.__makeFinished" ID="Project.__makeFinished"></a>
990 <h4>Project.__makeFinished</h4>
991 <b>__makeFinished</b>(<i>exitCode, exitStatus, questionOnly, interactive=True</i>)
992 <p>
993 Private slot handling the make process finished signal.
994 </p><dl>
995 <dt><i>exitCode</i> (int)</dt>
996 <dd>
997 exit code of the make process
998 </dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
999 <dd>
1000 exit status of the make process
1001 </dd><dt><i>questionOnly</i> (bool)</dt>
1002 <dd>
1003 flag indicating a test only run
1004 </dd><dt><i>interactive</i> (bool)</dt>
1005 <dd>
1006 flag indicating an interactive invocation (i.e.
1007 through a menu action)
1008 </dd>
1009 </dl><a NAME="Project.__makeReadStdErr" ID="Project.__makeReadStdErr"></a>
1010 <h4>Project.__makeReadStdErr</h4>
1011 <b>__makeReadStdErr</b>(<i></i>)
1012 <p>
1013 Private slot to process process output received via stderr.
1014 </p><a NAME="Project.__makeReadStdOut" ID="Project.__makeReadStdOut"></a>
1015 <h4>Project.__makeReadStdOut</h4>
1016 <b>__makeReadStdOut</b>(<i></i>)
1017 <p>
1018 Private slot to process process output received via stdout.
935 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a> 1019 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a>
936 <h4>Project.__openRecent</h4> 1020 <h4>Project.__openRecent</h4>
937 <b>__openRecent</b>(<i>act</i>) 1021 <b>__openRecent</b>(<i>act</i>)
938 <p> 1022 <p>
939 Private method to open a project from the list of rencently opened 1023 Private method to open a project from the list of rencently opened
1098 </p><a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a> 1182 </p><a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a>
1099 <h4>Project.__showContextMenuGraphics</h4> 1183 <h4>Project.__showContextMenuGraphics</h4>
1100 <b>__showContextMenuGraphics</b>(<i></i>) 1184 <b>__showContextMenuGraphics</b>(<i></i>)
1101 <p> 1185 <p>
1102 Private slot called before the graphics menu is shown. 1186 Private slot called before the graphics menu is shown.
1187 </p><a NAME="Project.__showContextMenuMake" ID="Project.__showContextMenuMake"></a>
1188 <h4>Project.__showContextMenuMake</h4>
1189 <b>__showContextMenuMake</b>(<i></i>)
1190 <p>
1191 Private slot called before the make menu is shown.
1103 </p><a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a> 1192 </p><a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a>
1104 <h4>Project.__showContextMenuPackagers</h4> 1193 <h4>Project.__showContextMenuPackagers</h4>
1105 <b>__showContextMenuPackagers</b>(<i></i>) 1194 <b>__showContextMenuPackagers</b>(<i></i>)
1106 <p> 1195 <p>
1107 Private slot called before the packagers menu is shown. 1196 Private slot called before the packagers menu is shown.
1524 </p><dl> 1613 </p><dl>
1525 <dt><i>langFile</i></dt> 1614 <dt><i>langFile</i></dt>
1526 <dd> 1615 <dd>
1527 the translation file to be removed (string) 1616 the translation file to be removed (string)
1528 </dd> 1617 </dd>
1529 </dl><a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a> 1618 </dl><a NAME="Project.executeMake" ID="Project.executeMake"></a>
1619 <h4>Project.executeMake</h4>
1620 <b>executeMake</b>(<i></i>)
1621 <p>
1622 Public slot to execute a project specific make run (auto-run)
1623 (execute or question).
1624 </p><a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
1530 <h4>Project.getAbsolutePath</h4> 1625 <h4>Project.getAbsolutePath</h4>
1531 <b>getAbsolutePath</b>(<i>fn</i>) 1626 <b>getAbsolutePath</b>(<i>fn</i>)
1532 <p> 1627 <p>
1533 Public method to convert a project relative file path to an absolute 1628 Public method to convert a project relative file path to an absolute
1534 file path. 1629 file path.
2032 </p><a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a> 2127 </p><a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a>
2033 <h4>Project.handlePreferencesChanged</h4> 2128 <h4>Project.handlePreferencesChanged</h4>
2034 <b>handlePreferencesChanged</b>(<i></i>) 2129 <b>handlePreferencesChanged</b>(<i></i>)
2035 <p> 2130 <p>
2036 Public slot used to handle the preferencesChanged signal. 2131 Public slot used to handle the preferencesChanged signal.
2037 </p><a NAME="Project.hasEntry" ID="Project.hasEntry"></a> 2132 </p><a NAME="Project.hasDefaultMakeParameters" ID="Project.hasDefaultMakeParameters"></a>
2133 <h4>Project.hasDefaultMakeParameters</h4>
2134 <b>hasDefaultMakeParameters</b>(<i></i>)
2135 <p>
2136 Private method to test, if the project contains the default make
2137 parameters.
2138 </p><dl>
2139 <dt>Returns:</dt>
2140 <dd>
2141 flag indicating default parameter set
2142 </dd>
2143 </dl><dl>
2144 <dt>Return Type:</dt>
2145 <dd>
2146 bool
2147 </dd>
2148 </dl><a NAME="Project.hasEntry" ID="Project.hasEntry"></a>
2038 <h4>Project.hasEntry</h4> 2149 <h4>Project.hasEntry</h4>
2039 <b>hasEntry</b>(<i>fn</i>) 2150 <b>hasEntry</b>(<i>fn</i>)
2040 <p> 2151 <p>
2041 Public method to check the project for a file. 2152 Public method to check the project for a file.
2042 </p><dl> 2153 </p><dl>
2152 </p><dl> 2263 </p><dl>
2153 <dt>Returns:</dt> 2264 <dt>Returns:</dt>
2154 <dd> 2265 <dd>
2155 flag indicating a JavaScript project (boolean) 2266 flag indicating a JavaScript project (boolean)
2156 </dd> 2267 </dd>
2268 </dl><a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a>
2269 <h4>Project.isMakeEnabled</h4>
2270 <b>isMakeEnabled</b>(<i></i>)
2271 <p>
2272 Public method to test, if make is enabled for the project.
2273 </p><dl>
2274 <dt>Returns:</dt>
2275 <dd>
2276 flag indicating enabled make support
2277 </dd>
2278 </dl><dl>
2279 <dt>Return Type:</dt>
2280 <dd>
2281 bool
2282 </dd>
2157 </dl><a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a> 2283 </dl><a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a>
2158 <h4>Project.isMixedLanguageProject</h4> 2284 <h4>Project.isMixedLanguageProject</h4>
2159 <b>isMixedLanguageProject</b>(<i></i>) 2285 <b>isMixedLanguageProject</b>(<i></i>)
2160 <p> 2286 <p>
2161 Public method to check, if this is a mixed language project. 2287 Public method to check, if this is a mixed language project.

Mercurial Repository: eric

eric ide

mercurial