--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,57 +7,58 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ConfigurationPages.EditorHighlightingStylesPage</h1>
-
<p>
Module implementing the Editor Highlighting Styles configuration page.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EditorHighlightingStylesPage">EditorHighlightingStylesPage</a></td>
<td>Class implementing the Editor Highlighting Styles 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="EditorHighlightingStylesPage" ID="EditorHighlightingStylesPage"></a>
<h2>EditorHighlightingStylesPage</h2>
-
<p>
Class implementing the Editor Highlighting Styles configuration page.
</p>
+
<h3>Derived from</h3>
ConfigurationPageBase, Ui_EditorHighlightingStylesPage
<h3>Class Attributes</h3>
+<table>
+<tr><td>FAMILYANDSIZE</td></tr>
+<tr><td>FAMILYONLY</td></tr>
+<tr><td>FONT</td></tr>
+<tr><td>SIZEONLY</td></tr>
+<tr><td>StyleRole</td></tr>
+<tr><td>SubstyleRole</td></tr>
+</table>
-<table>
-<tr><td>FAMILYANDSIZE</td></tr><tr><td>FAMILYONLY</td></tr><tr><td>FONT</td></tr><tr><td>SIZEONLY</td></tr><tr><td>StyleRole</td></tr><tr><td>SubstyleRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td>
<td>Constructor</td>
@@ -211,19 +212,20 @@
<td>Public method to set the state of the widget.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EditorHighlightingStylesPage.__init__" ID="EditorHighlightingStylesPage.__init__"></a>
<h4>EditorHighlightingStylesPage (Constructor)</h4>
<b>EditorHighlightingStylesPage</b>(<i>lexers</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>lexers</i> (dict)</dt>
@@ -234,10 +236,10 @@
<a NAME="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered" ID="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered"></a>
<h4>EditorHighlightingStylesPage.__allFontsButtonMenuTriggered</h4>
<b>__allFontsButtonMenuTriggered</b>(<i>act</i>)
-
<p>
Private slot used to change the font of all styles of a selected lexer.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -248,10 +250,10 @@
<a NAME="EditorHighlightingStylesPage.__applyStyles" ID="EditorHighlightingStylesPage.__applyStyles"></a>
<h4>EditorHighlightingStylesPage.__applyStyles</h4>
<b>__applyStyles</b>(<i>stylesList, importAll=False</i>)
-
<p>
Private method to apply the imported styles to this dialog.
</p>
+
<dl>
<dt><i>stylesList</i> (list of dict)</dt>
@@ -267,10 +269,10 @@
<a NAME="EditorHighlightingStylesPage.__changeFont" ID="EditorHighlightingStylesPage.__changeFont"></a>
<h4>EditorHighlightingStylesPage.__changeFont</h4>
<b>__changeFont</b>(<i>doAll, familyOnly, sizeOnly</i>)
-
<p>
Private slot to change the highlighter font.
</p>
+
<dl>
<dt><i>doAll</i> (bool)</dt>
@@ -289,10 +291,10 @@
<a NAME="EditorHighlightingStylesPage.__currentStyles" ID="EditorHighlightingStylesPage.__currentStyles"></a>
<h4>EditorHighlightingStylesPage.__currentStyles</h4>
<b>__currentStyles</b>(<i></i>)
-
<p>
Private method to get the styles of the current item.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -308,10 +310,10 @@
<a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a>
<h4>EditorHighlightingStylesPage.__exportStyles</h4>
<b>__exportStyles</b>(<i>exportAll=False</i>)
-
<p>
Private method to export the styles of selectable lexers.
</p>
+
<dl>
<dt><i>exportAll</i> (bool (optional))</dt>
@@ -323,10 +325,10 @@
<a NAME="EditorHighlightingStylesPage.__fontButtonMenuTriggered" ID="EditorHighlightingStylesPage.__fontButtonMenuTriggered"></a>
<h4>EditorHighlightingStylesPage.__fontButtonMenuTriggered</h4>
<b>__fontButtonMenuTriggered</b>(<i>act</i>)
-
<p>
Private slot used to select the font of the selected style and lexer.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -337,10 +339,10 @@
<a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a>
<h4>EditorHighlightingStylesPage.__importStyles</h4>
<b>__importStyles</b>(<i>importAll=False</i>)
-
<p>
Private method to import the styles of lexers to be selected.
</p>
+
<dl>
<dt><i>importAll</i> (bool (optional))</dt>
@@ -352,10 +354,10 @@
<a NAME="EditorHighlightingStylesPage.__populateLanguages" ID="EditorHighlightingStylesPage.__populateLanguages"></a>
<h4>EditorHighlightingStylesPage.__populateLanguages</h4>
<b>__populateLanguages</b>(<i>languages</i>)
-
<p>
Private method to populate the language selection box.
</p>
+
<dl>
<dt><i>languages</i> (list of str)</dt>
@@ -366,10 +368,10 @@
<a NAME="EditorHighlightingStylesPage.__setToDefault" ID="EditorHighlightingStylesPage.__setToDefault"></a>
<h4>EditorHighlightingStylesPage.__setToDefault</h4>
<b>__setToDefault</b>(<i>style, substyle</i>)
-
<p>
Private method to set a specific style to its default values.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -384,17 +386,17 @@
<a NAME="EditorHighlightingStylesPage.__styleAllItems" ID="EditorHighlightingStylesPage.__styleAllItems"></a>
<h4>EditorHighlightingStylesPage.__styleAllItems</h4>
<b>__styleAllItems</b>(<i></i>)
-
<p>
Private method to style all items of the style element list.
</p>
+
<a NAME="EditorHighlightingStylesPage.__styleOneItem" ID="EditorHighlightingStylesPage.__styleOneItem"></a>
<h4>EditorHighlightingStylesPage.__styleOneItem</h4>
<b>__styleOneItem</b>(<i>item, style, substyle</i>)
-
<p>
Private method to style one item of the style element list.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -413,10 +415,10 @@
<a NAME="EditorHighlightingStylesPage.__styleSample" ID="EditorHighlightingStylesPage.__styleSample"></a>
<h4>EditorHighlightingStylesPage.__styleSample</h4>
<b>__styleSample</b>(<i>color, paper, font=None</i>)
-
<p>
Private method to style the sample text.
</p>
+
<dl>
<dt><i>color</i> (QColor)</dt>
@@ -435,10 +437,10 @@
<a NAME="EditorHighlightingStylesPage.__stylesForItem" ID="EditorHighlightingStylesPage.__stylesForItem"></a>
<h4>EditorHighlightingStylesPage.__stylesForItem</h4>
<b>__stylesForItem</b>(<i>itm</i>)
-
<p>
Private method to get the style and sub-style number of the given item.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -461,84 +463,84 @@
<a NAME="EditorHighlightingStylesPage.on_addSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_addSubstyleButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_addSubstyleButton_clicked</h4>
<b>on_addSubstyleButton_clicked</b>(<i></i>)
-
<p>
Private slot to add a new sub-style.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked" ID="EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_allBackgroundColoursButton_clicked</h4>
<b>on_allBackgroundColoursButton_clicked</b>(<i></i>)
-
<p>
Private method used to select the background colour of all styles of a
selected lexer.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_allDefaultButton_clicked" ID="EditorHighlightingStylesPage.on_allDefaultButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_allDefaultButton_clicked</h4>
<b>on_allDefaultButton_clicked</b>(<i></i>)
-
<p>
Private method to set all styles to their default values.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4>
<b>on_allEolFillButton_clicked</b>(<i></i>)
-
<p>
Private method used to set the eolfill for all styles of a selected
lexer.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4>
<b>on_backgroundButton_clicked</b>(<i></i>)
-
<p>
Private method used to select the background colour of the selected
style and lexer.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_copySubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_copySubstyleButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_copySubstyleButton_clicked</h4>
<b>on_copySubstyleButton_clicked</b>(<i></i>)
-
<p>
Private slot to copy the selected sub-style.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_defaultButton_clicked" ID="EditorHighlightingStylesPage.on_defaultButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_defaultButton_clicked</h4>
<b>on_defaultButton_clicked</b>(<i></i>)
-
<p>
Private method to set the current style to its default values.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked" ID="EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_defaultSubstylesButton_clicked</h4>
<b>on_defaultSubstylesButton_clicked</b>(<i></i>)
-
<p>
Private slot to reset all substyles to default values.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_deleteSubstyleButton_clicked</h4>
<b>on_deleteSubstyleButton_clicked</b>(<i></i>)
-
<p>
Private slot to delete the selected sub-style.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_editSubstyleButton_clicked" ID="EditorHighlightingStylesPage.on_editSubstyleButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_editSubstyleButton_clicked</h4>
<b>on_editSubstyleButton_clicked</b>(<i></i>)
-
<p>
Private slot to edit the selected sub-style entry.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked" ID="EditorHighlightingStylesPage.on_eolfillCheckBox_clicked"></a>
<h4>EditorHighlightingStylesPage.on_eolfillCheckBox_clicked</h4>
<b>on_eolfillCheckBox_clicked</b>(<i>on</i>)
-
<p>
Private method used to set the eolfill for the selected style and
lexer.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -549,46 +551,46 @@
<a NAME="EditorHighlightingStylesPage.on_exportAllButton_clicked" ID="EditorHighlightingStylesPage.on_exportAllButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_exportAllButton_clicked</h4>
<b>on_exportAllButton_clicked</b>(<i></i>)
-
<p>
Private slot to export the styles of all lexers.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_exportButton_clicked" ID="EditorHighlightingStylesPage.on_exportButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_exportButton_clicked</h4>
<b>on_exportButton_clicked</b>(<i></i>)
-
<p>
Private slot to export styles to be selected.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4>
<b>on_foregroundButton_clicked</b>(<i></i>)
-
<p>
Private method used to select the foreground colour of the selected
style and lexer.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_importAllButton_clicked" ID="EditorHighlightingStylesPage.on_importAllButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_importAllButton_clicked</h4>
<b>on_importAllButton_clicked</b>(<i></i>)
-
<p>
Private slot to import the styles of all lexers.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_importButton_clicked" ID="EditorHighlightingStylesPage.on_importButton_clicked"></a>
<h4>EditorHighlightingStylesPage.on_importButton_clicked</h4>
<b>on_importButton_clicked</b>(<i></i>)
-
<p>
Private slot to import styles to be selected.
</p>
+
<a NAME="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated" ID="EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated"></a>
<h4>EditorHighlightingStylesPage.on_lexerLanguageComboBox_activated</h4>
<b>on_lexerLanguageComboBox_activated</b>(<i>index</i>)
-
<p>
Private slot to fill the style combo of the source page.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -599,10 +601,10 @@
<a NAME="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged" ID="EditorHighlightingStylesPage.on_styleElementList_currentItemChanged"></a>
<h4>EditorHighlightingStylesPage.on_styleElementList_currentItemChanged</h4>
<b>on_styleElementList_currentItemChanged</b>(<i>current, previous</i>)
-
<p>
Private method to handle a change of the current row.
</p>
+
<dl>
<dt><i>current</i> (QTreeWidgetItem)</dt>
@@ -617,17 +619,17 @@
<a NAME="EditorHighlightingStylesPage.save" ID="EditorHighlightingStylesPage.save"></a>
<h4>EditorHighlightingStylesPage.save</h4>
<b>save</b>(<i></i>)
-
<p>
Public slot to save the Editor Highlighting Styles configuration.
</p>
+
<a NAME="EditorHighlightingStylesPage.saveState" ID="EditorHighlightingStylesPage.saveState"></a>
<h4>EditorHighlightingStylesPage.saveState</h4>
<b>saveState</b>(<i></i>)
-
<p>
Public method to save the current state of the widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -645,10 +647,10 @@
<a NAME="EditorHighlightingStylesPage.setFont" ID="EditorHighlightingStylesPage.setFont"></a>
<h4>EditorHighlightingStylesPage.setFont</h4>
<b>setFont</b>(<i>style, substyle, familyOnly, sizeOnly</i>)
-
<p>
Local function to set the font.
</p>
+
<dl>
<dt><i>font</i> (QFont)</dt>
@@ -675,10 +677,10 @@
<a NAME="EditorHighlightingStylesPage.setMode" ID="EditorHighlightingStylesPage.setMode"></a>
<h4>EditorHighlightingStylesPage.setMode</h4>
<b>setMode</b>(<i>displayMode</i>)
-
<p>
Public method to perform mode dependent setups.
</p>
+
<dl>
<dt><i>displayMode</i> (ConfigurationMode)</dt>
@@ -689,10 +691,10 @@
<a NAME="EditorHighlightingStylesPage.setSampleFont" ID="EditorHighlightingStylesPage.setSampleFont"></a>
<h4>EditorHighlightingStylesPage.setSampleFont</h4>
<b>setSampleFont</b>(<i>familyOnly, sizeOnly</i>)
-
<p>
Local function to set the font of the sample text.
</p>
+
<dl>
<dt><i>font</i></dt>
@@ -712,10 +714,10 @@
<a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a>
<h4>EditorHighlightingStylesPage.setState</h4>
<b>setState</b>(<i>state</i>)
-
<p>
Public method to set the state of the widget.
</p>
+
<dl>
<dt><i>state</i> (list of [int, tuple of (int, int)])</dt>
@@ -729,10 +731,10 @@
<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> (ConfigurationDialog)</dt>
@@ -754,4 +756,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
