Documentation/Source/eric5.Project.Project.html

changeset 501
5c615a85241a
parent 440
69ace3e2dcf6
child 603
7f620c649182
equal deleted inserted replaced
500:c3abc7895a01 501:5c615a85241a
44 <h2>Project</h2> 44 <h2>Project</h2>
45 <p> 45 <p>
46 Class implementing the project management functionality. 46 Class implementing the project management functionality.
47 </p><h4>Signals</h4> 47 </p><h4>Signals</h4>
48 <dl> 48 <dl>
49 <dt>completeRepopulateItem(string)</dt> 49 <dt>completeRepopulateItem(str)</dt>
50 <dd> 50 <dd>
51 emitted after an item of the model was 51 emitted after an item of the model was
52 repopulated 52 repopulated
53 </dd><dt>directoryRemoved(string)</dt> 53 </dd><dt>directoryRemoved(str)</dt>
54 <dd> 54 <dd>
55 emitted after a directory has been removed from 55 emitted after a directory has been removed from
56 the project 56 the project
57 </dd><dt>dirty(int)</dt> 57 </dd><dt>dirty(int)</dt>
58 <dd> 58 <dd>
66 emitted after a new project was generated 66 emitted after a new project was generated
67 </dd><dt>newProjectHooks()</dt> 67 </dd><dt>newProjectHooks()</dt>
68 <dd> 68 <dd>
69 emitted after a new project was generated but before 69 emitted after a new project was generated but before
70 the newProject() signal is sent 70 the newProject() signal is sent
71 </dd><dt>prepareRepopulateItem(string)</dt> 71 </dd><dt>prepareRepopulateItem(str)</dt>
72 <dd> 72 <dd>
73 emitted before an item of the model is 73 emitted before an item of the model is
74 repopulated 74 repopulated
75 </dd><dt>projectAboutToBeCreated()</dt> 75 </dd><dt>projectAboutToBeCreated()</dt>
76 <dd> 76 <dd>
80 emitted after a project was closed 80 emitted after a project was closed
81 </dd><dt>projectClosedHooks()</dt> 81 </dd><dt>projectClosedHooks()</dt>
82 <dd> 82 <dd>
83 emitted after a project file was closed but before the 83 emitted after a project file was closed but before the
84 projectClosed() signal is sent 84 projectClosed() signal is sent
85 </dd><dt>projectFileRenamed(string, string)</dt> 85 </dd><dt>projectFileRenamed(str, str)</dt>
86 <dd> 86 <dd>
87 emitted after a file of the project 87 emitted after a file of the project
88 has been renamed 88 has been renamed
89 </dd><dt>projectFormAdded(string)</dt> 89 </dd><dt>projectFormAdded(str)</dt>
90 <dd> 90 <dd>
91 emitted after a new form was added 91 emitted after a new form was added
92 </dd><dt>projectInterfaceAdded(string)</dt> 92 </dd><dt>projectInterfaceAdded(str)</dt>
93 <dd> 93 <dd>
94 emitted after a new IDL file was added 94 emitted after a new IDL file was added
95 </dd><dt>projectLanguageAdded(string)</dt> 95 </dd><dt>projectLanguageAdded(str)</dt>
96 <dd> 96 <dd>
97 emitted after a new language was added 97 emitted after a new language was added
98 </dd><dt>projectLanguageAddedByCode(string)</dt> 98 </dd><dt>projectLanguageAddedByCode(str)</dt>
99 <dd> 99 <dd>
100 emitted after a new language was added. 100 emitted after a new language was added.
101 The language code is sent by this signal. 101 The language code is sent by this signal.
102 </dd><dt>projectOpened()</dt> 102 </dd><dt>projectOpened()</dt>
103 <dd> 103 <dd>
104 emitted after a project file was read 104 emitted after a project file was read
105 </dd><dt>projectOpenedHooks()</dt> 105 </dd><dt>projectOpenedHooks()</dt>
106 <dd> 106 <dd>
107 emitted after a project file was read but before the 107 emitted after a project file was read but before the
108 projectOpened() signal is sent 108 projectOpened() signal is sent
109 </dd><dt>projectOthersAdded(string)</dt> 109 </dd><dt>projectOthersAdded(str)</dt>
110 <dd> 110 <dd>
111 emitted after a file or directory was added 111 emitted after a file or directory was added
112 to the OTHERS project data area 112 to the OTHERS project data area
113 </dd><dt>projectPropertiesChanged()</dt> 113 </dd><dt>projectPropertiesChanged()</dt>
114 <dd> 114 <dd>
115 emitted after the project properties were changed 115 emitted after the project properties were changed
116 </dd><dt>projectResourceAdded(string)</dt> 116 </dd><dt>projectResourceAdded(str)</dt>
117 <dd> 117 <dd>
118 emitted after a new resource file was added 118 emitted after a new resource file was added
119 </dd><dt>projectSessionLoaded()</dt> 119 </dd><dt>projectSourceAdded(str)</dt>
120 <dd>
121 emitted after a project session file was loaded
122 </dd><dt>projectSourceAdded(string)</dt>
123 <dd> 120 <dd>
124 emitted after a new source file was added 121 emitted after a new source file was added
125 </dd><dt>reinitVCS()</dt> 122 </dd><dt>reinitVCS()</dt>
126 <dd> 123 <dd>
127 emitted after the VCS has been reinitialized 124 emitted after the VCS has been reinitialized
128 </dd><dt>showMenu(string, QMenu)</dt> 125 </dd><dt>showMenu(str, QMenu)</dt>
129 <dd> 126 <dd>
130 emitted when a menu is about to be shown. The name 127 emitted when a menu is about to be shown. The name
131 of the menu and a reference to the menu are given. 128 of the menu and a reference to the menu are given.
132 </dd><dt>sourceFile(string)</dt> 129 </dd><dt>sourceFile(str)</dt>
133 <dd> 130 <dd>
134 emitted after a project file was read to 131 emitted after a project file was read to
135 open the main script 132 open the main script
136 </dd><dt>vcsStatusMonitorStatus(QString, QString)</dt> 133 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
137 <dd> 134 <dd>
138 emitted to signal the status of the 135 emitted to signal the status of the
139 monitoring thread (ok, nok, op, off) and a status message 136 monitoring thread (ok, nok, op, off) and a status message
140 </dd> 137 </dd>
141 </dl> 138 </dl>
142 <h3>Derived from</h3> 139 <h3>Derived from</h3>
143 QObject 140 QObject
144 <h3>Class Attributes</h3> 141 <h3>Class Attributes</h3>
145 <table> 142 <table>
146 <tr><td>dbgKeynames</td></tr><tr><td>eols</td></tr><tr><td>keynames</td></tr><tr><td>userKeynames</td></tr> 143 <tr><td>completeRepopulateItem</td></tr><tr><td>dbgKeynames</td></tr><tr><td>directoryRemoved</td></tr><tr><td>dirty</td></tr><tr><td>eols</td></tr><tr><td>keynames</td></tr><tr><td>lexerAssociationsChanged</td></tr><tr><td>newProject</td></tr><tr><td>newProjectHooks</td></tr><tr><td>prepareRepopulateItem</td></tr><tr><td>projectAboutToBeCreated</td></tr><tr><td>projectClosed</td></tr><tr><td>projectClosedHooks</td></tr><tr><td>projectFileRenamed</td></tr><tr><td>projectFormAdded</td></tr><tr><td>projectInterfaceAdded</td></tr><tr><td>projectLanguageAdded</td></tr><tr><td>projectLanguageAddedByCode</td></tr><tr><td>projectOpened</td></tr><tr><td>projectOpenedHooks</td></tr><tr><td>projectOthersAdded</td></tr><tr><td>projectPropertiesChanged</td></tr><tr><td>projectResourceAdded</td></tr><tr><td>projectSourceAdded</td></tr><tr><td>reinitVCS</td></tr><tr><td>showMenu</td></tr><tr><td>sourceFile</td></tr><tr><td>userKeynames</td></tr><tr><td>vcsStatusMonitorStatus</td></tr>
147 </table> 144 </table>
148 <h3>Methods</h3> 145 <h3>Methods</h3>
149 <table> 146 <table>
150 <tr> 147 <tr>
151 <td><a href="#Project.__init__">Project</a></td> 148 <td><a href="#Project.__init__">Project</a></td>
380 <td>Public slot to close the current project.</td> 377 <td>Public slot to close the current project.</td>
381 </tr><tr> 378 </tr><tr>
382 <td><a href="#Project.copyDirectory">copyDirectory</a></td> 379 <td><a href="#Project.copyDirectory">copyDirectory</a></td>
383 <td>Public slot to copy a directory.</td> 380 <td>Public slot to copy a directory.</td>
384 </tr><tr> 381 </tr><tr>
382 <td><a href="#Project.createNewProject">createNewProject</a></td>
383 <td>Public slot to built a new project.</td>
384 </tr><tr>
385 <td><a href="#Project.deleteDirectory">deleteDirectory</a></td> 385 <td><a href="#Project.deleteDirectory">deleteDirectory</a></td>
386 <td>Public slot to delete a directory from the project directory.</td> 386 <td>Public slot to delete a directory from the project directory.</td>
387 </tr><tr> 387 </tr><tr>
388 <td><a href="#Project.deleteFile">deleteFile</a></td> 388 <td><a href="#Project.deleteFile">deleteFile</a></td>
389 <td>Public slot to delete a file from the project directory.</td> 389 <td>Public slot to delete a file from the project directory.</td>
523 <td><a href="#Project.isProjectSource">isProjectSource</a></td> 523 <td><a href="#Project.isProjectSource">isProjectSource</a></td>
524 <td>Public method used to check, if the passed in filename belongs to the project sources.</td> 524 <td>Public method used to check, if the passed in filename belongs to the project sources.</td>
525 </tr><tr> 525 </tr><tr>
526 <td><a href="#Project.moveDirectory">moveDirectory</a></td> 526 <td><a href="#Project.moveDirectory">moveDirectory</a></td>
527 <td>Public slot to move a directory.</td> 527 <td>Public slot to move a directory.</td>
528 </tr><tr>
529 <td><a href="#Project.newProject">newProject</a></td>
530 <td>Public slot to built a new project.</td>
531 </tr><tr> 528 </tr><tr>
532 <td><a href="#Project.newProjectAddFiles">newProjectAddFiles</a></td> 529 <td><a href="#Project.newProjectAddFiles">newProjectAddFiles</a></td>
533 <td>Public method to add files to a new project.</td> 530 <td>Public method to add files to a new project.</td>
534 </tr><tr> 531 </tr><tr>
535 <td><a href="#Project.openProject">openProject</a></td> 532 <td><a href="#Project.openProject">openProject</a></td>
1332 original directory name (string) 1329 original directory name (string)
1333 </dd><dt><i>newdn</i></dt> 1330 </dd><dt><i>newdn</i></dt>
1334 <dd> 1331 <dd>
1335 new directory name (string) 1332 new directory name (string)
1336 </dd> 1333 </dd>
1337 </dl><a NAME="Project.deleteDirectory" ID="Project.deleteDirectory"></a> 1334 </dl><a NAME="Project.createNewProject" ID="Project.createNewProject"></a>
1335 <h4>Project.createNewProject</h4>
1336 <b>createNewProject</b>(<i></i>)
1337 <p>
1338 Public slot to built a new project.
1339 </p><p>
1340 This method displays the new project dialog and initializes
1341 the project object with the data entered.
1342 </p><a NAME="Project.deleteDirectory" ID="Project.deleteDirectory"></a>
1338 <h4>Project.deleteDirectory</h4> 1343 <h4>Project.deleteDirectory</h4>
1339 <b>deleteDirectory</b>(<i>dn</i>) 1344 <b>deleteDirectory</b>(<i>dn</i>)
1340 <p> 1345 <p>
1341 Public slot to delete a directory from the project directory. 1346 Public slot to delete a directory from the project directory.
1342 </p><dl> 1347 </p><dl>
1909 old directory name (string) 1914 old directory name (string)
1910 </dd><dt><i>newdn</i></dt> 1915 </dd><dt><i>newdn</i></dt>
1911 <dd> 1916 <dd>
1912 new directory name (string) 1917 new directory name (string)
1913 </dd> 1918 </dd>
1914 </dl><a NAME="Project.newProject" ID="Project.newProject"></a> 1919 </dl><a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
1915 <h4>Project.newProject</h4>
1916 <b>newProject</b>(<i></i>)
1917 <p>
1918 Public slot to built a new project.
1919 </p><p>
1920 This method displays the new project dialog and initializes
1921 the project object with the data entered.
1922 </p><a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
1923 <h4>Project.newProjectAddFiles</h4> 1920 <h4>Project.newProjectAddFiles</h4>
1924 <b>newProjectAddFiles</b>(<i>mainscript</i>) 1921 <b>newProjectAddFiles</b>(<i>mainscript</i>)
1925 <p> 1922 <p>
1926 Public method to add files to a new project. 1923 Public method to add files to a new project.
1927 </p><dl> 1924 </p><dl>

eric ide

mercurial