--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,38 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Project.ProjectBaseBrowser</h1>
-
<p>
Module implementing the baseclass for the various project browsers.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ProjectBaseBrowser">ProjectBaseBrowser</a></td>
<td>Baseclass implementing common functionality for the various project browsers.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ProjectBaseBrowser" ID="ProjectBaseBrowser"></a>
<h2>ProjectBaseBrowser</h2>
-
<p>
Baseclass implementing common functionality for the various project
browsers.
</p>
+
<h3>Signals</h3>
<dl>
@@ -50,19 +49,17 @@
<h3>Derived from</h3>
Browser
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ProjectBaseBrowser.__init__">ProjectBaseBrowser</a></td>
<td>Constructor</td>
@@ -252,19 +249,20 @@
<td>Public slot to handle the select VCS files context menu entries.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBaseBrowser.__init__" ID="ProjectBaseBrowser.__init__"></a>
<h4>ProjectBaseBrowser (Constructor)</h4>
<b>ProjectBaseBrowser</b>(<i>project, filterType, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -283,10 +281,10 @@
<a NAME="ProjectBaseBrowser.__checkHookKey" ID="ProjectBaseBrowser.__checkHookKey"></a>
<h4>ProjectBaseBrowser.__checkHookKey</h4>
<b>__checkHookKey</b>(<i>key</i>)
-
<p>
Private method to check a hook key.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -304,10 +302,10 @@
<a NAME="ProjectBaseBrowser.__modelRowsInserted" ID="ProjectBaseBrowser.__modelRowsInserted"></a>
<h4>ProjectBaseBrowser.__modelRowsInserted</h4>
<b>__modelRowsInserted</b>(<i>parent, start, end</i>)
-
<p>
Private slot called after rows have been inserted into the model.
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -326,24 +324,24 @@
<a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a>
<h4>ProjectBaseBrowser._collapseAllDirs</h4>
<b>_collapseAllDirs</b>(<i></i>)
-
<p>
Protected slot to handle the 'Collapse all directories' menu action.
</p>
+
<a NAME="ProjectBaseBrowser._collapseAllFiles" ID="ProjectBaseBrowser._collapseAllFiles"></a>
<h4>ProjectBaseBrowser._collapseAllFiles</h4>
<b>_collapseAllFiles</b>(<i></i>)
-
<p>
Protected slot to handle the 'Collapse all files' menu action.
</p>
+
<a NAME="ProjectBaseBrowser._completeRepopulateItem" ID="ProjectBaseBrowser._completeRepopulateItem"></a>
<h4>ProjectBaseBrowser._completeRepopulateItem</h4>
<b>_completeRepopulateItem</b>(<i>name</i>)
-
<p>
Protected slot to handle the completeRepopulateItem signal.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -354,24 +352,24 @@
<a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a>
<h4>ProjectBaseBrowser._configure</h4>
<b>_configure</b>(<i></i>)
-
<p>
Protected method to open the configuration dialog.
</p>
+
<a NAME="ProjectBaseBrowser._connectExpandedCollapsed" ID="ProjectBaseBrowser._connectExpandedCollapsed"></a>
<h4>ProjectBaseBrowser._connectExpandedCollapsed</h4>
<b>_connectExpandedCollapsed</b>(<i></i>)
-
<p>
Protected method to connect the expanded and collapsed signals.
</p>
+
<a NAME="ProjectBaseBrowser._contextMenuRequested" ID="ProjectBaseBrowser._contextMenuRequested"></a>
<h4>ProjectBaseBrowser._contextMenuRequested</h4>
<b>_contextMenuRequested</b>(<i>coord</i>)
-
<p>
Protected slot to show the context menu.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -382,43 +380,42 @@
<a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a>
<h4>ProjectBaseBrowser._copyToClipboard</h4>
<b>_copyToClipboard</b>(<i></i>)
-
<p>
Protected method to copy the path of an entry to the clipboard.
</p>
+
<a NAME="ProjectBaseBrowser._createPopupMenus" ID="ProjectBaseBrowser._createPopupMenus"></a>
<h4>ProjectBaseBrowser._createPopupMenus</h4>
<b>_createPopupMenus</b>(<i></i>)
-
<p>
Protected overloaded method to generate the popup menus.
</p>
+
<a NAME="ProjectBaseBrowser._deleteDirectory" ID="ProjectBaseBrowser._deleteDirectory"></a>
<h4>ProjectBaseBrowser._deleteDirectory</h4>
<b>_deleteDirectory</b>(<i></i>)
-
<p>
Protected method to delete the selected directory from the project
data area.
</p>
+
<a NAME="ProjectBaseBrowser._disconnectExpandedCollapsed" ID="ProjectBaseBrowser._disconnectExpandedCollapsed"></a>
<h4>ProjectBaseBrowser._disconnectExpandedCollapsed</h4>
<b>_disconnectExpandedCollapsed</b>(<i></i>)
-
<p>
Protected method to disconnect the expanded and collapsed signals.
</p>
+
<a NAME="ProjectBaseBrowser._expandAllDirs" ID="ProjectBaseBrowser._expandAllDirs"></a>
<h4>ProjectBaseBrowser._expandAllDirs</h4>
<b>_expandAllDirs</b>(<i></i>)
-
<p>
Protected slot to handle the 'Expand all directories' menu action.
</p>
+
<a NAME="ProjectBaseBrowser._initHookMethods" ID="ProjectBaseBrowser._initHookMethods"></a>
<h4>ProjectBaseBrowser._initHookMethods</h4>
<b>_initHookMethods</b>(<i></i>)
-
<p>
Protected method to initialize the hooks dictionary.
</p>
@@ -427,20 +424,21 @@
hook methods should be initialized with a None value. The keys
must be strings.
</p>
+
<a NAME="ProjectBaseBrowser._initMenusAndVcs" ID="ProjectBaseBrowser._initMenusAndVcs"></a>
<h4>ProjectBaseBrowser._initMenusAndVcs</h4>
<b>_initMenusAndVcs</b>(<i></i>)
-
<p>
Protected slot to initialize the menus and the Vcs interface.
</p>
+
<a NAME="ProjectBaseBrowser._keyboardSearchType" ID="ProjectBaseBrowser._keyboardSearchType"></a>
<h4>ProjectBaseBrowser._keyboardSearchType</h4>
<b>_keyboardSearchType</b>(<i>item</i>)
-
<p>
Protected method to check, if the item is of the correct type.
</p>
+
<dl>
<dt><i>item</i> (BrowserItem)</dt>
@@ -463,17 +461,17 @@
<a NAME="ProjectBaseBrowser._newProject" ID="ProjectBaseBrowser._newProject"></a>
<h4>ProjectBaseBrowser._newProject</h4>
<b>_newProject</b>(<i></i>)
-
<p>
Protected slot to handle the newProject signal.
</p>
+
<a NAME="ProjectBaseBrowser._prepareRepopulateItem" ID="ProjectBaseBrowser._prepareRepopulateItem"></a>
<h4>ProjectBaseBrowser._prepareRepopulateItem</h4>
<b>_prepareRepopulateItem</b>(<i>name</i>)
-
<p>
Protected slot to handle the prepareRepopulateItem signal.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -484,45 +482,45 @@
<a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a>
<h4>ProjectBaseBrowser._projectClosed</h4>
<b>_projectClosed</b>(<i></i>)
-
<p>
Protected slot to handle the projectClosed signal.
</p>
+
<a NAME="ProjectBaseBrowser._projectOpened" ID="ProjectBaseBrowser._projectOpened"></a>
<h4>ProjectBaseBrowser._projectOpened</h4>
<b>_projectOpened</b>(<i></i>)
-
<p>
Protected slot to handle the projectOpened signal.
</p>
+
<a NAME="ProjectBaseBrowser._removeDir" ID="ProjectBaseBrowser._removeDir"></a>
<h4>ProjectBaseBrowser._removeDir</h4>
<b>_removeDir</b>(<i></i>)
-
<p>
Protected method to remove a (single) directory from the project.
</p>
+
<a NAME="ProjectBaseBrowser._removeFile" ID="ProjectBaseBrowser._removeFile"></a>
<h4>ProjectBaseBrowser._removeFile</h4>
<b>_removeFile</b>(<i></i>)
-
<p>
Protected method to remove a file or files from the project.
</p>
+
<a NAME="ProjectBaseBrowser._renameFile" ID="ProjectBaseBrowser._renameFile"></a>
<h4>ProjectBaseBrowser._renameFile</h4>
<b>_renameFile</b>(<i></i>)
-
<p>
Protected method to rename a file of the project.
</p>
+
<a NAME="ProjectBaseBrowser._selectEntries" ID="ProjectBaseBrowser._selectEntries"></a>
<h4>ProjectBaseBrowser._selectEntries</h4>
<b>_selectEntries</b>(<i>local=True, filterList=None</i>)
-
<p>
Protected method to select entries based on their VCS status.
</p>
+
<dl>
<dt><i>local</i> (boolean))</dt>
@@ -538,10 +536,10 @@
<a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a>
<h4>ProjectBaseBrowser._selectSingleItem</h4>
<b>_selectSingleItem</b>(<i>index</i>)
-
<p>
Protected method to select a single item.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -552,10 +550,10 @@
<a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a>
<h4>ProjectBaseBrowser._setItemRangeSelected</h4>
<b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>)
-
<p>
Protected method to set the selection status of a range of items.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -574,10 +572,10 @@
<a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a>
<h4>ProjectBaseBrowser._setItemSelected</h4>
<b>_setItemSelected</b>(<i>index, selected</i>)
-
<p>
Protected method to set the selection status of an item.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -592,7 +590,6 @@
<a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a>
<h4>ProjectBaseBrowser._showContextMenu</h4>
<b>_showContextMenu</b>(<i>menu</i>)
-
<p>
Protected slot called before the context menu is shown.
</p>
@@ -600,6 +597,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the file status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -610,10 +608,10 @@
<a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a>
<h4>ProjectBaseBrowser._showContextMenuBack</h4>
<b>_showContextMenuBack</b>(<i>menu</i>)
-
<p>
Protected slot called before the context menu is shown.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -624,7 +622,6 @@
<a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a>
<h4>ProjectBaseBrowser._showContextMenuDir</h4>
<b>_showContextMenuDir</b>(<i>menu</i>)
-
<p>
Protected slot called before the context menu is shown.
</p>
@@ -632,6 +629,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the directory status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -642,7 +640,6 @@
<a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a>
<h4>ProjectBaseBrowser._showContextMenuDirMulti</h4>
<b>_showContextMenuDirMulti</b>(<i>menu</i>)
-
<p>
Protected slot called before the context menu is shown.
</p>
@@ -650,6 +647,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the directory status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -660,7 +658,6 @@
<a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a>
<h4>ProjectBaseBrowser._showContextMenuMulti</h4>
<b>_showContextMenuMulti</b>(<i>menu</i>)
-
<p>
Protected slot called before the context menu (multiple selections) is
shown.
@@ -669,6 +666,7 @@
It enables/disables the VCS menu entries depending on the overall
VCS status and the files status.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -679,17 +677,17 @@
<a NAME="ProjectBaseBrowser._showProjectInFileManager" ID="ProjectBaseBrowser._showProjectInFileManager"></a>
<h4>ProjectBaseBrowser._showProjectInFileManager</h4>
<b>_showProjectInFileManager</b>(<i></i>)
-
<p>
Protected slot to show the path of the project in a file manager application.
</p>
+
<a NAME="ProjectBaseBrowser.addHookMethod" ID="ProjectBaseBrowser.addHookMethod"></a>
<h4>ProjectBaseBrowser.addHookMethod</h4>
<b>addHookMethod</b>(<i>key, method</i>)
-
<p>
Public method to add a hook method to the dictionary.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -704,10 +702,10 @@
<a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a>
<h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4>
<b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>)
-
<p>
Public method to add a hook method to the dictionary.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -726,10 +724,10 @@
<a NAME="ProjectBaseBrowser.currentDirectory" ID="ProjectBaseBrowser.currentDirectory"></a>
<h4>ProjectBaseBrowser.currentDirectory</h4>
<b>currentDirectory</b>(<i>relative=False</i>)
-
<p>
Public method to determine the directory of the currently selected entry.
</p>
+
<dl>
<dt><i>relative</i> (bool)</dt>
@@ -752,10 +750,10 @@
<a NAME="ProjectBaseBrowser.currentItem" ID="ProjectBaseBrowser.currentItem"></a>
<h4>ProjectBaseBrowser.currentItem</h4>
<b>currentItem</b>(<i></i>)
-
<p>
Public method to get a reference to the current item.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -771,10 +769,10 @@
<a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a>
<h4>ProjectBaseBrowser.expandItemsByName</h4>
<b>expandItemsByName</b>(<i>names</i>)
-
<p>
Public method to expand items given their names.
</p>
+
<dl>
<dt><i>names</i> (list of str)</dt>
@@ -785,10 +783,10 @@
<a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a>
<h4>ProjectBaseBrowser.getExpandedItemNames</h4>
<b>getExpandedItemNames</b>(<i></i>)
-
<p>
Public method to get the file/directory names of all expanded items.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -804,10 +802,10 @@
<a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a>
<h4>ProjectBaseBrowser.removeHookMethod</h4>
<b>removeHookMethod</b>(<i>key</i>)
-
<p>
Public method to remove a hook method from the dictionary.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -818,10 +816,10 @@
<a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a>
<h4>ProjectBaseBrowser.selectFile</h4>
<b>selectFile</b>(<i>fn</i>)
-
<p>
Public method to highlight a node given its filename.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -832,10 +830,10 @@
<a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a>
<h4>ProjectBaseBrowser.selectFileLine</h4>
<b>selectFileLine</b>(<i>fn, lineno</i>)
-
<p>
Public method to highlight a node given its filename.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -850,32 +848,32 @@
<a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a>
<h4>ProjectBaseBrowser.selectLocalDirEntries</h4>
<b>selectLocalDirEntries</b>(<i></i>)
-
<p>
Public slot to handle the select local directories context menu
entries.
</p>
+
<a NAME="ProjectBaseBrowser.selectLocalEntries" ID="ProjectBaseBrowser.selectLocalEntries"></a>
<h4>ProjectBaseBrowser.selectLocalEntries</h4>
<b>selectLocalEntries</b>(<i></i>)
-
<p>
Public slot to handle the select local files context menu entries.
</p>
+
<a NAME="ProjectBaseBrowser.selectVCSDirEntries" ID="ProjectBaseBrowser.selectVCSDirEntries"></a>
<h4>ProjectBaseBrowser.selectVCSDirEntries</h4>
<b>selectVCSDirEntries</b>(<i></i>)
-
<p>
Public slot to handle the select VCS directories context menu entries.
</p>
+
<a NAME="ProjectBaseBrowser.selectVCSEntries" ID="ProjectBaseBrowser.selectVCSEntries"></a>
<h4>ProjectBaseBrowser.selectVCSEntries</h4>
<b>selectVCSEntries</b>(<i></i>)
-
<p>
Public slot to handle the select VCS files context menu entries.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
