ProjectFlask/Documentation/source/Plugin_Project_Flask.PluginProjectFlask.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Flask.PluginProjectFlask</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_Project_Flask.PluginProjectFlask</h1>

<p>
Module implementing the Flask 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>error</td></tr><tr><td>flaskPluginObject</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="#ProjectFlaskPlugin">ProjectFlaskPlugin</a></td>
<td>Class implementing the Flask 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>
</tr>
<tr>
<td><a href="#createFlaskPage">createFlaskPage</a></td>
<td>Module function to create the Flask configuration page.</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="#prepareUninstall">prepareUninstall</a></td>
<td>Module function to prepare for an uninstallation.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="ProjectFlaskPlugin" ID="ProjectFlaskPlugin"></a>
<h2>ProjectFlaskPlugin</h2>

<p>
    Class implementing the Flask project plugin.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>

<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="#ProjectFlaskPlugin.__init__">ProjectFlaskPlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.__projectClosed">__projectClosed</a></td>
<td>Private slot to handle the projectClosed signal.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.__projectOpened">__projectOpened</a></td>
<td>Private slot to handle the projectOpened signal.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.__reregisterProjectType">__reregisterProjectType</a></td>
<td>Private method to re-register the project type.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td>
<td>Public method to determine the filename of a compiled translation file given the translation source file.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.fileTypesCallback">fileTypesCallback</a></td>
<td>Public method get the filetype associations of the Django project type.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.getDefaultPreference">getDefaultPreference</a></td>
<td>Public method to get the default value for a setting.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.getMenu">getMenu</a></td>
<td>Public method to get a reference to the requested menu.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.getMenuNames">getMenuNames</a></td>
<td>Public method to get the names of all menus.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.getPreferences">getPreferences</a></td>
<td>Public method to retrieve the various settings.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td>
<td>Public method to get the lexer association of the Django project type for a file.</td>
</tr>
<tr>
<td><a href="#ProjectFlaskPlugin.setPreferences">setPreferences</a></td>
<td>Public method to store the various settings.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ProjectFlaskPlugin.__init__" ID="ProjectFlaskPlugin.__init__"></a>
<h4>ProjectFlaskPlugin (Constructor)</h4>
<b>ProjectFlaskPlugin</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="ProjectFlaskPlugin.__initialize" ID="ProjectFlaskPlugin.__initialize"></a>
<h4>ProjectFlaskPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)

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

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

<p>
        Private slot to handle the projectClosed signal.
</p>
<a NAME="ProjectFlaskPlugin.__projectOpened" ID="ProjectFlaskPlugin.__projectOpened"></a>
<h4>ProjectFlaskPlugin.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)

<p>
        Private slot to handle the projectOpened signal.
</p>
<a NAME="ProjectFlaskPlugin.__reregisterProjectType" ID="ProjectFlaskPlugin.__reregisterProjectType"></a>
<h4>ProjectFlaskPlugin.__reregisterProjectType</h4>
<b>__reregisterProjectType</b>(<i></i>)

<p>
        Private method to re-register the project type.
</p>
<a NAME="ProjectFlaskPlugin.activate" ID="ProjectFlaskPlugin.activate"></a>
<h4>ProjectFlaskPlugin.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
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.binaryTranslationsCallback" ID="ProjectFlaskPlugin.binaryTranslationsCallback"></a>
<h4>ProjectFlaskPlugin.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>
<dd>
name of the translation source file
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
name of the binary translation file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.deactivate" ID="ProjectFlaskPlugin.deactivate"></a>
<h4>ProjectFlaskPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)

<p>
        Public method to deactivate this plugin.
</p>
<a NAME="ProjectFlaskPlugin.fileTypesCallback" ID="ProjectFlaskPlugin.fileTypesCallback"></a>
<h4>ProjectFlaskPlugin.fileTypesCallback</h4>
<b>fileTypesCallback</b>(<i></i>)

<p>
        Public method get the filetype associations of the Django project type.
</p>
<dl>
<dt>Returns:</dt>
<dd>
dictionary with file type associations
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.getDefaultPreference" ID="ProjectFlaskPlugin.getDefaultPreference"></a>
<h4>ProjectFlaskPlugin.getDefaultPreference</h4>
<b>getDefaultPreference</b>(<i>key</i>)

<p>
        Public method to get the default value for a setting.
</p>
<dl>

<dt><i>key</i> (str)</dt>
<dd>
the key of the value to get
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
the requested setting
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
any
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.getMenu" ID="ProjectFlaskPlugin.getMenu"></a>
<h4>ProjectFlaskPlugin.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>
<dd>
name of the menu
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
reference to the menu or None, if no
            menu with the given name exists
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu or None
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.getMenuNames" ID="ProjectFlaskPlugin.getMenuNames"></a>
<h4>ProjectFlaskPlugin.getMenuNames</h4>
<b>getMenuNames</b>(<i></i>)

<p>
        Public method to get the names of all menus.
</p>
<dl>
<dt>Returns:</dt>
<dd>
menu names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.getPreferences" ID="ProjectFlaskPlugin.getPreferences"></a>
<h4>ProjectFlaskPlugin.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)

<p>
        Public method to retrieve the various settings.
</p>
<dl>

<dt><i>key</i> (str)</dt>
<dd>
the key of the value to get
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
the requested setting
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
any
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.lexerAssociationCallback" ID="ProjectFlaskPlugin.lexerAssociationCallback"></a>
<h4>ProjectFlaskPlugin.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>
<dd>
name of the file
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
name of the lexer (Pygments lexers are prefixed with
            'Pygments|')
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ProjectFlaskPlugin.setPreferences" ID="ProjectFlaskPlugin.setPreferences"></a>
<h4>ProjectFlaskPlugin.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>
<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="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></dt>
<dd>
language to get APIs for (string)
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
list of API filenames (list of string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createFlaskPage" ID="createFlaskPage"></a>
<h2>createFlaskPage</h2>
<b>createFlaskPage</b>(<i>configDlg</i>)

<p>
    Module function to create the Flask configuration page.
</p>
<dl>

<dt><i>configDlg</i></dt>
<dd>
reference to the configuration dialog
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
reference to the configuration page
</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>Returns:</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>
    Module function to prepare for an uninstallation.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>