SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html

branch
eric7
changeset 48
4f0e000eab79
parent 45
e12f7ab5f6c0
child 52
8dcfbc830b52
equal deleted inserted replaced
47:0780a9985266 48:4f0e000eab79
75 <tr> 75 <tr>
76 <td><a href="#SplitMergeCamelCasePlugin.__applyChange">__applyChange</a></td> 76 <td><a href="#SplitMergeCamelCasePlugin.__applyChange">__applyChange</a></td>
77 <td>Private method to change the selected text.</td> 77 <td>Private method to change the selected text.</td>
78 </tr> 78 </tr>
79 <tr> 79 <tr>
80 <td><a href="#SplitMergeCamelCasePlugin.__camelCaseToUnderscore">__camelCaseToUnderscore</a></td> 80 <td><a href="#SplitMergeCamelCasePlugin.__camelCaseToSnakeCase">__camelCaseToSnakeCase</a></td>
81 <td>Private slot to convert camel case text to underscore separated text.</td> 81 <td>Private slot to convert camel case text to underscore separated text.</td>
82 </tr> 82 </tr>
83 <tr> 83 <tr>
84 <td><a href="#SplitMergeCamelCasePlugin.__editorClosed">__editorClosed</a></td> 84 <td><a href="#SplitMergeCamelCasePlugin.__editorClosed">__editorClosed</a></td>
85 <td>Private slot called, when an editor was closed.</td> 85 <td>Private slot called, when an editor was closed.</td>
103 <tr> 103 <tr>
104 <td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCase">__mergeCamelCase</a></td> 104 <td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCase">__mergeCamelCase</a></td>
105 <td>Private slot to merge the selected text to camel case.</td> 105 <td>Private slot to merge the selected text to camel case.</td>
106 </tr> 106 </tr>
107 <tr> 107 <tr>
108 <td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst">__mergeCamelCaseUppercaseFirst</a></td>
109 <td>Private slot to merge the selected text to camel case upper casing the first character.</td>
110 </tr>
111 <tr>
112 <td><a href="#SplitMergeCamelCasePlugin.__mergeSnakeCase">__mergeSnakeCase</a></td>
113 <td>Private slot to merge the selected text to snake case.</td>
114 </tr>
115 <tr>
108 <td><a href="#SplitMergeCamelCasePlugin.__populateMenu">__populateMenu</a></td> 116 <td><a href="#SplitMergeCamelCasePlugin.__populateMenu">__populateMenu</a></td>
109 <td>Private slot to populate the tools menu with our entries.</td> 117 <td>Private slot to populate the tools menu with our entries.</td>
110 </tr> 118 </tr>
111 <tr> 119 <tr>
120 <td><a href="#SplitMergeCamelCasePlugin.__snakeCaseToCamelCase">__snakeCaseToCamelCase</a></td>
121 <td>Private slot to convert underscore separated text to camel case.</td>
122 </tr>
123 <tr>
124 <td><a href="#SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst">__snakeCaseToCamelCaseUppercaseFirst</a></td>
125 <td>Private slot to convert underscore separated text to camel case upper casing the first character.</td>
126 </tr>
127 <tr>
112 <td><a href="#SplitMergeCamelCasePlugin.__splitCamelCase">__splitCamelCase</a></td> 128 <td><a href="#SplitMergeCamelCasePlugin.__splitCamelCase">__splitCamelCase</a></td>
113 <td>Private slot to split the selected camel case text.</td> 129 <td>Private slot to split the selected camel case text.</td>
114 </tr> 130 </tr>
115 <tr> 131 <tr>
116 <td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCase">__underscoreToCamelCase</a></td> 132 <td><a href="#SplitMergeCamelCasePlugin.__splitSnakeCase">__splitSnakeCase</a></td>
117 <td>Private slot to convert underscore separated text to camel case.</td> 133 <td>Private slot to split the selected snake case text.</td>
118 </tr>
119 <tr>
120 <td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst">__underscoreToCamelCaseUppercaseFirst</a></td>
121 <td>Private slot to convert underscore separated text to camel case upper casing the first character.</td>
122 </tr> 134 </tr>
123 <tr> 135 <tr>
124 <td><a href="#SplitMergeCamelCasePlugin.activate">activate</a></td> 136 <td><a href="#SplitMergeCamelCasePlugin.activate">activate</a></td>
125 <td>Public method to activate this plugin.</td> 137 <td>Public method to activate this plugin.</td>
126 </tr> 138 </tr>
142 <p> 154 <p>
143 Constructor 155 Constructor
144 </p> 156 </p>
145 <dl> 157 <dl>
146 158
147 <dt><i>ui</i></dt> 159 <dt><i>ui</i> (UserInterface)</dt>
148 <dd> 160 <dd>
149 reference to the user interface object (UI.UserInterface) 161 reference to the user interface object
150 </dd> 162 </dd>
151 </dl> 163 </dl>
152 <a NAME="SplitMergeCamelCasePlugin.__applyChange" ID="SplitMergeCamelCasePlugin.__applyChange"></a> 164 <a NAME="SplitMergeCamelCasePlugin.__applyChange" ID="SplitMergeCamelCasePlugin.__applyChange"></a>
153 <h4>SplitMergeCamelCasePlugin.__applyChange</h4> 165 <h4>SplitMergeCamelCasePlugin.__applyChange</h4>
154 <b>__applyChange</b>(<i>newText, editor</i>) 166 <b>__applyChange</b>(<i>newText, editor</i>)
156 <p> 168 <p>
157 Private method to change the selected text. 169 Private method to change the selected text.
158 </p> 170 </p>
159 <dl> 171 <dl>
160 172
161 <dt><i>newText</i></dt> 173 <dt><i>newText</i> (str)</dt>
162 <dd> 174 <dd>
163 new (converted) text (string) 175 new (converted) text
164 </dd> 176 </dd>
165 <dt><i>editor</i></dt> 177 <dt><i>editor</i> (Editor)</dt>
166 <dd> 178 <dd>
167 reference to the editor to apply the text 179 reference to the editor to apply the text
168 change to (Editor) 180 change to
169 </dd> 181 </dd>
170 </dl> 182 </dl>
171 <a NAME="SplitMergeCamelCasePlugin.__camelCaseToUnderscore" ID="SplitMergeCamelCasePlugin.__camelCaseToUnderscore"></a> 183 <a NAME="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase" ID="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase"></a>
172 <h4>SplitMergeCamelCasePlugin.__camelCaseToUnderscore</h4> 184 <h4>SplitMergeCamelCasePlugin.__camelCaseToSnakeCase</h4>
173 <b>__camelCaseToUnderscore</b>(<i></i>) 185 <b>__camelCaseToSnakeCase</b>(<i></i>)
174 186
175 <p> 187 <p>
176 Private slot to convert camel case text to underscore separated text. 188 Private slot to convert camel case text to underscore separated text.
177 </p> 189 </p>
178 <a NAME="SplitMergeCamelCasePlugin.__editorClosed" ID="SplitMergeCamelCasePlugin.__editorClosed"></a> 190 <a NAME="SplitMergeCamelCasePlugin.__editorClosed" ID="SplitMergeCamelCasePlugin.__editorClosed"></a>
182 <p> 194 <p>
183 Private slot called, when an editor was closed. 195 Private slot called, when an editor was closed.
184 </p> 196 </p>
185 <dl> 197 <dl>
186 198
187 <dt><i>editor</i></dt> 199 <dt><i>editor</i> (Editor)</dt>
188 <dd> 200 <dd>
189 reference to the editor (QScintilla.Editor) 201 reference to the editor
190 </dd> 202 </dd>
191 </dl> 203 </dl>
192 <a NAME="SplitMergeCamelCasePlugin.__editorOpened" ID="SplitMergeCamelCasePlugin.__editorOpened"></a> 204 <a NAME="SplitMergeCamelCasePlugin.__editorOpened" ID="SplitMergeCamelCasePlugin.__editorOpened"></a>
193 <h4>SplitMergeCamelCasePlugin.__editorOpened</h4> 205 <h4>SplitMergeCamelCasePlugin.__editorOpened</h4>
194 <b>__editorOpened</b>(<i>editor</i>) 206 <b>__editorOpened</b>(<i>editor</i>)
196 <p> 208 <p>
197 Private slot called, when a new editor was opened. 209 Private slot called, when a new editor was opened.
198 </p> 210 </p>
199 <dl> 211 <dl>
200 212
201 <dt><i>editor</i></dt> 213 <dt><i>editor</i> (Editor)</dt>
202 <dd> 214 <dd>
203 reference to the new editor (QScintilla.Editor) 215 reference to the new editor
204 </dd> 216 </dd>
205 </dl> 217 </dl>
206 <a NAME="SplitMergeCamelCasePlugin.__editorShowMenu" ID="SplitMergeCamelCasePlugin.__editorShowMenu"></a> 218 <a NAME="SplitMergeCamelCasePlugin.__editorShowMenu" ID="SplitMergeCamelCasePlugin.__editorShowMenu"></a>
207 <h4>SplitMergeCamelCasePlugin.__editorShowMenu</h4> 219 <h4>SplitMergeCamelCasePlugin.__editorShowMenu</h4>
208 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 220 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
211 Private slot called, when the the editor context menu or a submenu is 223 Private slot called, when the the editor context menu or a submenu is
212 about to be shown. 224 about to be shown.
213 </p> 225 </p>
214 <dl> 226 <dl>
215 227
216 <dt><i>menuName</i></dt> 228 <dt><i>menuName</i> (str)</dt>
217 <dd> 229 <dd>
218 name of the menu to be shown (string) 230 name of the menu to be shown
219 </dd> 231 </dd>
220 <dt><i>menu</i></dt> 232 <dt><i>menu</i> (QMenu)</dt>
221 <dd> 233 <dd>
222 reference to the menu (QMenu) 234 reference to the menu
223 </dd> 235 </dd>
224 <dt><i>editor</i></dt> 236 <dt><i>editor</i> (Editor)</dt>
225 <dd> 237 <dd>
226 reference to the editor 238 reference to the editor
227 </dd> 239 </dd>
228 </dl> 240 </dl>
229 <a NAME="SplitMergeCamelCasePlugin.__initMenu" ID="SplitMergeCamelCasePlugin.__initMenu"></a> 241 <a NAME="SplitMergeCamelCasePlugin.__initMenu" ID="SplitMergeCamelCasePlugin.__initMenu"></a>
240 <p> 252 <p>
241 Private method to load the translation file. 253 Private method to load the translation file.
242 </p> 254 </p>
243 <a NAME="SplitMergeCamelCasePlugin.__mergeCamelCase" ID="SplitMergeCamelCasePlugin.__mergeCamelCase"></a> 255 <a NAME="SplitMergeCamelCasePlugin.__mergeCamelCase" ID="SplitMergeCamelCasePlugin.__mergeCamelCase"></a>
244 <h4>SplitMergeCamelCasePlugin.__mergeCamelCase</h4> 256 <h4>SplitMergeCamelCasePlugin.__mergeCamelCase</h4>
245 <b>__mergeCamelCase</b>(<i></i>) 257 <b>__mergeCamelCase</b>(<i>uppercaseFirst=False</i>)
246 258
247 <p> 259 <p>
248 Private slot to merge the selected text to camel case. 260 Private slot to merge the selected text to camel case.
261 </p>
262 <dl>
263
264 <dt><i>uppercaseFirst</i> (bool)</dt>
265 <dd>
266 flag indicating to upper case the
267 first character
268 </dd>
269 </dl>
270 <a NAME="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst"></a>
271 <h4>SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst</h4>
272 <b>__mergeCamelCaseUppercaseFirst</b>(<i></i>)
273
274 <p>
275 Private slot to merge the selected text to camel case upper casing
276 the first character.
277 </p>
278 <a NAME="SplitMergeCamelCasePlugin.__mergeSnakeCase" ID="SplitMergeCamelCasePlugin.__mergeSnakeCase"></a>
279 <h4>SplitMergeCamelCasePlugin.__mergeSnakeCase</h4>
280 <b>__mergeSnakeCase</b>(<i></i>)
281
282 <p>
283 Private slot to merge the selected text to snake case.
249 </p> 284 </p>
250 <a NAME="SplitMergeCamelCasePlugin.__populateMenu" ID="SplitMergeCamelCasePlugin.__populateMenu"></a> 285 <a NAME="SplitMergeCamelCasePlugin.__populateMenu" ID="SplitMergeCamelCasePlugin.__populateMenu"></a>
251 <h4>SplitMergeCamelCasePlugin.__populateMenu</h4> 286 <h4>SplitMergeCamelCasePlugin.__populateMenu</h4>
252 <b>__populateMenu</b>(<i>name, menu</i>) 287 <b>__populateMenu</b>(<i>name, menu</i>)
253 288
254 <p> 289 <p>
255 Private slot to populate the tools menu with our entries. 290 Private slot to populate the tools menu with our entries.
256 </p> 291 </p>
257 <dl> 292 <dl>
258 293
259 <dt><i>name</i></dt> 294 <dt><i>name</i> (str)</dt>
260 <dd> 295 <dd>
261 name of the menu (string) 296 name of the menu
262 </dd> 297 </dd>
263 <dt><i>menu</i></dt> 298 <dt><i>menu</i> (QMenu)</dt>
264 <dd> 299 <dd>
265 reference to the menu to be populated (QMenu) 300 reference to the menu to be populated
266 </dd> 301 </dd>
267 </dl> 302 </dl>
303 <a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase"></a>
304 <h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCase</h4>
305 <b>__snakeCaseToCamelCase</b>(<i>uppercaseFirst=False</i>)
306
307 <p>
308 Private slot to convert underscore separated text to camel case.
309 </p>
310 <dl>
311
312 <dt><i>uppercaseFirst</i> (bool)</dt>
313 <dd>
314 flag indicating to upper case the
315 first character
316 </dd>
317 </dl>
318 <a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst"></a>
319 <h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst</h4>
320 <b>__snakeCaseToCamelCaseUppercaseFirst</b>(<i></i>)
321
322 <p>
323 Private slot to convert underscore separated text to camel case
324 upper casing the first character.
325 </p>
268 <a NAME="SplitMergeCamelCasePlugin.__splitCamelCase" ID="SplitMergeCamelCasePlugin.__splitCamelCase"></a> 326 <a NAME="SplitMergeCamelCasePlugin.__splitCamelCase" ID="SplitMergeCamelCasePlugin.__splitCamelCase"></a>
269 <h4>SplitMergeCamelCasePlugin.__splitCamelCase</h4> 327 <h4>SplitMergeCamelCasePlugin.__splitCamelCase</h4>
270 <b>__splitCamelCase</b>(<i></i>) 328 <b>__splitCamelCase</b>(<i></i>)
271 329
272 <p> 330 <p>
273 Private slot to split the selected camel case text. 331 Private slot to split the selected camel case text.
274 </p> 332 </p>
275 <a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCase" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCase"></a> 333 <a NAME="SplitMergeCamelCasePlugin.__splitSnakeCase" ID="SplitMergeCamelCasePlugin.__splitSnakeCase"></a>
276 <h4>SplitMergeCamelCasePlugin.__underscoreToCamelCase</h4> 334 <h4>SplitMergeCamelCasePlugin.__splitSnakeCase</h4>
277 <b>__underscoreToCamelCase</b>(<i>uppercaseFirst=False</i>) 335 <b>__splitSnakeCase</b>(<i></i>)
278 336
279 <p> 337 <p>
280 Private slot to convert underscore separated text to camel case. 338 Private slot to split the selected snake case text.
281 </p>
282 <dl>
283
284 <dt><i>uppercaseFirst</i></dt>
285 <dd>
286 flag indicating to upper case the
287 first character (boolean)
288 </dd>
289 </dl>
290 <a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst"></a>
291 <h4>SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst</h4>
292 <b>__underscoreToCamelCaseUppercaseFirst</b>(<i></i>)
293
294 <p>
295 Private slot to convert underscore separated text to camel case
296 upper casing the first character.
297 </p> 339 </p>
298 <a NAME="SplitMergeCamelCasePlugin.activate" ID="SplitMergeCamelCasePlugin.activate"></a> 340 <a NAME="SplitMergeCamelCasePlugin.activate" ID="SplitMergeCamelCasePlugin.activate"></a>
299 <h4>SplitMergeCamelCasePlugin.activate</h4> 341 <h4>SplitMergeCamelCasePlugin.activate</h4>
300 <b>activate</b>(<i></i>) 342 <b>activate</b>(<i></i>)
301 343
303 Public method to activate this plugin. 345 Public method to activate this plugin.
304 </p> 346 </p>
305 <dl> 347 <dl>
306 <dt>Return:</dt> 348 <dt>Return:</dt>
307 <dd> 349 <dd>
308 tuple of None and activation status (boolean) 350 tuple of None and activation status
351 </dd>
352 </dl>
353 <dl>
354 <dt>Return Type:</dt>
355 <dd>
356 tuple of (None, bool)
309 </dd> 357 </dd>
310 </dl> 358 </dl>
311 <a NAME="SplitMergeCamelCasePlugin.deactivate" ID="SplitMergeCamelCasePlugin.deactivate"></a> 359 <a NAME="SplitMergeCamelCasePlugin.deactivate" ID="SplitMergeCamelCasePlugin.deactivate"></a>
312 <h4>SplitMergeCamelCasePlugin.deactivate</h4> 360 <h4>SplitMergeCamelCasePlugin.deactivate</h4>
313 <b>deactivate</b>(<i></i>) 361 <b>deactivate</b>(<i></i>)

eric ide

mercurial