--- a/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html Thu Dec 01 19:18:56 2016 +0100 +++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html Thu Dec 01 19:22:06 2016 +0100 @@ -63,6 +63,9 @@ <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> <td>Constructor</td> </tr><tr> +<td><a href="#EditorAPIsPage.__apiKey">__apiKey</a></td> +<td>Private method to generate a key for the apis dictionary.</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> @@ -75,6 +78,9 @@ <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.__fillApisList">__fillApisList</a></td> +<td>Private slot to fill the list of API files.</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> @@ -99,6 +105,9 @@ <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.on_projectTypeComboBox_activated">on_projectTypeComboBox_activated</a></td> +<td>Private slot to handle the selection of a project type.</td> +</tr><tr> <td><a href="#EditorAPIsPage.save">save</a></td> <td>Public slot to save the Editor APIs configuration.</td> </tr><tr> @@ -118,7 +127,30 @@ <b>EditorAPIsPage</b>(<i></i>) <p> Constructor -</p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> +</p><a NAME="EditorAPIsPage.__apiKey" ID="EditorAPIsPage.__apiKey"></a> +<h4>EditorAPIsPage.__apiKey</h4> +<b>__apiKey</b>(<i>language, projectType</i>) +<p> + Private method to generate a key for the apis dictionary. +</p><dl> +<dt><i>language</i> (str)</dt> +<dd> +programming language of the API +</dd><dt><i>projectType</i> (str)</dt> +<dd> +project type of the API +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +key to be used +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> <h4>EditorAPIsPage.__apiPreparationCancelled</h4> <b>__apiPreparationCancelled</b>(<i></i>) <p> @@ -143,7 +175,12 @@ <dd> list of api filenames (list of strings) </dd> -</dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> +</dl><a NAME="EditorAPIsPage.__fillApisList" ID="EditorAPIsPage.__fillApisList"></a> +<h4>EditorAPIsPage.__fillApisList</h4> +<b>__fillApisList</b>(<i></i>) +<p> + Private slot to fill the list of API files. +</p><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> @@ -196,7 +233,17 @@ <p> Private slot to prepare the API file for the currently selected language. -</p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> +</p><a NAME="EditorAPIsPage.on_projectTypeComboBox_activated" ID="EditorAPIsPage.on_projectTypeComboBox_activated"></a> +<h4>EditorAPIsPage.on_projectTypeComboBox_activated</h4> +<b>on_projectTypeComboBox_activated</b>(<i>index</i>) +<p> + Private slot to handle the selection of a project type. +</p><dl> +<dt><i>index</i> (str)</dt> +<dd> +index of the selected entry +</dd> +</dl><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> <h4>EditorAPIsPage.save</h4> <b>save</b>(<i></i>) <p> @@ -209,7 +256,13 @@ </p><dl> <dt>Returns:</dt> <dd> -index of the selected lexer language (integer) +tuple containing the index of the selected lexer language + and the index of the selected project type +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +tuple of int and int </dd> </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> <h4>EditorAPIsPage.setState</h4>