tip/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Pyramid.PluginProjectPyramid</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Pyramid.PluginProjectPyramid</h1>

<p>
Module implementing the Pyramid 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>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>pyramidPluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ProjectPyramidPlugin">ProjectPyramidPlugin</a></td>
<td>Class implementing the Pyramid 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="#createPyramidPage">createPyramidPage</a></td>
<td>Module function to create the Pyramid 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="#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 uninstallation.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="ProjectPyramidPlugin" ID="ProjectPyramidPlugin"></a>
<h2>ProjectPyramidPlugin</h2>

<p>
    Class implementing the Pyramid 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="#ProjectPyramidPlugin.__init__">ProjectPyramidPlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.__projectClosed">__projectClosed</a></td>
<td>Private slot to handle the projectClosed signal.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.__projectOpened">__projectOpened</a></td>
<td>Private slot to handle the projectOpened signal.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.__reregisterProjectType">__reregisterProjectType</a></td>
<td>Private method to re-register the project type.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.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="#ProjectPyramidPlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.fileTypesCallback">fileTypesCallback</a></td>
<td>Public method get the filetype associations of the Pyramid project type.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.getDefaultPreference">getDefaultPreference</a></td>
<td>Public method to get the default value for a setting.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.getMenu">getMenu</a></td>
<td>Public method to get a reference to the requested menu.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.getMenuNames">getMenuNames</a></td>
<td>Public method to get the names of all menus.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.getPreferences">getPreferences</a></td>
<td>Public method to retrieve the various settings.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td>
<td>Public method to get the lexer association of the Pyramid project type for a file.</td>
</tr>
<tr>
<td><a href="#ProjectPyramidPlugin.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="ProjectPyramidPlugin.__init__" ID="ProjectPyramidPlugin.__init__"></a>
<h4>ProjectPyramidPlugin (Constructor)</h4>
<b>ProjectPyramidPlugin</b>(<i>ui</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>ui</i> (UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a>
<h4>ProjectPyramidPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)

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

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

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

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

<p>
        Private method to re-register the project type.
</p>
<a NAME="ProjectPyramidPlugin.activate" ID="ProjectPyramidPlugin.activate"></a>
<h4>ProjectPyramidPlugin.activate</h4>
<b>activate</b>(<i></i>)

<p>
        Public method to activate this plugin.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple of None and activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
(None, bool)
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a>
<h4>ProjectPyramidPlugin.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>Return:</dt>
<dd>
name of the binary translation file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a>
<h4>ProjectPyramidPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)

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

<p>
        Public method get the filetype associations of the Pyramid project
        type.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary with file type associations
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a>
<h4>ProjectPyramidPlugin.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>
key of the value to get
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
value of the requested setting
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a>
<h4>ProjectPyramidPlugin.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>Return:</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
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.getMenuNames" ID="ProjectPyramidPlugin.getMenuNames"></a>
<h4>ProjectPyramidPlugin.getMenuNames</h4>
<b>getMenuNames</b>(<i></i>)

<p>
        Public method to get the names of all menus.
</p>
<dl>
<dt>Return:</dt>
<dd>
menu names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a>
<h4>ProjectPyramidPlugin.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>
key of the value to get
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
value of the requested setting
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a>
<h4>ProjectPyramidPlugin.lexerAssociationCallback</h4>
<b>lexerAssociationCallback</b>(<i>filename</i>)

<p>
        Public method to get the lexer association of the Pyramid project type
        for a file.
</p>
<dl>

<dt><i>filename</i> (str)</dt>
<dd>
name of the file
</dd>
</dl>
<dl>
<dt>Return:</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="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a>
<h4>ProjectPyramidPlugin.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>
key of the setting to be set
</dd>
<dt><i>value</i> (Any)</dt>
<dd>
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> (str)</dt>
<dd>
language to get APIs for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of API filenames
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createPyramidPage" ID="createPyramidPage"></a>
<h2>createPyramidPage</h2>
<b>createPyramidPage</b>(<i>configDlg</i>)

<p>
    Module function to create the Pyramid 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>
PyramidPage
</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 uninstallation.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>