--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.Project.html Sun Mar 24 13:26:59 2013 +0100 @@ -0,0 +1,904 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Django.ProjectDjango.Project</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_Django.ProjectDjango.Project</h1> +<p> +Module implementing the Django project support. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#DjangoNoSiteSelectedException">DjangoNoSiteSelectedException</a></td> +<td>Exception thrown to signal, that there is no current site.</td> +</tr><tr> +<td><a href="#Project">Project</a></td> +<td>Class implementing the Django project support.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="DjangoNoSiteSelectedException" ID="DjangoNoSiteSelectedException"></a> +<h2>DjangoNoSiteSelectedException</h2> +<p> + Exception thrown to signal, that there is no current site. +</p> +<h3>Derived from</h3> +Exception +<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>None</td></tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="Project" ID="Project"></a> +<h2>Project</h2> +<p> + Class implementing the Django project support. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>RecentApplicationsKey</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Project.__init__">Project</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Project.__cleanup">__cleanup</a></td> +<td>Private slot to clean out old data from the database.</td> +</tr><tr> +<td><a href="#Project.__createApplication">__createApplication</a></td> +<td>Private slot to create a new Django application.</td> +</tr><tr> +<td><a href="#Project.__createCacheTables">__createCacheTables</a></td> +<td>Private slot to create the tables for the SQL caching backend.</td> +</tr><tr> +<td><a href="#Project.__createProject">__createProject</a></td> +<td>Private slot to create a new Django project.</td> +</tr><tr> +<td><a href="#Project.__databaseFlush">__databaseFlush</a></td> +<td>Private slot to return all database tables to the state just after their installation.</td> +</tr><tr> +<td><a href="#Project.__databaseInspect">__databaseInspect</a></td> +<td>Private slot to introspect the database and output a Django model module.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlCreateEverything">__databaseSqlCreateEverything</a></td> +<td>Private slot to print the CREATE TABLE, custom SQL and CREATE INDEX SQL statements for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlCreateIndexes">__databaseSqlCreateIndexes</a></td> +<td>Private slot to print the CREATE INDEX SQL statements for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlCreateTables">__databaseSqlCreateTables</a></td> +<td>Private slot to print the CREATE TABLE SQL statements for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlCustom">__databaseSqlCustom</a></td> +<td>Private slot to print the custom table modifying SQL statements for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlDropTables">__databaseSqlDropTables</a></td> +<td>Private slot to print the DROP TABLE SQL statements for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlFlushDatabase">__databaseSqlFlushDatabase</a></td> +<td>Private slot to print a list of statements to return all database tables to their initial state.</td> +</tr><tr> +<td><a href="#Project.__databaseSqlResetSequences">__databaseSqlResetSequences</a></td> +<td>Private slot to print the SQL statements for resetting sequences for one or more applications.</td> +</tr><tr> +<td><a href="#Project.__databaseSynchronize">__databaseSynchronize</a></td> +<td>Private slot to synchronize the database.</td> +</tr><tr> +<td><a href="#Project.__diffSettings">__diffSettings</a></td> +<td>Private slot to show the changes made to the settings.py file.</td> +</tr><tr> +<td><a href="#Project.__djangoInfo">__djangoInfo</a></td> +<td>Private slot to show some info about Django.</td> +</tr><tr> +<td><a href="#Project.__dumpData">__dumpData</a></td> +<td>Private slot to dump the database data to a fixture.</td> +</tr><tr> +<td><a href="#Project.__findSites">__findSites</a></td> +<td>Private method to determine the relative path to all manage.py scripts.</td> +</tr><tr> +<td><a href="#Project.__getApplications">__getApplications</a></td> +<td>Private method to ask the user for a list of application names.</td> +</tr><tr> +<td><a href="#Project.__getLocale">__getLocale</a></td> +<td>Private method to extract the locale out of a file name.</td> +</tr><tr> +<td><a href="#Project.__getPythonExecutable">__getPythonExecutable</a></td> +<td>Private method to determine the name of the Python executable.</td> +</tr><tr> +<td><a href="#Project.__initDatabaseActions">__initDatabaseActions</a></td> +<td>Private method to define the database related actions.</td> +</tr><tr> +<td><a href="#Project.__initDatabaseMenu">__initDatabaseMenu</a></td> +<td>Private slot to initialize the database menu.</td> +</tr><tr> +<td><a href="#Project.__initDatabaseSqlActions">__initDatabaseSqlActions</a></td> +<td>Private method to define the database SQL related actions.</td> +</tr><tr> +<td><a href="#Project.__initDatabaseSqlMenu">__initDatabaseSqlMenu</a></td> +<td>Private slot to initialize the database SQL submenu.</td> +</tr><tr> +<td><a href="#Project.__initTestingActions">__initTestingActions</a></td> +<td>Private method to define the testing actions.</td> +</tr><tr> +<td><a href="#Project.__initTestingMenu">__initTestingMenu</a></td> +<td>Private slot to initialize the testing menu.</td> +</tr><tr> +<td><a href="#Project.__initToolsActions">__initToolsActions</a></td> +<td>Private method to define the tool actions.</td> +</tr><tr> +<td><a href="#Project.__initToolsMenu">__initToolsMenu</a></td> +<td>Private slot to initialize the tools menu.</td> +</tr><tr> +<td><a href="#Project.__isSpawningConsole">__isSpawningConsole</a></td> +<td>Private method to check, if the given console is a spawning console.</td> +</tr><tr> +<td><a href="#Project.__loadData">__loadData</a></td> +<td>Private slot to load data from fixture files.</td> +</tr><tr> +<td><a href="#Project.__loadRecentApplications">__loadRecentApplications</a></td> +<td>Private method to load the recently used applications list.</td> +</tr><tr> +<td><a href="#Project.__normalizeList">__normalizeList</a></td> +<td>Private method to normalize a list of file names.</td> +</tr><tr> +<td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> +<td>Private slot handling the addition of a new language.</td> +</tr><tr> +<td><a href="#Project.__runBrowser">__runBrowser</a></td> +<td>Private slot to start the default web browser with the server URL.</td> +</tr><tr> +<td><a href="#Project.__runDatabaseClient">__runDatabaseClient</a></td> +<td>Private slot to start a database client for a Django project.</td> +</tr><tr> +<td><a href="#Project.__runPythonShell">__runPythonShell</a></td> +<td>Private slot to start a Python console for a Django project.</td> +</tr><tr> +<td><a href="#Project.__runServer">__runServer</a></td> +<td>Private slot to start the Django Web server.</td> +</tr><tr> +<td><a href="#Project.__runTestServer">__runTestServer</a></td> +<td>Private slot to run a development server with data from a set of fixtures.</td> +</tr><tr> +<td><a href="#Project.__runTestSuite">__runTestSuite</a></td> +<td>Private slot to run the test suite for applications or the whole site.</td> +</tr><tr> +<td><a href="#Project.__saveRecentApplications">__saveRecentApplications</a></td> +<td>Private method to save the list of recently used applications list.</td> +</tr><tr> +<td><a href="#Project.__selectSite">__selectSite</a></td> +<td>Private method to select a site to work with.</td> +</tr><tr> +<td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#Project.__setCurrentSite">__setCurrentSite</a></td> +<td>Private slot to set the current site.</td> +</tr><tr> +<td><a href="#Project.__showHelpIndex">__showHelpIndex</a></td> +<td>Private slot to show the help index page.</td> +</tr><tr> +<td><a href="#Project.__site">__site</a></td> +<td>Private method to get the name of the current site.</td> +</tr><tr> +<td><a href="#Project.__siteFilteredList">__siteFilteredList</a></td> +<td>Private method to filter a list of file names by site.</td> +</tr><tr> +<td><a href="#Project.__sitePath">__sitePath</a></td> +<td>Private method to calculate the full path of the Django site.</td> +</tr><tr> +<td><a href="#Project.__sqlCommand">__sqlCommand</a></td> +<td>Private method to perform an SQL creation function.</td> +</tr><tr> +<td><a href="#Project.__startGlobalApplication">__startGlobalApplication</a></td> +<td>Private slot to start a new global Django application.</td> +</tr><tr> +<td><a href="#Project.__startLocalApplication">__startLocalApplication</a></td> +<td>Private slot to start a new local Django application.</td> +</tr><tr> +<td><a href="#Project.__startProject">__startProject</a></td> +<td>Private slot to start a new Django project.</td> +</tr><tr> +<td><a href="#Project.__testServerProcFinished">__testServerProcFinished</a></td> +<td>Private slot connected to the finished signal of the test server.</td> +</tr><tr> +<td><a href="#Project.__validate">__validate</a></td> +<td>Private slot to validate all installed models.</td> +</tr><tr> +<td><a href="#Project.compileCatalogs">compileCatalogs</a></td> +<td>Public method to compile the message catalogs.</td> +</tr><tr> +<td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr><tr> +<td><a href="#Project.getDjangoVersion">getDjangoVersion</a></td> +<td>Public method to get the Django version.</td> +</tr><tr> +<td><a href="#Project.getProjectPath">getProjectPath</a></td> +<td>Public method to get the path of the eric5 project.</td> +</tr><tr> +<td><a href="#Project.getRecentApplications">getRecentApplications</a></td> +<td>Public method to get the list of recent applications.</td> +</tr><tr> +<td><a href="#Project.initActions">initActions</a></td> +<td>Public method to define the Pyramid actions.</td> +</tr><tr> +<td><a href="#Project.initMenu">initMenu</a></td> +<td>Public slot to initialize the Django menu.</td> +</tr><tr> +<td><a href="#Project.newForm">newForm</a></td> +<td>Public method to create a new form.</td> +</tr><tr> +<td><a href="#Project.projectClosed">projectClosed</a></td> +<td>Public method to handle the closing of a project.</td> +</tr><tr> +<td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> +<td>Public method to remove our hook methods.</td> +</tr><tr> +<td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> +<td>Public method to add our hook methods.</td> +</tr><tr> +<td><a href="#Project.setMostRecentApplication">setMostRecentApplication</a></td> +<td>Public method to set the most recently used applications entry.</td> +</tr><tr> +<td><a href="#Project.startProjectOrApplication">startProjectOrApplication</a></td> +<td>Public slot to start a new Django project or application.</td> +</tr><tr> +<td><a href="#Project.updateCatalogs">updateCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr><tr> +<td><a href="#Project.updateCatalogsWithObsolete">updateCatalogsWithObsolete</a></td> +<td>Public method to update the message catalogs keeping obsolete messages.</td> +</tr><tr> +<td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr><tr> +<td><a href="#Project.updateSelectedCatalogsWithObsolete">updateSelectedCatalogsWithObsolete</a></td> +<td>Public method to update the message catalogs keeping obsolete messages.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Project.__init__" ID="Project.__init__"></a> +<h4>Project (Constructor)</h4> +<b>Project</b>(<i>plugin, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd><dt><i>parent</i></dt> +<dd> +parent (QObject) +</dd> +</dl><a NAME="Project.__cleanup" ID="Project.__cleanup"></a> +<h4>Project.__cleanup</h4> +<b>__cleanup</b>(<i></i>) +<p> + Private slot to clean out old data from the database. +</p><a NAME="Project.__createApplication" ID="Project.__createApplication"></a> +<h4>Project.__createApplication</h4> +<b>__createApplication</b>(<i>applName, path, isGlobal = True</i>) +<p> + Private slot to create a new Django application. +</p><dl> +<dt><i>applName</i></dt> +<dd> +name of the new application (string) +</dd><dt><i>path</i></dt> +<dd> +the directory where the application should be created + (string) +</dd><dt><i>isGlobal</i></dt> +<dd> +flag indicating a standalone Django application (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful creation (boolean) +</dd> +</dl><a NAME="Project.__createCacheTables" ID="Project.__createCacheTables"></a> +<h4>Project.__createCacheTables</h4> +<b>__createCacheTables</b>(<i></i>) +<p> + Private slot to create the tables for the SQL caching backend. +</p><a NAME="Project.__createProject" ID="Project.__createProject"></a> +<h4>Project.__createProject</h4> +<b>__createProject</b>(<i>projectName, path</i>) +<p> + Private slot to create a new Django project. +</p><dl> +<dt><i>projectName</i></dt> +<dd> +name of the new project (string) +</dd><dt><i>path</i></dt> +<dd> +the directory where the project should be created + (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful creation (boolean) +</dd> +</dl><a NAME="Project.__databaseFlush" ID="Project.__databaseFlush"></a> +<h4>Project.__databaseFlush</h4> +<b>__databaseFlush</b>(<i></i>) +<p> + Private slot to return all database tables to the state just after their + installation. +</p><a NAME="Project.__databaseInspect" ID="Project.__databaseInspect"></a> +<h4>Project.__databaseInspect</h4> +<b>__databaseInspect</b>(<i></i>) +<p> + Private slot to introspect the database and output a Django model module. +</p><a NAME="Project.__databaseSqlCreateEverything" ID="Project.__databaseSqlCreateEverything"></a> +<h4>Project.__databaseSqlCreateEverything</h4> +<b>__databaseSqlCreateEverything</b>(<i></i>) +<p> + Private slot to print the CREATE TABLE, custom SQL and + CREATE INDEX SQL statements for one or more applications. +</p><a NAME="Project.__databaseSqlCreateIndexes" ID="Project.__databaseSqlCreateIndexes"></a> +<h4>Project.__databaseSqlCreateIndexes</h4> +<b>__databaseSqlCreateIndexes</b>(<i></i>) +<p> + Private slot to print the CREATE INDEX SQL statements for one + or more applications. +</p><a NAME="Project.__databaseSqlCreateTables" ID="Project.__databaseSqlCreateTables"></a> +<h4>Project.__databaseSqlCreateTables</h4> +<b>__databaseSqlCreateTables</b>(<i></i>) +<p> + Private slot to print the CREATE TABLE SQL statements for one + or more applications. +</p><a NAME="Project.__databaseSqlCustom" ID="Project.__databaseSqlCustom"></a> +<h4>Project.__databaseSqlCustom</h4> +<b>__databaseSqlCustom</b>(<i></i>) +<p> + Private slot to print the custom table modifying SQL statements + for one or more applications. +</p><a NAME="Project.__databaseSqlDropTables" ID="Project.__databaseSqlDropTables"></a> +<h4>Project.__databaseSqlDropTables</h4> +<b>__databaseSqlDropTables</b>(<i></i>) +<p> + Private slot to print the DROP TABLE SQL statements for one or + more applications. +</p><a NAME="Project.__databaseSqlFlushDatabase" ID="Project.__databaseSqlFlushDatabase"></a> +<h4>Project.__databaseSqlFlushDatabase</h4> +<b>__databaseSqlFlushDatabase</b>(<i></i>) +<p> + Private slot to print a list of statements to return all database + tables to their initial state. +</p><a NAME="Project.__databaseSqlResetSequences" ID="Project.__databaseSqlResetSequences"></a> +<h4>Project.__databaseSqlResetSequences</h4> +<b>__databaseSqlResetSequences</b>(<i></i>) +<p> + Private slot to print the SQL statements for resetting sequences for + one or more applications. +</p><a NAME="Project.__databaseSynchronize" ID="Project.__databaseSynchronize"></a> +<h4>Project.__databaseSynchronize</h4> +<b>__databaseSynchronize</b>(<i></i>) +<p> + Private slot to synchronize the database. +</p><a NAME="Project.__diffSettings" ID="Project.__diffSettings"></a> +<h4>Project.__diffSettings</h4> +<b>__diffSettings</b>(<i></i>) +<p> + Private slot to show the changes made to the settings.py file. +</p><a NAME="Project.__djangoInfo" ID="Project.__djangoInfo"></a> +<h4>Project.__djangoInfo</h4> +<b>__djangoInfo</b>(<i></i>) +<p> + Private slot to show some info about Django. +</p><a NAME="Project.__dumpData" ID="Project.__dumpData"></a> +<h4>Project.__dumpData</h4> +<b>__dumpData</b>(<i></i>) +<p> + Private slot to dump the database data to a fixture. +</p><a NAME="Project.__findSites" ID="Project.__findSites"></a> +<h4>Project.__findSites</h4> +<b>__findSites</b>(<i></i>) +<p> + Private method to determine the relative path to all manage.py scripts. +</p><dl> +<dt>Returns:</dt> +<dd> +list of sites (list of strings) +</dd> +</dl><a NAME="Project.__getApplications" ID="Project.__getApplications"></a> +<h4>Project.__getApplications</h4> +<b>__getApplications</b>(<i></i>) +<p> + Private method to ask the user for a list of application names. +</p><dl> +<dt>Returns:</dt> +<dd> +list of application names (list of strings) +</dd> +</dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a> +<h4>Project.__getLocale</h4> +<b>__getLocale</b>(<i>filename</i>) +<p> + Private method to extract the locale out of a file name. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file used for extraction (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +extracted locale (string) or None +</dd> +</dl><a NAME="Project.__getPythonExecutable" ID="Project.__getPythonExecutable"></a> +<h4>Project.__getPythonExecutable</h4> +<b>__getPythonExecutable</b>(<i></i>) +<p> + Private method to determine the name of the Python executable. +</p><dl> +<dt>Returns:</dt> +<dd> +Python executable (string) +</dd> +</dl><a NAME="Project.__initDatabaseActions" ID="Project.__initDatabaseActions"></a> +<h4>Project.__initDatabaseActions</h4> +<b>__initDatabaseActions</b>(<i></i>) +<p> + Private method to define the database related actions. +</p><a NAME="Project.__initDatabaseMenu" ID="Project.__initDatabaseMenu"></a> +<h4>Project.__initDatabaseMenu</h4> +<b>__initDatabaseMenu</b>(<i></i>) +<p> + Private slot to initialize the database menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.__initDatabaseSqlActions" ID="Project.__initDatabaseSqlActions"></a> +<h4>Project.__initDatabaseSqlActions</h4> +<b>__initDatabaseSqlActions</b>(<i></i>) +<p> + Private method to define the database SQL related actions. +</p><a NAME="Project.__initDatabaseSqlMenu" ID="Project.__initDatabaseSqlMenu"></a> +<h4>Project.__initDatabaseSqlMenu</h4> +<b>__initDatabaseSqlMenu</b>(<i></i>) +<p> + Private slot to initialize the database SQL submenu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.__initTestingActions" ID="Project.__initTestingActions"></a> +<h4>Project.__initTestingActions</h4> +<b>__initTestingActions</b>(<i></i>) +<p> + Private method to define the testing actions. +</p><a NAME="Project.__initTestingMenu" ID="Project.__initTestingMenu"></a> +<h4>Project.__initTestingMenu</h4> +<b>__initTestingMenu</b>(<i></i>) +<p> + Private slot to initialize the testing menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.__initToolsActions" ID="Project.__initToolsActions"></a> +<h4>Project.__initToolsActions</h4> +<b>__initToolsActions</b>(<i></i>) +<p> + Private method to define the tool actions. +</p><a NAME="Project.__initToolsMenu" ID="Project.__initToolsMenu"></a> +<h4>Project.__initToolsMenu</h4> +<b>__initToolsMenu</b>(<i></i>) +<p> + Private slot to initialize the tools menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.__isSpawningConsole" ID="Project.__isSpawningConsole"></a> +<h4>Project.__isSpawningConsole</h4> +<b>__isSpawningConsole</b>(<i>consoleCmd</i>) +<p> + Private method to check, if the given console is a spawning console. +</p><dl> +<dt><i>consoleCmd</i></dt> +<dd> +console command (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of two entries giving an indication, if the console + is spawning (boolean) and the (possibly) cleaned console command + (string) +</dd> +</dl><a NAME="Project.__loadData" ID="Project.__loadData"></a> +<h4>Project.__loadData</h4> +<b>__loadData</b>(<i></i>) +<p> + Private slot to load data from fixture files. +</p><a NAME="Project.__loadRecentApplications" ID="Project.__loadRecentApplications"></a> +<h4>Project.__loadRecentApplications</h4> +<b>__loadRecentApplications</b>(<i></i>) +<p> + Private method to load the recently used applications list. +</p><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> +<h4>Project.__normalizeList</h4> +<b>__normalizeList</b>(<i>filenames</i>) +<p> + Private method to normalize a list of file names. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names to normalize (list of strings) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +normalized file names (list of strings) +</dd> +</dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> +<h4>Project.__projectLanguageAdded</h4> +<b>__projectLanguageAdded</b>(<i>code</i>) +<p> + Private slot handling the addition of a new language. +</p><dl> +<dt><i>code</i></dt> +<dd> +language code of the new language (string) +</dd> +</dl><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> +<h4>Project.__runBrowser</h4> +<b>__runBrowser</b>(<i></i>) +<p> + Private slot to start the default web browser with the server URL. +</p><a NAME="Project.__runDatabaseClient" ID="Project.__runDatabaseClient"></a> +<h4>Project.__runDatabaseClient</h4> +<b>__runDatabaseClient</b>(<i></i>) +<p> + Private slot to start a database client for a Django project. +</p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> +<h4>Project.__runPythonShell</h4> +<b>__runPythonShell</b>(<i></i>) +<p> + Private slot to start a Python console for a Django project. +</p><a NAME="Project.__runServer" ID="Project.__runServer"></a> +<h4>Project.__runServer</h4> +<b>__runServer</b>(<i></i>) +<p> + Private slot to start the Django Web server. +</p><a NAME="Project.__runTestServer" ID="Project.__runTestServer"></a> +<h4>Project.__runTestServer</h4> +<b>__runTestServer</b>(<i></i>) +<p> + Private slot to run a development server with data from a set of fixtures. +</p><a NAME="Project.__runTestSuite" ID="Project.__runTestSuite"></a> +<h4>Project.__runTestSuite</h4> +<b>__runTestSuite</b>(<i></i>) +<p> + Private slot to run the test suite for applications or the whole site. +</p><a NAME="Project.__saveRecentApplications" ID="Project.__saveRecentApplications"></a> +<h4>Project.__saveRecentApplications</h4> +<b>__saveRecentApplications</b>(<i></i>) +<p> + Private method to save the list of recently used applications list. +</p><a NAME="Project.__selectSite" ID="Project.__selectSite"></a> +<h4>Project.__selectSite</h4> +<b>__selectSite</b>(<i></i>) +<p> + Private method to select a site to work with. +</p><dl> +<dt>Returns:</dt> +<dd> +selected site (string) +</dd> +</dl><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> +<h4>Project.__serverProcFinished</h4> +<b>__serverProcFinished</b>(<i></i>) +<p> + Private slot connected to the finished signal. +</p><a NAME="Project.__setCurrentSite" ID="Project.__setCurrentSite"></a> +<h4>Project.__setCurrentSite</h4> +<b>__setCurrentSite</b>(<i>site</i>) +<p> + Private slot to set the current site. +</p><dl> +<dt><i>site</i></dt> +<dd> +name of the site (string) +</dd> +</dl><a NAME="Project.__showHelpIndex" ID="Project.__showHelpIndex"></a> +<h4>Project.__showHelpIndex</h4> +<b>__showHelpIndex</b>(<i></i>) +<p> + Private slot to show the help index page. +</p><a NAME="Project.__site" ID="Project.__site"></a> +<h4>Project.__site</h4> +<b>__site</b>(<i></i>) +<p> + Private method to get the name of the current site. +</p><dl> +<dt>Returns:</dt> +<dd> +name of the site (string) +</dd> +</dl><dl> +<dt>Raises <b>DjangoNoSiteSelectedException</b>:</dt> +<dd> +raised, if no site is selected +</dd> +</dl><a NAME="Project.__siteFilteredList" ID="Project.__siteFilteredList"></a> +<h4>Project.__siteFilteredList</h4> +<b>__siteFilteredList</b>(<i>filenames</i>) +<p> + Private method to filter a list of file names by site. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names to be filtered (list of strings) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +file names belonging to the current site (list of strings) +</dd> +</dl><a NAME="Project.__sitePath" ID="Project.__sitePath"></a> +<h4>Project.__sitePath</h4> +<b>__sitePath</b>(<i></i>) +<p> + Private method to calculate the full path of the Django site. +</p><dl> +<dt>Returns:</dt> +<dd> +path of the site (string) +</dd> +</dl><dl> +<dt>Raises <b>DjangoNoSiteSelectedException</b>:</dt> +<dd> +raised, if no site is selected +</dd> +</dl><a NAME="Project.__sqlCommand" ID="Project.__sqlCommand"></a> +<h4>Project.__sqlCommand</h4> +<b>__sqlCommand</b>(<i>title, command, requestApps = True</i>) +<p> + Private method to perform an SQL creation function. +</p><dl> +<dt><i>title</i></dt> +<dd> +dialog title (string) +</dd><dt><i>command</i></dt> +<dd> +Django sql... command (string) +</dd><dt><i>requestApps</i></dt> +<dd> +flag indicating to request a list of applications + to work on (boolean) +</dd> +</dl><a NAME="Project.__startGlobalApplication" ID="Project.__startGlobalApplication"></a> +<h4>Project.__startGlobalApplication</h4> +<b>__startGlobalApplication</b>(<i></i>) +<p> + Private slot to start a new global Django application. +</p><a NAME="Project.__startLocalApplication" ID="Project.__startLocalApplication"></a> +<h4>Project.__startLocalApplication</h4> +<b>__startLocalApplication</b>(<i></i>) +<p> + Private slot to start a new local Django application. +</p><a NAME="Project.__startProject" ID="Project.__startProject"></a> +<h4>Project.__startProject</h4> +<b>__startProject</b>(<i></i>) +<p> + Private slot to start a new Django project. +</p><a NAME="Project.__testServerProcFinished" ID="Project.__testServerProcFinished"></a> +<h4>Project.__testServerProcFinished</h4> +<b>__testServerProcFinished</b>(<i></i>) +<p> + Private slot connected to the finished signal of the test server. +</p><a NAME="Project.__validate" ID="Project.__validate"></a> +<h4>Project.__validate</h4> +<b>__validate</b>(<i></i>) +<p> + Private slot to validate all installed models. +</p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> +<h4>Project.compileCatalogs</h4> +<b>compileCatalogs</b>(<i>filenames</i>) +<p> + Public method to compile the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames (not used) +</dd> +</dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> +<h4>Project.compileSelectedCatalogs</h4> +<b>compileSelectedCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames +</dd> +</dl><a NAME="Project.getDjangoVersion" ID="Project.getDjangoVersion"></a> +<h4>Project.getDjangoVersion</h4> +<b>getDjangoVersion</b>(<i></i>) +<p> + Public method to get the Django version. +</p><dl> +<dt>Returns:</dt> +<dd> +Django version as a tuple +</dd> +</dl><a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> +<h4>Project.getProjectPath</h4> +<b>getProjectPath</b>(<i></i>) +<p> + Public method to get the path of the eric5 project. +</p><dl> +<dt>Returns:</dt> +<dd> +path of the eric5 project (string) +</dd> +</dl><a NAME="Project.getRecentApplications" ID="Project.getRecentApplications"></a> +<h4>Project.getRecentApplications</h4> +<b>getRecentApplications</b>(<i></i>) +<p> + Public method to get the list of recent applications. +</p><dl> +<dt>Returns:</dt> +<dd> +list of recent applications entries (list of strings) +</dd> +</dl><a NAME="Project.initActions" ID="Project.initActions"></a> +<h4>Project.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to define the Pyramid actions. +</p><a NAME="Project.initMenu" ID="Project.initMenu"></a> +<h4>Project.initMenu</h4> +<b>initMenu</b>(<i></i>) +<p> + Public slot to initialize the Django menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.newForm" ID="Project.newForm"></a> +<h4>Project.newForm</h4> +<b>newForm</b>(<i>path</i>) +<p> + Public method to create a new form. +</p><dl> +<dt><i>path</i></dt> +<dd> +full directory path for the new form file (string) +</dd> +</dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a> +<h4>Project.projectClosed</h4> +<b>projectClosed</b>(<i></i>) +<p> + Public method to handle the closing of a project. +</p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> +<h4>Project.projectClosedHooks</h4> +<b>projectClosedHooks</b>(<i></i>) +<p> + Public method to remove our hook methods. +</p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> +<h4>Project.projectOpenedHooks</h4> +<b>projectOpenedHooks</b>(<i></i>) +<p> + Public method to add our hook methods. +</p><a NAME="Project.setMostRecentApplication" ID="Project.setMostRecentApplication"></a> +<h4>Project.setMostRecentApplication</h4> +<b>setMostRecentApplication</b>(<i>applStr</i>) +<p> + Public method to set the most recently used applications entry. +</p><dl> +<dt><i>applStr</i></dt> +<dd> +applications entry (string) +</dd> +</dl><a NAME="Project.startProjectOrApplication" ID="Project.startProjectOrApplication"></a> +<h4>Project.startProjectOrApplication</h4> +<b>startProjectOrApplication</b>(<i></i>) +<p> + Public slot to start a new Django project or application. +</p><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> +<h4>Project.updateCatalogs</h4> +<b>updateCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames (not used) +</dd> +</dl><a NAME="Project.updateCatalogsWithObsolete" ID="Project.updateCatalogsWithObsolete"></a> +<h4>Project.updateCatalogsWithObsolete</h4> +<b>updateCatalogsWithObsolete</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs keeping obsolete messages. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames (not used) +</dd> +</dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> +<h4>Project.updateSelectedCatalogs</h4> +<b>updateSelectedCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names (list of strings) +</dd> +</dl><a NAME="Project.updateSelectedCatalogsWithObsolete" ID="Project.updateSelectedCatalogsWithObsolete"></a> +<h4>Project.updateSelectedCatalogsWithObsolete</h4> +<b>updateSelectedCatalogsWithObsolete</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs keeping obsolete messages. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file