--- a/ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html Tue Dec 10 15:48:57 2024 +0100
+++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html Thu Dec 26 14:19:48 2024 +0100
@@ -7,28 +7,27 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Django.PluginProjectDjango</h1>
-
<p>
Module implementing the Django project plugin.
</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>djangoPluginObject</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>
+<tr><td>__header__</td></tr>
+<tr><td>djangoPluginObject</td></tr>
+<tr><td>error</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ProjectDjangoPlugin">ProjectDjangoPlugin</a></td>
<td>Class implementing the Django project plugin.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#apiFiles">apiFiles</a></td>
<td>Module function to return the API files made available by this plugin.</td>
@@ -46,30 +45,30 @@
<td>Module function to prepare for an uninstallation.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="ProjectDjangoPlugin" ID="ProjectDjangoPlugin"></a>
<h2>ProjectDjangoPlugin</h2>
-
<p>
Class implementing the Django project plugin.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>PreferencesKey</td></tr>
+<tr><td>lexerAssociations</td></tr>
+</table>
-<table>
-<tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ProjectDjangoPlugin.__init__">ProjectDjangoPlugin</a></td>
<td>Constructor</td>
@@ -131,19 +130,20 @@
<td>Public method to store the various settings.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectDjangoPlugin.__init__" ID="ProjectDjangoPlugin.__init__"></a>
<h4>ProjectDjangoPlugin (Constructor)</h4>
<b>ProjectDjangoPlugin</b>(<i>ui</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>ui</i> (UserInterface)</dt>
@@ -154,45 +154,45 @@
<a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a>
<h4>ProjectDjangoPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private slot to (re)initialize the plugin.
</p>
+
<a NAME="ProjectDjangoPlugin.__loadTranslator" ID="ProjectDjangoPlugin.__loadTranslator"></a>
<h4>ProjectDjangoPlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)
-
<p>
Private method to load the translation file.
</p>
+
<a NAME="ProjectDjangoPlugin.__projectClosed" ID="ProjectDjangoPlugin.__projectClosed"></a>
<h4>ProjectDjangoPlugin.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to handle the projectClosed signal.
</p>
+
<a NAME="ProjectDjangoPlugin.__projectOpened" ID="ProjectDjangoPlugin.__projectOpened"></a>
<h4>ProjectDjangoPlugin.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
-
<p>
Private slot to handle the projectOpened signal.
</p>
+
<a NAME="ProjectDjangoPlugin.__reregisterProjectType" ID="ProjectDjangoPlugin.__reregisterProjectType"></a>
<h4>ProjectDjangoPlugin.__reregisterProjectType</h4>
<b>__reregisterProjectType</b>(<i></i>)
-
<p>
Private method to re-register the project type.
</p>
+
<a NAME="ProjectDjangoPlugin.activate" ID="ProjectDjangoPlugin.activate"></a>
<h4>ProjectDjangoPlugin.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate this plugin.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -208,11 +208,11 @@
<a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a>
<h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4>
<b>binaryTranslationsCallback</b>(<i>filename</i>)
-
<p>
Public method to determine the filename of a compiled translation file
given the translation source file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -235,17 +235,17 @@
<a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a>
<h4>ProjectDjangoPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
-
<p>
Public method to deactivate this plugin.
</p>
+
<a NAME="ProjectDjangoPlugin.fileTypesCallback" ID="ProjectDjangoPlugin.fileTypesCallback"></a>
<h4>ProjectDjangoPlugin.fileTypesCallback</h4>
<b>fileTypesCallback</b>(<i></i>)
-
<p>
Public method get the filetype associations of the Django project type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -261,10 +261,10 @@
<a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a>
<h4>ProjectDjangoPlugin.getMenu</h4>
<b>getMenu</b>(<i>name</i>)
-
<p>
Public method to get a reference to the requested menu.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -287,10 +287,10 @@
<a NAME="ProjectDjangoPlugin.getMenuNames" ID="ProjectDjangoPlugin.getMenuNames"></a>
<h4>ProjectDjangoPlugin.getMenuNames</h4>
<b>getMenuNames</b>(<i></i>)
-
<p>
Public method to get the names of all menus.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -306,10 +306,10 @@
<a NAME="ProjectDjangoPlugin.getPreferences" ID="ProjectDjangoPlugin.getPreferences"></a>
<h4>ProjectDjangoPlugin.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
-
<p>
Public method to retrieve the various settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -332,11 +332,11 @@
<a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a>
<h4>ProjectDjangoPlugin.lexerAssociationCallback</h4>
<b>lexerAssociationCallback</b>(<i>filename</i>)
-
<p>
Public method to get the lexer association of the Django project type
for a file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -360,10 +360,10 @@
<a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a>
<h4>ProjectDjangoPlugin.setPreferences</h4>
<b>setPreferences</b>(<i>key, value</i>)
-
<p>
Public method to store the various settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -381,10 +381,10 @@
<a NAME="apiFiles" ID="apiFiles"></a>
<h2>apiFiles</h2>
<b>apiFiles</b>(<i>language</i>)
-
<p>
Module function to return the API files made available by this plugin.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -410,10 +410,10 @@
<a NAME="createDjangoPage" ID="createDjangoPage"></a>
<h2>createDjangoPage</h2>
<b>createDjangoPage</b>(<i>configDlg</i>)
-
<p>
Module function to create the Django configuration page.
</p>
+
<dl>
<dt><i>configDlg</i> (ConfigurationWidget)</dt>
@@ -439,10 +439,10 @@
<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>
@@ -461,10 +461,10 @@
<a NAME="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
-
<p>
Module function to prepare for an uninstallation.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
