--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ExtensionProtobuf/Documentation/source/Plugin_Extension_Protobuf.PluginExtensionProtobuf.html Sun Dec 04 14:32:07 2022 +0100 @@ -0,0 +1,313 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Extension_Protobuf.PluginExtensionProtobuf</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Extension_Protobuf.PluginExtensionProtobuf</h1> + +<p> +Module implementing a plugin to add support for Protobuf development. +</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>protobufExtensionPluginObject</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="#ProtobufExtensionPlugin">ProtobufExtensionPlugin</a></td> +<td>Class implementing a plugin to add support for Protobuf development.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#createProtobufPage">createProtobufPage</a></td> +<td>Module function to create the Protobuf configuration page.</td> +</tr> +<tr> +<td><a href="#exeDisplayDataList">exeDisplayDataList</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="ProtobufExtensionPlugin" ID="ProtobufExtensionPlugin"></a> +<h2>ProtobufExtensionPlugin</h2> + +<p> + Class implementing a plugin to add support for Protobuf development. +</p> +<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="#ProtobufExtensionPlugin.__init__">ProtobufExtensionPlugin</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.activate">activate</a></td> +<td>Public method to activate this plug-in.</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plug-in.</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings values.</td> +</tr> +<tr> +<td><a href="#ProtobufExtensionPlugin.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="ProtobufExtensionPlugin.__init__" ID="ProtobufExtensionPlugin.__init__"></a> +<h4>ProtobufExtensionPlugin (Constructor)</h4> +<b>ProtobufExtensionPlugin</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="ProtobufExtensionPlugin.__initialize" ID="ProtobufExtensionPlugin.__initialize"></a> +<h4>ProtobufExtensionPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) + +<p> + Private slot to (re)initialize the plugin. +</p> +<a NAME="ProtobufExtensionPlugin.__loadTranslator" ID="ProtobufExtensionPlugin.__loadTranslator"></a> +<h4>ProtobufExtensionPlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) + +<p> + Private method to load the translation file. +</p> +<a NAME="ProtobufExtensionPlugin.activate" ID="ProtobufExtensionPlugin.activate"></a> +<h4>ProtobufExtensionPlugin.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="ProtobufExtensionPlugin.deactivate" ID="ProtobufExtensionPlugin.deactivate"></a> +<h4>ProtobufExtensionPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) + +<p> + Public method to deactivate this plug-in. +</p> +<a NAME="ProtobufExtensionPlugin.getPreferences" ID="ProtobufExtensionPlugin.getPreferences"></a> +<h4>ProtobufExtensionPlugin.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="ProtobufExtensionPlugin.setPreferences" ID="ProtobufExtensionPlugin.setPreferences"></a> +<h4>ProtobufExtensionPlugin.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="createProtobufPage" ID="createProtobufPage"></a> +<h2>createProtobufPage</h2> +<b>createProtobufPage</b>(<i>configDlg</i>) + +<p> + Module function to create the Protobuf 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> +CorbaPage +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> +<h2>exeDisplayDataList</h2> +<b>exeDisplayDataList</b>(<i></i>) + +<p> + Module function to support the display of some executable info. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of dictionaries containing the data to query the presence of + the executable +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of 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> \ No newline at end of file