--- a/src/eric7/Documentation/Source/eric7.Preferences.PreferencesLexer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.PreferencesLexer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.PreferencesLexer</h1>
-
<p>
Module implementing a special QScintilla lexer to handle the preferences.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PreferencesLexer">PreferencesLexer</a></td>
<td>Class implementing a Lexer facade for the highlighting styles configuration.</td>
@@ -33,36 +31,35 @@
<td>Class defining a special error for the PreferencesLexer class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PreferencesLexer" ID="PreferencesLexer"></a>
<h2>PreferencesLexer</h2>
-
<p>
Class implementing a Lexer facade for the highlighting styles
configuration.
</p>
+
<h3>Derived from</h3>
QObject
<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="#PreferencesLexer.__init__">PreferencesLexer</a></td>
<td>Constructor</td>
@@ -176,19 +173,20 @@
<td>Public method to write the lexer settings.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PreferencesLexer.__init__" ID="PreferencesLexer.__init__"></a>
<h4>PreferencesLexer (Constructor)</h4>
<b>PreferencesLexer</b>(<i>language, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -211,10 +209,10 @@
<a NAME="PreferencesLexer.addSubstyle" ID="PreferencesLexer.addSubstyle"></a>
<h4>PreferencesLexer.addSubstyle</h4>
<b>addSubstyle</b>(<i>style</i>)
-
<p>
Public method to add an empty sub-style to a given style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -237,10 +235,10 @@
<a NAME="PreferencesLexer.color" ID="PreferencesLexer.color"></a>
<h4>PreferencesLexer.color</h4>
<b>color</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the color of a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -267,10 +265,10 @@
<a NAME="PreferencesLexer.defaultColor" ID="PreferencesLexer.defaultColor"></a>
<h4>PreferencesLexer.defaultColor</h4>
<b>defaultColor</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default color of a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -297,10 +295,10 @@
<a NAME="PreferencesLexer.defaultDescription" ID="PreferencesLexer.defaultDescription"></a>
<h4>PreferencesLexer.defaultDescription</h4>
<b>defaultDescription</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default descriptive string for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -327,10 +325,10 @@
<a NAME="PreferencesLexer.defaultEolFill" ID="PreferencesLexer.defaultEolFill"></a>
<h4>PreferencesLexer.defaultEolFill</h4>
<b>defaultEolFill</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default eolFill flag for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -357,10 +355,10 @@
<a NAME="PreferencesLexer.defaultFont" ID="PreferencesLexer.defaultFont"></a>
<h4>PreferencesLexer.defaultFont</h4>
<b>defaultFont</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default font for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -387,10 +385,10 @@
<a NAME="PreferencesLexer.defaultPaper" ID="PreferencesLexer.defaultPaper"></a>
<h4>PreferencesLexer.defaultPaper</h4>
<b>defaultPaper</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default background for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -417,10 +415,10 @@
<a NAME="PreferencesLexer.defaultWords" ID="PreferencesLexer.defaultWords"></a>
<h4>PreferencesLexer.defaultWords</h4>
<b>defaultWords</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the default list of words for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -447,10 +445,10 @@
<a NAME="PreferencesLexer.delSubstyle" ID="PreferencesLexer.delSubstyle"></a>
<h4>PreferencesLexer.delSubstyle</h4>
<b>delSubstyle</b>(<i>style, substyle</i>)
-
<p>
Public method to delete a given sub-style definition.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -477,10 +475,10 @@
<a NAME="PreferencesLexer.description" ID="PreferencesLexer.description"></a>
<h4>PreferencesLexer.description</h4>
<b>description</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get a descriptive string for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -507,10 +505,10 @@
<a NAME="PreferencesLexer.eolFill" ID="PreferencesLexer.eolFill"></a>
<h4>PreferencesLexer.eolFill</h4>
<b>eolFill</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the eolFill flag for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -537,10 +535,10 @@
<a NAME="PreferencesLexer.font" ID="PreferencesLexer.font"></a>
<h4>PreferencesLexer.font</h4>
<b>font</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the font for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -567,10 +565,10 @@
<a NAME="PreferencesLexer.getStyles" ID="PreferencesLexer.getStyles"></a>
<h4>PreferencesLexer.getStyles</h4>
<b>getStyles</b>(<i></i>)
-
<p>
Public method to get a list of all supported styles.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -587,10 +585,10 @@
<a NAME="PreferencesLexer.getSubStyles" ID="PreferencesLexer.getSubStyles"></a>
<h4>PreferencesLexer.getSubStyles</h4>
<b>getSubStyles</b>(<i>style</i>)
-
<p>
Public method to get a list of all sub-styles of a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -614,10 +612,10 @@
<a NAME="PreferencesLexer.hasStyle" ID="PreferencesLexer.hasStyle"></a>
<h4>PreferencesLexer.hasStyle</h4>
<b>hasStyle</b>(<i>style, substyle</i>)
-
<p>
Public method to test for a given style definition.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -644,10 +642,10 @@
<a NAME="PreferencesLexer.isBaseStyle" ID="PreferencesLexer.isBaseStyle"></a>
<h4>PreferencesLexer.isBaseStyle</h4>
<b>isBaseStyle</b>(<i>style</i>)
-
<p>
Public method to test, if a given style may have sub-styles.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -670,10 +668,10 @@
<a NAME="PreferencesLexer.language" ID="PreferencesLexer.language"></a>
<h4>PreferencesLexer.language</h4>
<b>language</b>(<i></i>)
-
<p>
Public method to get the lexers programming language.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -689,10 +687,10 @@
<a NAME="PreferencesLexer.loadDefaultSubStyles" ID="PreferencesLexer.loadDefaultSubStyles"></a>
<h4>PreferencesLexer.loadDefaultSubStyles</h4>
<b>loadDefaultSubStyles</b>(<i>style</i>)
-
<p>
Public method to load the default sub-styles for a given base style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -703,10 +701,10 @@
<a NAME="PreferencesLexer.paper" ID="PreferencesLexer.paper"></a>
<h4>PreferencesLexer.paper</h4>
<b>paper</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the background for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -733,10 +731,10 @@
<a NAME="PreferencesLexer.setColor" ID="PreferencesLexer.setColor"></a>
<h4>PreferencesLexer.setColor</h4>
<b>setColor</b>(<i>c, style, substyle=-1</i>)
-
<p>
Public method to set the color for a style.
</p>
+
<dl>
<dt><i>c</i> (QColor)</dt>
@@ -755,10 +753,10 @@
<a NAME="PreferencesLexer.setDescription" ID="PreferencesLexer.setDescription"></a>
<h4>PreferencesLexer.setDescription</h4>
<b>setDescription</b>(<i>description, style, substyle=-1</i>)
-
<p>
Public method to set a descriptive string for a style.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -777,10 +775,10 @@
<a NAME="PreferencesLexer.setEolFill" ID="PreferencesLexer.setEolFill"></a>
<h4>PreferencesLexer.setEolFill</h4>
<b>setEolFill</b>(<i>eolfill, style, substyle=-1</i>)
-
<p>
Public method to set the eolFill flag for a style.
</p>
+
<dl>
<dt><i>eolfill</i> (bool)</dt>
@@ -799,10 +797,10 @@
<a NAME="PreferencesLexer.setFont" ID="PreferencesLexer.setFont"></a>
<h4>PreferencesLexer.setFont</h4>
<b>setFont</b>(<i>f, style, substyle=-1</i>)
-
<p>
Public method to set the font for a style.
</p>
+
<dl>
<dt><i>f</i> (QFont)</dt>
@@ -821,10 +819,10 @@
<a NAME="PreferencesLexer.setPaper" ID="PreferencesLexer.setPaper"></a>
<h4>PreferencesLexer.setPaper</h4>
<b>setPaper</b>(<i>c, style, substyle=-1</i>)
-
<p>
Public method to set the background for a style.
</p>
+
<dl>
<dt><i>c</i> (QColor)</dt>
@@ -843,10 +841,10 @@
<a NAME="PreferencesLexer.setWords" ID="PreferencesLexer.setWords"></a>
<h4>PreferencesLexer.setWords</h4>
<b>setWords</b>(<i>words, style, substyle=-1</i>)
-
<p>
Public method to set the list of words for a style.
</p>
+
<dl>
<dt><i>words</i> (str)</dt>
@@ -865,10 +863,10 @@
<a NAME="PreferencesLexer.words" ID="PreferencesLexer.words"></a>
<h4>PreferencesLexer.words</h4>
<b>words</b>(<i>style, substyle=-1</i>)
-
<p>
Public method to get the list of words for a style.
</p>
+
<dl>
<dt><i>style</i> (int)</dt>
@@ -895,35 +893,33 @@
<a NAME="PreferencesLexer.writeSettings" ID="PreferencesLexer.writeSettings"></a>
<h4>PreferencesLexer.writeSettings</h4>
<b>writeSettings</b>(<i></i>)
-
<p>
Public method to write the lexer settings.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PreferencesLexerError" ID="PreferencesLexerError"></a>
<h2>PreferencesLexerError</h2>
-
<p>
Class defining a special error for the PreferencesLexer class.
</p>
+
<h3>Derived from</h3>
Exception
<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="#PreferencesLexerError.__init__">PreferencesLexerError</a></td>
<td>Constructor</td>
@@ -937,26 +933,27 @@
<td>Special method returning a string representation of the exception.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PreferencesLexerError.__init__" ID="PreferencesLexerError.__init__"></a>
<h4>PreferencesLexerError (Constructor)</h4>
<b>PreferencesLexerError</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="PreferencesLexerError.__repr__" ID="PreferencesLexerError.__repr__"></a>
<h4>PreferencesLexerError.__repr__</h4>
<b>__repr__</b>(<i></i>)
-
<p>
Special method returning a representation of the exception.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -972,10 +969,10 @@
<a NAME="PreferencesLexerError.__str__" ID="PreferencesLexerError.__str__"></a>
<h4>PreferencesLexerError.__str__</h4>
<b>__str__</b>(<i></i>)
-
<p>
Special method returning a string representation of the exception.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -993,44 +990,43 @@
<hr />
<a NAME="PreferencesLexerLanguageError" ID="PreferencesLexerLanguageError"></a>
<h2>PreferencesLexerLanguageError</h2>
-
<p>
Class defining a special error for the PreferencesLexer class.
</p>
+
<h3>Derived from</h3>
PreferencesLexerError
<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="#PreferencesLexerLanguageError.__init__">PreferencesLexerLanguageError</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PreferencesLexerLanguageError.__init__" ID="PreferencesLexerLanguageError.__init__"></a>
<h4>PreferencesLexerLanguageError (Constructor)</h4>
<b>PreferencesLexerLanguageError</b>(<i>language</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -1040,4 +1036,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
