diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.UI.Browser.html --- a/src/eric7/Documentation/Source/eric7.UI.Browser.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.UI.Browser.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,34 +7,32 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.UI.Browser</h1> - <p> Module implementing a browser with class browsing capabilities. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#Browser">Browser</a></td> <td>Class used to display a file system tree.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="Browser" ID="Browser"></a> <h2>Browser</h2> - <p> Class used to display a file system tree. </p> @@ -43,6 +41,7 @@ is displayed by a right click the user can select various actions on the selected file. </p> + <h3>Signals</h3> <dl> @@ -127,19 +126,17 @@ <h3>Derived from</h3> QTreeView <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="#Browser.__init__">Browser</a></td> <td>Constructor</td> @@ -313,19 +310,20 @@ <td>Public method to check type of an item.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="Browser.__init__" ID="Browser.__init__"></a> <h4>Browser (Constructor)</h4> <b>Browser</b>(<i>parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>parent</i> (QWidget)</dt> @@ -336,24 +334,24 @@ <a NAME="Browser.__addAsToplevelDir" ID="Browser.__addAsToplevelDir"></a> <h4>Browser.__addAsToplevelDir</h4> <b>__addAsToplevelDir</b>(<i></i>) - <p> Private slot to handle the Add as toplevel directory popup menu entry. </p> + <a NAME="Browser.__createPopupMenus" ID="Browser.__createPopupMenus"></a> <h4>Browser.__createPopupMenus</h4> <b>__createPopupMenus</b>(<i></i>) - <p> Private method to generate the various popup menus. </p> + <a NAME="Browser.__deleteDirectory" ID="Browser.__deleteDirectory"></a> <h4>Browser.__deleteDirectory</h4> <b>__deleteDirectory</b>(<i>dn</i>) - <p> Private method to delete a directory. </p> + <dl> <dt><i>dn</i> (str)</dt> @@ -364,10 +362,10 @@ <a NAME="Browser.__deleteFile" ID="Browser.__deleteFile"></a> <h4>Browser.__deleteFile</h4> <b>__deleteFile</b>(<i>fn</i>) - <p> Private method to delete a file. </p> + <dl> <dt><i>fn</i> (str)</dt> @@ -378,7 +376,6 @@ <a NAME="Browser.__deleteMultiple" ID="Browser.__deleteMultiple"></a> <h4>Browser.__deleteMultiple</h4> <b>__deleteMultiple</b>(<i></i>) - <p> Private slot to delete multiple directories and files. </p> @@ -386,62 +383,63 @@ Note: The context menu for multi selection is only shown for file items. </p> + <a NAME="Browser.__findInDirectory" ID="Browser.__findInDirectory"></a> <h4>Browser.__findInDirectory</h4> <b>__findInDirectory</b>(<i></i>) - <p> Private slot to handle the Find in directory popup menu entry. </p> + <a NAME="Browser.__newToplevelDir" ID="Browser.__newToplevelDir"></a> <h4>Browser.__newToplevelDir</h4> <b>__newToplevelDir</b>(<i></i>) - <p> Private slot to handle the New toplevel directory popup menu entry. </p> + <a NAME="Browser.__refreshDirectory" ID="Browser.__refreshDirectory"></a> <h4>Browser.__refreshDirectory</h4> <b>__refreshDirectory</b>(<i></i>) - <p> Private slot to refresh a directory entry. </p> + <a NAME="Browser.__refreshSource" ID="Browser.__refreshSource"></a> <h4>Browser.__refreshSource</h4> <b>__refreshSource</b>(<i></i>) - <p> Private slot to refresh the structure of a source file. </p> + <a NAME="Browser.__removeToplevel" ID="Browser.__removeToplevel"></a> <h4>Browser.__removeToplevel</h4> <b>__removeToplevel</b>(<i></i>) - <p> Private slot to handle the Remove from toplevel popup menu entry. </p> + <a NAME="Browser.__replaceInDirectory" ID="Browser.__replaceInDirectory"></a> <h4>Browser.__replaceInDirectory</h4> <b>__replaceInDirectory</b>(<i></i>) - <p> Private slot to handle the Find&Replace in directory popup menu entry. </p> + <a NAME="Browser.__showMimeType" ID="Browser.__showMimeType"></a> <h4>Browser.__showMimeType</h4> <b>__showMimeType</b>(<i></i>) - <p> Private slot to show the mime type of the selected entry. </p> + <a NAME="Browser._contextMenuRequested" ID="Browser._contextMenuRequested"></a> <h4>Browser._contextMenuRequested</h4> <b>_contextMenuRequested</b>(<i>coord</i>) - <p> Protected slot to show the context menu of the listview. </p> + <dl> <dt><i>coord</i> (QPoint)</dt> @@ -452,31 +450,31 @@ <a NAME="Browser._copyToClipboard" ID="Browser._copyToClipboard"></a> <h4>Browser._copyToClipboard</h4> <b>_copyToClipboard</b>(<i></i>) - <p> Protected method to copy the text shown for an entry to the clipboard. </p> + <a NAME="Browser._deleteFileOrDirectory" ID="Browser._deleteFileOrDirectory"></a> <h4>Browser._deleteFileOrDirectory</h4> <b>_deleteFileOrDirectory</b>(<i></i>) - <p> Protected slot to delete a directory or file. </p> + <a NAME="Browser._editPixmap" ID="Browser._editPixmap"></a> <h4>Browser._editPixmap</h4> <b>_editPixmap</b>(<i></i>) - <p> Protected slot to handle the open in icon editor popup menu entry. </p> + <a NAME="Browser._gotoAttribute" ID="Browser._gotoAttribute"></a> <h4>Browser._gotoAttribute</h4> <b>_gotoAttribute</b>(<i>act</i>) - <p> Protected slot to handle the selection of the goto menu. </p> + <dl> <dt><i>act</i> (EricAction)</dt> @@ -487,18 +485,18 @@ <a NAME="Browser._init" ID="Browser._init"></a> <h4>Browser._init</h4> <b>_init</b>(<i></i>) - <p> Protected method to perform initialization tasks common to this base class and all derived classes. </p> + <a NAME="Browser._keyboardSearchType" ID="Browser._keyboardSearchType"></a> <h4>Browser._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> @@ -521,73 +519,73 @@ <a NAME="Browser._newDirectory" ID="Browser._newDirectory"></a> <h4>Browser._newDirectory</h4> <b>_newDirectory</b>(<i></i>) - <p> Protected slot to create a new directory. </p> + <a NAME="Browser._newFile" ID="Browser._newFile"></a> <h4>Browser._newFile</h4> <b>_newFile</b>(<i></i>) - <p> Protected slot to create a new file. </p> + <a NAME="Browser._openFileInEditor" ID="Browser._openFileInEditor"></a> <h4>Browser._openFileInEditor</h4> <b>_openFileInEditor</b>(<i></i>) - <p> Protected slot to handle the Open in Editor menu action. </p> + <a NAME="Browser._openHexEditor" ID="Browser._openHexEditor"></a> <h4>Browser._openHexEditor</h4> <b>_openHexEditor</b>(<i></i>) - <p> Protected slot to handle the open in hex editor popup menu entry. </p> + <a NAME="Browser._openItem" ID="Browser._openItem"></a> <h4>Browser._openItem</h4> <b>_openItem</b>(<i></i>) - <p> Protected slot to handle the open popup menu entry. </p> + <a NAME="Browser._openPdfViewer" ID="Browser._openPdfViewer"></a> <h4>Browser._openPdfViewer</h4> <b>_openPdfViewer</b>(<i></i>) - <p> Protected slot to handle the open in PDF viewer popup menu entry. </p> + <a NAME="Browser._resizeColumns" ID="Browser._resizeColumns"></a> <h4>Browser._resizeColumns</h4> <b>_resizeColumns</b>(<i></i>) - <p> Protected slot to resize the view when items get expanded or collapsed. </p> + <a NAME="Browser._resort" ID="Browser._resort"></a> <h4>Browser._resort</h4> <b>_resort</b>(<i></i>) - <p> Protected slot to resort the tree. </p> + <a NAME="Browser._showGotoMenu" ID="Browser._showGotoMenu"></a> <h4>Browser._showGotoMenu</h4> <b>_showGotoMenu</b>(<i></i>) - <p> Protected slot to prepare the goto submenu of the attribute menu. </p> + <a NAME="Browser._showHidden" ID="Browser._showHidden"></a> <h4>Browser._showHidden</h4> <b>_showHidden</b>(<i>checked</i>) - <p> Protected slot to show or hide hidden files. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -598,17 +596,17 @@ <a NAME="Browser._showInFileManager" ID="Browser._showInFileManager"></a> <h4>Browser._showInFileManager</h4> <b>_showInFileManager</b>(<i></i>) - <p> Protected method to show the selected items path in a file manager application. </p> + <a NAME="Browser.getSelectedItems" ID="Browser.getSelectedItems"></a> <h4>Browser.getSelectedItems</h4> <b>getSelectedItems</b>(<i>filterList=None</i>) - <p> Public method to get the selected items. </p> + <dl> <dt><i>filterList</i> (list of Class)</dt> @@ -631,10 +629,10 @@ <a NAME="Browser.getSelectedItemsCount" ID="Browser.getSelectedItemsCount"></a> <h4>Browser.getSelectedItemsCount</h4> <b>getSelectedItemsCount</b>(<i>filterList=None</i>) - <p> Public method to get the count of items selected. </p> + <dl> <dt><i>filterList</i> (list of Class)</dt> @@ -657,10 +655,10 @@ <a NAME="Browser.getSelectedItemsCountCategorized" ID="Browser.getSelectedItemsCountCategorized"></a> <h4>Browser.getSelectedItemsCountCategorized</h4> <b>getSelectedItemsCountCategorized</b>(<i>filterList=None</i>) - <p> Public method to get a categorized count of selected items. </p> + <dl> <dt><i>filterList</i> (list of Class)</dt> @@ -688,10 +686,10 @@ <a NAME="Browser.handleInterpreterChanged" ID="Browser.handleInterpreterChanged"></a> <h4>Browser.handleInterpreterChanged</h4> <b>handleInterpreterChanged</b>(<i>interpreter</i>) - <p> Public slot to handle a change of the debug client's interpreter. </p> + <dl> <dt><i>interpreter</i> (str)</dt> @@ -702,17 +700,17 @@ <a NAME="Browser.handlePreferencesChanged" ID="Browser.handlePreferencesChanged"></a> <h4>Browser.handlePreferencesChanged</h4> <b>handlePreferencesChanged</b>(<i></i>) - <p> Public slot used to handle the preferencesChanged signal. </p> + <a NAME="Browser.handleProgramChange" ID="Browser.handleProgramChange"></a> <h4>Browser.handleProgramChange</h4> <b>handleProgramChange</b>(<i>fn</i>) - <p> Public slot to handle the programChange signal. </p> + <dl> <dt><i>fn</i> (str)</dt> @@ -723,17 +721,17 @@ <a NAME="Browser.handleTesting" ID="Browser.handleTesting"></a> <h4>Browser.handleTesting</h4> <b>handleTesting</b>(<i></i>) - <p> Public slot to handle the testing popup menu entry. </p> + <a NAME="Browser.keyboardSearch" ID="Browser.keyboardSearch"></a> <h4>Browser.keyboardSearch</h4> <b>keyboardSearch</b>(<i>search</i>) - <p> Public function to search the tree via the keyboard. </p> + <dl> <dt><i>search</i> (str)</dt> @@ -744,14 +742,13 @@ <a NAME="Browser.layoutDisplay" ID="Browser.layoutDisplay"></a> <h4>Browser.layoutDisplay</h4> <b>layoutDisplay</b>(<i></i>) - <p> Public slot to perform a layout operation. </p> + <a NAME="Browser.mouseDoubleClickEvent" ID="Browser.mouseDoubleClickEvent"></a> <h4>Browser.mouseDoubleClickEvent</h4> <b>mouseDoubleClickEvent</b>(<i>mouseEvent</i>) - <p> Protected method of QAbstractItemView. </p> @@ -759,6 +756,7 @@ Reimplemented to disable expanding/collapsing of items when double-clicking. Instead the double-clicked entry is opened. </p> + <dl> <dt><i>mouseEvent</i> (QMouseEvent)</dt> @@ -769,17 +767,17 @@ <a NAME="Browser.saveToplevelDirs" ID="Browser.saveToplevelDirs"></a> <h4>Browser.saveToplevelDirs</h4> <b>saveToplevelDirs</b>(<i></i>) - <p> Public slot to save the toplevel directories. </p> + <a NAME="Browser.wantedItem" ID="Browser.wantedItem"></a> <h4>Browser.wantedItem</h4> <b>wantedItem</b>(<i>itm, filterList=None</i>) - <p> Public method to check type of an item. </p> + <dl> <dt><i>itm</i> (BrowserItem)</dt> @@ -805,4 +803,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>