--- a/ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html Mon Jun 22 19:38:53 2020 +0200 @@ -18,149 +18,196 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Kivy.PluginProjectKivy</h1> + <p> Module implementing the Kivy project plug-in. </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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +<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>shortDescription</td></tr><tr><td>version</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ProjectKivyPlugin">ProjectKivyPlugin</a></td> <td>Class implementing the Kivy 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> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> <h2>ProjectKivyPlugin</h2> + <p> Class implementing the Kivy project plugin. </p> <h3>Derived from</h3> QObject <h3>Class Attributes</h3> + <table> <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</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="#ProjectKivyPlugin.__init__">ProjectKivyPlugin</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.__initialize">__initialize</a></td> <td>Private slot to (re)initialize the plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.__loadTranslator">__loadTranslator</a></td> <td>Private method to load the translation file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.activate">activate</a></td> <td>Public method to activate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> <td>Public method get the filetype associations of the Kivy project type.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> <td>Public method to instantiate a Pygments Kivy lexer object.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> <td>Public method to get the lexer association of the Kivy project type for a file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ProjectKivyPlugin.__init__" ID="ProjectKivyPlugin.__init__"></a> <h4>ProjectKivyPlugin (Constructor)</h4> <b>ProjectKivyPlugin</b>(<i>ui</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the user interface object (UI.UserInterface) </dd> -</dl><a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> +</dl> +<a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> <h4>ProjectKivyPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) + <p> Private slot to (re)initialize the plugin. -</p><a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a> +</p> +<a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a> <h4>ProjectKivyPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) + <p> Private method to load the translation file. -</p><a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a> +</p> +<a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a> <h4>ProjectKivyPlugin.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plugin. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> +</dl> +<a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> <h4>ProjectKivyPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plugin. -</p><a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a> +</p> +<a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a> <h4>ProjectKivyPlugin.fileTypesCallback</h4> <b>fileTypesCallback</b>(<i></i>) + <p> Public method get the filetype associations of the Kivy project type. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary with file type associations </dd> -</dl><a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> +</dl> +<a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> <h4>ProjectKivyPlugin.getLexer</h4> <b>getLexer</b>(<i>parent=None</i>) + <p> Public method to instantiate a Pygments Kivy lexer object. -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent object (QObject) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the instanciated lexer object (QsciLexer) </dd> -</dl><a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> +</dl> +<a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> <b>lexerAssociationCallback</b>(<i>filename</i>) + <p> Public method to get the lexer association of the Kivy project type for a file. -</p><dl> +</p> +<dl> + <dt><i>filename</i></dt> <dd> name of the file (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> name of the lexer (string) (Pygments lexers are prefixed with @@ -168,18 +215,23 @@ </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<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> +</p> +<dl> + <dt><i>language</i></dt> <dd> language to get API file for (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> list of API filenames (list of string)