--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html Sat Dec 21 15:26:24 2013 +0100 @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase</h1> +<p> +Module implementing the split, merge or convert camel case plug-in. +</p> +<h3>Global Attributes</h3> +<table> +<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> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SplitMergeCamelCasePlugin">SplitMergeCamelCasePlugin</a></td> +<td>Class implementing the split, merge or convert camel case plug-in.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SplitMergeCamelCasePlugin" ID="SplitMergeCamelCasePlugin"></a> +<h2>SplitMergeCamelCasePlugin</h2> +<p> + Class implementing the split, merge or convert camel case plug-in. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SplitMergeCamelCasePlugin.__init__">SplitMergeCamelCasePlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__applyChange">__applyChange</a></td> +<td>Private method to change the selected text.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__camelCaseToUnderscore">__camelCaseToUnderscore</a></td> +<td>Private slot to convert camel case text to underscore separated text.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__initMenu">__initMenu</a></td> +<td>Private method to initialize the camel case handling menu.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCase">__mergeCamelCase</a></td> +<td>Private slot to merge the selected text to camel case.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__populateMenu">__populateMenu</a></td> +<td>Private slot to populate the tools menu with our entries.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__splitCamelCase">__splitCamelCase</a></td> +<td>Private slot to split the selected camel case text.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCase">__underscoreToCamelCase</a></td> +<td>Private slot to convert underscore separated text to camel case.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst">__underscoreToCamelCaseUppercaseFirst</a></td> +<td>Private slot to convert underscore separated text to camel case upper casing the first character.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#SplitMergeCamelCasePlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="SplitMergeCamelCasePlugin.__init__" ID="SplitMergeCamelCasePlugin.__init__"></a> +<h4>SplitMergeCamelCasePlugin (Constructor)</h4> +<b>SplitMergeCamelCasePlugin</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the user interface object (UI.UserInterface) +</dd> +</dl><a NAME="SplitMergeCamelCasePlugin.__applyChange" ID="SplitMergeCamelCasePlugin.__applyChange"></a> +<h4>SplitMergeCamelCasePlugin.__applyChange</h4> +<b>__applyChange</b>(<i>newText, editor</i>) +<p> + Private method to change the selected text. +</p><dl> +<dt><i>newText</i></dt> +<dd> +new (converted) text (string) +</dd><dt><i>editor</i></dt> +<dd> +reference to the editor to apply the text + change to (Editor) +</dd> +</dl><a NAME="SplitMergeCamelCasePlugin.__camelCaseToUnderscore" ID="SplitMergeCamelCasePlugin.__camelCaseToUnderscore"></a> +<h4>SplitMergeCamelCasePlugin.__camelCaseToUnderscore</h4> +<b>__camelCaseToUnderscore</b>(<i></i>) +<p> + Private slot to convert camel case text to underscore separated text. +</p><a NAME="SplitMergeCamelCasePlugin.__initMenu" ID="SplitMergeCamelCasePlugin.__initMenu"></a> +<h4>SplitMergeCamelCasePlugin.__initMenu</h4> +<b>__initMenu</b>(<i></i>) +<p> + Private method to initialize the camel case handling menu. +</p><a NAME="SplitMergeCamelCasePlugin.__loadTranslator" ID="SplitMergeCamelCasePlugin.__loadTranslator"></a> +<h4>SplitMergeCamelCasePlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) +<p> + Private method to load the translation file. +</p><a NAME="SplitMergeCamelCasePlugin.__mergeCamelCase" ID="SplitMergeCamelCasePlugin.__mergeCamelCase"></a> +<h4>SplitMergeCamelCasePlugin.__mergeCamelCase</h4> +<b>__mergeCamelCase</b>(<i></i>) +<p> + Private slot to merge the selected text to camel case. +</p><a NAME="SplitMergeCamelCasePlugin.__populateMenu" ID="SplitMergeCamelCasePlugin.__populateMenu"></a> +<h4>SplitMergeCamelCasePlugin.__populateMenu</h4> +<b>__populateMenu</b>(<i>name, menu</i>) +<p> + Private slot to populate the tools menu with our entries. +</p><dl> +<dt><i>name</i></dt> +<dd> +name of the menu (string) +</dd><dt><i>menu</i></dt> +<dd> +reference to the menu to be populated (QMenu) +</dd> +</dl><a NAME="SplitMergeCamelCasePlugin.__splitCamelCase" ID="SplitMergeCamelCasePlugin.__splitCamelCase"></a> +<h4>SplitMergeCamelCasePlugin.__splitCamelCase</h4> +<b>__splitCamelCase</b>(<i></i>) +<p> + Private slot to split the selected camel case text. +</p><a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCase" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCase"></a> +<h4>SplitMergeCamelCasePlugin.__underscoreToCamelCase</h4> +<b>__underscoreToCamelCase</b>(<i>uppercaseFirst=False</i>) +<p> + Private slot to convert underscore separated text to camel case. +</p><dl> +<dt><i>uppercaseFirst</i></dt> +<dd> +flag indicating to upper case the + first character (boolean) +</dd> +</dl><a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst"></a> +<h4>SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst</h4> +<b>__underscoreToCamelCaseUppercaseFirst</b>(<i></i>) +<p> + Private slot to convert underscore separated text to camel case + upper casing the first character. +</p><a NAME="SplitMergeCamelCasePlugin.activate" ID="SplitMergeCamelCasePlugin.activate"></a> +<h4>SplitMergeCamelCasePlugin.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="SplitMergeCamelCasePlugin.deactivate" ID="SplitMergeCamelCasePlugin.deactivate"></a> +<h4>SplitMergeCamelCasePlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plugin. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file