Updated source docu.

Sun, 09 Dec 2018 12:09:37 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 09 Dec 2018 12:09:37 +0100
changeset 6616
05b9ad19c8e1
parent 6615
386607e32376
child 6617
0136c0542ca3

Updated source docu.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
APIs/Python3/eric6.bas file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.E5XML.Config.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Project.Project.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Project.ProjectResourcesBrowser.html file | annotate | diff | comparison | revisions
Documentation/Source/index-eric6.Project.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Sun Dec 09 12:08:57 2018 +0100
+++ b/APIs/Python3/eric6.api	Sun Dec 09 12:09:37 2018 +0100
@@ -1593,6 +1593,7 @@
 eric6.E5XML.Config.projectFileFormatVersionIdl?7
 eric6.E5XML.Config.projectFileFormatVersionMake?7
 eric6.E5XML.Config.projectFileFormatVersionProto?7
+eric6.E5XML.Config.projectFileFormatVersionUic?7
 eric6.E5XML.Config.sessionFileFormatVersion?7
 eric6.E5XML.Config.shortcutsFileFormatVersion?7
 eric6.E5XML.Config.tasksFileFormatVersion?7
@@ -3968,6 +3969,7 @@
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.on_repositoryUrlEditButton_toggled?4(checked)
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget?1(pluginManager, parent=None)
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWindow?1(parent=None)
+eric6.PluginManager.PluginRepositoryDialog.registerPlugin?4(name, short, description, url, author, version, filename, status)
 eric6.PluginManager.PluginUninstallDialog.PluginUninstallDialog?1(pluginManager, parent=None)
 eric6.PluginManager.PluginUninstallDialog.PluginUninstallWidget.accepted?7
 eric6.PluginManager.PluginUninstallDialog.PluginUninstallWidget.on_buttonBox_accepted?4()
@@ -7886,6 +7888,7 @@
 eric6.Project.Project.Project.getData?4(category, key)
 eric6.Project.Project.Project.getDebugProperty?4(key)
 eric6.Project.Project.Project.getDebuggerFilters?4(language)
+eric6.Project.Project.Project.getDefaultRccCompilerParameters?4()
 eric6.Project.Project.Project.getDefaultSourceExtension?4()
 eric6.Project.Project.Project.getEditorLexerAssoc?4(filename)
 eric6.Project.Project.Project.getEolString?4()
@@ -7921,6 +7924,7 @@
 eric6.Project.Project.Project.handlePreferencesChanged?4()
 eric6.Project.Project.Project.hasDefaultIdlCompilerParameters?4()
 eric6.Project.Project.Project.hasDefaultMakeParameters?4()
+eric6.Project.Project.Project.hasDefaultRccCompilerParameters?4()
 eric6.Project.Project.Project.hasDefaultUicCompilerParameters?4()
 eric6.Project.Project.Project.hasEntry?4(fn)
 eric6.Project.Project.Project.hasProjectType?4(type_, progLanguage="")
@@ -8202,6 +8206,8 @@
 eric6.Project.QuickFindFileDialog.QuickFindFileDialog.show?4()
 eric6.Project.QuickFindFileDialog.QuickFindFileDialog.sourceFile?7
 eric6.Project.QuickFindFileDialog.QuickFindFileDialog?1(project, parent=None)
+eric6.Project.RccCompilerOptionsDialog.RccCompilerOptionsDialog.getData?4()
+eric6.Project.RccCompilerOptionsDialog.RccCompilerOptionsDialog?1(compilerOptions, parent=None)
 eric6.Project.SpellingPropertiesDialog.SpellingPropertiesDialog.initDialog?4()
 eric6.Project.SpellingPropertiesDialog.SpellingPropertiesDialog.storeData?4()
 eric6.Project.SpellingPropertiesDialog.SpellingPropertiesDialog?1(project, new, parent)
--- a/APIs/Python3/eric6.bas	Sun Dec 09 12:08:57 2018 +0100
+++ b/APIs/Python3/eric6.bas	Sun Dec 09 12:09:37 2018 +0100
@@ -770,6 +770,7 @@
 QuickSearchLineEdit QLineEdit
 QuotedString str
 RbModule Class
