--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Project.ProjectSourcesBrowser.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,289 @@ +<?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.ProjectSourcesBrowser</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Project.ProjectSourcesBrowser</h1> +<p> +Module implementing a class used to display the Sources part of the project. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ProjectSourcesBrowser">ProjectSourcesBrowser</a></td> +<td>A class used to display the Sources part of the project.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ProjectSourcesBrowser" ID="ProjectSourcesBrowser"></a> +<h2>ProjectSourcesBrowser</h2> +<p> + A class used to display the Sources part of the project. +</p><h4>Signals</h4> +<dl> +<dt>closeSourceWindow(string)</dt> +<dd> +emitted after a file has been removed/deleted + from the project +</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. +</dd> +</dl> +<h3>Derived from</h3> +ProjectBaseBrowser +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ProjectSourcesBrowser.__init__">ProjectSourcesBrowser</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__addNewPackage">__addNewPackage</a></td> +<td>Private method to add a new package to the project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__addSourceDirectory">__addSourceDirectory</a></td> +<td>Private method to add source files of a directory to the project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__addSourceFiles">__addSourceFiles</a></td> +<td>Private method to add a source file to the project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__closeAllWindows">__closeAllWindows</a></td> +<td>Private method to close all project related windows.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__createPythonPopupMenus">__createPythonPopupMenus</a></td> +<td>Privat method to generate the popup menus for a Python project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__createRubyPopupMenus">__createRubyPopupMenus</a></td> +<td>Privat method to generate the popup menus for a Ruby project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__deleteFile">__deleteFile</a></td> +<td>Private method to delete files from the project.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td> +<td>Private method to handle the application diagram context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showClassDiagram">__showClassDiagram</a></td> +<td>Private method to handle the class diagram context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showCodeCoverage">__showCodeCoverage</a></td> +<td>Private method to handle the code coverage context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showCodeMetrics">__showCodeMetrics</a></td> +<td>Private method to handle the code metrics context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenu">__showContextMenu</a></td> +<td>Private slot called by the sourceMenu aboutToShow signal.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuBack">__showContextMenuBack</a></td> +<td>Private slot called by the backMenu aboutToShow signal.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuCheck">__showContextMenuCheck</a></td> +<td>Private slot called before the checks menu is shown.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuDir">__showContextMenuDir</a></td> +<td>Private slot called by the dirMenu aboutToShow signal.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td> +<td>Private slot called by the dirMultiMenu aboutToShow signal.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td> +<td>Private slot called before the checks menu is shown.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td> +<td>Private slot called by the multiMenu aboutToShow signal.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuShow">__showContextMenuShow</a></td> +<td>Private slot called before the show menu is shown.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showImportsDiagram">__showImportsDiagram</a></td> +<td>Private method to handle the imports diagram context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showPackageDiagram">__showPackageDiagram</a></td> +<td>Private method to handle the package diagram context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser.__showProfileData">__showProfileData</a></td> +<td>Private method to handle the show profile data context menu action.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser._contextMenuRequested">_contextMenuRequested</a></td> +<td>Protected slot to show the context menu.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser._createPopupMenus">_createPopupMenus</a></td> +<td>Protected overloaded method to generate the popup menu.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser._openItem">_openItem</a></td> +<td>Protected slot to handle the open popup menu entry.</td> +</tr><tr> +<td><a href="#ProjectSourcesBrowser._projectClosed">_projectClosed</a></td> +<td>Protected slot to handle the projectClosed signal.</td> +</tr> +</table> +<a NAME="ProjectSourcesBrowser.__init__" ID="ProjectSourcesBrowser.__init__"></a> +<h4>ProjectSourcesBrowser (Constructor)</h4> +<b>ProjectSourcesBrowser</b>(<i>project, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i></dt> +<dd> +reference to the project object +</dd><dt><i>parent</i></dt> +<dd> +parent widget of this browser (QWidget) +</dd> +</dl><a NAME="ProjectSourcesBrowser.__addNewPackage" ID="ProjectSourcesBrowser.__addNewPackage"></a> +<h4>ProjectSourcesBrowser.__addNewPackage</h4> +<b>__addNewPackage</b>(<i></i>) +<p> + Private method to add a new package to the project. +</p><a NAME="ProjectSourcesBrowser.__addSourceDirectory" ID="ProjectSourcesBrowser.__addSourceDirectory"></a> +<h4>ProjectSourcesBrowser.__addSourceDirectory</h4> +<b>__addSourceDirectory</b>(<i></i>) +<p> + Private method to add source files of a directory to the project. +</p><a NAME="ProjectSourcesBrowser.__addSourceFiles" ID="ProjectSourcesBrowser.__addSourceFiles"></a> +<h4>ProjectSourcesBrowser.__addSourceFiles</h4> +<b>__addSourceFiles</b>(<i></i>) +<p> + Private method to add a source file to the project. +</p><a NAME="ProjectSourcesBrowser.__closeAllWindows" ID="ProjectSourcesBrowser.__closeAllWindows"></a> +<h4>ProjectSourcesBrowser.__closeAllWindows</h4> +<b>__closeAllWindows</b>(<i></i>) +<p> + Private method to close all project related windows. +</p><a NAME="ProjectSourcesBrowser.__createPythonPopupMenus" ID="ProjectSourcesBrowser.__createPythonPopupMenus"></a> +<h4>ProjectSourcesBrowser.__createPythonPopupMenus</h4> +<b>__createPythonPopupMenus</b>(<i></i>) +<p> + Privat method to generate the popup menus for a Python project. +</p><a NAME="ProjectSourcesBrowser.__createRubyPopupMenus" ID="ProjectSourcesBrowser.__createRubyPopupMenus"></a> +<h4>ProjectSourcesBrowser.__createRubyPopupMenus</h4> +<b>__createRubyPopupMenus</b>(<i></i>) +<p> + Privat method to generate the popup menus for a Ruby project. +</p><a NAME="ProjectSourcesBrowser.__deleteFile" ID="ProjectSourcesBrowser.__deleteFile"></a> +<h4>ProjectSourcesBrowser.__deleteFile</h4> +<b>__deleteFile</b>(<i></i>) +<p> + Private method to delete files from the project. +</p><a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a> +<h4>ProjectSourcesBrowser.__showApplicationDiagram</h4> +<b>__showApplicationDiagram</b>(<i></i>) +<p> + Private method to handle the application diagram context menu action. +</p><a NAME="ProjectSourcesBrowser.__showClassDiagram" ID="ProjectSourcesBrowser.__showClassDiagram"></a> +<h4>ProjectSourcesBrowser.__showClassDiagram</h4> +<b>__showClassDiagram</b>(<i></i>) +<p> + Private method to handle the class diagram context menu action. +</p><a NAME="ProjectSourcesBrowser.__showCodeCoverage" ID="ProjectSourcesBrowser.__showCodeCoverage"></a> +<h4>ProjectSourcesBrowser.__showCodeCoverage</h4> +<b>__showCodeCoverage</b>(<i></i>) +<p> + Private method to handle the code coverage context menu action. +</p><a NAME="ProjectSourcesBrowser.__showCodeMetrics" ID="ProjectSourcesBrowser.__showCodeMetrics"></a> +<h4>ProjectSourcesBrowser.__showCodeMetrics</h4> +<b>__showCodeMetrics</b>(<i></i>) +<p> + Private method to handle the code metrics context menu action. +</p><a NAME="ProjectSourcesBrowser.__showContextMenu" ID="ProjectSourcesBrowser.__showContextMenu"></a> +<h4>ProjectSourcesBrowser.__showContextMenu</h4> +<b>__showContextMenu</b>(<i></i>) +<p> + Private slot called by the sourceMenu aboutToShow signal. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuBack" ID="ProjectSourcesBrowser.__showContextMenuBack"></a> +<h4>ProjectSourcesBrowser.__showContextMenuBack</h4> +<b>__showContextMenuBack</b>(<i></i>) +<p> + Private slot called by the backMenu aboutToShow signal. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuCheck" ID="ProjectSourcesBrowser.__showContextMenuCheck"></a> +<h4>ProjectSourcesBrowser.__showContextMenuCheck</h4> +<b>__showContextMenuCheck</b>(<i></i>) +<p> + Private slot called before the checks menu is shown. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuDir" ID="ProjectSourcesBrowser.__showContextMenuDir"></a> +<h4>ProjectSourcesBrowser.__showContextMenuDir</h4> +<b>__showContextMenuDir</b>(<i></i>) +<p> + Private slot called by the dirMenu aboutToShow signal. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuDirMulti" ID="ProjectSourcesBrowser.__showContextMenuDirMulti"></a> +<h4>ProjectSourcesBrowser.__showContextMenuDirMulti</h4> +<b>__showContextMenuDirMulti</b>(<i></i>) +<p> + Private slot called by the dirMultiMenu aboutToShow signal. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a> +<h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4> +<b>__showContextMenuGraphics</b>(<i></i>) +<p> + Private slot called before the checks menu is shown. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuMulti" ID="ProjectSourcesBrowser.__showContextMenuMulti"></a> +<h4>ProjectSourcesBrowser.__showContextMenuMulti</h4> +<b>__showContextMenuMulti</b>(<i></i>) +<p> + Private slot called by the multiMenu aboutToShow signal. +</p><a NAME="ProjectSourcesBrowser.__showContextMenuShow" ID="ProjectSourcesBrowser.__showContextMenuShow"></a> +<h4>ProjectSourcesBrowser.__showContextMenuShow</h4> +<b>__showContextMenuShow</b>(<i></i>) +<p> + Private slot called before the show menu is shown. +</p><a NAME="ProjectSourcesBrowser.__showImportsDiagram" ID="ProjectSourcesBrowser.__showImportsDiagram"></a> +<h4>ProjectSourcesBrowser.__showImportsDiagram</h4> +<b>__showImportsDiagram</b>(<i></i>) +<p> + Private method to handle the imports diagram context menu action. +</p><a NAME="ProjectSourcesBrowser.__showPackageDiagram" ID="ProjectSourcesBrowser.__showPackageDiagram"></a> +<h4>ProjectSourcesBrowser.__showPackageDiagram</h4> +<b>__showPackageDiagram</b>(<i></i>) +<p> + Private method to handle the package diagram context menu action. +</p><a NAME="ProjectSourcesBrowser.__showProfileData" ID="ProjectSourcesBrowser.__showProfileData"></a> +<h4>ProjectSourcesBrowser.__showProfileData</h4> +<b>__showProfileData</b>(<i></i>) +<p> + Private method to handle the show profile data context menu action. +</p><a NAME="ProjectSourcesBrowser._contextMenuRequested" ID="ProjectSourcesBrowser._contextMenuRequested"></a> +<h4>ProjectSourcesBrowser._contextMenuRequested</h4> +<b>_contextMenuRequested</b>(<i>coord</i>) +<p> + Protected slot to show the context menu. +</p><dl> +<dt><i>coord</i></dt> +<dd> +the position of the mouse pointer (QPoint) +</dd> +</dl><a NAME="ProjectSourcesBrowser._createPopupMenus" ID="ProjectSourcesBrowser._createPopupMenus"></a> +<h4>ProjectSourcesBrowser._createPopupMenus</h4> +<b>_createPopupMenus</b>(<i></i>) +<p> + Protected overloaded method to generate the popup menu. +</p><a NAME="ProjectSourcesBrowser._openItem" ID="ProjectSourcesBrowser._openItem"></a> +<h4>ProjectSourcesBrowser._openItem</h4> +<b>_openItem</b>(<i></i>) +<p> + Protected slot to handle the open popup menu entry. +</p><a NAME="ProjectSourcesBrowser._projectClosed" ID="ProjectSourcesBrowser._projectClosed"></a> +<h4>ProjectSourcesBrowser._projectClosed</h4> +<b>_projectClosed</b>(<i></i>) +<p> + Protected slot to handle the projectClosed signal. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file