diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.MultiProject.MultiProject.html
--- a/Documentation/Source/eric5.MultiProject.MultiProject.html Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.MultiProject.MultiProject.html Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
<body><a NAME="top" ID="top"></a>
<h1>eric5.MultiProject.MultiProject</h1>
<p>
-Module implementing the multi project management functionality.
+Module implementing the multi project management functionality.
</p>
<h3>Global Attributes</h3>
<table>
@@ -32,7 +32,7 @@
<table>
<tr>
<td><a href="#MultiProject">MultiProject</a></td>
-<td>Class implementing the project management functionality.</td>
+<td>Class implementing the project management functionality.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -43,44 +43,44 @@
<a NAME="MultiProject" ID="MultiProject"></a>
<h2>MultiProject</h2>
<p>
- Class implementing the project management functionality.
+ Class implementing the project management functionality.
</p><h4>Signals</h4>
<dl>
<dt>dirty(int)</dt>
<dd>
-emitted when the dirty state changes
+emitted when the dirty state changes
</dd><dt>multiProjectClosed()</dt>
<dd>
-emitted after a multi project was closed
+emitted after a multi project was closed
</dd><dt>multiProjectOpened()</dt>
<dd>
-emitted after a multi project file was read
+emitted after a multi project file was read
</dd><dt>multiProjectPropertiesChanged()</dt>
<dd>
-emitted after the multi project
- properties were changed
+emitted after the multi project
+ properties were changed
</dd><dt>newMultiProject()</dt>
<dd>
-emitted after a new multi project was generated
+emitted after a new multi project was generated
</dd><dt>projectAdded(project data dict)</dt>
<dd>
-emitted after a project entry
- has been added
+emitted after a project entry
+ has been added
</dd><dt>projectDataChanged(project data dict)</dt>
<dd>
-emitted after a project entry
- has been changed
+emitted after a project entry
+ has been changed
</dd><dt>projectOpened(filename)</dt>
<dd>
-emitted after the project has been opened
+emitted after the project has been opened
</dd><dt>projectRemoved(project data dict)</dt>
<dd>
-emitted after a project entry
- has been removed
+emitted after a project entry
+ has been removed
</dd><dt>showMenu(string, QMenu)</dt>
<dd>
-emitted when a menu is about to be shown.
- The name of the menu and a reference to the menu are given.
+emitted when a menu is about to be shown.
+ The name of the menu and a reference to the menu are given.
</dd>
</dl>
<h3>Derived from</h3>
@@ -93,569 +93,569 @@
<table>
<tr>
<td><a href="#MultiProject.__init__">MultiProject</a></td>
-<td>Constructor</td>
+<td>Constructor</td>
</tr><tr>
<td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td>
-<td>Private method to check, if the files in a list exist.</td>
+<td>Private method to check, if the files in a list exist.</td>
</tr><tr>
<td><a href="#MultiProject.__clearRecent">__clearRecent</a></td>
-<td>Private method to clear the recent multi projects menu.</td>
+<td>Private method to clear the recent multi projects menu.</td>
</tr><tr>
<td><a href="#MultiProject.__initData">__initData</a></td>
-<td>Private method to initialize the multi project data part.</td>
+<td>Private method to initialize the multi project data part.</td>
</tr><tr>
<td><a href="#MultiProject.__loadRecent">__loadRecent</a></td>
-<td>Private method to load the recently opened multi project filenames.</td>
+<td>Private method to load the recently opened multi project filenames.</td>
</tr><tr>
<td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td>
-<td>Public slot to open the master project.</td>
+<td>Public slot to open the master project.</td>
</tr><tr>
<td><a href="#MultiProject.__openRecent">__openRecent</a></td>
-<td>Private method to open a multi project from the list of rencently opened multi projects.</td>
+<td>Private method to open a multi project from the list of rencently opened multi projects.</td>
</tr><tr>
<td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td>
-<td>Private method to read in a multi project (.e4m, .e4mz) file.</td>
+<td>Private method to read in a multi project (.e4m, .e4mz) file.</td>
</tr><tr>
<td><a href="#MultiProject.__readXMLMultiProject">__readXMLMultiProject</a></td>
-<td>Private method to read the multi project data from an XML file.</td>
+<td>Private method to read the multi project data from an XML file.</td>
</tr><tr>
<td><a href="#MultiProject.__saveRecent">__saveRecent</a></td>
-<td>Private method to save the list of recently opened filenames.</td>
+<td>Private method to save the list of recently opened filenames.</td>
</tr><tr>
<td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td>
-<td>Private method to set up the recent multi projects menu.</td>
+<td>Private method to set up the recent multi projects menu.</td>
</tr><tr>
<td><a href="#MultiProject.__showMenu">__showMenu</a></td>
-<td>Private method to set up the multi project menu.</td>
+<td>Private method to set up the multi project menu.</td>
</tr><tr>
<td><a href="#MultiProject.__showProperties">__showProperties</a></td>
-<td>Private slot to display the properties dialog.</td>
+<td>Private slot to display the properties dialog.</td>
</tr><tr>
<td><a href="#MultiProject.__syncRecent">__syncRecent</a></td>
-<td>Private method to synchronize the list of recently opened multi projects with the central store.</td>
+<td>Private method to synchronize the list of recently opened multi projects with the central store.</td>
</tr><tr>
<td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td>
-<td>Private method to save the multi project infos to a multi project file.</td>
+<td>Private method to save the multi project infos to a multi project file.</td>
</tr><tr>
<td><a href="#MultiProject.__writeXMLMultiProject">__writeXMLMultiProject</a></td>
-<td>Private method to write the multi project data to an XML file.</td>
+<td>Private method to write the multi project data to an XML file.</td>
</tr><tr>
<td><a href="#MultiProject.addE5Actions">addE5Actions</a></td>
-<td>Public method to add actions to the list of actions.</td>
+<td>Public method to add actions to the list of actions.</td>
</tr><tr>
<td><a href="#MultiProject.addProject">addProject</a></td>
-<td>Public slot used to add files to the project.</td>
+<td>Public slot used to add files to the project.</td>
</tr><tr>
<td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td>
-<td>Public method to change the data of a project entry.</td>
+<td>Public method to change the data of a project entry.</td>
</tr><tr>
<td><a href="#MultiProject.checkDirty">checkDirty</a></td>
-<td>Public method to check the dirty status and open a message window.</td>
+<td>Public method to check the dirty status and open a message window.</td>
</tr><tr>
<td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td>
-<td>Public slot to close the current multi project.</td>
+<td>Public slot to close the current multi project.</td>
</tr><tr>
<td><a href="#MultiProject.getActions">getActions</a></td>
-<td>Public method to get a list of all actions.</td>
+<td>Public method to get a list of all actions.</td>
</tr><tr>
<td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td>
-<td>Public method to get the filenames of the dependant projects.</td>
+<td>Public method to get the filenames of the dependant projects.</td>
</tr><tr>
<td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td>
-<td>Public method to get the filename of the master project.</td>
+<td>Public method to get the filename of the master project.</td>
</tr><tr>
<td><a href="#MultiProject.getMenu">getMenu</a></td>
-<td>Public method to get a reference to the main menu or a submenu.</td>
+<td>Public method to get a reference to the main menu or a submenu.</td>
</tr><tr>
<td><a href="#MultiProject.getMostRecent">getMostRecent</a></td>
-<td>Public method to get the most recently opened multiproject.</td>
+<td>Public method to get the most recently opened multiproject.</td>
</tr><tr>
<td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td>
-<td>Public method to get the path of the multi project file.</td>
+<td>Public method to get the path of the multi project file.</td>
</tr><tr>
<td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td>
-<td>Public method to get the multi project path.</td>
+<td>Public method to get the multi project path.</td>
</tr><tr>
<td><a href="#MultiProject.getProject">getProject</a></td>
-<td>Public method to get a reference to a project entry.</td>
+<td>Public method to get a reference to a project entry.</td>
</tr><tr>
<td><a href="#MultiProject.getProjects">getProjects</a></td>
-<td>Public method to get all project entries.</td>
+<td>Public method to get all project entries.</td>
</tr><tr>
<td><a href="#MultiProject.initActions">initActions</a></td>
-<td>Public slot to initialize the multi project related actions.</td>
+<td>Public slot to initialize the multi project related actions.</td>
</tr><tr>
<td><a href="#MultiProject.initMenu">initMenu</a></td>
-<td>Public slot to initialize the multi project menu.</td>
+<td>Public slot to initialize the multi project menu.</td>
</tr><tr>
<td><a href="#MultiProject.initToolbar">initToolbar</a></td>
-<td>Public slot to initialize the multi project toolbar.</td>
+<td>Public slot to initialize the multi project toolbar.</td>
</tr><tr>
<td><a href="#MultiProject.isDirty">isDirty</a></td>
-<td>Public method to return the dirty state.</td>
+<td>Public method to return the dirty state.</td>
</tr><tr>
<td><a href="#MultiProject.isOpen">isOpen</a></td>
-<td>Public method to return the opened state.</td>
+<td>Public method to return the opened state.</td>
</tr><tr>
<td><a href="#MultiProject.newMultiProject">newMultiProject</a></td>
-<td>Public slot to build a new multi project.</td>
+<td>Public slot to build a new multi project.</td>
</tr><tr>
<td><a href="#MultiProject.openMultiProject">openMultiProject</a></td>
-<td>Public slot to open a multi project.</td>
+<td>Public slot to open a multi project.</td>
</tr><tr>
<td><a href="#MultiProject.openProject">openProject</a></td>
-<td>Public slot to open a project.</td>
+<td>Public slot to open a project.</td>
</tr><tr>
<td><a href="#MultiProject.removeE5Actions">removeE5Actions</a></td>
-<td>Public method to remove actions from the list of actions.</td>
+<td>Public method to remove actions from the list of actions.</td>
</tr><tr>
<td><a href="#MultiProject.removeProject">removeProject</a></td>
-<td>Public slot to remove a project from the multi project.</td>
+<td>Public slot to remove a project from the multi project.</td>
</tr><tr>
<td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td>
-<td>Public slot to save the current multi project.</td>
+<td>Public slot to save the current multi project.</td>
</tr><tr>
<td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td>
-<td>Public slot to save the current multi project to a different file.</td>
+<td>Public slot to save the current multi project to a different file.</td>
</tr><tr>
<td><a href="#MultiProject.setDirty">setDirty</a></td>
-<td>Public method to set the dirty state.</td>
+<td>Public method to set the dirty state.</td>
</tr>
</table>
<a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a>
<h4>MultiProject (Constructor)</h4>
<b>MultiProject</b>(<i>project, parent = None, filename = None</i>)
<p>
- Constructor
+ Constructor
</p><dl>
<dt><i>project</i></dt>
<dd>
-reference to the project object (Project.Project)
+reference to the project object (Project.Project)
</dd><dt><i>parent</i></dt>
<dd>
-parent widget (usually the ui object) (QWidget)
+parent widget (usually the ui object) (QWidget)
</dd><dt><i>filename</i></dt>
<dd>
-optional filename of a multi project file to open (string)
+optional filename of a multi project file to open (string)
</dd>
</dl><a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
<h4>MultiProject.__checkFilesExist</h4>
<b>__checkFilesExist</b>(<i></i>)
<p>
- Private method to check, if the files in a list exist.
+ Private method to check, if the files in a list exist.
</p><p>
- The project files are checked for existance in the
- filesystem. Non existant projects are removed from the list and the
- dirty state of the multi project is changed accordingly.
+ The project files are checked for existance in the
+ filesystem. Non existant projects are removed from the list and the
+ dirty state of the multi project is changed accordingly.
</p><a NAME="MultiProject.__clearRecent" ID="MultiProject.__clearRecent"></a>
<h4>MultiProject.__clearRecent</h4>
<b>__clearRecent</b>(<i></i>)
<p>
- Private method to clear the recent multi projects menu.
+ Private method to clear the recent multi projects menu.
</p><a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a>
<h4>MultiProject.__initData</h4>
<b>__initData</b>(<i></i>)
<p>
- Private method to initialize the multi project data part.
+ Private method to initialize the multi project data part.
</p><a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a>
<h4>MultiProject.__loadRecent</h4>
<b>__loadRecent</b>(<i></i>)
<p>
- Private method to load the recently opened multi project filenames.
+ Private method to load the recently opened multi project filenames.
</p><a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a>
<h4>MultiProject.__openMasterProject</h4>
<b>__openMasterProject</b>(<i>reopen = True</i>)
<p>
- Public slot to open the master project.
+ Public slot to open the master project.
</p><dl>
<dt><i>reopen</i></dt>
<dd>
-flag indicating, that the master project should be
- reopened, if it has been opened already (boolean)
+flag indicating, that the master project should be
+ reopened, if it has been opened already (boolean)
</dd>
</dl><a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
<h4>MultiProject.__openRecent</h4>
<b>__openRecent</b>(<i>act</i>)
<p>
- Private method to open a multi project from the list of rencently
- opened multi projects.
+ Private method to open a multi project from the list of rencently
+ opened multi projects.
</p><dl>
<dt><i>act</i></dt>
<dd>
-reference to the action that triggered (QAction)
+reference to the action that triggered (QAction)
</dd>
</dl><a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
<h4>MultiProject.__readMultiProject</h4>
<b>__readMultiProject</b>(<i>fn</i>)
<p>
- Private method to read in a multi project (.e4m, .e4mz) file.
+ Private method to read in a multi project (.e4m, .e4mz) file.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-filename of the multi project file to be read (string)
+filename of the multi project file to be read (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success
+flag indicating success
</dd>
</dl><a NAME="MultiProject.__readXMLMultiProject" ID="MultiProject.__readXMLMultiProject"></a>
<h4>MultiProject.__readXMLMultiProject</h4>
<b>__readXMLMultiProject</b>(<i>fn, validating</i>)
<p>
- Private method to read the multi project data from an XML file.
+ Private method to read the multi project data from an XML file.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-filename of the multi project file to be read (string)
+filename of the multi project file to be read (string)
</dd><dt><i>validating</i></dt>
<dd>
-flag indicating a validation of the XML file is
- requested (boolean)
+flag indicating a validation of the XML file is
+ requested (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success
+flag indicating success
</dd>
</dl><a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
<h4>MultiProject.__saveRecent</h4>
<b>__saveRecent</b>(<i></i>)
<p>
- Private method to save the list of recently opened filenames.
+ Private method to save the list of recently opened filenames.
</p><a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a>
<h4>MultiProject.__showContextMenuRecent</h4>
<b>__showContextMenuRecent</b>(<i></i>)
<p>
- Private method to set up the recent multi projects menu.
+ Private method to set up the recent multi projects menu.
</p><a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a>
<h4>MultiProject.__showMenu</h4>
<b>__showMenu</b>(<i></i>)
<p>
- Private method to set up the multi project menu.
+ Private method to set up the multi project menu.
</p><a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a>
<h4>MultiProject.__showProperties</h4>
<b>__showProperties</b>(<i></i>)
<p>
- Private slot to display the properties dialog.
+ Private slot to display the properties dialog.
</p><a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a>
<h4>MultiProject.__syncRecent</h4>
<b>__syncRecent</b>(<i></i>)
<p>
- Private method to synchronize the list of recently opened multi projects
- with the central store.
+ Private method to synchronize the list of recently opened multi projects
+ with the central store.
</p><a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a>
<h4>MultiProject.__writeMultiProject</h4>
<b>__writeMultiProject</b>(<i>fn = None</i>)
<p>
- Private method to save the multi project infos to a multi project file.
+ Private method to save the multi project infos to a multi project file.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-optional filename of the multi project file to be written.
- If fn is None, the filename stored in the multi project object
- is used. This is the 'save' action. If fn is given, this filename
- is used instead of the one in the multi project object. This is the
- 'save as' action.
+optional filename of the multi project file to be written.
+ If fn is None, the filename stored in the multi project object
+ is used. This is the 'save' action. If fn is given, this filename
+ is used instead of the one in the multi project object. This is the
+ 'save as' action.
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success
+flag indicating success
</dd>
</dl><a NAME="MultiProject.__writeXMLMultiProject" ID="MultiProject.__writeXMLMultiProject"></a>
<h4>MultiProject.__writeXMLMultiProject</h4>
<b>__writeXMLMultiProject</b>(<i>fn = None</i>)
<p>
- Private method to write the multi project data to an XML file.
+ Private method to write the multi project data to an XML file.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-the filename of the multi project file (string)
+the filename of the multi project file (string)
</dd>
</dl><a NAME="MultiProject.addE5Actions" ID="MultiProject.addE5Actions"></a>
<h4>MultiProject.addE5Actions</h4>
<b>addE5Actions</b>(<i>actions</i>)
<p>
- Public method to add actions to the list of actions.
+ Public method to add actions to the list of actions.
</p><dl>
<dt><i>actions</i></dt>
<dd>
-list of actions (list of E5Action)
+list of actions (list of E5Action)
</dd>
</dl><a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a>
<h4>MultiProject.addProject</h4>
<b>addProject</b>(<i>startdir = None</i>)
<p>
- Public slot used to add files to the project.
+ Public slot used to add files to the project.
</p><dl>
<dt><i>startdir</i></dt>
<dd>
-start directory for the selection dialog (string)
+start directory for the selection dialog (string)
</dd>
</dl><a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a>
<h4>MultiProject.changeProjectProperties</h4>
<b>changeProjectProperties</b>(<i>pro</i>)
<p>
- Public method to change the data of a project entry.
+ Public method to change the data of a project entry.
</p><dl>
<dt><i>pro</i></dt>
<dd>
-dictionary with the project data (string)
+dictionary with the project data (string)
</dd>
</dl><a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
<h4>MultiProject.checkDirty</h4>
<b>checkDirty</b>(<i></i>)
<p>
- Public method to check the dirty status and open a message window.
+ Public method to check the dirty status and open a message window.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating whether this operation was successful (boolean)
+flag indicating whether this operation was successful (boolean)
</dd>
</dl><a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a>
<h4>MultiProject.closeMultiProject</h4>
<b>closeMultiProject</b>(<i></i>)
<p>
- Public slot to close the current multi project.
+ Public slot to close the current multi project.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success (boolean)
</dd>
</dl><a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a>
<h4>MultiProject.getActions</h4>
<b>getActions</b>(<i></i>)
<p>
- Public method to get a list of all actions.
+ Public method to get a list of all actions.
</p><dl>
<dt>Returns:</dt>
<dd>
-list of all actions (list of E5Action)
+list of all actions (list of E5Action)
</dd>
</dl><a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
<h4>MultiProject.getDependantProjectFiles</h4>
<b>getDependantProjectFiles</b>(<i></i>)
<p>
- Public method to get the filenames of the dependant projects.
+ Public method to get the filenames of the dependant projects.
</p><dl>
<dt>Returns:</dt>
<dd>
-names of the dependant project files (list of strings)
+names of the dependant project files (list of strings)
</dd>
</dl><a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a>
<h4>MultiProject.getMasterProjectFile</h4>
<b>getMasterProjectFile</b>(<i></i>)
<p>
- Public method to get the filename of the master project.
+ Public method to get the filename of the master project.
</p><dl>
<dt>Returns:</dt>
<dd>
-name of the master project file (string)
+name of the master project file (string)
</dd>
</dl><a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a>
<h4>MultiProject.getMenu</h4>
<b>getMenu</b>(<i>menuName</i>)
<p>
- Public method to get a reference to the main menu or a submenu.
+ Public method to get a reference to the main menu or a submenu.
</p><dl>
<dt><i>menuName</i></dt>
<dd>
-name of the menu (string)
+name of the menu (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-reference to the requested menu (QMenu) or None
+reference to the requested menu (QMenu) or None
</dd>
</dl><a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
<h4>MultiProject.getMostRecent</h4>
<b>getMostRecent</b>(<i></i>)
<p>
- Public method to get the most recently opened multiproject.
+ Public method to get the most recently opened multiproject.
</p><dl>
<dt>Returns:</dt>
<dd>
-path of the most recently opened multiproject (string)
+path of the most recently opened multiproject (string)
</dd>
</dl><a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
<h4>MultiProject.getMultiProjectFile</h4>
<b>getMultiProjectFile</b>(<i></i>)
<p>
- Public method to get the path of the multi project file.
+ Public method to get the path of the multi project file.
</p><dl>
<dt>Returns:</dt>
<dd>
-path of the multi project file (string)
+path of the multi project file (string)
</dd>
</dl><a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
<h4>MultiProject.getMultiProjectPath</h4>
<b>getMultiProjectPath</b>(<i></i>)
<p>
- Public method to get the multi project path.
+ Public method to get the multi project path.
</p><dl>
<dt>Returns:</dt>
<dd>
-multi project path (string)
+multi project path (string)
</dd>
</dl><a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
<h4>MultiProject.getProject</h4>
<b>getProject</b>(<i>fn</i>)
<p>
- Public method to get a reference to a project entry.
+ Public method to get a reference to a project entry.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-filename of the project (string)
+filename of the project (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-dictionary containing the project data
+dictionary containing the project data
</dd>
</dl><a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
<h4>MultiProject.getProjects</h4>
<b>getProjects</b>(<i></i>)
<p>
- Public method to get all project entries.
+ Public method to get all project entries.
</p><dl>
<dt>Returns:</dt>
<dd>
-list of all project entries (list of dictionaries)
+list of all project entries (list of dictionaries)
</dd>
</dl><a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
<h4>MultiProject.initActions</h4>
<b>initActions</b>(<i></i>)
<p>
- Public slot to initialize the multi project related actions.
+ Public slot to initialize the multi project related actions.
</p><a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a>
<h4>MultiProject.initMenu</h4>
<b>initMenu</b>(<i></i>)
<p>
- Public slot to initialize the multi project menu.
+ Public slot to initialize the multi project menu.
</p><dl>
<dt>Returns:</dt>
<dd>
-the menu generated (QMenu)
+the menu generated (QMenu)
</dd>
</dl><a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
<h4>MultiProject.initToolbar</h4>
<b>initToolbar</b>(<i>toolbarManager</i>)
<p>
- Public slot to initialize the multi project toolbar.
+ Public slot to initialize the multi project toolbar.
</p><dl>
<dt><i>toolbarManager</i></dt>
<dd>
-reference to a toolbar manager object (E5ToolBarManager)
+reference to a toolbar manager object (E5ToolBarManager)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the toolbar generated (QToolBar)
+the toolbar generated (QToolBar)
</dd>
</dl><a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
<h4>MultiProject.isDirty</h4>
<b>isDirty</b>(<i></i>)
<p>
- Public method to return the dirty state.
+ Public method to return the dirty state.
</p><dl>
<dt>Returns:</dt>
<dd>
-dirty state (boolean)
+dirty state (boolean)
</dd>
</dl><a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
<h4>MultiProject.isOpen</h4>
<b>isOpen</b>(<i></i>)
<p>
- Public method to return the opened state.
+ Public method to return the opened state.
</p><dl>
<dt>Returns:</dt>
<dd>
-open state (boolean)
+open state (boolean)
</dd>
</dl><a NAME="MultiProject.newMultiProject" ID="MultiProject.newMultiProject"></a>
<h4>MultiProject.newMultiProject</h4>
<b>newMultiProject</b>(<i></i>)
<p>
- Public slot to build a new multi project.
+ Public slot to build a new multi project.
</p><p>
- This method displays the new multi project dialog and initializes
- the multi project object with the data entered.
+ This method displays the new multi project dialog and initializes
+ the multi project object with the data entered.
</p><a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
<h4>MultiProject.openMultiProject</h4>
<b>openMultiProject</b>(<i>fn = None, openMaster = True</i>)
<p>
- Public slot to open a multi project.
+ Public slot to open a multi project.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-optional filename of the multi project file to be read (string)
+optional filename of the multi project file to be read (string)
</dd><dt><i>openMaster</i></dt>
<dd>
-flag indicating, that the master project
- should be opened depending on the configuration (boolean)
+flag indicating, that the master project
+ should be opened depending on the configuration (boolean)
</dd>
</dl><a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a>
<h4>MultiProject.openProject</h4>
<b>openProject</b>(<i>filename</i>)
<p>
- Public slot to open a project.
+ Public slot to open a project.
</p><dl>
<dt><i>filename</i></dt>
<dd>
-filename of the project file (string)
+filename of the project file (string)
</dd>
</dl><a NAME="MultiProject.removeE5Actions" ID="MultiProject.removeE5Actions"></a>
<h4>MultiProject.removeE5Actions</h4>
<b>removeE5Actions</b>(<i>actions</i>)
<p>
- Public method to remove actions from the list of actions.
+ Public method to remove actions from the list of actions.
</p><dl>
<dt><i>actions</i></dt>
<dd>
-list of actions (list of E5Action)
+list of actions (list of E5Action)
</dd>
</dl><a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
<h4>MultiProject.removeProject</h4>
<b>removeProject</b>(<i>fn</i>)
<p>
- Public slot to remove a project from the multi project.
+ Public slot to remove a project from the multi project.
</p><dl>
<dt><i>fn</i></dt>
<dd>
-filename of the project to be removed from the multi project (string)
+filename of the project to be removed from the multi project (string)
</dd>
</dl><a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a>
<h4>MultiProject.saveMultiProject</h4>
<b>saveMultiProject</b>(<i></i>)
<p>
- Public slot to save the current multi project.
+ Public slot to save the current multi project.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success (boolean)
</dd>
</dl><a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a>
<h4>MultiProject.saveMultiProjectAs</h4>
<b>saveMultiProjectAs</b>(<i></i>)
<p>
- Public slot to save the current multi project to a different file.
+ Public slot to save the current multi project to a different file.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success (boolean)
</dd>
</dl><a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a>
<h4>MultiProject.setDirty</h4>
<b>setDirty</b>(<i>b</i>)
<p>
- Public method to set the dirty state.
+ Public method to set the dirty state.
</p><p>
- It emits the signal dirty(int).
+ It emits the signal dirty(int).
</p><dl>
<dt><i>b</i></dt>
<dd>
-dirty state (boolean)
+dirty state (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
