tip/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Pipx_Interface.PluginPipxInterface</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Pipx_Interface.PluginPipxInterface</h1>
<p>
Module implementing the pipx Interface plug-in.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>_Side</td></tr>
<tr><td>__header__</td></tr>
<tr><td>error</td></tr>
<tr><td>pipxInterfacePluginObject</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#PluginPipxInterface">PluginPipxInterface</a></td>
<td>Class documentation goes here.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#createPipxPage">createPipxPage</a></td>
<td>Module function to create the pipx configuration page.</td>
</tr>
<tr>
<td><a href="#exeDisplayData">exeDisplayData</a></td>
<td>Module function to support the display of some executable info.</td>
</tr>
<tr>
<td><a href="#getConfigData">getConfigData</a></td>
<td>Module function returning data as required by the configuration dialog.</td>
</tr>
<tr>
<td><a href="#installDependencies">installDependencies</a></td>
<td>Function to install dependencies of this plug-in.</td>
</tr>
<tr>
<td><a href="#prepareUninstall">prepareUninstall</a></td>
<td>Module function to prepare for an un-installation.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="PluginPipxInterface" ID="PluginPipxInterface"></a>
<h2>PluginPipxInterface</h2>
<p>
    Class documentation goes here.
</p>

<h3>Signals</h3>
<dl>

<dt>preferencesChanged()</dt>
<dd>
emitted to signal a change of preferences. This
        signal is simply relayed from the main UI.
</dd>
</dl>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>PreferencesKey</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#PluginPipxInterface.__init__">PluginPipxInterface</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.__activateLeftRightSidebarWidget">__activateLeftRightSidebarWidget</a></td>
<td>Private method to activate the given widget in the left or right sidebar.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.__activateWidget">__activateWidget</a></td>
<td>Private slot to handle the activation of the pipx interface.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.__setLeftRightSidebarWidgetIcon">__setLeftRightSidebarWidgetIcon</a></td>
<td>Private method to set the icon of the given widget in the left or right sidebar.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.activate">activate</a></td>
<td>Public method to activate this plug-in.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.deactivate">deactivate</a></td>
<td>Public method to deactivate this plug-in.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.getPreferences">getPreferences</a></td>
<td>Public method to retrieve the various settings values.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.setOutdatedIndicator">setOutdatedIndicator</a></td>
<td>Public method to set or clear the outdated indication of the pipx icon.</td>
</tr>
<tr>
<td><a href="#PluginPipxInterface.setPreferences">setPreferences</a></td>
<td>Public method to store the various settings values.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="PluginPipxInterface.__init__" ID="PluginPipxInterface.__init__"></a>
<h4>PluginPipxInterface (Constructor)</h4>
<b>PluginPipxInterface</b>(<i>ui</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>ui</i> (UI.UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
</dl>
<a NAME="PluginPipxInterface.__activateLeftRightSidebarWidget" ID="PluginPipxInterface.__activateLeftRightSidebarWidget"></a>
<h4>PluginPipxInterface.__activateLeftRightSidebarWidget</h4>
<b>__activateLeftRightSidebarWidget</b>(<i>widget</i>)
<p>
        Private method to activate the given widget in the left or right
        sidebar.
</p>

<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to be activated
</dd>
</dl>
<a NAME="PluginPipxInterface.__activateWidget" ID="PluginPipxInterface.__activateWidget"></a>
<h4>PluginPipxInterface.__activateWidget</h4>
<b>__activateWidget</b>(<i></i>)
<p>
        Private slot to handle the activation of the pipx interface.
</p>

<a NAME="PluginPipxInterface.__initialize" ID="PluginPipxInterface.__initialize"></a>
<h4>PluginPipxInterface.__initialize</h4>
<b>__initialize</b>(<i></i>)
<p>
        Private slot to (re)initialize the plugin.
</p>

<a NAME="PluginPipxInterface.__loadTranslator" ID="PluginPipxInterface.__loadTranslator"></a>
<h4>PluginPipxInterface.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)
<p>
        Private method to load the translation file.
</p>

<a NAME="PluginPipxInterface.__setLeftRightSidebarWidgetIcon" ID="PluginPipxInterface.__setLeftRightSidebarWidgetIcon"></a>
<h4>PluginPipxInterface.__setLeftRightSidebarWidgetIcon</h4>
<b>__setLeftRightSidebarWidgetIcon</b>(<i>widget, icon</i>)
<p>
        Private method to set the icon of the given widget in the left or right
        sidebar.
</p>

<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to set the icon for
</dd>
<dt><i>icon</i> (QIcon)</dt>
<dd>
icon to be set
</dd>
</dl>
<a NAME="PluginPipxInterface.activate" ID="PluginPipxInterface.activate"></a>
<h4>PluginPipxInterface.activate</h4>
<b>activate</b>(<i></i>)
<p>
        Public method to activate this plug-in.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of None and activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="PluginPipxInterface.deactivate" ID="PluginPipxInterface.deactivate"></a>
<h4>PluginPipxInterface.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
        Public method to deactivate this plug-in.
</p>

<a NAME="PluginPipxInterface.getPreferences" ID="PluginPipxInterface.getPreferences"></a>
<h4>PluginPipxInterface.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
<p>
        Public method to retrieve the various settings values.
</p>

<dl>

<dt><i>key</i> (str)</dt>
<dd>
the key of the value to get
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
the requested setting value
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<a NAME="PluginPipxInterface.setOutdatedIndicator" ID="PluginPipxInterface.setOutdatedIndicator"></a>
<h4>PluginPipxInterface.setOutdatedIndicator</h4>
<b>setOutdatedIndicator</b>(<i>outdated</i>)
<p>
        Public method to set or clear the outdated indication of the pipx icon.
</p>

<dl>

<dt><i>outdated</i> (bool)</dt>
<dd>
flag indicating outdated packages or dependencies
</dd>
</dl>
<a NAME="PluginPipxInterface.setPreferences" ID="PluginPipxInterface.setPreferences"></a>
<h4>PluginPipxInterface.setPreferences</h4>
<b>setPreferences</b>(<i>key, value</i>)
<p>
        Public method to store the various settings values.
</p>

<dl>

<dt><i>key</i> (str)</dt>
<dd>
the key of the setting to be set
</dd>
<dt><i>value</i> (Any)</dt>
<dd>
the value to be set
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createPipxPage" ID="createPipxPage"></a>
<h2>createPipxPage</h2>
<b>createPipxPage</b>(<i>_configDlg</i>)
<p>
    Module function to create the pipx configuration page.
</p>

<dl>

<dt><i>_configDlg</i> (ConfigurationWidget)</dt>
<dd>
reference to the configuration dialog (unused)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the configuration page
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
PipxPage
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="exeDisplayData" ID="exeDisplayData"></a>
<h2>exeDisplayData</h2>
<b>exeDisplayData</b>(<i></i>)
<p>
    Module function to support the display of some executable info.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the data to query the presence of
        the executable
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getConfigData" ID="getConfigData"></a>
<h2>getConfigData</h2>
<b>getConfigData</b>(<i></i>)
<p>
    Module function returning data as required by the configuration dialog.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the relevant data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="installDependencies" ID="installDependencies"></a>
<h2>installDependencies</h2>
<b>installDependencies</b>(<i>pipInstall</i>)
<p>
    Function to install dependencies of this plug-in.
</p>

<dl>

<dt><i>pipInstall</i> (function)</dt>
<dd>
function to be called with a list of package names.
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
<p>
    Module function to prepare for an un-installation.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>