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

changeset 55
d501156be247
parent 44
8aa985c8dee5
child 204
b4bf79b956bc
equal deleted inserted replaced
54:e795cb8240aa 55:d501156be247
28 <tr><td>None</td></tr> 28 <tr><td>None</td></tr>
29 </table> 29 </table>
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> 35 </tr>
36 </table> 36 </table>
37 <h3>Functions</h3> 37 <h3>Functions</h3>
38 <table> 38 <table>
39 <tr><td>None</td></tr> 39 <tr><td>None</td></tr>
40 </table> 40 </table>
41 <hr /><hr /> 41 <hr /><hr />
42 <a NAME="e5FileSystemCommands" ID="e5FileSystemCommands"></a> 42 <a NAME="E5FileSystemCommands" ID="E5FileSystemCommands"></a>
43 <h2>e5FileSystemCommands</h2> 43 <h2>E5FileSystemCommands</h2>
44 <p> 44 <p>
45 Class implementing file system commands for rope. 45 Class implementing file system commands for rope.
46 </p> 46 </p>
47 <h3>Derived from</h3> 47 <h3>Derived from</h3>
48 object 48 object
55 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
56 </table> 56 </table>
57 <h3>Methods</h3> 57 <h3>Methods</h3>
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#e5FileSystemCommands.__init__">e5FileSystemCommands</a></td> 60 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td>
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#e5FileSystemCommands.create_file">create_file</a></td> 63 <td><a href="#E5FileSystemCommands.create_file">create_file</a></td>
64 <td>Public method called by rope to create a new file.</td> 64 <td>Public method called by rope to create a new file.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#e5FileSystemCommands.create_folder">create_folder</a></td> 66 <td><a href="#E5FileSystemCommands.create_folder">create_folder</a></td>
67 <td>Public method called by rope to create a new directory.</td> 67 <td>Public method called by rope to create a new directory.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#e5FileSystemCommands.move">move</a></td> 69 <td><a href="#E5FileSystemCommands.move">move</a></td>
70 <td>Public method called by rope to rename a file or directory.</td> 70 <td>Public method called by rope to rename a file or directory.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#e5FileSystemCommands.remove">remove</a></td> 72 <td><a href="#E5FileSystemCommands.remove">remove</a></td>
73 <td>Public method called by rope to remove a file or directory.</td> 73 <td>Public method called by rope to remove a file or directory.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#e5FileSystemCommands.write">write</a></td> 75 <td><a href="#E5FileSystemCommands.write">write</a></td>
76 <td>Public method called by rope to write data to a file.</td> 76 <td>Public method called by rope to write data to a file.</td>
77 </tr> 77 </tr>
78 </table> 78 </table>
79 <h3>Static Methods</h3> 79 <h3>Static Methods</h3>
80 <table> 80 <table>
81 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
82 </table> 82 </table>
83 <a NAME="e5FileSystemCommands.__init__" ID="e5FileSystemCommands.__init__"></a> 83 <a NAME="E5FileSystemCommands.__init__" ID="E5FileSystemCommands.__init__"></a>
84 <h4>e5FileSystemCommands (Constructor)</h4> 84 <h4>E5FileSystemCommands (Constructor)</h4>
85 <b>e5FileSystemCommands</b>(<i>project</i>) 85 <b>E5FileSystemCommands</b>(<i>project</i>)
86 <p> 86 <p>
87 Constructor 87 Constructor
88 </p><dl> 88 </p><dl>
89 <dt><i>project</i></dt> 89 <dt><i>project</i></dt>
90 <dd> 90 <dd>
91 reference to the eric4 project object (Project.Project) 91 reference to the eric4 project object (Project.Project)
92 </dd> 92 </dd>
93 </dl><a NAME="e5FileSystemCommands.create_file" ID="e5FileSystemCommands.create_file"></a> 93 </dl><a NAME="E5FileSystemCommands.create_file" ID="E5FileSystemCommands.create_file"></a>
94 <h4>e5FileSystemCommands.create_file</h4> 94 <h4>E5FileSystemCommands.create_file</h4>
95 <b>create_file</b>(<i>path</i>) 95 <b>create_file</b>(<i>path</i>)
96 <p> 96 <p>
97 Public method called by rope to create a new file. 97 Public method called by rope to create a new file.
98 </p><dl> 98 </p><dl>
99 <dt><i>path</i></dt> 99 <dt><i>path</i></dt>
100 <dd> 100 <dd>
101 new filename (string) 101 new filename (string)
102 </dd> 102 </dd>
103 </dl><a NAME="e5FileSystemCommands.create_folder" ID="e5FileSystemCommands.create_folder"></a> 103 </dl><a NAME="E5FileSystemCommands.create_folder" ID="E5FileSystemCommands.create_folder"></a>
104 <h4>e5FileSystemCommands.create_folder</h4> 104 <h4>E5FileSystemCommands.create_folder</h4>
105 <b>create_folder</b>(<i>path</i>) 105 <b>create_folder</b>(<i>path</i>)
106 <p> 106 <p>
107 Public method called by rope to create a new directory. 107 Public method called by rope to create a new directory.
108 </p><dl> 108 </p><dl>
109 <dt><i>path</i></dt> 109 <dt><i>path</i></dt>
110 <dd> 110 <dd>
111 new directory (string) 111 new directory (string)
112 </dd> 112 </dd>
113 </dl><a NAME="e5FileSystemCommands.move" ID="e5FileSystemCommands.move"></a> 113 </dl><a NAME="E5FileSystemCommands.move" ID="E5FileSystemCommands.move"></a>
114 <h4>e5FileSystemCommands.move</h4> 114 <h4>E5FileSystemCommands.move</h4>
115 <b>move</b>(<i>path, new_location</i>) 115 <b>move</b>(<i>path, new_location</i>)
116 <p> 116 <p>
117 Public method called by rope to rename a file or directory. 117 Public method called by rope to rename a file or directory.
118 </p><dl> 118 </p><dl>
119 <dt><i>path</i></dt> 119 <dt><i>path</i></dt>
121 old file/directory name (string) 121 old file/directory name (string)
122 </dd><dt><i>new_location</i></dt> 122 </dd><dt><i>new_location</i></dt>
123 <dd> 123 <dd>
124 new file/directory name (string) 124 new file/directory name (string)
125 </dd> 125 </dd>
126 </dl><a NAME="e5FileSystemCommands.remove" ID="e5FileSystemCommands.remove"></a> 126 </dl><a NAME="E5FileSystemCommands.remove" ID="E5FileSystemCommands.remove"></a>
127 <h4>e5FileSystemCommands.remove</h4> 127 <h4>E5FileSystemCommands.remove</h4>
128 <b>remove</b>(<i>path</i>) 128 <b>remove</b>(<i>path</i>)
129 <p> 129 <p>
130 Public method called by rope to remove a file or directory. 130 Public method called by rope to remove a file or directory.
131 </p><dl> 131 </p><dl>
132 <dt><i>path</i></dt> 132 <dt><i>path</i></dt>
133 <dd> 133 <dd>
134 name of file/directory to remove (string) 134 name of file/directory to remove (string)
135 </dd> 135 </dd>
136 </dl><a NAME="e5FileSystemCommands.write" ID="e5FileSystemCommands.write"></a> 136 </dl><a NAME="E5FileSystemCommands.write" ID="E5FileSystemCommands.write"></a>
137 <h4>e5FileSystemCommands.write</h4> 137 <h4>E5FileSystemCommands.write</h4>
138 <b>write</b>(<i>path, data</i>) 138 <b>write</b>(<i>path, data</i>)
139 <p> 139 <p>
140 Public method called by rope to write data to a file. 140 Public method called by rope to write data to a file.
141 </p><dl> 141 </p><dl>
142 <dt><i>path</i></dt> 142 <dt><i>path</i></dt>

eric ide

mercurial