tip/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.PluginAiOllama.html

<!DOCTYPE html>
<html><head>
<title>Plugin_AI_Ollama.PluginAiOllama</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_AI_Ollama.PluginAiOllama</h1>
<p>
Module implementing the ollama 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>ollamaInterfacePluginObject</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#PluginOllamaInterface">PluginOllamaInterface</a></td>
<td>Class implementing the ollama Interface plug-in.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#clearPrivateData">clearPrivateData</a></td>
<td>Function to clear the private data of the plug-in.</td>
</tr>
<tr>
<td><a href="#createOllamaPage">createOllamaPage</a></td>
<td>Function to create the 'ollama' interface' configuration page.</td>
</tr>
<tr>
<td><a href="#getConfigData">getConfigData</a></td>
<td>Function returning data as required by the configuration dialog.</td>
</tr>
<tr>
<td><a href="#prepareUninstall">prepareUninstall</a></td>
<td>Function to prepare for an un-installation.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="PluginOllamaInterface" ID="PluginOllamaInterface"></a>
<h2>PluginOllamaInterface</h2>
<p>
    Class implementing the ollama Interface plug-in.
</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="#PluginOllamaInterface.__init__">PluginOllamaInterface</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.__activateLeftRightSidebarWidget">__activateLeftRightSidebarWidget</a></td>
<td>Private method to activate the given widget in the left or right sidebar.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.__activateWidget">__activateWidget</a></td>
<td>Private slot to handle the activation of the pipx interface.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.activate">activate</a></td>
<td>Public method to activate this plug-in.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.deactivate">deactivate</a></td>
<td>Public method to deactivate this plug-in.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.getPreferences">getPreferences</a></td>
<td>Public method to retrieve the various settings values.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.getWidget">getWidget</a></td>
<td>Public method to get a reference to the 'ollama' widget.</td>
</tr>
<tr>
<td><a href="#PluginOllamaInterface.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="PluginOllamaInterface.__init__" ID="PluginOllamaInterface.__init__"></a>
<h4>PluginOllamaInterface (Constructor)</h4>
<b>PluginOllamaInterface</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="PluginOllamaInterface.__activateLeftRightSidebarWidget" ID="PluginOllamaInterface.__activateLeftRightSidebarWidget"></a>
<h4>PluginOllamaInterface.__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="PluginOllamaInterface.__activateWidget" ID="PluginOllamaInterface.__activateWidget"></a>
<h4>PluginOllamaInterface.__activateWidget</h4>
<b>__activateWidget</b>(<i></i>)
<p>
        Private slot to handle the activation of the pipx interface.
</p>

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

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

<a NAME="PluginOllamaInterface.activate" ID="PluginOllamaInterface.activate"></a>
<h4>PluginOllamaInterface.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="PluginOllamaInterface.deactivate" ID="PluginOllamaInterface.deactivate"></a>
<h4>PluginOllamaInterface.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
        Public method to deactivate this plug-in.
</p>

<a NAME="PluginOllamaInterface.getPreferences" ID="PluginOllamaInterface.getPreferences"></a>
<h4>PluginOllamaInterface.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="PluginOllamaInterface.getWidget" ID="PluginOllamaInterface.getWidget"></a>
<h4>PluginOllamaInterface.getWidget</h4>
<b>getWidget</b>(<i></i>)
<p>
        Public method to get a reference to the 'ollama' widget.
</p>

<dl>
<dt>Return:</dt>
<dd>
reference to the 'ollama' widget
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
OllamaWidget
</dd>
</dl>
<a NAME="PluginOllamaInterface.setPreferences" ID="PluginOllamaInterface.setPreferences"></a>
<h4>PluginOllamaInterface.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="clearPrivateData" ID="clearPrivateData"></a>
<h2>clearPrivateData</h2>
<b>clearPrivateData</b>(<i></i>)
<p>
    Function to clear the private data of the plug-in.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createOllamaPage" ID="createOllamaPage"></a>
<h2>createOllamaPage</h2>
<b>createOllamaPage</b>(<i>_configDlg</i>)
<p>
    Function to create the 'ollama' interface' configuration page.
</p>

<dl>

<dt><i>_configDlg</i> (ConfigurationWidget)</dt>
<dd>
reference to the configuration dialog
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the configuration page
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
OllamaPage
</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>
    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="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
<p>
    Function to prepare for an un-installation.
</p>

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