--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonFileManagerWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonFileManagerWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonFileManagerWidget</h1>
-
<p>
Module implementing a file manager for MicroPython devices.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonFileManagerWidget">MicroPythonFileManagerWidget</a></td>
<td>Class implementing a file manager for MicroPython devices.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonFileManagerWidget" ID="MicroPythonFileManagerWidget"></a>
<h2>MicroPythonFileManagerWidget</h2>
-
<p>
Class implementing a file manager for MicroPython devices.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_MicroPythonFileManagerWidget
<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="#MicroPythonFileManagerWidget.__init__">MicroPythonFileManagerWidget</a></td>
<td>Constructor</td>
@@ -247,19 +244,20 @@
<td>Public method to stop the widget.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicroPythonFileManagerWidget.__init__" ID="MicroPythonFileManagerWidget.__init__"></a>
<h4>MicroPythonFileManagerWidget (Constructor)</h4>
<b>MicroPythonFileManagerWidget</b>(<i>fileManager, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>fileManager</i> (MicroPythonFileManager)</dt>
@@ -274,7 +272,6 @@
<a NAME="MicroPythonFileManagerWidget.__changeDeviceDirectory" ID="MicroPythonFileManagerWidget.__changeDeviceDirectory"></a>
<h4>MicroPythonFileManagerWidget.__changeDeviceDirectory</h4>
<b>__changeDeviceDirectory</b>(<i></i>)
-
<p>
Private slot to change the current directory of the device.
</p>
@@ -282,13 +279,14 @@
Note: This triggers a re-population of the device list for the new
current directory.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__changeLocalDirectory" ID="MicroPythonFileManagerWidget.__changeLocalDirectory"></a>
<h4>MicroPythonFileManagerWidget.__changeLocalDirectory</h4>
<b>__changeLocalDirectory</b>(<i>localDevice=False</i>)
-
<p>
Private slot to change the local directory.
</p>
+
<dl>
<dt><i>localDevice</i> (bool)</dt>
@@ -299,17 +297,17 @@
<a NAME="MicroPythonFileManagerWidget.__createDeviceDirectory" ID="MicroPythonFileManagerWidget.__createDeviceDirectory"></a>
<h4>MicroPythonFileManagerWidget.__createDeviceDirectory</h4>
<b>__createDeviceDirectory</b>(<i></i>)
-
<p>
Private slot to create a directory on the device.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__createLocalDirectory" ID="MicroPythonFileManagerWidget.__createLocalDirectory"></a>
<h4>MicroPythonFileManagerWidget.__createLocalDirectory</h4>
<b>__createLocalDirectory</b>(<i>localDevice=False</i>)
-
<p>
Private slot to create a local directory.
</p>
+
<dl>
<dt><i>localDevice</i> (bool)</dt>
@@ -320,32 +318,32 @@
<a NAME="MicroPythonFileManagerWidget.__deleteDeviceDirectory" ID="MicroPythonFileManagerWidget.__deleteDeviceDirectory"></a>
<h4>MicroPythonFileManagerWidget.__deleteDeviceDirectory</h4>
<b>__deleteDeviceDirectory</b>(<i></i>)
-
<p>
Private slot to delete an empty directory on the device.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__deleteDeviceDirectoryTree" ID="MicroPythonFileManagerWidget.__deleteDeviceDirectoryTree"></a>
<h4>MicroPythonFileManagerWidget.__deleteDeviceDirectoryTree</h4>
<b>__deleteDeviceDirectoryTree</b>(<i></i>)
-
<p>
Private slot to delete a directory and all its subdirectories
recursively.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__deleteDeviceFile" ID="MicroPythonFileManagerWidget.__deleteDeviceFile"></a>
<h4>MicroPythonFileManagerWidget.__deleteDeviceFile</h4>
<b>__deleteDeviceFile</b>(<i></i>)
-
<p>
Private slot to delete a file.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__deleteLocalDirectoryTree" ID="MicroPythonFileManagerWidget.__deleteLocalDirectoryTree"></a>
<h4>MicroPythonFileManagerWidget.__deleteLocalDirectoryTree</h4>
<b>__deleteLocalDirectoryTree</b>(<i>localDevice=False</i>)
-
<p>
Private slot to delete a local directory tree.
</p>
+
<dl>
<dt><i>localDevice</i> (bool)</dt>
@@ -356,10 +354,10 @@
<a NAME="MicroPythonFileManagerWidget.__deleteLocalFile" ID="MicroPythonFileManagerWidget.__deleteLocalFile"></a>
<h4>MicroPythonFileManagerWidget.__deleteLocalFile</h4>
<b>__deleteLocalFile</b>(<i>localDevice=False</i>)
-
<p>
Private slot to delete a local file.
</p>
+
<dl>
<dt><i>localDevice</i> (bool)</dt>
@@ -370,10 +368,10 @@
<a NAME="MicroPythonFileManagerWidget.__deviceHiddenChanged" ID="MicroPythonFileManagerWidget.__deviceHiddenChanged"></a>
<h4>MicroPythonFileManagerWidget.__deviceHiddenChanged</h4>
<b>__deviceHiddenChanged</b>(<i>checked</i>)
-
<p>
Private slot handling a change of the device show hidden menu entry.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -384,10 +382,10 @@
<a NAME="MicroPythonFileManagerWidget.__fsInfoResultReceived" ID="MicroPythonFileManagerWidget.__fsInfoResultReceived"></a>
<h4>MicroPythonFileManagerWidget.__fsInfoResultReceived</h4>
<b>__fsInfoResultReceived</b>(<i>fsinfo</i>)
-
<p>
Private slot to show the file system information of the device.
</p>
+
<dl>
<dt><i>fsinfo</i> (tuple of tuples of (str, int, int, int))</dt>
@@ -399,10 +397,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleCurrentDir" ID="MicroPythonFileManagerWidget.__handleCurrentDir"></a>
<h4>MicroPythonFileManagerWidget.__handleCurrentDir</h4>
<b>__handleCurrentDir</b>(<i>dirname</i>)
-
<p>
Private slot to handle a change of the current directory of the device.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -413,10 +411,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleError" ID="MicroPythonFileManagerWidget.__handleError"></a>
<h4>MicroPythonFileManagerWidget.__handleError</h4>
<b>__handleError</b>(<i>method, error</i>)
-
<p>
Private slot to handle errors.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -431,10 +429,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleGetDone" ID="MicroPythonFileManagerWidget.__handleGetDone"></a>
<h4>MicroPythonFileManagerWidget.__handleGetDone</h4>
<b>__handleGetDone</b>(<i>deviceFile, localFile</i>)
-
<p>
Private slot handling a successful copy of a file from the device.
</p>
+
<dl>
<dt><i>deviceFile</i> (str)</dt>
@@ -449,10 +447,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleLongListFiles" ID="MicroPythonFileManagerWidget.__handleLongListFiles"></a>
<h4>MicroPythonFileManagerWidget.__handleLongListFiles</h4>
<b>__handleLongListFiles</b>(<i>filesList</i>)
-
<p>
Private slot to receive a long directory listing.
</p>
+
<dl>
<dt><i>filesList</i> (tuple of (str, str, str, str))</dt>
@@ -464,10 +462,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleRsyncDone" ID="MicroPythonFileManagerWidget.__handleRsyncDone"></a>
<h4>MicroPythonFileManagerWidget.__handleRsyncDone</h4>
<b>__handleRsyncDone</b>(<i>localDir, deviceDir</i>)
-
<p>
Private method to handle the completion of the rsync operation.
</p>
+
<dl>
<dt><i>localDir</i> (str)</dt>
@@ -482,10 +480,10 @@
<a NAME="MicroPythonFileManagerWidget.__handleRsyncProgressMessage" ID="MicroPythonFileManagerWidget.__handleRsyncProgressMessage"></a>
<h4>MicroPythonFileManagerWidget.__handleRsyncProgressMessage</h4>
<b>__handleRsyncProgressMessage</b>(<i>message</i>)
-
<p>
Private slot handling progress messages sent by the file manager.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -496,10 +494,10 @@
<a NAME="MicroPythonFileManagerWidget.__isFileInList" ID="MicroPythonFileManagerWidget.__isFileInList"></a>
<h4>MicroPythonFileManagerWidget.__isFileInList</h4>
<b>__isFileInList</b>(<i>filename, treeWidget</i>)
-
<p>
Private method to check, if a file name is contained in a tree widget.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -526,10 +524,10 @@
<a NAME="MicroPythonFileManagerWidget.__listLocalFiles" ID="MicroPythonFileManagerWidget.__listLocalFiles"></a>
<h4>MicroPythonFileManagerWidget.__listLocalFiles</h4>
<b>__listLocalFiles</b>(<i>dirname="", localDevice=False</i>)
-
<p>
Private method to populate the local files list.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -544,10 +542,10 @@
<a NAME="MicroPythonFileManagerWidget.__localHiddenChanged" ID="MicroPythonFileManagerWidget.__localHiddenChanged"></a>
<h4>MicroPythonFileManagerWidget.__localHiddenChanged</h4>
<b>__localHiddenChanged</b>(<i>checked</i>)
-
<p>
Private slot handling a change of the local show hidden menu entry.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -558,24 +556,24 @@
<a NAME="MicroPythonFileManagerWidget.__newDeviceList" ID="MicroPythonFileManagerWidget.__newDeviceList"></a>
<h4>MicroPythonFileManagerWidget.__newDeviceList</h4>
<b>__newDeviceList</b>(<i></i>)
-
<p>
Private slot to initiate a new long list of the device directory.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__progressInfoDialogFinished" ID="MicroPythonFileManagerWidget.__progressInfoDialogFinished"></a>
<h4>MicroPythonFileManagerWidget.__progressInfoDialogFinished</h4>
<b>__progressInfoDialogFinished</b>(<i></i>)
-
<p>
Private slot handling the closing of the progress info dialog.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__showDeviceContextMenu" ID="MicroPythonFileManagerWidget.__showDeviceContextMenu"></a>
<h4>MicroPythonFileManagerWidget.__showDeviceContextMenu</h4>
<b>__showDeviceContextMenu</b>(<i>pos</i>)
-
<p>
Private slot to show the REPL context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -586,17 +584,17 @@
<a NAME="MicroPythonFileManagerWidget.__showFileSystemInfo" ID="MicroPythonFileManagerWidget.__showFileSystemInfo"></a>
<h4>MicroPythonFileManagerWidget.__showFileSystemInfo</h4>
<b>__showFileSystemInfo</b>(<i></i>)
-
<p>
Private slot to show some file system information.
</p>
+
<a NAME="MicroPythonFileManagerWidget.__showLocalContextMenu" ID="MicroPythonFileManagerWidget.__showLocalContextMenu"></a>
<h4>MicroPythonFileManagerWidget.__showLocalContextMenu</h4>
<b>__showLocalContextMenu</b>(<i>pos</i>)
-
<p>
Private slot to show the REPL context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -607,10 +605,10 @@
<a NAME="MicroPythonFileManagerWidget.on_deviceCwd_textChanged" ID="MicroPythonFileManagerWidget.on_deviceCwd_textChanged"></a>
<h4>MicroPythonFileManagerWidget.on_deviceCwd_textChanged</h4>
<b>on_deviceCwd_textChanged</b>(<i>cwd</i>)
-
<p>
Private slot handling a change of the current device working directory.
</p>
+
<dl>
<dt><i>cwd</i> (str)</dt>
@@ -621,7 +619,6 @@
<a NAME="MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemActivated" ID="MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemActivated"></a>
<h4>MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemActivated</h4>
<b>on_deviceFileTreeWidget_itemActivated</b>(<i>item, column</i>)
-
<p>
Private slot to handle the activation of a device item.
</p>
@@ -629,6 +626,7 @@
If the item is a directory, the current working directory is changed
and the list will be re-populated for this directory.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -643,46 +641,46 @@
<a NAME="MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemSelectionChanged" ID="MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemSelectionChanged"></a>
<h4>MicroPythonFileManagerWidget.on_deviceFileTreeWidget_itemSelectionChanged</h4>
<b>on_deviceFileTreeWidget_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot handling a change of selection in the local pane.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_deviceHomeButton_clicked" ID="MicroPythonFileManagerWidget.on_deviceHomeButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_deviceHomeButton_clicked</h4>
<b>on_deviceHomeButton_clicked</b>(<i></i>)
-
<p>
Private slot to move to the device home directory.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_deviceReloadButton_clicked" ID="MicroPythonFileManagerWidget.on_deviceReloadButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_deviceReloadButton_clicked</h4>
<b>on_deviceReloadButton_clicked</b>(<i></i>)
-
<p>
Private slot to reload the device list.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_deviceUpButton_clicked" ID="MicroPythonFileManagerWidget.on_deviceUpButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_deviceUpButton_clicked</h4>
<b>on_deviceUpButton_clicked</b>(<i></i>)
-
<p>
Private slot to go up one directory level on the device.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_getAsButton_clicked" ID="MicroPythonFileManagerWidget.on_getAsButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_getAsButton_clicked</h4>
<b>on_getAsButton_clicked</b>(<i></i>)
-
<p>
Private slot to copy the selected file from the connected device
with a different name.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_getButton_clicked" ID="MicroPythonFileManagerWidget.on_getButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_getButton_clicked</h4>
<b>on_getButton_clicked</b>(<i>getAs=False</i>)
-
<p>
Private slot to copy the selected file from the connected device.
</p>
+
<dl>
<dt><i>getAs</i> (bool)</dt>
@@ -693,10 +691,10 @@
<a NAME="MicroPythonFileManagerWidget.on_localCwd_textChanged" ID="MicroPythonFileManagerWidget.on_localCwd_textChanged"></a>
<h4>MicroPythonFileManagerWidget.on_localCwd_textChanged</h4>
<b>on_localCwd_textChanged</b>(<i>cwd</i>)
-
<p>
Private slot handling a change of the current local working directory.
</p>
+
<dl>
<dt><i>cwd</i> (str)</dt>
@@ -707,7 +705,6 @@
<a NAME="MicroPythonFileManagerWidget.on_localFileTreeWidget_itemActivated" ID="MicroPythonFileManagerWidget.on_localFileTreeWidget_itemActivated"></a>
<h4>MicroPythonFileManagerWidget.on_localFileTreeWidget_itemActivated</h4>
<b>on_localFileTreeWidget_itemActivated</b>(<i>item, column</i>)
-
<p>
Private slot to handle the activation of a local item.
</p>
@@ -715,6 +712,7 @@
If the item is a directory, the list will be re-populated for this
directory.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -729,53 +727,53 @@
<a NAME="MicroPythonFileManagerWidget.on_localFileTreeWidget_itemSelectionChanged" ID="MicroPythonFileManagerWidget.on_localFileTreeWidget_itemSelectionChanged"></a>
<h4>MicroPythonFileManagerWidget.on_localFileTreeWidget_itemSelectionChanged</h4>
<b>on_localFileTreeWidget_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot handling a change of selection in the local pane.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_localHomeButton_clicked" ID="MicroPythonFileManagerWidget.on_localHomeButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_localHomeButton_clicked</h4>
<b>on_localHomeButton_clicked</b>(<i></i>)
-
<p>
Private slot to change directory to the configured workspace.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_localReloadButton_clicked" ID="MicroPythonFileManagerWidget.on_localReloadButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_localReloadButton_clicked</h4>
<b>on_localReloadButton_clicked</b>(<i></i>)
-
<p>
Private slot to reload the local list.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_localUpButton_clicked" ID="MicroPythonFileManagerWidget.on_localUpButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_localUpButton_clicked</h4>
<b>on_localUpButton_clicked</b>(<i></i>)
-
<p>
Private slot to go up one directory level.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_openButton_clicked" ID="MicroPythonFileManagerWidget.on_openButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_openButton_clicked</h4>
<b>on_openButton_clicked</b>(<i></i>)
-
<p>
Private slot to open the selected file in a new editor.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_putAsButton_clicked" ID="MicroPythonFileManagerWidget.on_putAsButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_putAsButton_clicked</h4>
<b>on_putAsButton_clicked</b>(<i></i>)
-
<p>
Private slot to copy the selected file to the connected device
with a different name.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_putButton_clicked" ID="MicroPythonFileManagerWidget.on_putButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_putButton_clicked</h4>
<b>on_putButton_clicked</b>(<i>putAs=False</i>)
-
<p>
Private slot to copy the selected file to the connected device.
</p>
+
<dl>
<dt><i>putAs</i> (bool)</dt>
@@ -786,17 +784,17 @@
<a NAME="MicroPythonFileManagerWidget.on_saveAsButton_clicked" ID="MicroPythonFileManagerWidget.on_saveAsButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_saveAsButton_clicked</h4>
<b>on_saveAsButton_clicked</b>(<i></i>)
-
<p>
Private slot to save the current editor in a new file on the connected device.
</p>
+
<a NAME="MicroPythonFileManagerWidget.on_saveButton_clicked" ID="MicroPythonFileManagerWidget.on_saveButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_saveButton_clicked</h4>
<b>on_saveButton_clicked</b>(<i>saveAs=False</i>)
-
<p>
Private slot to save the text of the current editor to a file on the device.
</p>
+
<dl>
<dt><i>saveAs</i> (bool)</dt>
@@ -807,24 +805,24 @@
<a NAME="MicroPythonFileManagerWidget.on_syncButton_clicked" ID="MicroPythonFileManagerWidget.on_syncButton_clicked"></a>
<h4>MicroPythonFileManagerWidget.on_syncButton_clicked</h4>
<b>on_syncButton_clicked</b>(<i></i>)
-
<p>
Private slot to synchronize the local directory to the device.
</p>
+
<a NAME="MicroPythonFileManagerWidget.start" ID="MicroPythonFileManagerWidget.start"></a>
<h4>MicroPythonFileManagerWidget.start</h4>
<b>start</b>(<i></i>)
-
<p>
Public method to start the widget.
</p>
+
<a NAME="MicroPythonFileManagerWidget.stop" ID="MicroPythonFileManagerWidget.stop"></a>
<h4>MicroPythonFileManagerWidget.stop</h4>
<b>stop</b>(<i></i>)
-
<p>
Public method to stop the widget.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