+RccCompilerOptionsDialog QDialog Ui_RccCompilerOptionsDialog
 Rebase HgExtension
 RebaseProjectHelper HgExtensionProjectHelper
 RecursionError OverflowError ValueError
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Help/source.qhp	Sun Dec 09 12:09:37 2018 +0100
@@ -995,6 +995,7 @@
             <section title="eric6.Project.ProjectTranslationsBrowser" ref="eric6.Project.ProjectTranslationsBrowser.html" />
             <section title="eric6.Project.PropertiesDialog" ref="eric6.Project.PropertiesDialog.html" />
             <section title="eric6.Project.QuickFindFileDialog" ref="eric6.Project.QuickFindFileDialog.html" />
+            <section title="eric6.Project.RccCompilerOptionsDialog" ref="eric6.Project.RccCompilerOptionsDialog.html" />
             <section title="eric6.Project.SpellingPropertiesDialog" ref="eric6.Project.SpellingPropertiesDialog.html" />
             <section title="eric6.Project.TranslationPropertiesDialog" ref="eric6.Project.TranslationPropertiesDialog.html" />
             <section title="eric6.Project.UicCompilerOptionsDialog" ref="eric6.Project.UicCompilerOptionsDialog.html" />
@@ -12696,6 +12697,7 @@
       <keyword name="Project.getData" id="Project.getData" ref="eric6.Project.Project.html#Project.getData" />
       <keyword name="Project.getDebugProperty" id="Project.getDebugProperty" ref="eric6.Project.Project.html#Project.getDebugProperty" />
       <keyword name="Project.getDebuggerFilters" id="Project.getDebuggerFilters" ref="eric6.Project.Project.html#Project.getDebuggerFilters" />
+      <keyword name="Project.getDefaultRccCompilerParameters" id="Project.getDefaultRccCompilerParameters" ref="eric6.Project.Project.html#Project.getDefaultRccCompilerParameters" />
       <keyword name="Project.getDefaultSourceExtension" id="Project.getDefaultSourceExtension" ref="eric6.Project.Project.html#Project.getDefaultSourceExtension" />
       <keyword name="Project.getEditorLexerAssoc" id="Project.getEditorLexerAssoc" ref="eric6.Project.Project.html#Project.getEditorLexerAssoc" />
       <keyword name="Project.getEolString" id="Project.getEolString" ref="eric6.Project.Project.html#Project.getEolString" />
@@ -12731,6 +12733,7 @@
       <keyword name="Project.handlePreferencesChanged" id="Project.handlePreferencesChanged" ref="eric6.Project.Project.html#Project.handlePreferencesChanged" />
       <keyword name="Project.hasDefaultIdlCompilerParameters" id="Project.hasDefaultIdlCompilerParameters" ref="eric6.Project.Project.html#Project.hasDefaultIdlCompilerParameters" />
       <keyword name="Project.hasDefaultMakeParameters" id="Project.hasDefaultMakeParameters" ref="eric6.Project.Project.html#Project.hasDefaultMakeParameters" />
+      <keyword name="Project.hasDefaultRccCompilerParameters" id="Project.hasDefaultRccCompilerParameters" ref="eric6.Project.Project.html#Project.hasDefaultRccCompilerParameters" />
       <keyword name="Project.hasDefaultUicCompilerParameters" id="Project.hasDefaultUicCompilerParameters" ref="eric6.Project.Project.html#Project.hasDefaultUicCompilerParameters" />
       <keyword name="Project.hasEntry" id="Project.hasEntry" ref="eric6.Project.Project.html#Project.hasEntry" />
       <keyword name="Project.hasProjectType" id="Project.hasProjectType" ref="eric6.Project.Project.html#Project.hasProjectType" />
@@ -13051,6 +13054,7 @@
       <keyword name="ProjectResourcesBrowser.__compileQRCDone" id="ProjectResourcesBrowser.__compileQRCDone" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__compileQRCDone" />
       <keyword name="ProjectResourcesBrowser.__compileResource" id="ProjectResourcesBrowser.__compileResource" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__compileResource" />
       <keyword name="ProjectResourcesBrowser.__compileSelectedResources" id="ProjectResourcesBrowser.__compileSelectedResources" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__compileSelectedResources" />
