RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html	Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,145 @@
+<?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>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</h1>
+<p>
+Module implementing file system commands for rope.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#e5FileSystemCommands">e5FileSystemCommands</a></td>
+<td>Class implementing file system commands for rope.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="e5FileSystemCommands" ID="e5FileSystemCommands"></a>
+<h2>e5FileSystemCommands</h2>
+<p>
+    Class implementing file system commands for rope.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#e5FileSystemCommands.__init__">e5FileSystemCommands</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#e5FileSystemCommands.create_file">create_file</a></td>
+<td>Public method called by rope to create a new file.</td>
+</tr><tr>
+<td><a href="#e5FileSystemCommands.create_folder">create_folder</a></td>
+<td>Public method called by rope to create a new directory.</td>
+</tr><tr>
+<td><a href="#e5FileSystemCommands.move">move</a></td>
+<td>Public method called by rope to rename a file or directory.</td>
+</tr><tr>
+<td><a href="#e5FileSystemCommands.remove">remove</a></td>
+<td>Public method called by rope to remove a file or directory.</td>
+</tr><tr>
+<td><a href="#e5FileSystemCommands.write">write</a></td>
+<td>Public method called by rope to write data to a file.</td>
+</tr>
+</table>
+<a NAME="e5FileSystemCommands.__init__" ID="e5FileSystemCommands.__init__"></a>
+<h4>e5FileSystemCommands (Constructor)</h4>
+<b>e5FileSystemCommands</b>(<i>project</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>project</i></dt>
+<dd>
+reference to the eric4 project object (Project.Project)
+</dd>
+</dl><a NAME="e5FileSystemCommands.create_file" ID="e5FileSystemCommands.create_file"></a>
+<h4>e5FileSystemCommands.create_file</h4>
+<b>create_file</b>(<i>path</i>)
+<p>
+        Public method called by rope to create a new file.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+new filename (string)
+</dd>
+</dl><a NAME="e5FileSystemCommands.create_folder" ID="e5FileSystemCommands.create_folder"></a>
+<h4>e5FileSystemCommands.create_folder</h4>
+<b>create_folder</b>(<i>path</i>)
+<p>
+        Public method called by rope to create a new directory.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+new directory (string)
+</dd>
+</dl><a NAME="e5FileSystemCommands.move" ID="e5FileSystemCommands.move"></a>
+<h4>e5FileSystemCommands.move</h4>
+<b>move</b>(<i>path, new_location</i>)
+<p>
+        Public method called by rope to rename a file or directory.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+old file/directory name (string)
+</dd><dt><i>new_location</i></dt>
+<dd>
+new file/directory name (string)
+</dd>
+</dl><a NAME="e5FileSystemCommands.remove" ID="e5FileSystemCommands.remove"></a>
+<h4>e5FileSystemCommands.remove</h4>
+<b>remove</b>(<i>path</i>)
+<p>
+        Public method called by rope to remove a file or directory.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+name of file/directory to remove (string)
+</dd>
+</dl><a NAME="e5FileSystemCommands.write" ID="e5FileSystemCommands.write"></a>
+<h4>e5FileSystemCommands.write</h4>
+<b>write</b>(<i>path, data</i>)
+<p>
+        Public method called by rope to write data to a file.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+filename of file to write to (string)
+</dd><dt><i>data</i></dt>
+<dd>
+dat to be written
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial