--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorHighlightersPage.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,225 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Preferences.ConfigurationPages.EditorHighlightersPage</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>eric7.Preferences.ConfigurationPages.EditorHighlightersPage</h1> + +<p> +Module implementing the Editor Highlighter Associations configuration page. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#EditorHighlightersPage">EditorHighlightersPage</a></td> +<td>Class implementing the Editor Highlighter Associations 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="EditorHighlightersPage" ID="EditorHighlightersPage"></a> +<h2>EditorHighlightersPage</h2> + +<p> + Class implementing the Editor Highlighter Associations configuration page. +</p> +<h3>Derived from</h3> +ConfigurationPageBase, Ui_EditorHighlightersPage +<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><a href="#EditorHighlightersPage.__init__">EditorHighlightersPage</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.on_addLexerButton_clicked">on_addLexerButton_clicked</a></td> +<td>Private slot to add the lexer association displayed to the list.</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.on_deleteLexerButton_clicked">on_deleteLexerButton_clicked</a></td> +<td>Private slot to delete the currently selected lexer association of the list.</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged">on_editorLexerCombo_currentIndexChanged</a></td> +<td>Private slot to handle the selection of a lexer.</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.on_editorLexerList_itemActivated">on_editorLexerList_itemActivated</a></td> +<td>Private slot to handle the activated signal of the lexer association list.</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.on_editorLexerList_itemClicked">on_editorLexerList_itemClicked</a></td> +<td>Private slot to handle the clicked signal of the lexer association list.</td> +</tr> +<tr> +<td><a href="#EditorHighlightersPage.save">save</a></td> +<td>Public slot to save the Editor Highlighter Associations configuration.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EditorHighlightersPage.__init__" ID="EditorHighlightersPage.__init__"></a> +<h4>EditorHighlightersPage (Constructor)</h4> +<b>EditorHighlightersPage</b>(<i>lexers</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>lexers</i></dt> +<dd> +reference to the lexers dictionary +</dd> +</dl> +<a NAME="EditorHighlightersPage.on_addLexerButton_clicked" ID="EditorHighlightersPage.on_addLexerButton_clicked"></a> +<h4>EditorHighlightersPage.on_addLexerButton_clicked</h4> +<b>on_addLexerButton_clicked</b>(<i></i>) + +<p> + Private slot to add the lexer association displayed to the list. +</p> +<a NAME="EditorHighlightersPage.on_deleteLexerButton_clicked" ID="EditorHighlightersPage.on_deleteLexerButton_clicked"></a> +<h4>EditorHighlightersPage.on_deleteLexerButton_clicked</h4> +<b>on_deleteLexerButton_clicked</b>(<i></i>) + +<p> + Private slot to delete the currently selected lexer association of the + list. +</p> +<a NAME="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged" ID="EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged"></a> +<h4>EditorHighlightersPage.on_editorLexerCombo_currentIndexChanged</h4> +<b>on_editorLexerCombo_currentIndexChanged</b>(<i>index</i>) + +<p> + Private slot to handle the selection of a lexer. +</p> +<dl> + +<dt><i>index</i> (int)</dt> +<dd> +index of the current item +</dd> +</dl> +<a NAME="EditorHighlightersPage.on_editorLexerList_itemActivated" ID="EditorHighlightersPage.on_editorLexerList_itemActivated"></a> +<h4>EditorHighlightersPage.on_editorLexerList_itemActivated</h4> +<b>on_editorLexerList_itemActivated</b>(<i>itm, column</i>) + +<p> + Private slot to handle the activated signal of the lexer association + list. +</p> +<dl> + +<dt><i>itm</i></dt> +<dd> +reference to the selecte item (QTreeWidgetItem) +</dd> +<dt><i>column</i></dt> +<dd> +column the item was clicked or activated (integer) + (ignored) +</dd> +</dl> +<a NAME="EditorHighlightersPage.on_editorLexerList_itemClicked" ID="EditorHighlightersPage.on_editorLexerList_itemClicked"></a> +<h4>EditorHighlightersPage.on_editorLexerList_itemClicked</h4> +<b>on_editorLexerList_itemClicked</b>(<i>itm, column</i>) + +<p> + Private slot to handle the clicked signal of the lexer association + list. +</p> +<dl> + +<dt><i>itm</i></dt> +<dd> +reference to the selecte item (QTreeWidgetItem) +</dd> +<dt><i>column</i></dt> +<dd> +column the item was clicked or activated (integer) + (ignored) +</dd> +</dl> +<a NAME="EditorHighlightersPage.save" ID="EditorHighlightersPage.save"></a> +<h4>EditorHighlightersPage.save</h4> +<b>save</b>(<i></i>) + +<p> + Public slot to save the Editor Highlighter Associations configuration. +</p> +<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> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file