tip/SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</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.__camelCaseToSnakeCase">__camelCaseToSnakeCase</a></td>
<td>Private slot to convert camel case text to underscore separated text.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__editorClosed">__editorClosed</a></td>
<td>Private slot called, when an editor was closed.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__editorOpened">__editorOpened</a></td>
<td>Private slot called, when a new editor was opened.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__editorShowMenu">__editorShowMenu</a></td>
<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</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.__mergeCamelCaseUppercaseFirst">__mergeCamelCaseUppercaseFirst</a></td>
<td>Private slot to merge the selected text to camel case upper casing the first character.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__mergeSnakeCase">__mergeSnakeCase</a></td>
<td>Private slot to merge the selected text to snake 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.__snakeCaseToCamelCase">__snakeCaseToCamelCase</a></td>
<td>Private slot to convert underscore separated text to camel case.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst">__snakeCaseToCamelCaseUppercaseFirst</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.__splitCamelCase">__splitCamelCase</a></td>
<td>Private slot to split the selected camel case text.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.__splitSnakeCase">__splitSnakeCase</a></td>
<td>Private slot to split the selected snake case text.</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> (UserInterface)</dt>
<dd>
reference to the user interface object
</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> (str)</dt>
<dd>
new (converted) text
</dd>
<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor to apply the text
            change to
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase" ID="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase"></a>
<h4>SplitMergeCamelCasePlugin.__camelCaseToSnakeCase</h4>
<b>__camelCaseToSnakeCase</b>(<i></i>)

<p>
        Private slot to convert camel case text to underscore separated text.
</p>
<a NAME="SplitMergeCamelCasePlugin.__editorClosed" ID="SplitMergeCamelCasePlugin.__editorClosed"></a>
<h4>SplitMergeCamelCasePlugin.__editorClosed</h4>
<b>__editorClosed</b>(<i>editor</i>)

<p>
        Private slot called, when an editor was closed.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__editorOpened" ID="SplitMergeCamelCasePlugin.__editorOpened"></a>
<h4>SplitMergeCamelCasePlugin.__editorOpened</h4>
<b>__editorOpened</b>(<i>editor</i>)

<p>
        Private slot called, when a new editor was opened.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the new editor
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__editorShowMenu" ID="SplitMergeCamelCasePlugin.__editorShowMenu"></a>
<h4>SplitMergeCamelCasePlugin.__editorShowMenu</h4>
<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)

<p>
        Private slot called, when the the editor context menu or a submenu is
        about to be shown.
</p>
<dl>

<dt><i>menuName</i> (str)</dt>
<dd>
name of the menu to be shown
</dd>
<dt><i>menu</i> (QMenu)</dt>
<dd>
reference to the menu
</dd>
<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<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>uppercaseFirst=False</i>)

<p>
        Private slot to merge the selected text to camel case.
</p>
<dl>

<dt><i>uppercaseFirst</i> (bool)</dt>
<dd>
flag indicating to upper case the
            first character
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst"></a>
<h4>SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst</h4>
<b>__mergeCamelCaseUppercaseFirst</b>(<i></i>)

<p>
        Private slot to merge the selected text to camel case upper casing
        the first character.
</p>
<a NAME="SplitMergeCamelCasePlugin.__mergeSnakeCase" ID="SplitMergeCamelCasePlugin.__mergeSnakeCase"></a>
<h4>SplitMergeCamelCasePlugin.__mergeSnakeCase</h4>
<b>__mergeSnakeCase</b>(<i></i>)

<p>
        Private slot to merge the selected text to snake 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> (str)</dt>
<dd>
name of the menu
</dd>
<dt><i>menu</i> (QMenu)</dt>
<dd>
reference to the menu to be populated
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase"></a>
<h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCase</h4>
<b>__snakeCaseToCamelCase</b>(<i>uppercaseFirst=False</i>)

<p>
        Private slot to convert underscore separated text to camel case.
</p>
<dl>

<dt><i>uppercaseFirst</i> (bool)</dt>
<dd>
flag indicating to upper case the
            first character
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst"></a>
<h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst</h4>
<b>__snakeCaseToCamelCaseUppercaseFirst</b>(<i></i>)

<p>
        Private slot to convert underscore separated text to camel case
        upper casing the first character.
</p>
<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.__splitSnakeCase" ID="SplitMergeCamelCasePlugin.__splitSnakeCase"></a>
<h4>SplitMergeCamelCasePlugin.__splitSnakeCase</h4>
<b>__splitSnakeCase</b>(<i></i>)

<p>
        Private slot to split the selected snake case text.
</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>Return:</dt>
<dd>
tuple of None and activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (None, bool)
</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>