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
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 55
- d501156be247
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td> | 33 <td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td> |
| 34 <td>Class implementing file system commands for rope.</td> | 34 <td>Class implementing file system commands for rope.</td> |
| 35 </tr><tr> | |
| 36 <td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td> | |
| 37 <td>Class implementing the client side of the rope file system commands.</td> | |
| 35 </tr> | 38 </tr> |
| 36 </table> | 39 </table> |
| 37 <h3>Functions</h3> | 40 <h3>Functions</h3> |
| 38 <table> | 41 <table> |
| 39 <tr><td>None</td></tr> | 42 <tr><td>None</td></tr> |
| 58 <table> | 61 <table> |
| 59 <tr> | 62 <tr> |
| 60 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td> | 63 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td> |
| 61 <td>Constructor</td> | 64 <td>Constructor</td> |
| 62 </tr><tr> | 65 </tr><tr> |
| 63 <td><a href="#E5FileSystemCommands.create_file">create_file</a></td> | 66 <td><a href="#E5FileSystemCommands.__createFile">__createFile</a></td> |
| 64 <td>Public method called by rope to create a new file.</td> | 67 <td>Private method called by rope to create a new file.</td> |
| 65 </tr><tr> | 68 </tr><tr> |
| 66 <td><a href="#E5FileSystemCommands.create_folder">create_folder</a></td> | 69 <td><a href="#E5FileSystemCommands.__createFolder">__createFolder</a></td> |
| 67 <td>Public method called by rope to create a new directory.</td> | 70 <td>Private method called by rope to create a new directory.</td> |
| 68 </tr><tr> | 71 </tr><tr> |
| 69 <td><a href="#E5FileSystemCommands.move">move</a></td> | 72 <td><a href="#E5FileSystemCommands.__move">__move</a></td> |
| 70 <td>Public method called by rope to rename a file or directory.</td> | 73 <td>Private method called by rope to rename a file or directory.</td> |
| 71 </tr><tr> | 74 </tr><tr> |
| 72 <td><a href="#E5FileSystemCommands.remove">remove</a></td> | 75 <td><a href="#E5FileSystemCommands.__remove">__remove</a></td> |
| 73 <td>Public method called by rope to remove a file or directory.</td> | 76 <td>Private method called by rope to remove a file or directory.</td> |
| 74 </tr><tr> | 77 </tr><tr> |
| 75 <td><a href="#E5FileSystemCommands.write">write</a></td> | 78 <td><a href="#E5FileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td> |
| 76 <td>Public method called by rope to write data to a file.</td> | 79 <td>Public method to process rope file system commands.</td> |
| 77 </tr> | 80 </tr> |
| 78 </table> | 81 </table> |
| 79 <h3>Static Methods</h3> | 82 <h3>Static Methods</h3> |
| 80 <table> | 83 <table> |
| 81 <tr><td>None</td></tr> | 84 <tr><td>None</td></tr> |
| 84 <h4>E5FileSystemCommands (Constructor)</h4> | 87 <h4>E5FileSystemCommands (Constructor)</h4> |
| 85 <b>E5FileSystemCommands</b>(<i>project</i>) | 88 <b>E5FileSystemCommands</b>(<i>project</i>) |
| 86 <p> | 89 <p> |
| 87 Constructor | 90 Constructor |
| 88 </p><dl> | 91 </p><dl> |
| 89 <dt><i>project</i></dt> | 92 <dt><i>project</i> (Project.Project)</dt> |
| 90 <dd> | 93 <dd> |
| 91 reference to the eric4 project object (Project.Project) | 94 reference to the eric project object |
| 92 </dd> | 95 </dd> |
| 93 </dl><a NAME="E5FileSystemCommands.create_file" ID="E5FileSystemCommands.create_file"></a> | 96 </dl><a NAME="E5FileSystemCommands.__createFile" ID="E5FileSystemCommands.__createFile"></a> |
| 94 <h4>E5FileSystemCommands.create_file</h4> | 97 <h4>E5FileSystemCommands.__createFile</h4> |
| 98 <b>__createFile</b>(<i>path</i>) | |
| 99 <p> | |
| 100 Private method called by rope to create a new file. | |
| 101 </p><dl> | |
| 102 <dt><i>path</i> (str)</dt> | |
| 103 <dd> | |
| 104 new filename | |
| 105 </dd> | |
| 106 </dl><a NAME="E5FileSystemCommands.__createFolder" ID="E5FileSystemCommands.__createFolder"></a> | |
| 107 <h4>E5FileSystemCommands.__createFolder</h4> | |
| 108 <b>__createFolder</b>(<i>path</i>) | |
| 109 <p> | |
| 110 Private method called by rope to create a new directory. | |
| 111 </p><dl> | |
| 112 <dt><i>path</i> (str)</dt> | |
| 113 <dd> | |
| 114 new directory | |
| 115 </dd> | |
| 116 </dl><a NAME="E5FileSystemCommands.__move" ID="E5FileSystemCommands.__move"></a> | |
| 117 <h4>E5FileSystemCommands.__move</h4> | |
| 118 <b>__move</b>(<i>path, new_location</i>) | |
| 119 <p> | |
| 120 Private method called by rope to rename a file or directory. | |
| 121 </p><dl> | |
| 122 <dt><i>path</i> (str)</dt> | |
| 123 <dd> | |
| 124 old file/directory name | |
| 125 </dd><dt><i>new_location</i> (str)</dt> | |
| 126 <dd> | |
| 127 new file/directory name | |
| 128 </dd> | |
| 129 </dl><a NAME="E5FileSystemCommands.__remove" ID="E5FileSystemCommands.__remove"></a> | |
| 130 <h4>E5FileSystemCommands.__remove</h4> | |
| 131 <b>__remove</b>(<i>path</i>) | |
| 132 <p> | |
| 133 Private method called by rope to remove a file or directory. | |
| 134 </p><dl> | |
| 135 <dt><i>path</i></dt> | |
| 136 <dd> | |
| 137 name of file/directory to remove (string) | |
| 138 </dd> | |
| 139 </dl><a NAME="E5FileSystemCommands.processFileSystemCommand" ID="E5FileSystemCommands.processFileSystemCommand"></a> | |
| 140 <h4>E5FileSystemCommands.processFileSystemCommand</h4> | |
| 141 <b>processFileSystemCommand</b>(<i>params</i>) | |
| 142 <p> | |
| 143 Public method to process rope file system commands. | |
| 144 </p><dl> | |
| 145 <dt><i>params</i> (dict)</dt> | |
| 146 <dd> | |
| 147 dictionary containing the command and relevant data | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <div align="right"><a href="#top">Up</a></div> | |
| 151 <hr /><hr /> | |
| 152 <a NAME="RefactoringClientFileSystemCommands" ID="RefactoringClientFileSystemCommands"></a> | |
| 153 <h2>RefactoringClientFileSystemCommands</h2> | |
| 154 <p> | |
| 155 Class implementing the client side of the rope file system commands. | |
| 156 </p> | |
| 157 <h3>Derived from</h3> | |
| 158 object | |
| 159 <h3>Class Attributes</h3> | |
| 160 <table> | |
| 161 <tr><td>None</td></tr> | |
| 162 </table> | |
| 163 <h3>Class Methods</h3> | |
| 164 <table> | |
| 165 <tr><td>None</td></tr> | |
| 166 </table> | |
| 167 <h3>Methods</h3> | |
| 168 <table> | |
| 169 <tr> | |
| 170 <td><a href="#RefactoringClientFileSystemCommands.__init__">RefactoringClientFileSystemCommands</a></td> | |
| 171 <td>Constructor</td> | |
| 172 </tr><tr> | |
| 173 <td><a href="#RefactoringClientFileSystemCommands.create_file">create_file</a></td> | |
| 174 <td>Public method called by rope to create a new file.</td> | |
| 175 </tr><tr> | |
| 176 <td><a href="#RefactoringClientFileSystemCommands.create_folder">create_folder</a></td> | |
| 177 <td>Public method called by rope to create a new directory.</td> | |
| 178 </tr><tr> | |
| 179 <td><a href="#RefactoringClientFileSystemCommands.move">move</a></td> | |
| 180 <td>Public method called by rope to rename a file or directory.</td> | |
| 181 </tr><tr> | |
| 182 <td><a href="#RefactoringClientFileSystemCommands.remove">remove</a></td> | |
| 183 <td>Public method called by rope to remove a file or directory.</td> | |
| 184 </tr><tr> | |
| 185 <td><a href="#RefactoringClientFileSystemCommands.write">write</a></td> | |
| 186 <td>Public method called by rope to write data to a file.</td> | |
| 187 </tr> | |
| 188 </table> | |
| 189 <h3>Static Methods</h3> | |
| 190 <table> | |
| 191 <tr><td>None</td></tr> | |
| 192 </table> | |
| 193 <a NAME="RefactoringClientFileSystemCommands.__init__" ID="RefactoringClientFileSystemCommands.__init__"></a> | |
| 194 <h4>RefactoringClientFileSystemCommands (Constructor)</h4> | |
| 195 <b>RefactoringClientFileSystemCommands</b>(<i>client</i>) | |
| 196 <p> | |
| 197 Constructor | |
| 198 </p><dl> | |
| 199 <dt><i>client</i> (RefactoringClient)</dt> | |
| 200 <dd> | |
| 201 reference to the refactoring client | |
| 202 </dd> | |
| 203 </dl><a NAME="RefactoringClientFileSystemCommands.create_file" ID="RefactoringClientFileSystemCommands.create_file"></a> | |
| 204 <h4>RefactoringClientFileSystemCommands.create_file</h4> | |
| 95 <b>create_file</b>(<i>path</i>) | 205 <b>create_file</b>(<i>path</i>) |
| 96 <p> | 206 <p> |
| 97 Public method called by rope to create a new file. | 207 Public method called by rope to create a new file. |
| 98 </p><dl> | 208 </p><dl> |
| 99 <dt><i>path</i></dt> | 209 <dt><i>path</i> (str)</dt> |
| 100 <dd> | 210 <dd> |
| 101 new filename (string) | 211 new filename |
| 102 </dd> | 212 </dd> |
| 103 </dl><a NAME="E5FileSystemCommands.create_folder" ID="E5FileSystemCommands.create_folder"></a> | 213 </dl><a NAME="RefactoringClientFileSystemCommands.create_folder" ID="RefactoringClientFileSystemCommands.create_folder"></a> |
| 104 <h4>E5FileSystemCommands.create_folder</h4> | 214 <h4>RefactoringClientFileSystemCommands.create_folder</h4> |
| 105 <b>create_folder</b>(<i>path</i>) | 215 <b>create_folder</b>(<i>path</i>) |
| 106 <p> | 216 <p> |
| 107 Public method called by rope to create a new directory. | 217 Public method called by rope to create a new directory. |
| 108 </p><dl> | 218 </p><dl> |
| 109 <dt><i>path</i></dt> | 219 <dt><i>path</i> (str)</dt> |
| 110 <dd> | 220 <dd> |
| 111 new directory (string) | 221 new directory |
| 112 </dd> | 222 </dd> |
| 113 </dl><a NAME="E5FileSystemCommands.move" ID="E5FileSystemCommands.move"></a> | 223 </dl><a NAME="RefactoringClientFileSystemCommands.move" ID="RefactoringClientFileSystemCommands.move"></a> |
| 114 <h4>E5FileSystemCommands.move</h4> | 224 <h4>RefactoringClientFileSystemCommands.move</h4> |
| 115 <b>move</b>(<i>path, new_location</i>) | 225 <b>move</b>(<i>path, new_location</i>) |
| 116 <p> | 226 <p> |
| 117 Public method called by rope to rename a file or directory. | 227 Public method called by rope to rename a file or directory. |
| 118 </p><dl> | 228 </p><dl> |
| 119 <dt><i>path</i></dt> | 229 <dt><i>path</i> (str)</dt> |
| 120 <dd> | 230 <dd> |
| 121 old file/directory name (string) | 231 old file/directory name |
| 122 </dd><dt><i>new_location</i></dt> | 232 </dd><dt><i>new_location</i> (str)</dt> |
| 123 <dd> | 233 <dd> |
| 124 new file/directory name (string) | 234 new file/directory name |
| 125 </dd> | 235 </dd> |
| 126 </dl><a NAME="E5FileSystemCommands.remove" ID="E5FileSystemCommands.remove"></a> | 236 </dl><a NAME="RefactoringClientFileSystemCommands.remove" ID="RefactoringClientFileSystemCommands.remove"></a> |
| 127 <h4>E5FileSystemCommands.remove</h4> | 237 <h4>RefactoringClientFileSystemCommands.remove</h4> |
| 128 <b>remove</b>(<i>path</i>) | 238 <b>remove</b>(<i>path</i>) |
| 129 <p> | 239 <p> |
| 130 Public method called by rope to remove a file or directory. | 240 Public method called by rope to remove a file or directory. |
| 131 </p><dl> | 241 </p><dl> |
| 132 <dt><i>path</i></dt> | 242 <dt><i>path</i> (str)</dt> |
| 133 <dd> | 243 <dd> |
| 134 name of file/directory to remove (string) | 244 name of file/directory to remove |
| 135 </dd> | 245 </dd> |
| 136 </dl><a NAME="E5FileSystemCommands.write" ID="E5FileSystemCommands.write"></a> | 246 </dl><a NAME="RefactoringClientFileSystemCommands.write" ID="RefactoringClientFileSystemCommands.write"></a> |
| 137 <h4>E5FileSystemCommands.write</h4> | 247 <h4>RefactoringClientFileSystemCommands.write</h4> |
| 138 <b>write</b>(<i>path, data</i>) | 248 <b>write</b>(<i>path, data</i>) |
| 139 <p> | 249 <p> |
| 140 Public method called by rope to write data to a file. | 250 Public method called by rope to write data to a file. |
| 141 </p><dl> | 251 </p><dl> |
| 142 <dt><i>path</i></dt> | 252 <dt><i>path</i> (str)</dt> |
| 143 <dd> | 253 <dd> |
| 144 filename of file to write to (string) | 254 filename of file to write to |
| 145 </dd><dt><i>data</i></dt> | 255 </dd><dt><i>data</i></dt> |
| 146 <dd> | 256 <dd> |
| 147 dat to be written | 257 data to be written |
| 148 </dd> | 258 </dd> |
| 149 </dl> | 259 </dl> |
| 150 <div align="right"><a href="#top">Up</a></div> | 260 <div align="right"><a href="#top">Up</a></div> |
| 151 <hr /> | 261 <hr /> |
| 152 </body></html> | 262 </body></html> |