+      <keyword name="ProjectResourcesBrowser.__configureRccCompiler" id="ProjectResourcesBrowser.__configureRccCompiler" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__configureRccCompiler" />
       <keyword name="ProjectResourcesBrowser.__deleteFile" id="ProjectResourcesBrowser.__deleteFile" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__deleteFile" />
       <keyword name="ProjectResourcesBrowser.__newResource" id="ProjectResourcesBrowser.__newResource" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__newResource" />
       <keyword name="ProjectResourcesBrowser.__openFile" id="ProjectResourcesBrowser.__openFile" ref="eric6.Project.ProjectResourcesBrowser.html#ProjectResourcesBrowser.__openFile" />
@@ -13800,6 +13804,10 @@
       <keyword name="RbModule" id="RbModule" ref="eric6.Utilities.ModuleParser.html#RbModule" />
       <keyword name="RbModule (Constructor)" id="RbModule (Constructor)" ref="eric6.Utilities.ModuleParser.html#RbModule.__init__" />
       <keyword name="RbModule.addClass" id="RbModule.addClass" ref="eric6.Utilities.ModuleParser.html#RbModule.addClass" />
+      <keyword name="RccCompilerOptionsDialog" id="RccCompilerOptionsDialog" ref="eric6.Project.RccCompilerOptionsDialog.html#RccCompilerOptionsDialog" />
+      <keyword name="RccCompilerOptionsDialog (Constructor)" id="RccCompilerOptionsDialog (Constructor)" ref="eric6.Project.RccCompilerOptionsDialog.html#RccCompilerOptionsDialog.__init__" />
+      <keyword name="RccCompilerOptionsDialog (Module)" id="RccCompilerOptionsDialog (Module)" ref="eric6.Project.RccCompilerOptionsDialog.html" />
+      <keyword name="RccCompilerOptionsDialog.getData" id="RccCompilerOptionsDialog.getData" ref="eric6.Project.RccCompilerOptionsDialog.html#RccCompilerOptionsDialog.getData" />
       <keyword name="Rebase" id="Rebase" ref="eric6.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html#Rebase" />
       <keyword name="Rebase (Constructor)" id="Rebase (Constructor)" ref="eric6.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html#Rebase.__init__" />
       <keyword name="Rebase.hgRebase" id="Rebase.hgRebase" ref="eric6.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html#Rebase.hgRebase" />
@@ -19255,6 +19263,7 @@
       <keyword name="readmodule_ex" id="readmodule_ex" ref="eric6.Utilities.ClassBrowsers.rbclbr.html#readmodule_ex" />
       <keyword name="rebase (Module)" id="rebase (Module)" ref="eric6.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html" />
       <keyword name="registerLexer" id="registerLexer" ref="eric6.QScintilla.Lexers.__init__.html#registerLexer" />
+      <keyword name="registerPlugin" id="registerPlugin" ref="eric6.PluginManager.PluginRepositoryDialog.html#registerPlugin" />
       <keyword name="registerView" id="registerView" ref="eric6.WebBrowser.WebInspector.html#registerView" />
       <keyword name="register_check" id="register_check" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#register_check" />
       <keyword name="rehashPassword" id="rehashPassword" ref="eric6.Utilities.crypto.py3PBKDF2.html#rehashPassword" />
@@ -20233,6 +20242,7 @@
       <file>eric6.Project.ProjectTranslationsBrowser.html</file>
       <file>eric6.Project.PropertiesDialog.html</file>
       <file>eric6.Project.QuickFindFileDialog.html</file>
+      <file>eric6.Project.RccCompilerOptionsDialog.html</file>
       <file>eric6.Project.SpellingPropertiesDialog.html</file>
       <file>eric6.Project.TranslationPropertiesDialog.html</file>
       <file>eric6.Project.UicCompilerOptionsDialog.html</file>
--- a/Documentation/Source/eric6.E5XML.Config.html	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Source/eric6.E5XML.Config.html	Sun Dec 09 12:09:37 2018 +0100
@@ -25,7 +25,7 @@
 </p>
 <h3>Global Attributes</h3>
 <table>
