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

branch
eric7
changeset 365
f740b50380df
parent 354
a967ff16629a
child 375
c61a2f18ed78
equal deleted inserted replaced
364:a92b3272f4c1 365:f740b50380df
33 <h3>Classes</h3> 33 <h3>Classes</h3>
34 34
35 <table> 35 <table>
36 36
37 <tr> 37 <tr>
38 <td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td> 38 <td><a href="#EricFileSystemCommands">EricFileSystemCommands</a></td>
39 <td>Class implementing file system commands for rope.</td> 39 <td>Class implementing file system commands for rope.</td>
40 </tr> 40 </tr>
41 <tr> 41 <tr>
42 <td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td> 42 <td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td>
43 <td>Class implementing the client side of the rope file system commands.</td> 43 <td>Class implementing the client side of the rope file system commands.</td>
48 <table> 48 <table>
49 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
50 </table> 50 </table>
51 <hr /> 51 <hr />
52 <hr /> 52 <hr />
53 <a NAME="E5FileSystemCommands" ID="E5FileSystemCommands"></a> 53 <a NAME="EricFileSystemCommands" ID="EricFileSystemCommands"></a>
54 <h2>E5FileSystemCommands</h2> 54 <h2>EricFileSystemCommands</h2>
55 55
56 <p> 56 <p>
57 Class implementing file system commands for rope. 57 Class implementing file system commands for rope.
58 </p> 58 </p>
59 <h3>Derived from</h3> 59 <h3>Derived from</h3>
71 <h3>Methods</h3> 71 <h3>Methods</h3>
72 72
73 <table> 73 <table>
74 74
75 <tr> 75 <tr>
76 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td> 76 <td><a href="#EricFileSystemCommands.__init__">EricFileSystemCommands</a></td>
77 <td>Constructor</td> 77 <td>Constructor</td>
78 </tr> 78 </tr>
79 <tr> 79 <tr>
80 <td><a href="#E5FileSystemCommands.__createFile">__createFile</a></td> 80 <td><a href="#EricFileSystemCommands.__createFile">__createFile</a></td>
81 <td>Private method called by rope to create a new file.</td> 81 <td>Private method called by rope to create a new file.</td>
82 </tr> 82 </tr>
83 <tr> 83 <tr>
84 <td><a href="#E5FileSystemCommands.__createFolder">__createFolder</a></td> 84 <td><a href="#EricFileSystemCommands.__createFolder">__createFolder</a></td>
85 <td>Private method called by rope to create a new directory.</td> 85 <td>Private method called by rope to create a new directory.</td>
86 </tr> 86 </tr>
87 <tr> 87 <tr>
88 <td><a href="#E5FileSystemCommands.__move">__move</a></td> 88 <td><a href="#EricFileSystemCommands.__move">__move</a></td>
89 <td>Private method called by rope to rename a file or directory.</td> 89 <td>Private method called by rope to rename a file or directory.</td>
90 </tr> 90 </tr>
91 <tr> 91 <tr>
92 <td><a href="#E5FileSystemCommands.__remove">__remove</a></td> 92 <td><a href="#EricFileSystemCommands.__remove">__remove</a></td>
93 <td>Private method called by rope to remove a file or directory.</td> 93 <td>Private method called by rope to remove a file or directory.</td>
94 </tr> 94 </tr>
95 <tr> 95 <tr>
96 <td><a href="#E5FileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td> 96 <td><a href="#EricFileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td>
97 <td>Public method to process rope file system commands.</td> 97 <td>Public method to process rope file system commands.</td>
98 </tr> 98 </tr>
99 </table> 99 </table>
100 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
101 101
102 <table> 102 <table>
103 <tr><td>None</td></tr> 103 <tr><td>None</td></tr>
104 </table> 104 </table>
105 105
106 <a NAME="E5FileSystemCommands.__init__" ID="E5FileSystemCommands.__init__"></a> 106 <a NAME="EricFileSystemCommands.__init__" ID="EricFileSystemCommands.__init__"></a>
107 <h4>E5FileSystemCommands (Constructor)</h4> 107 <h4>EricFileSystemCommands (Constructor)</h4>
108 <b>E5FileSystemCommands</b>(<i>project</i>) 108 <b>EricFileSystemCommands</b>(<i>project</i>)
109 109
110 <p> 110 <p>
111 Constructor 111 Constructor
112 </p> 112 </p>
113 <dl> 113 <dl>
115 <dt><i>project</i> (Project.Project)</dt> 115 <dt><i>project</i> (Project.Project)</dt>
116 <dd> 116 <dd>
117 reference to the eric project object 117 reference to the eric project object
118 </dd> 118 </dd>
119 </dl> 119 </dl>
120 <a NAME="E5FileSystemCommands.__createFile" ID="E5FileSystemCommands.__createFile"></a> 120 <a NAME="EricFileSystemCommands.__createFile" ID="EricFileSystemCommands.__createFile"></a>
121 <h4>E5FileSystemCommands.__createFile</h4> 121 <h4>EricFileSystemCommands.__createFile</h4>
122 <b>__createFile</b>(<i>path</i>) 122 <b>__createFile</b>(<i>path</i>)
123 123
124 <p> 124 <p>
125 Private method called by rope to create a new file. 125 Private method called by rope to create a new file.
126 </p> 126 </p>
129 <dt><i>path</i> (str)</dt> 129 <dt><i>path</i> (str)</dt>
130 <dd> 130 <dd>
131 new filename 131 new filename
132 </dd> 132 </dd>
133 </dl> 133 </dl>
134 <a NAME="E5FileSystemCommands.__createFolder" ID="E5FileSystemCommands.__createFolder"></a> 134 <a NAME="EricFileSystemCommands.__createFolder" ID="EricFileSystemCommands.__createFolder"></a>
135 <h4>E5FileSystemCommands.__createFolder</h4> 135 <h4>EricFileSystemCommands.__createFolder</h4>
136 <b>__createFolder</b>(<i>path</i>) 136 <b>__createFolder</b>(<i>path</i>)
137 137
138 <p> 138 <p>
139 Private method called by rope to create a new directory. 139 Private method called by rope to create a new directory.
140 </p> 140 </p>
143 <dt><i>path</i> (str)</dt> 143 <dt><i>path</i> (str)</dt>
144 <dd> 144 <dd>
145 new directory 145 new directory
146 </dd> 146 </dd>
147 </dl> 147 </dl>
148 <a NAME="E5FileSystemCommands.__move" ID="E5FileSystemCommands.__move"></a> 148 <a NAME="EricFileSystemCommands.__move" ID="EricFileSystemCommands.__move"></a>
149 <h4>E5FileSystemCommands.__move</h4> 149 <h4>EricFileSystemCommands.__move</h4>
150 <b>__move</b>(<i>path, new_location</i>) 150 <b>__move</b>(<i>path, new_location</i>)
151 151
152 <p> 152 <p>
153 Private method called by rope to rename a file or directory. 153 Private method called by rope to rename a file or directory.
154 </p> 154 </p>
161 <dt><i>new_location</i> (str)</dt> 161 <dt><i>new_location</i> (str)</dt>
162 <dd> 162 <dd>
163 new file/directory name 163 new file/directory name
164 </dd> 164 </dd>
165 </dl> 165 </dl>
166 <a NAME="E5FileSystemCommands.__remove" ID="E5FileSystemCommands.__remove"></a> 166 <a NAME="EricFileSystemCommands.__remove" ID="EricFileSystemCommands.__remove"></a>
167 <h4>E5FileSystemCommands.__remove</h4> 167 <h4>EricFileSystemCommands.__remove</h4>
168 <b>__remove</b>(<i>path</i>) 168 <b>__remove</b>(<i>path</i>)
169 169
170 <p> 170 <p>
171 Private method called by rope to remove a file or directory. 171 Private method called by rope to remove a file or directory.
172 </p> 172 </p>
175 <dt><i>path</i></dt> 175 <dt><i>path</i></dt>
176 <dd> 176 <dd>
177 name of file/directory to remove (string) 177 name of file/directory to remove (string)
178 </dd> 178 </dd>
179 </dl> 179 </dl>
180 <a NAME="E5FileSystemCommands.processFileSystemCommand" ID="E5FileSystemCommands.processFileSystemCommand"></a> 180 <a NAME="EricFileSystemCommands.processFileSystemCommand" ID="EricFileSystemCommands.processFileSystemCommand"></a>
181 <h4>E5FileSystemCommands.processFileSystemCommand</h4> 181 <h4>EricFileSystemCommands.processFileSystemCommand</h4>
182 <b>processFileSystemCommand</b>(<i>params</i>) 182 <b>processFileSystemCommand</b>(<i>params</i>)
183 183
184 <p> 184 <p>
185 Public method to process rope file system commands. 185 Public method to process rope file system commands.
186 </p> 186 </p>

eric ide

mercurial