Documentation/Source/eric5.Project.ProjectOthersBrowser.html

<?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.ProjectOthersBrowser</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Project.ProjectOthersBrowser</h1>
<p>
Module implementing a class used to display the parts of the project, that don't fit 
the other categories.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#ProjectOthersBrowser">ProjectOthersBrowser</a></td>
<td>A class used to display the parts of the project, that don't fit the other categories.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="ProjectOthersBrowser" ID="ProjectOthersBrowser"></a>
<h2>ProjectOthersBrowser</h2>
<p>
    A class used to display the parts of the project, that don't fit the other categories.
</p><h4>Signals</h4>
<dl>
<dt>closeSourceWindow(string)</dt>
<dd>
emitted after a file has been removed/deleted
            from the project
</dd><dt>pixmapEditFile(string)</dt>
<dd>
emitted to edit a pixmap file
</dd><dt>pixmapFile(string)</dt>
<dd>
emitted to open a pixmap file
</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><dt>sourceFile(string)</dt>
<dd>
emitted to open a file
</dd><dt>svgFile(string)</dt>
<dd>
emitted to open a SVG file
</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="#ProjectOthersBrowser.__init__">ProjectOthersBrowser</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__deleteItem">__deleteItem</a></td>
<td>Private method to delete the selected entry from the OTHERS project data area.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__refreshItem">__refreshItem</a></td>
<td>Private slot to refresh (repopulate) an item.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__removeItem">__removeItem</a></td>
<td>Private slot to remove the selected entry from the OTHERS project data area.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__showContextMenu">__showContextMenu</a></td>
<td>Private slot called by the menu aboutToShow signal.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__showContextMenuBack">__showContextMenuBack</a></td>
<td>Private slot called by the backMenu aboutToShow signal.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td>
<td>Private slot called by the multiMenu aboutToShow signal.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser._contextMenuRequested">_contextMenuRequested</a></td>
<td>Protected slot to show the context menu.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser._createPopupMenus">_createPopupMenus</a></td>
<td>Protected overloaded method to generate the popup menu.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser._editPixmap">_editPixmap</a></td>
<td>Protected slot to handle the open in icon editor popup menu entry.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser._openItem">_openItem</a></td>
<td>Protected slot to handle the open popup menu entry.</td>
</tr><tr>
<td><a href="#ProjectOthersBrowser._showContextMenu">_showContextMenu</a></td>
<td>Protected slot called before the context menu is shown.</td>
</tr>
</table>
<a NAME="ProjectOthersBrowser.__init__" ID="ProjectOthersBrowser.__init__"></a>
<h4>ProjectOthersBrowser (Constructor)</h4>
<b>ProjectOthersBrowser</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="ProjectOthersBrowser.__deleteItem" ID="ProjectOthersBrowser.__deleteItem"></a>
<h4>ProjectOthersBrowser.__deleteItem</h4>
<b>__deleteItem</b>(<i></i>)
<p>
        Private method to delete the selected entry from the OTHERS project data area.
</p><a NAME="ProjectOthersBrowser.__refreshItem" ID="ProjectOthersBrowser.__refreshItem"></a>
<h4>ProjectOthersBrowser.__refreshItem</h4>
<b>__refreshItem</b>(<i></i>)
<p>
        Private slot to refresh (repopulate) an item.
</p><a NAME="ProjectOthersBrowser.__removeItem" ID="ProjectOthersBrowser.__removeItem"></a>
<h4>ProjectOthersBrowser.__removeItem</h4>
<b>__removeItem</b>(<i></i>)
<p>
        Private slot to remove the selected entry from the OTHERS project data area.
</p><a NAME="ProjectOthersBrowser.__showContextMenu" ID="ProjectOthersBrowser.__showContextMenu"></a>
<h4>ProjectOthersBrowser.__showContextMenu</h4>
<b>__showContextMenu</b>(<i></i>)
<p>
        Private slot called by the menu aboutToShow signal.
</p><a NAME="ProjectOthersBrowser.__showContextMenuBack" ID="ProjectOthersBrowser.__showContextMenuBack"></a>
<h4>ProjectOthersBrowser.__showContextMenuBack</h4>
<b>__showContextMenuBack</b>(<i></i>)
<p>
        Private slot called by the backMenu aboutToShow signal.
</p><a NAME="ProjectOthersBrowser.__showContextMenuMulti" ID="ProjectOthersBrowser.__showContextMenuMulti"></a>
<h4>ProjectOthersBrowser.__showContextMenuMulti</h4>
<b>__showContextMenuMulti</b>(<i></i>)
<p>
        Private slot called by the multiMenu aboutToShow signal.
</p><a NAME="ProjectOthersBrowser._contextMenuRequested" ID="ProjectOthersBrowser._contextMenuRequested"></a>
<h4>ProjectOthersBrowser._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="ProjectOthersBrowser._createPopupMenus" ID="ProjectOthersBrowser._createPopupMenus"></a>
<h4>ProjectOthersBrowser._createPopupMenus</h4>
<b>_createPopupMenus</b>(<i></i>)
<p>
        Protected overloaded method to generate the popup menu.
</p><a NAME="ProjectOthersBrowser._editPixmap" ID="ProjectOthersBrowser._editPixmap"></a>
<h4>ProjectOthersBrowser._editPixmap</h4>
<b>_editPixmap</b>(<i></i>)
<p>
        Protected slot to handle the open in icon editor popup menu entry.
</p><a NAME="ProjectOthersBrowser._openItem" ID="ProjectOthersBrowser._openItem"></a>
<h4>ProjectOthersBrowser._openItem</h4>
<b>_openItem</b>(<i></i>)
<p>
        Protected slot to handle the open popup menu entry.
</p><a NAME="ProjectOthersBrowser._showContextMenu" ID="ProjectOthersBrowser._showContextMenu"></a>
<h4>ProjectOthersBrowser._showContextMenu</h4>
<b>_showContextMenu</b>(<i>menu</i>)
<p>
        Protected slot called before the context menu is shown. 
</p><p>
        It enables/disables the VCS menu entries depending on the overall 
        VCS status and the file status.
</p><dl>
<dt><i>menu</i></dt>
<dd>
Reference to the popup menu (QPopupMenu)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>