--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonFileManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonFileManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,38 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonFileManager</h1>
-
<p>
Module implementing some file system commands for MicroPython.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonFileManager">MicroPythonFileManager</a></td>
<td>Class implementing an interface to the device file system commands with some additional sugar.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonFileManager" ID="MicroPythonFileManager"></a>
<h2>MicroPythonFileManager</h2>
-
<p>
Class implementing an interface to the device file system commands with
some additional sugar.
</p>
+
<h3>Signals</h3>
<dl>
@@ -109,19 +108,17 @@
<h3>Derived from</h3>
QObject
<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="#MicroPythonFileManager.__init__">MicroPythonFileManager</a></td>
<td>Constructor</td>
@@ -191,19 +188,20 @@
<td>Public method to write some text to a file on the connected device.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicroPythonFileManager.__init__" ID="MicroPythonFileManager.__init__"></a>
<h4>MicroPythonFileManager (Constructor)</h4>
<b>MicroPythonFileManager</b>(<i>device, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>device</i> (BaseDevice)</dt>
@@ -218,10 +216,10 @@
<a NAME="MicroPythonFileManager.__rsync" ID="MicroPythonFileManager.__rsync"></a>
<h4>MicroPythonFileManager.__rsync</h4>
<b>__rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False, indentLevel=0, </i>)
-
<p>
Private method to synchronize a local directory to the device.
</p>
+
<dl>
<dt><i>hostDirectory</i> (str)</dt>
@@ -261,10 +259,10 @@
<a NAME="MicroPythonFileManager.cd" ID="MicroPythonFileManager.cd"></a>
<h4>MicroPythonFileManager.cd</h4>
<b>cd</b>(<i>dirname</i>)
-
<p>
Public slot to change the current directory of the device.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -275,10 +273,10 @@
<a NAME="MicroPythonFileManager.delete" ID="MicroPythonFileManager.delete"></a>
<h4>MicroPythonFileManager.delete</h4>
<b>delete</b>(<i>deviceFileName</i>)
-
<p>
Public slot to delete a file on the device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -289,10 +287,10 @@
<a NAME="MicroPythonFileManager.exists" ID="MicroPythonFileManager.exists"></a>
<h4>MicroPythonFileManager.exists</h4>
<b>exists</b>(<i>pathname</i>)
-
<p>
Public method to check the existence of a file or directory.
</p>
+
<dl>
<dt><i>pathname</i> (str)</dt>
@@ -315,18 +313,18 @@
<a NAME="MicroPythonFileManager.fileSystemInfo" ID="MicroPythonFileManager.fileSystemInfo"></a>
<h4>MicroPythonFileManager.fileSystemInfo</h4>
<b>fileSystemInfo</b>(<i></i>)
-
<p>
Public method to obtain information about the currently mounted file
systems.
</p>
+
<a NAME="MicroPythonFileManager.get" ID="MicroPythonFileManager.get"></a>
<h4>MicroPythonFileManager.get</h4>
<b>get</b>(<i>deviceFileName, hostFileName=""</i>)
-
<p>
Public slot to get a file from the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -341,10 +339,10 @@
<a NAME="MicroPythonFileManager.getData" ID="MicroPythonFileManager.getData"></a>
<h4>MicroPythonFileManager.getData</h4>
<b>getData</b>(<i>deviceFileName</i>)
-
<p>
Public method to read data from the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -367,10 +365,10 @@
<a NAME="MicroPythonFileManager.lls" ID="MicroPythonFileManager.lls"></a>
<h4>MicroPythonFileManager.lls</h4>
<b>lls</b>(<i>dirname, showHidden=False</i>)
-
<p>
Public slot to get a long listing of the given directory.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -385,10 +383,10 @@
<a NAME="MicroPythonFileManager.makedirs" ID="MicroPythonFileManager.makedirs"></a>
<h4>MicroPythonFileManager.makedirs</h4>
<b>makedirs</b>(<i>dirname</i>)
-
<p>
Public slot to create a new directory and all intermediates.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -399,10 +397,10 @@
<a NAME="MicroPythonFileManager.mkdir" ID="MicroPythonFileManager.mkdir"></a>
<h4>MicroPythonFileManager.mkdir</h4>
<b>mkdir</b>(<i>dirname</i>)
-
<p>
Public slot to create a new directory.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -413,10 +411,10 @@
<a NAME="MicroPythonFileManager.put" ID="MicroPythonFileManager.put"></a>
<h4>MicroPythonFileManager.put</h4>
<b>put</b>(<i>hostFileName, deviceFileName=""</i>)
-
<p>
Public slot to put a file onto the device.
</p>
+
<dl>
<dt><i>hostFileName</i> (str)</dt>
@@ -431,10 +429,10 @@
<a NAME="MicroPythonFileManager.putData" ID="MicroPythonFileManager.putData"></a>
<h4>MicroPythonFileManager.putData</h4>
<b>putData</b>(<i>deviceFileName, data</i>)
-
<p>
Public method to write data to the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -449,17 +447,17 @@
<a NAME="MicroPythonFileManager.pwd" ID="MicroPythonFileManager.pwd"></a>
<h4>MicroPythonFileManager.pwd</h4>
<b>pwd</b>(<i></i>)
-
<p>
Public slot to get the current directory of the device.
</p>
+
<a NAME="MicroPythonFileManager.rmdir" ID="MicroPythonFileManager.rmdir"></a>
<h4>MicroPythonFileManager.rmdir</h4>
<b>rmdir</b>(<i>dirname, recursive=False</i>)
-
<p>
Public slot to (recursively) remove a directory.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -474,10 +472,10 @@
<a NAME="MicroPythonFileManager.rsync" ID="MicroPythonFileManager.rsync"></a>
<h4>MicroPythonFileManager.rsync</h4>
<b>rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False</i>)
-
<p>
Public slot to synchronize a local directory to the device.
</p>
+
<dl>
<dt><i>hostDirectory</i> (str)</dt>
@@ -501,10 +499,10 @@
<a NAME="MicroPythonFileManager.writeFile" ID="MicroPythonFileManager.writeFile"></a>
<h4>MicroPythonFileManager.writeFile</h4>
<b>writeFile</b>(<i>filename, text</i>)
-
<p>
Public method to write some text to a file on the connected device.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -530,4 +528,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
