PySide2PyQt/Documentation/source/Plugin_Tools_PySide2PyQt.PluginPySide2PyQt.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Tools_PySide2PyQt.PluginPySide2PyQt</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_PySide2PyQt.PluginPySide2PyQt</h1>

<p>
Module implementing the PySide to PyQt (and vice versa) 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="#PySide2PyQtPlugin">PySide2PyQtPlugin</a></td>
<td>Class implementing the PySide to PyQt (and vice versa) plugin.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="PySide2PyQtPlugin" ID="PySide2PyQtPlugin"></a>
<h2>PySide2PyQtPlugin</h2>

<p>
    Class implementing the PySide to PyQt (and vice versa) plugin.
</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="#PySide2PyQtPlugin.__init__">PySide2PyQtPlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__editorClosed">__editorClosed</a></td>
<td>Private slot called, when an editor was closed.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__editorOpened">__editorOpened</a></td>
<td>Private slot called, when a new editor was opened.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__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="#PySide2PyQtPlugin.__initMenu">__initMenu</a></td>
<td>Private method to initialize the menu.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__populateMenu">__populateMenu</a></td>
<td>Private slot to populate the tools menu with our entries.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__pyqt2Pyside">__pyqt2Pyside</a></td>
<td>Private slot to convert the code of the current editor from PyQt to PySide.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.__pyside2Pyqt">__pyside2Pyqt</a></td>
<td>Private slot to convert the code of the current editor from PySide to PyQt.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#PySide2PyQtPlugin.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="PySide2PyQtPlugin.__init__" ID="PySide2PyQtPlugin.__init__"></a>
<h4>PySide2PyQtPlugin (Constructor)</h4>
<b>PySide2PyQtPlugin</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="PySide2PyQtPlugin.__editorClosed" ID="PySide2PyQtPlugin.__editorClosed"></a>
<h4>PySide2PyQtPlugin.__editorClosed</h4>
<b>__editorClosed</b>(<i>editor</i>)

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

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

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

<dt><i>editor</i></dt>
<dd>
reference to the new editor (QScintilla.Editor)
</dd>
</dl>
<a NAME="PySide2PyQtPlugin.__editorShowMenu" ID="PySide2PyQtPlugin.__editorShowMenu"></a>
<h4>PySide2PyQtPlugin.__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></dt>
<dd>
name of the menu to be shown (string)
</dd>
<dt><i>menu</i></dt>
<dd>
reference to the menu (QMenu)
</dd>
<dt><i>editor</i></dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="PySide2PyQtPlugin.__initMenu" ID="PySide2PyQtPlugin.__initMenu"></a>
<h4>PySide2PyQtPlugin.__initMenu</h4>
<b>__initMenu</b>(<i></i>)

<p>
        Private method to initialize the menu.
</p>
<a NAME="PySide2PyQtPlugin.__loadTranslator" ID="PySide2PyQtPlugin.__loadTranslator"></a>
<h4>PySide2PyQtPlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)

<p>
        Private method to load the translation file.
</p>
<a NAME="PySide2PyQtPlugin.__populateMenu" ID="PySide2PyQtPlugin.__populateMenu"></a>
<h4>PySide2PyQtPlugin.__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="PySide2PyQtPlugin.__pyqt2Pyside" ID="PySide2PyQtPlugin.__pyqt2Pyside"></a>
<h4>PySide2PyQtPlugin.__pyqt2Pyside</h4>
<b>__pyqt2Pyside</b>(<i>pyqt, pyside</i>)

<p>
        Private slot to convert the code of the current editor from PyQt
        to PySide.
</p>
<dl>

<dt><i>pyqt</i> (str)</dt>
<dd>
PyQt variant (pyqt5)
</dd>
<dt><i>pyside</i> (str)</dt>
<dd>
PySide variant (pyside2)
</dd>
</dl>
<a NAME="PySide2PyQtPlugin.__pyside2Pyqt" ID="PySide2PyQtPlugin.__pyside2Pyqt"></a>
<h4>PySide2PyQtPlugin.__pyside2Pyqt</h4>
<b>__pyside2Pyqt</b>(<i>pyside, pyqt</i>)

<p>
        Private slot to convert the code of the current editor from PySide
        to PyQt.
</p>
<dl>

<dt><i>pyside</i> (str)</dt>
<dd>
PySide variant (pyside2)
</dd>
<dt><i>pyqt</i> (str)</dt>
<dd>
PyQt variant (pyqt5)
</dd>
</dl>
<a NAME="PySide2PyQtPlugin.activate" ID="PySide2PyQtPlugin.activate"></a>
<h4>PySide2PyQtPlugin.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="PySide2PyQtPlugin.deactivate" ID="PySide2PyQtPlugin.deactivate"></a>
<h4>PySide2PyQtPlugin.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>