Sat, 02 Jan 2010 18:19:35 +0000
Updated documentation.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.Preferences.ConfigurationPages.EditorAPIsPage</title> <style> b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Preferences.ConfigurationPages.EditorAPIsPage</h1> <p> Module implementing the Editor APIs configuration page. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#EditorAPIsPage">EditorAPIsPage</a></td> <td>Class implementing the Editor APIs configuration page.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#create">create</a></td> <td>Module function to create the configuration page.</td> </tr> </table> <hr /><hr /> <a NAME="EditorAPIsPage" ID="EditorAPIsPage"></a> <h2>EditorAPIsPage</h2> <p> Class implementing the Editor APIs configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_EditorAPIsPage <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> <td>Constructor</td> </tr><tr> <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> <td>Private slot called after the API preparation has been cancelled.</td> </tr><tr> <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> <td>Private method called after the API preparation has finished.</td> </tr><tr> <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> <td>Private method called after the API preparation has started.</td> </tr><tr> <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> <td>Private slot to retrieve the api filenames from the list.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> <td>Private slot to add the api file displayed to the listbox.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_apiFileButton_clicked">on_apiFileButton_clicked</a></td> <td>Private method to select an api file.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> <td>Private slot to fill the api listbox of the api page.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> <td>Private slot to delete the currently selected file of the listbox.</td> </tr><tr> <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> <td>Private slot to prepare the API file for the currently selected language.</td> </tr><tr> <td><a href="#EditorAPIsPage.save">save</a></td> <td>Public slot to save the Editor APIs configuration.</td> </tr><tr> <td><a href="#EditorAPIsPage.saveState">saveState</a></td> <td>Public method to save the current state of the widget.</td> </tr><tr> <td><a href="#EditorAPIsPage.setState">setState</a></td> <td>Public method to set the state of the widget.</td> </tr> </table> <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> <h4>EditorAPIsPage (Constructor)</h4> <b>EditorAPIsPage</b>(<i></i>) <p> Constructor </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> <h4>EditorAPIsPage.__apiPreparationCancelled</h4> <b>__apiPreparationCancelled</b>(<i></i>) <p> Private slot called after the API preparation has been cancelled. </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> <h4>EditorAPIsPage.__apiPreparationFinished</h4> <b>__apiPreparationFinished</b>(<i></i>) <p> Private method called after the API preparation has finished. </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> <h4>EditorAPIsPage.__apiPreparationStarted</h4> <b>__apiPreparationStarted</b>(<i></i>) <p> Private method called after the API preparation has started. </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> <b>__editorGetApisFromApiList</b>(<i></i>) <p> Private slot to retrieve the api filenames from the list. </p><dl> <dt>Returns:</dt> <dd> list of api filenames (list of strings) </dd> </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> <b>on_addApiFileButton_clicked</b>(<i></i>) <p> Private slot to add the api file displayed to the listbox. </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) <p> Private slot to add an API file from the list of installed API files for the selected lexer language. </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> <b>on_addPluginApiFileButton_clicked</b>(<i></i>) <p> Private slot to add an API file from the list of API files installed by plugins for the selected lexer language. </p><a NAME="EditorAPIsPage.on_apiFileButton_clicked" ID="EditorAPIsPage.on_apiFileButton_clicked"></a> <h4>EditorAPIsPage.on_apiFileButton_clicked</h4> <b>on_apiFileButton_clicked</b>(<i></i>) <p> Private method to select an api file. </p><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> <b>on_apiLanguageComboBox_activated</b>(<i>language</i>) <p> Private slot to fill the api listbox of the api page. </p><dl> <dt><i>language</i></dt> <dd> selected API language (string) </dd> </dl><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> <b>on_deleteApiFileButton_clicked</b>(<i></i>) <p> Private slot to delete the currently selected file of the listbox. </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> <b>on_prepareApiButton_clicked</b>(<i></i>) <p> Private slot to prepare the API file for the currently selected language. </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> <h4>EditorAPIsPage.save</h4> <b>save</b>(<i></i>) <p> Public slot to save the Editor APIs configuration. </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> <h4>EditorAPIsPage.saveState</h4> <b>saveState</b>(<i></i>) <p> Public method to save the current state of the widget. </p><dl> <dt>Returns:</dt> <dd> index of the selected lexer language (integer) </dd> </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> <h4>EditorAPIsPage.setState</h4> <b>setState</b>(<i>state</i>) <p> Public method to set the state of the widget. </p><dl> <dt><i>state</i></dt> <dd> state data generated by saveState </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="create" ID="create"></a> <h2>create</h2> <b>create</b>(<i>dlg</i>) <p> Module function to create the configuration page. </p><dl> <dt><i>dlg</i></dt> <dd> reference to the configuration dialog </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>