eric: Documentation/Source/eric5.Project.Project.html@e2a956fcf5e7 (annotated)

 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 <html><head>
 <title>eric5.Project.Project</title>
 <style>
 body {
     background: #EDECE6;
     margin: 0em 1em 10em 1em;
     color: black;
 }
 h1 { color: white; background: #85774A; }
 h2 { color: white; background: #85774A; }
 h3 { color: white; background: #9D936E; }
 h4 { color: white; background: #9D936E; }
 a { color: #BA6D36; }
 </style>
 </head>
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Project.Project</h1>
 <p>
 Module implementing the project management functionality.
 </p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
 <tr>
 <td><a href="#Project">Project</a></td>
 <td>Class implementing the project management functionality.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
 <a NAME="Project" ID="Project"></a>
 <h2>Project</h2>
 <p>
     Class implementing the project management functionality.
 </p><h3>Signals</h3>
 <dl>
 <dt>completeRepopulateItem(str)</dt>
 <dd>
 emitted after an item of the model was
             repopulated
 </dd><dt>directoryRemoved(str)</dt>
 <dd>
 emitted after a directory has been removed from
             the project
 </dd><dt>dirty(int)</dt>
 <dd>
 emitted when the dirty state changes
 </dd><dt>lexerAssociationsChanged()</dt>
 <dd>
 emitted after the lexer associations have been
             changed
 </dd><dt>newProject()</dt>
 <dd>
 emitted after a new project was generated
 </dd><dt>newProjectHooks()</dt>
 <dd>
 emitted after a new project was generated but before
             the newProject() signal is sent
 </dd><dt>prepareRepopulateItem(str)</dt>
 <dd>
 emitted before an item of the model is
             repopulated
 </dd><dt>projectAboutToBeCreated()</dt>
 <dd>
 emitted just before the project will be created
 </dd><dt>projectClosed()</dt>
 <dd>
 emitted after a project was closed
 </dd><dt>projectClosedHooks()</dt>
 <dd>
 emitted after a project file was closed but before the
             projectClosed() signal is sent
 </dd><dt>projectFileRenamed(str, str)</dt>
 <dd>
 emitted after a file of the project
             has been renamed
 </dd><dt>projectFormAdded(str)</dt>
 <dd>
 emitted after a new form was added
 </dd><dt>projectFormCompiled(str)</dt>
 <dd>
 emitted after a form was compiled
 </dd><dt>projectFormRemoved(str)</dt>
 <dd>
 emitted after a form was removed
 </dd><dt>projectInterfaceAdded(str)</dt>
 <dd>
 emitted after a new IDL file was added
 </dd><dt>projectInterfaceRemoved(str)</dt>
 <dd>
 emitted after a IDL file was removed
 </dd><dt>projectLanguageAdded(str)</dt>
 <dd>
 emitted after a new language was added
 </dd><dt>projectLanguageAddedByCode(str)</dt>
 <dd>
 emitted after a new language was added.
             The language code is sent by this signal.
 </dd><dt>projectLanguageRemoved(str)</dt>
 <dd>
 emitted after a language was removed
 </dd><dt>projectOpened()</dt>
 <dd>
 emitted after a project file was read
 </dd><dt>projectOpenedHooks()</dt>
 <dd>
 emitted after a project file was read but before the
             projectOpened() signal is sent
 </dd><dt>projectOthersAdded(str)</dt>
 <dd>
 emitted after a file or directory was added
             to the OTHERS project data area
 </dd><dt>projectOthersRemoved(str)</dt>
 <dd>
 emitted after a file was removed from the
             OTHERS project data area
 </dd><dt>projectPropertiesChanged()</dt>
 <dd>
 emitted after the project properties were changed
 </dd><dt>projectResourceAdded(str)</dt>
 <dd>
 emitted after a new resource file was added
 </dd><dt>projectResourceRemoved(str)</dt>
 <dd>
 emitted after a resource was removed
 </dd><dt>projectSourceAdded(str)</dt>
 <dd>
 emitted after a new source file was added
 </dd><dt>projectSourceRemoved(str)</dt>
 <dd>
 emitted after a source was removed
 </dd><dt>reinitVCS()</dt>
 <dd>
 emitted after the VCS has been reinitialized
 </dd><dt>showMenu(str, 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.
 </dd><dt>sourceFile(str)</dt>
 <dd>
 emitted after a project file was read to
             open the main script
 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
 <dd>
 emitted to signal the status of the
             monitoring thread (ok, nok, op, off) and a status message
 </dd>
 </dl>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
 <table>
 <tr><td>dbgKeynames</td></tr><tr><td>eols</td></tr><tr><td>keynames</td></tr><tr><td>userKeynames</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#Project.__init__">Project</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#Project.__addRecursiveDirectory">__addRecursiveDirectory</a></td>
 <td>Private method used to add all files of a directory tree.</td>
 </tr><tr>
 <td><a href="#Project.__addSingleDirectory">__addSingleDirectory</a></td>
 <td>Private method used to add all files of a single directory to the project.</td>
 </tr><tr>
 <td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td>
 <td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td>
 </tr><tr>
 <td><a href="#Project.__checkFilesExist">__checkFilesExist</a></td>
 <td>Private method to check, if the files in a list exist.</td>
 </tr><tr>
 <td><a href="#Project.__checkProjectFileGroup">__checkProjectFileGroup</a></td>
 <td>Private method to check, if a file is in a specific file group of the project.</td>
 </tr><tr>
 <td><a href="#Project.__clearRecent">__clearRecent</a></td>
 <td>Private method to clear the recent projects menu.</td>
 </tr><tr>
 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td>
 <td>Private method to close all project related windows.</td>
 </tr><tr>
 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td>
 <td>Private method to create a snapshot plugin version.</td>
 </tr><tr>
 <td><a href="#Project.__createZipDirEntries">__createZipDirEntries</a></td>
 <td>Private method to create dir entries in the zip file.</td>
 </tr><tr>
 <td><a href="#Project.__deleteDebugProperties">__deleteDebugProperties</a></td>
 <td>Private method to delete the project debugger properties file (.e4d)</td>
 </tr><tr>
 <td><a href="#Project.__deleteSession">__deleteSession</a></td>
 <td>Private method to delete the session file.</td>
 </tr><tr>
 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td>
 <td>Private method to search for new files in the project directory.</td>
 </tr><tr>
 <td><a href="#Project.__initData">__initData</a></td>
 <td>Private method to initialize the project data part.</td>
 </tr><tr>
 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td>
 <td>Private method to initialize the debug properties.</td>
 </tr><tr>
 <td><a href="#Project.__initProjectTypes">__initProjectTypes</a></td>
 <td>Private method to initialize the list of supported project types.</td>
 </tr><tr>
 <td><a href="#Project.__loadRecent">__loadRecent</a></td>
 <td>Private method to load the recently opened project filenames.</td>
 </tr><tr>
 <td><a href="#Project.__makePpathRe">__makePpathRe</a></td>
 <td>Private method to generate a regular expression for the project path.</td>
 </tr><tr>
 <td><a href="#Project.__openRecent">__openRecent</a></td>
 <td>Private method to open a project from the list of rencently opened projects.</td>
 </tr><tr>
 <td><a href="#Project.__pluginCreateArchive">__pluginCreateArchive</a></td>
 <td>Private slot to create an eric5 plugin archive.</td>
 </tr><tr>
 <td><a href="#Project.__pluginCreatePkgList">__pluginCreatePkgList</a></td>
 <td>Private slot to create a PKGLIST file needed for archive file creation.</td>
 </tr><tr>
 <td><a href="#Project.__pluginCreateSnapshotArchive">__pluginCreateSnapshotArchive</a></td>
 <td>Private slot to create an eric5 plugin archive snapshot release.</td>
 </tr><tr>
 <td><a href="#Project.__pluginExtractVersion">__pluginExtractVersion</a></td>
 <td>Private method to extract the version number entry.</td>
 </tr><tr>
 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td>
 <td>Private method to read in the project debugger properties file (.e4d)</td>
 </tr><tr>
 <td><a href="#Project.__readProject">__readProject</a></td>
 <td>Private method to read in a project (.e4p) file.</td>
 </tr><tr>
 <td><a href="#Project.__readSession">__readSession</a></td>
 <td>Private method to read in the project session file (.e4s)</td>
 </tr><tr>
 <td><a href="#Project.__readTasks">__readTasks</a></td>
 <td>Private method to read in the project tasks file (.e4t)</td>
 </tr><tr>
 <td><a href="#Project.__readUserProperties">__readUserProperties</a></td>
 <td>Private method to read in the user specific project file (.e4q)</td>
 </tr><tr>
 <td><a href="#Project.__saveRecent">__saveRecent</a></td>
 <td>Private method to save the list of recently opened filenames.</td>
 </tr><tr>
 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td>
 <td>Private slot used to handle the search new files action.</td>
 </tr><tr>
 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td>
 <td>Private slot used to show the code coverage information for the project files.</td>
 </tr><tr>
 <td><a href="#Project.__showCodeMetrics">__showCodeMetrics</a></td>
 <td>Private slot used to calculate some code metrics for the project files.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuApiDoc">__showContextMenuApiDoc</a></td>
 <td>Private slot called before the apidoc menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuChecks">__showContextMenuChecks</a></td>
 <td>Private slot called before the checks menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
 <td>Private slot called before the graphics menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td>
 <td>Private slot called before the packagers menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuRecent">__showContextMenuRecent</a></td>
 <td>Private method to set up the recent projects menu.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuShow">__showContextMenuShow</a></td>
 <td>Private slot called before the show menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showContextMenuVCS">__showContextMenuVCS</a></td>
 <td>Private slot called before the vcs menu is shown.</td>
 </tr><tr>
 <td><a href="#Project.__showDebugProperties">__showDebugProperties</a></td>
 <td>Private slot to display the debugger properties dialog.</td>
 </tr><tr>
 <td><a href="#Project.__showFiletypeAssociations">__showFiletypeAssociations</a></td>
 <td>Public slot to display the filetype association dialog.</td>
 </tr><tr>
 <td><a href="#Project.__showLexerAssociations">__showLexerAssociations</a></td>
 <td>Public slot to display the lexer association dialog.</td>
 </tr><tr>
 <td><a href="#Project.__showMenu">__showMenu</a></td>
 <td>Private method to set up the project menu.</td>
 </tr><tr>
 <td><a href="#Project.__showProfileData">__showProfileData</a></td>
 <td>Private slot used to show the profiling information for the project.</td>
 </tr><tr>
 <td><a href="#Project.__showProperties">__showProperties</a></td>
 <td>Private slot to display the properties dialog.</td>
 </tr><tr>
 <td><a href="#Project.__showUserProperties">__showUserProperties</a></td>
 <td>Private slot to display the user specific properties dialog.</td>
 </tr><tr>
 <td><a href="#Project.__statusMonitorStatus">__statusMonitorStatus</a></td>
 <td>Private method to receive the status monitor status.</td>
 </tr><tr>
 <td><a href="#Project.__syncRecent">__syncRecent</a></td>
 <td>Private method to synchronize the list of recently opened projects with the central store.</td>
 </tr><tr>
 <td><a href="#Project.__writeDebugProperties">__writeDebugProperties</a></td>
 <td>Private method to write the project debugger properties file (.e4d)</td>
 </tr><tr>
 <td><a href="#Project.__writeProject">__writeProject</a></td>
 <td>Private method to save the project infos to a project file.</td>
 </tr><tr>
 <td><a href="#Project.__writeSession">__writeSession</a></td>
 <td>Private method to write the session data to an XML file (.e4s).</td>
 </tr><tr>
 <td><a href="#Project.__writeUserProperties">__writeUserProperties</a></td>
 <td>Private method to write the project data to an XML file.</td>
 </tr><tr>
 <td><a href="#Project.addDirectory">addDirectory</a></td>
 <td>Public method used to add all files of a directory to the project.</td>
 </tr><tr>
 <td><a href="#Project.addE5Actions">addE5Actions</a></td>
 <td>Public method to add actions to the list of actions.</td>
 </tr><tr>
 <td><a href="#Project.addFiles">addFiles</a></td>
 <td>Public slot used to add files to the project.</td>
 </tr><tr>
 <td><a href="#Project.addIdlDir">addIdlDir</a></td>
 <td>Public slot to add all IDL interfaces of a directory to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addIdlFiles">addIdlFiles</a></td>
 <td>Public slot to add IDL interfaces to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addLanguage">addLanguage</a></td>
 <td>Public slot used to add a language to the project.</td>
 </tr><tr>
 <td><a href="#Project.addOthersDir">addOthersDir</a></td>
 <td>Public slot to add a directory to the OTHERS project data.</td>
 </tr><tr>
 <td><a href="#Project.addOthersFiles">addOthersFiles</a></td>
 <td>Public slot to add files to the OTHERS project data.</td>
 </tr><tr>
 <td><a href="#Project.addResourceDir">addResourceDir</a></td>
 <td>Public slot to add all Qt resource files of a directory to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addResourceFiles">addResourceFiles</a></td>
 <td>Public slot to add Qt resources to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addSourceDir">addSourceDir</a></td>
 <td>Public slot to add all source files of a directory to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addSourceFiles">addSourceFiles</a></td>
 <td>Public slot to add source files to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addToOthers">addToOthers</a></td>
 <td>Public method to add a file/directory to the OTHERS project data.</td>
 </tr><tr>
 <td><a href="#Project.addUiDir">addUiDir</a></td>
 <td>Public slot to add all forms of a directory to the current project.</td>
 </tr><tr>
 <td><a href="#Project.addUiFiles">addUiFiles</a></td>
 <td>Public slot to add forms to the current project.</td>
 </tr><tr>
 <td><a href="#Project.appendFile">appendFile</a></td>
 <td>Public method to append a file to the project.</td>
 </tr><tr>
 <td><a href="#Project.checkDirty">checkDirty</a></td>
 <td>Public method to check dirty status and open a message window.</td>
 </tr><tr>
 <td><a href="#Project.checkLanguageFiles">checkLanguageFiles</a></td>
 <td>Public slot to check the language files after a release process.</td>
 </tr><tr>
 <td><a href="#Project.checkVCSStatus">checkVCSStatus</a></td>
 <td>Public method to wake up the VCS status monitor thread.</td>
 </tr><tr>
 <td><a href="#Project.clearStatusMonitorCachedState">clearStatusMonitorCachedState</a></td>
 <td>Public method to clear the cached VCS state of a file/directory.</td>
 </tr><tr>
 <td><a href="#Project.closeProject">closeProject</a></td>
 <td>Public slot to close the current project.</td>
 </tr><tr>
 <td><a href="#Project.copyDirectory">copyDirectory</a></td>
 <td>Public slot to copy a directory.</td>
 </tr><tr>
 <td><a href="#Project.createNewProject">createNewProject</a></td>
 <td>Public slot to built a new project.</td>
 </tr><tr>
 <td><a href="#Project.deleteDirectory">deleteDirectory</a></td>
 <td>Public slot to delete a directory from the project directory.</td>
 </tr><tr>
 <td><a href="#Project.deleteFile">deleteFile</a></td>
 <td>Public slot to delete a file from the project directory.</td>
 </tr><tr>
 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td>
 <td>Public slot to delete a translation from the project directory.</td>
 </tr><tr>
 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td>
 <td>Public method to convert a project relative file path with universal separators to an absolute file path.</td>
 </tr><tr>
 <td><a href="#Project.getActions">getActions</a></td>
 <td>Public method to get a list of all actions.</td>
 </tr><tr>
 <td><a href="#Project.getData">getData</a></td>
 <td>Public method to get data out of the project data store.</td>
 </tr><tr>
 <td><a href="#Project.getDebugProperty">getDebugProperty</a></td>
 <td>Public method to retrieve a debugger property.</td>
 </tr><tr>
 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td>
 <td>Public method to get the default extension for the project's programming language.</td>
 </tr><tr>
 <td><a href="#Project.getEditorLexerAssoc">getEditorLexerAssoc</a></td>
 <td>Public method to retrieve a lexer association.</td>
 </tr><tr>
 <td><a href="#Project.getEolString">getEolString</a></td>
 <td>Public method to get the EOL-string to be used by the project.</td>
 </tr><tr>
 <td><a href="#Project.getFiles">getFiles</a></td>
 <td>Public method to get all files starting with a common prefix.</td>
 </tr><tr>
 <td><a href="#Project.getHash">getHash</a></td>
 <td>Public method to get the project hash.</td>
 </tr><tr>
 <td><a href="#Project.getMainScript">getMainScript</a></td>
 <td>Public method to return the main script filename.</td>
 </tr><tr>
 <td><a href="#Project.getMenu">getMenu</a></td>
 <td>Public method to get a reference to the main menu or a submenu.</td>
 </tr><tr>
 <td><a href="#Project.getModel">getModel</a></td>
 <td>Public method to get a reference to the project browser model.</td>
 </tr><tr>
 <td><a href="#Project.getMostRecent">getMostRecent</a></td>
 <td>Public method to get the most recently opened project.</td>
 </tr><tr>
 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td>
 <td>Public method to get the names of the project specific dictionaries.</td>
 </tr><tr>
 <td><a href="#Project.getProjectFile">getProjectFile</a></td>
 <td>Public method to get the path of the project file.</td>
 </tr><tr>
 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td>
 <td>Public method to get the project's programming language.</td>
 </tr><tr>
 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td>
 <td>Public method to get the path of the management directory.</td>
 </tr><tr>
 <td><a href="#Project.getProjectPath">getProjectPath</a></td>
 <td>Public method to get the project path.</td>
 </tr><tr>
 <td><a href="#Project.getProjectSpellLanguage">getProjectSpellLanguage</a></td>
 <td>Public method to get the project's programming language.</td>
 </tr><tr>
 <td><a href="#Project.getProjectType">getProjectType</a></td>
 <td>Public method to get the type of the project.</td>
 </tr><tr>
 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td>
 <td>Public method to get the list of supported project types.</td>
 </tr><tr>
 <td><a href="#Project.getRelativePath">getRelativePath</a></td>
 <td>Public method to convert a file path to a project relative file path.</td>
 </tr><tr>
 <td><a href="#Project.getRelativeUniversalPath">getRelativeUniversalPath</a></td>
 <td>Public method to convert a file path to a project relative file path with universal separators.</td>
 </tr><tr>
 <td><a href="#Project.getSources">getSources</a></td>
 <td>Public method to return the source script files.</td>
 </tr><tr>
 <td><a href="#Project.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td>
 <td>Public method to retrieve the status of the auto update function.</td>
 </tr><tr>
 <td><a href="#Project.getStatusMonitorInterval">getStatusMonitorInterval</a></td>
 <td>Public method to get the monitor interval.</td>
 </tr><tr>
 <td><a href="#Project.getTranslationPattern">getTranslationPattern</a></td>
 <td>Public method to get the translation pattern.</td>
 </tr><tr>
 <td><a href="#Project.getVcs">getVcs</a></td>
 <td>Public method to get a reference to the VCS object.</td>
 </tr><tr>
 <td><a href="#Project.handleApplicationDiagram">handleApplicationDiagram</a></td>
 <td>Private method to handle the application diagram context menu action.</td>
 </tr><tr>
 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td>
 <td>Public slot used to handle the preferencesChanged signal.</td>
 </tr><tr>
 <td><a href="#Project.hasEntry">hasEntry</a></td>
 <td>Public method to check the project for a file.</td>
 </tr><tr>
 <td><a href="#Project.hasProjectType">hasProjectType</a></td>
 <td>Public method to check, if a project type is already registered.</td>
 </tr><tr>
 <td><a href="#Project.initActions">initActions</a></td>
 <td>Public slot to initialize the project related actions.</td>
 </tr><tr>
 <td><a href="#Project.initFileTypes">initFileTypes</a></td>
 <td>Public method to initialize the filetype associations with default values.</td>
 </tr><tr>
 <td><a href="#Project.initMenu">initMenu</a></td>
 <td>Public slot to initialize the project menu.</td>
 </tr><tr>
 <td><a href="#Project.initToolbar">initToolbar</a></td>
 <td>Public slot to initialize the project toolbar.</td>
 </tr><tr>
 <td><a href="#Project.initVCS">initVCS</a></td>
 <td>Public method used to instantiate a vcs system.</td>
 </tr><tr>
 <td><a href="#Project.isDebugPropertiesLoaded">isDebugPropertiesLoaded</a></td>
 <td>Public method to return the status of the debug properties.</td>
 </tr><tr>
 <td><a href="#Project.isDirty">isDirty</a></td>
 <td>Public method to return the dirty state.</td>
 </tr><tr>
 <td><a href="#Project.isOpen">isOpen</a></td>
 <td>Public method to return the opened state.</td>
 </tr><tr>
 <td><a href="#Project.isProjectFile">isProjectFile</a></td>
 <td>Public method used to check, if the passed in filename belongs to the project.</td>
 </tr><tr>
 <td><a href="#Project.isProjectForm">isProjectForm</a></td>
 <td>Public method used to check, if the passed in filename belongs to the project forms.</td>
 </tr><tr>
 <td><a href="#Project.isProjectInterface">isProjectInterface</a></td>
 <td>Public method used to check, if the passed in filename belongs to the project interfaces.</td>
 </tr><tr>
 <td><a href="#Project.isProjectResource">isProjectResource</a></td>
 <td>Public method used to check, if the passed in filename belongs to the project resources.</td>
 </tr><tr>
 <td><a href="#Project.isProjectSource">isProjectSource</a></td>
 <td>Public method used to check, if the passed in filename belongs to the project sources.</td>
 </tr><tr>
 <td><a href="#Project.isPy2Project">isPy2Project</a></td>
 <td>Public method to check, if this project is a Python2 project.</td>
 </tr><tr>
 <td><a href="#Project.isPy3Project">isPy3Project</a></td>
 <td>Public method to check, if this project is a Python3 project.</td>
 </tr><tr>
 <td><a href="#Project.isRubyProject">isRubyProject</a></td>
 <td>Public method to check, if this project is a Ruby project.</td>
 </tr><tr>
 <td><a href="#Project.moveDirectory">moveDirectory</a></td>
 <td>Public slot to move a directory.</td>
 </tr><tr>
 <td><a href="#Project.newProjectAddFiles">newProjectAddFiles</a></td>
 <td>Public method to add files to a new project.</td>
 </tr><tr>
 <td><a href="#Project.openProject">openProject</a></td>
 <td>Public slot to open a project.</td>
 </tr><tr>
 <td><a href="#Project.othersAdded">othersAdded</a></td>
 <td>Public slot to be called, if something was added to the OTHERS project data area.</td>
 </tr><tr>
 <td><a href="#Project.registerProjectType">registerProjectType</a></td>
 <td>Public method to register a project type.</td>
 </tr><tr>
 <td><a href="#Project.removeDirectory">removeDirectory</a></td>
 <td>Public slot to remove a directory from the project.</td>
 </tr><tr>
 <td><a href="#Project.removeE5Actions">removeE5Actions</a></td>
 <td>Public method to remove actions from the list of actions.</td>
 </tr><tr>
 <td><a href="#Project.removeFile">removeFile</a></td>
 <td>Public slot to remove a file from the project.</td>
 </tr><tr>
 <td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td>
 <td>Public slot to remove a translation from the project.</td>
 </tr><tr>
 <td><a href="#Project.renameFile">renameFile</a></td>
 <td>Public slot to rename a file of the project.</td>
 </tr><tr>
 <td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td>
 <td>Public method to rename a file in the pdata structure.</td>
 </tr><tr>
 <td><a href="#Project.renameMainScript">renameMainScript</a></td>
 <td>Public method to rename the main script.</td>
 </tr><tr>
 <td><a href="#Project.reopenProject">reopenProject</a></td>
 <td>Public slot to reopen the current project.</td>
 </tr><tr>
 <td><a href="#Project.repopulateItem">repopulateItem</a></td>
 <td>Public slot to repopulate a named item.</td>
 </tr><tr>
 <td><a href="#Project.saveAllScripts">saveAllScripts</a></td>
 <td>Public method to save all scripts belonging to the project.</td>
 </tr><tr>
 <td><a href="#Project.saveProject">saveProject</a></td>
 <td>Public slot to save the current project.</td>
 </tr><tr>
 <td><a href="#Project.saveProjectAs">saveProjectAs</a></td>
 <td>Public slot to save the current project to a different file.</td>
 </tr><tr>
 <td><a href="#Project.setData">setData</a></td>
 <td>Public method to store data in the project data store.</td>
 </tr><tr>
 <td><a href="#Project.setDbgInfo">setDbgInfo</a></td>
 <td>Public method to set the debugging information.</td>
 </tr><tr>
 <td><a href="#Project.setDirty">setDirty</a></td>
 <td>Public method to set the dirty state.</td>
 </tr><tr>
 <td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td>
 <td>Public method to enable the auto update function.</td>
 </tr><tr>
 <td><a href="#Project.setStatusMonitorInterval">setStatusMonitorInterval</a></td>
 <td>Public method to se the interval of the VCS status monitor thread.</td>
 </tr><tr>
 <td><a href="#Project.startStatusMonitor">startStatusMonitor</a></td>
 <td>Public method to start the VCS status monitor thread.</td>
 </tr><tr>
 <td><a href="#Project.startswithProjectPath">startswithProjectPath</a></td>
 <td>Public method to check, if a path starts with the project path.</td>
 </tr><tr>
 <td><a href="#Project.stopStatusMonitor">stopStatusMonitor</a></td>
 <td>Public method to stop the VCS status monitor thread.</td>
 </tr><tr>
 <td><a href="#Project.unregisterProjectType">unregisterProjectType</a></td>
 <td>Public method to unregister a project type.</td>
 </tr><tr>
 <td><a href="#Project.updateFileTypes">updateFileTypes</a></td>
 <td>Public method to update the filetype associations with new default values.</td>
 </tr><tr>
 <td><a href="#Project.useSystemEol">useSystemEol</a></td>
 <td>Public method to check, if the project uses the system eol setting.</td>
 </tr><tr>
 <td><a href="#Project.writeTasks">writeTasks</a></td>
 <td>Public method to write the tasks data to an XML file (.e4t).</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="Project.__init__" ID="Project.__init__"></a>
 <h4>Project (Constructor)</h4>
 <b>Project</b>(<i>parent=None, filename=None</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent widget (usually the ui object) (QWidget)
 </dd><dt><i>filename</i></dt>
 <dd>
 optional filename of a project file to open (string)
 </dd>
 </dl><a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a>
 <h4>Project.__addRecursiveDirectory</h4>
 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>)
 <p>
         Private method used to add all files of a directory tree.
 </p><p>
         The tree is rooted at source to another one rooted at target. This
         method decents down to the lowest subdirectory.
 </p><dl>
 <dt><i>filetype</i></dt>
 <dd>
 type of files to add (string)
 </dd><dt><i>source</i></dt>
 <dd>
 source directory (string)
 </dd><dt><i>target</i></dt>
 <dd>
 target directory (string)
 </dd>
 </dl><a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a>
 <h4>Project.__addSingleDirectory</h4>
 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>)
 <p>
         Private method used to add all files of a single directory to the project.
 </p><dl>
 <dt><i>filetype</i></dt>
 <dd>
 type of files to add (string)
 </dd><dt><i>source</i></dt>
 <dd>
 source directory (string)
 </dd><dt><i>target</i></dt>
 <dd>
 target directory (string)
 </dd><dt><i>quiet</i></dt>
 <dd>
 flag indicating quiet operations (boolean)
 </dd>
 </dl><a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a>
 <h4>Project.__binaryTranslationFile</h4>
 <b>__binaryTranslationFile</b>(<i>langFile</i>)
 <p>
         Private method to calculate the filename of the binary translations file
         given the name of the raw translations file.
 </p><dl>
 <dt><i>langFile</i></dt>
 <dd>
 name of the raw translations file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 name of the binary translations file (string)
 </dd>
 </dl><a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a>
 <h4>Project.__checkFilesExist</h4>
 <b>__checkFilesExist</b>(<i>index</i>)
 <p>
         Private method to check, if the files in a list exist.
 </p><p>
         The files in the indicated list are checked for existance in the
         filesystem. Non existant files are removed from the list and the
         dirty state of the project is changed accordingly.
 </p><dl>
 <dt><i>index</i></dt>
 <dd>
 key of the list to be checked (string)
 </dd>
 </dl><a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a>
 <h4>Project.__checkProjectFileGroup</h4>
 <b>__checkProjectFileGroup</b>(<i>fn, group</i>)
 <p>
         Private method to check, if a file is in a specific file group of the project.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
 filename to be checked (string)
 </dd><dt><i>group</i></dt>
 <dd>
 group to check (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating membership (boolean)
 </dd>
 </dl><a NAME="Project.__clearRecent" ID="Project.__clearRecent"></a>
 <h4>Project.__clearRecent</h4>
 <b>__clearRecent</b>(<i></i>)
 <p>
         Private method to clear the recent projects menu.
 </p><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a>
 <h4>Project.__closeAllWindows</h4>
 <b>__closeAllWindows</b>(<i></i>)
 <p>
         Private method to close all project related windows.
 </p><a NAME="Project.__createSnapshotSource" ID="Project.__createSnapshotSource"></a>
 <h4>Project.__createSnapshotSource</h4>
 <b>__createSnapshotSource</b>(<i>filename</i>)
 <p>
         Private method to create a snapshot plugin version.
 </p><p>
         The version entry in the plugin module is modified to signify
         a snapshot version. This method appends the string "-snapshot-"
         and date indicator to the version string.
 </p><dl>
 <dt><i>filename</i></dt>
 <dd>
 name of the plugin file to modify (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 modified source (bytes), snapshot version string (string)
 </dd>
 </dl><a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a>
 <h4>Project.__createZipDirEntries</h4>
 <b>__createZipDirEntries</b>(<i>path, zipFile</i>)
 <p>
         Private method to create dir entries in the zip file.
 </p><dl>
 <dt><i>path</i></dt>
 <dd>
 name of the directory entry to create (string)
 </dd><dt><i>zipFile</i></dt>
 <dd>
 open ZipFile object (zipfile.ZipFile)
 </dd>
 </dl><a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a>
 <h4>Project.__deleteDebugProperties</h4>
 <b>__deleteDebugProperties</b>(<i></i>)
 <p>
         Private method to delete the project debugger properties file (.e4d)
 </p><a NAME="Project.__deleteSession" ID="Project.__deleteSession"></a>
 <h4>Project.__deleteSession</h4>
 <b>__deleteSession</b>(<i></i>)
 <p>
         Private method to delete the session file.
 </p><a NAME="Project.__doSearchNewFiles" ID="Project.__doSearchNewFiles"></a>
 <h4>Project.__doSearchNewFiles</h4>
 <b>__doSearchNewFiles</b>(<i>AI=True, onUserDemand=False</i>)
 <p>
         Private method to search for new files in the project directory.
 </p><p>
         If new files were found, it shows a dialog listing these files and
         gives the user the opportunity to select the ones he wants to
         include. If 'Automatic Inclusion' is enabled, the new files are
         automatically added to the project.
 </p><dl>
 <dt><i>AI</i></dt>
 <dd>
 flag indicating whether the automatic inclusion should
                 be honoured (boolean)
 </dd><dt><i>onUserDemand</i></dt>
 <dd>
 flag indicating whether this method was
                 requested by the user via a menu action (boolean)
 </dd>
 </dl><a NAME="Project.__initData" ID="Project.__initData"></a>
 <h4>Project.__initData</h4>
 <b>__initData</b>(<i></i>)
 <p>
         Private method to initialize the project data part.
 </p><a NAME="Project.__initDebugProperties" ID="Project.__initDebugProperties"></a>
 <h4>Project.__initDebugProperties</h4>
 <b>__initDebugProperties</b>(<i></i>)
 <p>
         Private method to initialize the debug properties.
 </p><a NAME="Project.__initProjectTypes" ID="Project.__initProjectTypes"></a>
 <h4>Project.__initProjectTypes</h4>
 <b>__initProjectTypes</b>(<i></i>)
 <p>
         Private method to initialize the list of supported project types.
 </p><a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a>
 <h4>Project.__loadRecent</h4>
 <b>__loadRecent</b>(<i></i>)
 <p>
         Private method to load the recently opened project filenames.
 </p><a NAME="Project.__makePpathRe" ID="Project.__makePpathRe"></a>
 <h4>Project.__makePpathRe</h4>
 <b>__makePpathRe</b>(<i></i>)
 <p>
         Private method to generate a regular expression for the project path.
 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a>
 <h4>Project.__openRecent</h4>
 <b>__openRecent</b>(<i>act</i>)
 <p>
         Private method to open a project from the list of rencently opened projects.
 </p><dl>
 <dt><i>act</i></dt>
 <dd>
 reference to the action that triggered (QAction)
 </dd>
 </dl><a NAME="Project.__pluginCreateArchive" ID="Project.__pluginCreateArchive"></a>
 <h4>Project.__pluginCreateArchive</h4>
 <b>__pluginCreateArchive</b>(<i>snapshot=False</i>)
 <p>
         Private slot to create an eric5 plugin archive.
 </p><dl>
 <dt><i>snapshot</i></dt>
 <dd>
 flag indicating a snapshot archive (boolean)
 </dd>
 </dl><a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a>
 <h4>Project.__pluginCreatePkgList</h4>
 <b>__pluginCreatePkgList</b>(<i></i>)
 <p>
         Private slot to create a PKGLIST file needed for archive file creation.
 </p><a NAME="Project.__pluginCreateSnapshotArchive" ID="Project.__pluginCreateSnapshotArchive"></a>
 <h4>Project.__pluginCreateSnapshotArchive</h4>
 <b>__pluginCreateSnapshotArchive</b>(<i></i>)
 <p>
         Private slot to create an eric5 plugin archive snapshot release.
 </p><a NAME="Project.__pluginExtractVersion" ID="Project.__pluginExtractVersion"></a>
 <h4>Project.__pluginExtractVersion</h4>
 <b>__pluginExtractVersion</b>(<i>filename</i>)
 <p>
         Private method to extract the version number entry.
 </p><dl>
 <dt><i>filename</i></dt>
 <dd>
 name of the plugin file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 version string (string)
 </dd>
 </dl><a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a>
 <h4>Project.__readDebugProperties</h4>
 <b>__readDebugProperties</b>(<i>quiet=False</i>)
 <p>
         Private method to read in the project debugger properties file (.e4d)
 </p><dl>
 <dt><i>quiet</i></dt>
 <dd>
 flag indicating quiet operations.
                 If this flag is true, no errors are reported.
 </dd>
 </dl><a NAME="Project.__readProject" ID="Project.__readProject"></a>
 <h4>Project.__readProject</h4>
 <b>__readProject</b>(<i>fn</i>)
 <p>
         Private method to read in a project (.e4p) file.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
 filename of the project file to be read (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating success
 </dd>
 </dl><a NAME="Project.__readSession" ID="Project.__readSession"></a>
 <h4>Project.__readSession</h4>
 <b>__readSession</b>(<i>quiet=False, indicator=""</i>)
 <p>
         Private method to read in the project session file (.e4s)
 </p><dl>
 <dt><i>quiet</i></dt>
 <dd>
 flag indicating quiet operations.
                 If this flag is true, no errors are reported.
 </dd><dt><i>indicator=</i></dt>
 <dd>
 indicator string (string)
 </dd>
 </dl><a NAME="Project.__readTasks" ID="Project.__readTasks"></a>
 <h4>Project.__readTasks</h4>
 <b>__readTasks</b>(<i></i>)
 <p>
         Private method to read in the project tasks file (.e4t)
 </p><a NAME="Project.__readUserProperties" ID="Project.__readUserProperties"></a>
 <h4>Project.__readUserProperties</h4>
 <b>__readUserProperties</b>(<i></i>)
 <p>
         Private method to read in the user specific project file (.e4q)
 </p><a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
 <h4>Project.__saveRecent</h4>
 <b>__saveRecent</b>(<i></i>)
 <p>
         Private method to save the list of recently opened filenames.
 </p><a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a>
 <h4>Project.__searchNewFiles</h4>
 <b>__searchNewFiles</b>(<i></i>)
 <p>
         Private slot used to handle the search new files action.
 </p><a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a>
 <h4>Project.__showCodeCoverage</h4>
 <b>__showCodeCoverage</b>(<i></i>)
 <p>
         Private slot used to show the code coverage information for the project files.
 </p><a NAME="Project.__showCodeMetrics" ID="Project.__showCodeMetrics"></a>
 <h4>Project.__showCodeMetrics</h4>
 <b>__showCodeMetrics</b>(<i></i>)
 <p>
         Private slot used to calculate some code metrics for the project files.
 </p><a NAME="Project.__showContextMenuApiDoc" ID="Project.__showContextMenuApiDoc"></a>
 <h4>Project.__showContextMenuApiDoc</h4>
 <b>__showContextMenuApiDoc</b>(<i></i>)
 <p>
         Private slot called before the apidoc menu is shown.
 </p><a NAME="Project.__showContextMenuChecks" ID="Project.__showContextMenuChecks"></a>
 <h4>Project.__showContextMenuChecks</h4>
 <b>__showContextMenuChecks</b>(<i></i>)
 <p>
         Private slot called before the checks menu is shown.
 </p><a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a>
 <h4>Project.__showContextMenuGraphics</h4>
 <b>__showContextMenuGraphics</b>(<i></i>)
 <p>
         Private slot called before the graphics menu is shown.
 </p><a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a>
 <h4>Project.__showContextMenuPackagers</h4>
 <b>__showContextMenuPackagers</b>(<i></i>)
 <p>
         Private slot called before the packagers menu is shown.
 




edde1fe80b3e
Updated documentation.

Detlev Offenbach <detlev@die-offenbachs.de>
parents: <

Mercurial Repositories > eric / annotate

Documentation/Source/eric5.Project.Project.html@e2a956fcf5e7 (annotated)

Documentation/Source/eric5.Project.Project.html