-<tr><td>debuggerPropertiesFileFormatVersion</td></tr><tr><td>dictionariesListFileFormatVersion</td></tr><tr><td>highlightingStylesFileFormatVersion</td></tr><tr><td>multiProjectFileFormatVersion</td></tr><tr><td>pluginRepositoryFileFormatVersion</td></tr><tr><td>projectFileFormatVersion</td></tr><tr><td>projectFileFormatVersionAlt</td></tr><tr><td>projectFileFormatVersionIdl</td></tr><tr><td>projectFileFormatVersionMake</td></tr><tr><td>projectFileFormatVersionProto</td></tr><tr><td>sessionFileFormatVersion</td></tr><tr><td>shortcutsFileFormatVersion</td></tr><tr><td>tasksFileFormatVersion</td></tr><tr><td>templatesFileFormatVersion</td></tr><tr><td>userProjectFileFormatVersion</td></tr>
+<tr><td>debuggerPropertiesFileFormatVersion</td></tr><tr><td>dictionariesListFileFormatVersion</td></tr><tr><td>highlightingStylesFileFormatVersion</td></tr><tr><td>multiProjectFileFormatVersion</td></tr><tr><td>pluginRepositoryFileFormatVersion</td></tr><tr><td>projectFileFormatVersion</td></tr><tr><td>projectFileFormatVersionAlt</td></tr><tr><td>projectFileFormatVersionIdl</td></tr><tr><td>projectFileFormatVersionMake</td></tr><tr><td>projectFileFormatVersionProto</td></tr><tr><td>projectFileFormatVersionUic</td></tr><tr><td>sessionFileFormatVersion</td></tr><tr><td>shortcutsFileFormatVersion</td></tr><tr><td>tasksFileFormatVersion</td></tr><tr><td>templatesFileFormatVersion</td></tr><tr><td>userProjectFileFormatVersion</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
--- a/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html	Sun Dec 09 12:09:37 2018 +0100
@@ -45,6 +45,9 @@
 <tr>
 <td><a href="#PluginRepositoryDownloadCleanup">PluginRepositoryDownloadCleanup</a></td>
 <td>Module function to clean up the plug-in downloads area.</td>
+</tr><tr>
+<td><a href="#registerPlugin">registerPlugin</a></td>
+<td>Method to register a plug-in's data.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -646,5 +649,39 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="registerPlugin" ID="registerPlugin"></a>
+<h2>registerPlugin</h2>
+<b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status</i>)
+<p>
+        Method to register a plug-in's data.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+data for the name field (string)
+</dd><dt><i>short</i></dt>
+<dd>
+data for the short field (string)
+</dd><dt><i>description</i></dt>
+<dd>
+data for the description field (list of strings)
+</dd><dt><i>url</i></dt>
+<dd>
+data for the url field (string)
+</dd><dt><i>author</i></dt>
+<dd>
+data for the author field (string)
+</dd><dt><i>version</i></dt>
+<dd>
+data for the version field (string)
+</dd><dt><i>filename</i></dt>
+<dd>
+data for the filename field (string)
+</dd><dt><i>status</i></dt>
+<dd>
+status of the plugin (string [stable, unstable, unknown])
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file
--- a/Documentation/Source/eric6.Project.Project.html	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Source/eric6.Project.Project.html	Sun Dec 09 12:09:37 2018 +0100
@@ -509,6 +509,9 @@
 <td><a href="#Project.getDebuggerFilters">getDebuggerFilters</a></td>
 <td>Public method to get the debugger filters for a programming language.</td>
 </tr><tr>
+<td><a href="#Project.getDefaultRccCompilerParameters">getDefaultRccCompilerParameters</a></td>
+<td>Public method to get the default rcc compiler parameters.</td>
+</tr><tr>
 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td>
 <td>Public method to get the default extension for the project's programming language.</td>
 </tr><tr>
@@ -614,6 +617,9 @@
 <td><a href="#Project.hasDefaultMakeParameters">hasDefaultMakeParameters</a></td>
 <td>Public method to test, if the project contains the default make parameters.</td>
 </tr><tr>
