Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html
- changeset 17
- a0fac63ef73f
- child 44
- 8aa985c8dee5
equal
deleted
inserted
replaced
| 16:65b340b40844 | 17:a0fac63ef73f |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</h1> | |
| 24 <p> | |
| 25 Module implementing file system commands for rope. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#e5FileSystemCommands">e5FileSystemCommands</a></td> | |
| 35 <td>Class implementing file system commands for rope.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="e5FileSystemCommands" ID="e5FileSystemCommands"></a> | |
| 44 <h2>e5FileSystemCommands</h2> | |
| 45 <p> | |
| 46 Class implementing file system commands for rope. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 object | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#e5FileSystemCommands.__init__">e5FileSystemCommands</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#e5FileSystemCommands.create_file">create_file</a></td> | |
| 61 <td>Public method called by rope to create a new file.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#e5FileSystemCommands.create_folder">create_folder</a></td> | |
| 64 <td>Public method called by rope to create a new directory.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#e5FileSystemCommands.move">move</a></td> | |
| 67 <td>Public method called by rope to rename a file or directory.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#e5FileSystemCommands.remove">remove</a></td> | |
| 70 <td>Public method called by rope to remove a file or directory.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#e5FileSystemCommands.write">write</a></td> | |
| 73 <td>Public method called by rope to write data to a file.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <a NAME="e5FileSystemCommands.__init__" ID="e5FileSystemCommands.__init__"></a> | |
| 77 <h4>e5FileSystemCommands (Constructor)</h4> | |
| 78 <b>e5FileSystemCommands</b>(<i>project</i>) | |
| 79 <p> | |
| 80 Constructor | |
| 81 </p><dl> | |
| 82 <dt><i>project</i></dt> | |
| 83 <dd> | |
| 84 reference to the eric4 project object (Project.Project) | |
| 85 </dd> | |
| 86 </dl><a NAME="e5FileSystemCommands.create_file" ID="e5FileSystemCommands.create_file"></a> | |
| 87 <h4>e5FileSystemCommands.create_file</h4> | |
| 88 <b>create_file</b>(<i>path</i>) | |
| 89 <p> | |
| 90 Public method called by rope to create a new file. | |
| 91 </p><dl> | |
| 92 <dt><i>path</i></dt> | |
| 93 <dd> | |
| 94 new filename (string) | |
| 95 </dd> | |
| 96 </dl><a NAME="e5FileSystemCommands.create_folder" ID="e5FileSystemCommands.create_folder"></a> | |
| 97 <h4>e5FileSystemCommands.create_folder</h4> | |
| 98 <b>create_folder</b>(<i>path</i>) | |
| 99 <p> | |
| 100 Public method called by rope to create a new directory. | |
| 101 </p><dl> | |
| 102 <dt><i>path</i></dt> | |
| 103 <dd> | |
| 104 new directory (string) | |
| 105 </dd> | |
| 106 </dl><a NAME="e5FileSystemCommands.move" ID="e5FileSystemCommands.move"></a> | |
| 107 <h4>e5FileSystemCommands.move</h4> | |
| 108 <b>move</b>(<i>path, new_location</i>) | |
| 109 <p> | |
| 110 Public method called by rope to rename a file or directory. | |
| 111 </p><dl> | |
| 112 <dt><i>path</i></dt> | |
| 113 <dd> | |
| 114 old file/directory name (string) | |
| 115 </dd><dt><i>new_location</i></dt> | |
| 116 <dd> | |
| 117 new file/directory name (string) | |
| 118 </dd> | |
| 119 </dl><a NAME="e5FileSystemCommands.remove" ID="e5FileSystemCommands.remove"></a> | |
| 120 <h4>e5FileSystemCommands.remove</h4> | |
| 121 <b>remove</b>(<i>path</i>) | |
| 122 <p> | |
| 123 Public method called by rope to remove a file or directory. | |
| 124 </p><dl> | |
| 125 <dt><i>path</i></dt> | |
| 126 <dd> | |
| 127 name of file/directory to remove (string) | |
| 128 </dd> | |
| 129 </dl><a NAME="e5FileSystemCommands.write" ID="e5FileSystemCommands.write"></a> | |
| 130 <h4>e5FileSystemCommands.write</h4> | |
| 131 <b>write</b>(<i>path, data</i>) | |
| 132 <p> | |
| 133 Public method called by rope to write data to a file. | |
| 134 </p><dl> | |
| 135 <dt><i>path</i></dt> | |
| 136 <dd> | |
| 137 filename of file to write to (string) | |
| 138 </dd><dt><i>data</i></dt> | |
| 139 <dd> | |
| 140 dat to be written | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <div align="right"><a href="#top">Up</a></div> | |
| 144 <hr /> | |
| 145 </body></html> |
