Mercurial Repositories > Camel Case Handling Tool / file comparison
comparison: SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html
SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html
- changeset 1
- 1ff6dcf50215
- child 10
- 97dd3b380cfd
equal
deleted
inserted
replaced
| 0:cff1c67f7dc1 | 1:1ff6dcf50215 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase</h1> | |
| 23 <p> | |
| 24 Module implementing the split, merge or convert camel case plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#SplitMergeCamelCasePlugin">SplitMergeCamelCasePlugin</a></td> | |
| 34 <td>Class implementing the split, merge or convert camel case plug-in.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="SplitMergeCamelCasePlugin" ID="SplitMergeCamelCasePlugin"></a> | |
| 43 <h2>SplitMergeCamelCasePlugin</h2> | |
| 44 <p> | |
| 45 Class implementing the split, merge or convert camel case plug-in. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#SplitMergeCamelCasePlugin.__init__">SplitMergeCamelCasePlugin</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SplitMergeCamelCasePlugin.__applyChange">__applyChange</a></td> | |
| 64 <td>Private method to change the selected text.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SplitMergeCamelCasePlugin.__camelCaseToUnderscore">__camelCaseToUnderscore</a></td> | |
| 67 <td>Private slot to convert camel case text to underscore separated text.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SplitMergeCamelCasePlugin.__initMenu">__initMenu</a></td> | |
| 70 <td>Private method to initialize the camel case handling menu.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#SplitMergeCamelCasePlugin.__loadTranslator">__loadTranslator</a></td> | |
| 73 <td>Private method to load the translation file.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCase">__mergeCamelCase</a></td> | |
| 76 <td>Private slot to merge the selected text to camel case.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#SplitMergeCamelCasePlugin.__populateMenu">__populateMenu</a></td> | |
| 79 <td>Private slot to populate the tools menu with our entries.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#SplitMergeCamelCasePlugin.__splitCamelCase">__splitCamelCase</a></td> | |
| 82 <td>Private slot to split the selected camel case text.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCase">__underscoreToCamelCase</a></td> | |
| 85 <td>Private slot to convert underscore separated text to camel case.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst">__underscoreToCamelCaseUppercaseFirst</a></td> | |
| 88 <td>Private slot to convert underscore separated text to camel case upper casing the first character.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#SplitMergeCamelCasePlugin.activate">activate</a></td> | |
| 91 <td>Public method to activate this plugin.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#SplitMergeCamelCasePlugin.deactivate">deactivate</a></td> | |
| 94 <td>Public method to deactivate this plugin.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 <a NAME="SplitMergeCamelCasePlugin.__init__" ID="SplitMergeCamelCasePlugin.__init__"></a> | |
| 102 <h4>SplitMergeCamelCasePlugin (Constructor)</h4> | |
| 103 <b>SplitMergeCamelCasePlugin</b>(<i>ui</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>ui</i></dt> | |
| 108 <dd> | |
| 109 reference to the user interface object (UI.UserInterface) | |
| 110 </dd> | |
| 111 </dl><a NAME="SplitMergeCamelCasePlugin.__applyChange" ID="SplitMergeCamelCasePlugin.__applyChange"></a> | |
| 112 <h4>SplitMergeCamelCasePlugin.__applyChange</h4> | |
| 113 <b>__applyChange</b>(<i>newText, editor</i>) | |
| 114 <p> | |
| 115 Private method to change the selected text. | |
| 116 </p><dl> | |
| 117 <dt><i>newText</i></dt> | |
| 118 <dd> | |
| 119 new (converted) text (string) | |
| 120 </dd><dt><i>editor</i></dt> | |
| 121 <dd> | |
| 122 reference to the editor to apply the text | |
| 123 change to (Editor) | |
| 124 </dd> | |
| 125 </dl><a NAME="SplitMergeCamelCasePlugin.__camelCaseToUnderscore" ID="SplitMergeCamelCasePlugin.__camelCaseToUnderscore"></a> | |
| 126 <h4>SplitMergeCamelCasePlugin.__camelCaseToUnderscore</h4> | |
| 127 <b>__camelCaseToUnderscore</b>(<i></i>) | |
| 128 <p> | |
| 129 Private slot to convert camel case text to underscore separated text. | |
| 130 </p><a NAME="SplitMergeCamelCasePlugin.__initMenu" ID="SplitMergeCamelCasePlugin.__initMenu"></a> | |
| 131 <h4>SplitMergeCamelCasePlugin.__initMenu</h4> | |
| 132 <b>__initMenu</b>(<i></i>) | |
| 133 <p> | |
| 134 Private method to initialize the camel case handling menu. | |
| 135 </p><a NAME="SplitMergeCamelCasePlugin.__loadTranslator" ID="SplitMergeCamelCasePlugin.__loadTranslator"></a> | |
| 136 <h4>SplitMergeCamelCasePlugin.__loadTranslator</h4> | |
| 137 <b>__loadTranslator</b>(<i></i>) | |
| 138 <p> | |
| 139 Private method to load the translation file. | |
| 140 </p><a NAME="SplitMergeCamelCasePlugin.__mergeCamelCase" ID="SplitMergeCamelCasePlugin.__mergeCamelCase"></a> | |
| 141 <h4>SplitMergeCamelCasePlugin.__mergeCamelCase</h4> | |
| 142 <b>__mergeCamelCase</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to merge the selected text to camel case. | |
| 145 </p><a NAME="SplitMergeCamelCasePlugin.__populateMenu" ID="SplitMergeCamelCasePlugin.__populateMenu"></a> | |
| 146 <h4>SplitMergeCamelCasePlugin.__populateMenu</h4> | |
| 147 <b>__populateMenu</b>(<i>name, menu</i>) | |
| 148 <p> | |
| 149 Private slot to populate the tools menu with our entries. | |
| 150 </p><dl> | |
| 151 <dt><i>name</i></dt> | |
| 152 <dd> | |
| 153 name of the menu (string) | |
| 154 </dd><dt><i>menu</i></dt> | |
| 155 <dd> | |
| 156 reference to the menu to be populated (QMenu) | |
| 157 </dd> | |
| 158 </dl><a NAME="SplitMergeCamelCasePlugin.__splitCamelCase" ID="SplitMergeCamelCasePlugin.__splitCamelCase"></a> | |
| 159 <h4>SplitMergeCamelCasePlugin.__splitCamelCase</h4> | |
| 160 <b>__splitCamelCase</b>(<i></i>) | |
| 161 <p> | |
| 162 Private slot to split the selected camel case text. | |
| 163 </p><a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCase" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCase"></a> | |
| 164 <h4>SplitMergeCamelCasePlugin.__underscoreToCamelCase</h4> | |
| 165 <b>__underscoreToCamelCase</b>(<i>uppercaseFirst=False</i>) | |
| 166 <p> | |
| 167 Private slot to convert underscore separated text to camel case. | |
| 168 </p><dl> | |
| 169 <dt><i>uppercaseFirst</i></dt> | |
| 170 <dd> | |
| 171 flag indicating to upper case the | |
| 172 first character (boolean) | |
| 173 </dd> | |
| 174 </dl><a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst"></a> | |
| 175 <h4>SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst</h4> | |
| 176 <b>__underscoreToCamelCaseUppercaseFirst</b>(<i></i>) | |
| 177 <p> | |
| 178 Private slot to convert underscore separated text to camel case | |
| 179 upper casing the first character. | |
| 180 </p><a NAME="SplitMergeCamelCasePlugin.activate" ID="SplitMergeCamelCasePlugin.activate"></a> | |
| 181 <h4>SplitMergeCamelCasePlugin.activate</h4> | |
| 182 <b>activate</b>(<i></i>) | |
| 183 <p> | |
| 184 Public method to activate this plugin. | |
| 185 </p><dl> | |
| 186 <dt>Returns:</dt> | |
| 187 <dd> | |
| 188 tuple of None and activation status (boolean) | |
| 189 </dd> | |
| 190 </dl><a NAME="SplitMergeCamelCasePlugin.deactivate" ID="SplitMergeCamelCasePlugin.deactivate"></a> | |
| 191 <h4>SplitMergeCamelCasePlugin.deactivate</h4> | |
| 192 <b>deactivate</b>(<i></i>) | |
| 193 <p> | |
| 194 Public method to deactivate this plugin. | |
| 195 </p> | |
| 196 <div align="right"><a href="#top">Up</a></div> | |
| 197 <hr /> | |
| 198 </body></html> |