+<td><a href="#Project.hasDefaultRccCompilerParameters">hasDefaultRccCompilerParameters</a></td>
+<td>Public method to test, if the project contains the default rcc compiler parameters.</td>
+</tr><tr>
 <td><a href="#Project.hasDefaultUicCompilerParameters">hasDefaultUicCompilerParameters</a></td>
 <td>Public method to test, if the project contains the default uic compiler parameters.</td>
 </tr><tr>
@@ -1731,6 +1737,21 @@
 <dd>
 str
 </dd>
+</dl><a NAME="Project.getDefaultRccCompilerParameters" ID="Project.getDefaultRccCompilerParameters"></a>
+<h4>Project.getDefaultRccCompilerParameters</h4>
+<b>getDefaultRccCompilerParameters</b>(<i></i>)
+<p>
+        Public method to get the default rcc compiler parameters.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the default rcc compiler parameters
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
 </dl><a NAME="Project.getDefaultSourceExtension" ID="Project.getDefaultSourceExtension"></a>
 <h4>Project.getDefaultSourceExtension</h4>
 <b>getDefaultSourceExtension</b>(<i></i>)
@@ -2174,6 +2195,22 @@
 <dd>
 bool
 </dd>
+</dl><a NAME="Project.hasDefaultRccCompilerParameters" ID="Project.hasDefaultRccCompilerParameters"></a>
+<h4>Project.hasDefaultRccCompilerParameters</h4>
+<b>hasDefaultRccCompilerParameters</b>(<i></i>)
+<p>
+        Public method to test, if the project contains the default rcc compiler
+        parameters.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating default parameter set
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="Project.hasDefaultUicCompilerParameters" ID="Project.hasDefaultUicCompilerParameters"></a>
 <h4>Project.hasDefaultUicCompilerParameters</h4>
 <b>hasDefaultUicCompilerParameters</b>(<i></i>)
--- a/Documentation/Source/eric6.Project.ProjectResourcesBrowser.html	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Source/eric6.Project.ProjectResourcesBrowser.html	Sun Dec 09 12:09:37 2018 +0100
@@ -95,6 +95,9 @@
 <td><a href="#ProjectResourcesBrowser.__compileSelectedResources">__compileSelectedResources</a></td>
 <td>Private method to compile selected resources to source files.</td>
 </tr><tr>
+<td><a href="#ProjectResourcesBrowser.__configureRccCompiler">__configureRccCompiler</a></td>
+<td>Private slot to configure some non-common rcc compiler options.</td>
+</tr><tr>
 <td><a href="#ProjectResourcesBrowser.__deleteFile">__deleteFile</a></td>
 <td>Private method to delete a resource file from the project.</td>
 </tr><tr>
@@ -239,6 +242,11 @@
 <b>__compileSelectedResources</b>(<i></i>)
 <p>
         Private method to compile selected resources to source files.
+</p><a NAME="ProjectResourcesBrowser.__configureRccCompiler" ID="ProjectResourcesBrowser.__configureRccCompiler"></a>
+<h4>ProjectResourcesBrowser.__configureRccCompiler</h4>
+<b>__configureRccCompiler</b>(<i></i>)
+<p>
+        Private slot to configure some non-common rcc compiler options.
 </p><a NAME="ProjectResourcesBrowser.__deleteFile" ID="ProjectResourcesBrowser.__deleteFile"></a>
 <h4>ProjectResourcesBrowser.__deleteFile</h4>
 <b>__deleteFile</b>(<i></i>)
--- a/Documentation/Source/index-eric6.Project.html	Sun Dec 09 12:08:57 2018 +0100
+++ b/Documentation/Source/index-eric6.Project.html	Sun Dec 09 12:09:37 2018 +0100
@@ -119,6 +119,9 @@
 <td><a href="eric6.Project.QuickFindFileDialog.html">QuickFindFileDialog</a></td>
 <td>Module implementing a quick search for files.</td>
 </tr><tr>
+<td><a href="eric6.Project.RccCompilerOptionsDialog.html">RccCompilerOptionsDialog</a></td>
+<td>Module implementing a dialog to enter some non-common rcc compiler options.</td>
+</tr><tr>
 <td><a href="eric6.Project.SpellingPropertiesDialog.html">SpellingPropertiesDialog</a></td>
 <td>Module implementing the Spelling Properties dialog.</td>
 </tr><tr>

eric ide

mercurial