CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.PluginCxFreeze.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Packager_CxFreeze.PluginCxFreeze</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_Packager_CxFreeze.PluginCxFreeze</h1>
<p>
Module implementing the CxFreeze 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>exePy2</td></tr><tr><td>exePy3</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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#CxFreezePlugin">CxFreezePlugin</a></td>
<td>Class implementing the CxFreeze plugin.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#_checkProgram">_checkProgram</a></td>
<td>Restricted function to check the availability of cxfreeze.</td>
</tr><tr>
<td><a href="#_findExecutable">_findExecutable</a></td>
<td>Restricted function to determine the names of the executable.</td>
</tr><tr>
<td><a href="#exeDisplayDataList">exeDisplayDataList</a></td>
<td>Public method to support the display of some executable info.</td>
</tr><tr>
<td><a href="#getExePath">getExePath</a></td>
<td></td>
</tr>
</table>
<hr /><hr />
<a NAME="CxFreezePlugin" ID="CxFreezePlugin"></a>
<h2>CxFreezePlugin</h2>
<p>
    Class implementing the CxFreeze plugin.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#CxFreezePlugin.__init__">CxFreezePlugin</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#CxFreezePlugin.__cxfreeze">__cxfreeze</a></td>
<td>Private slot to handle the cxfreeze execution.</td>
</tr><tr>
<td><a href="#CxFreezePlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr><tr>
<td><a href="#CxFreezePlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr><tr>
<td><a href="#CxFreezePlugin.__projectShowMenu">__projectShowMenu</a></td>
<td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
</tr><tr>
<td><a href="#CxFreezePlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr><tr>
<td><a href="#CxFreezePlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="CxFreezePlugin.__init__" ID="CxFreezePlugin.__init__"></a>
<h4>CxFreezePlugin (Constructor)</h4>
<b>CxFreezePlugin</b>(<i>ui</i>)
<p>
        Constructor
</p><dl>
<dt><i>ui</i></dt>
<dd>
reference to the user interface object (UI.UserInterface)
</dd>
</dl><a NAME="CxFreezePlugin.__cxfreeze" ID="CxFreezePlugin.__cxfreeze"></a>
<h4>CxFreezePlugin.__cxfreeze</h4>
<b>__cxfreeze</b>(<i></i>)
<p>
        Private slot to handle the cxfreeze execution.
</p><a NAME="CxFreezePlugin.__initialize" ID="CxFreezePlugin.__initialize"></a>
<h4>CxFreezePlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
<p>
        Private slot to (re)initialize the plugin.
</p><a NAME="CxFreezePlugin.__loadTranslator" ID="CxFreezePlugin.__loadTranslator"></a>
<h4>CxFreezePlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)
<p>
        Private method to load the translation file.
</p><a NAME="CxFreezePlugin.__projectShowMenu" ID="CxFreezePlugin.__projectShowMenu"></a>
<h4>CxFreezePlugin.__projectShowMenu</h4>
<b>__projectShowMenu</b>(<i>menuName, menu</i>)
<p>
        Private slot called, when the the project menu or a submenu is
        about to be shown.
</p><dl>
<dt><i>menuName</i></dt>
<dd>
name of the menu to be shown (string)
</dd><dt><i>menu</i></dt>
<dd>
reference to the menu (QMenu)
</dd>
</dl><a NAME="CxFreezePlugin.activate" ID="CxFreezePlugin.activate"></a>
<h4>CxFreezePlugin.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 (boolean)
</dd>
</dl><a NAME="CxFreezePlugin.deactivate" ID="CxFreezePlugin.deactivate"></a>
<h4>CxFreezePlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
        Public method to deactivate this plugin.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="_checkProgram" ID="_checkProgram"></a>
<h2>_checkProgram</h2>
<b>_checkProgram</b>(<i></i>)
<p>
    Restricted function to check the availability of cxfreeze.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating availability (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="_findExecutable" ID="_findExecutable"></a>
<h2>_findExecutable</h2>
<b>_findExecutable</b>(<i>majorVersion</i>)
<p>
    Restricted function to determine the names of the executable.
</p><dl>
<dt><i>majorVersion</i></dt>
<dd>
major python version of the executables (int)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
names of the executable (list)
</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>
    Public method to support the display of some executable info.
</p><dl>
<dt>Returns:</dt>
<dd>
dictionary containing the data to query the presence of
        the executable
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getExePath" ID="getExePath"></a>
<h2>getExePath</h2>
<b>getExePath</b>(<i>branch, access, versionStr</i>)

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