src/eric7/Documentation/Source/eric7.Preferences.HighlightingStylesFile.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Preferences.HighlightingStylesFile.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.HighlightingStylesFile</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Preferences.HighlightingStylesFile</h1>
+
+<p>
+Module implementing a class representing the highlighting styles JSON file.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#HighlightingStylesFile">HighlightingStylesFile</a></td>
+<td>Class representing the highlighting styles JSON file.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="HighlightingStylesFile" ID="HighlightingStylesFile"></a>
+<h2>HighlightingStylesFile</h2>
+
+<p>
+    Class representing the highlighting styles JSON file.
+</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="#HighlightingStylesFile.__init__">HighlightingStylesFile</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#HighlightingStylesFile.readFile">readFile</a></td>
+<td>Public method to read the highlighting styles data from a highlighting styles JSON file.</td>
+</tr>
+<tr>
+<td><a href="#HighlightingStylesFile.writeFile">writeFile</a></td>
+<td>Public method to write the highlighting styles data to a highlighting styles JSON file.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="HighlightingStylesFile.__init__" ID="HighlightingStylesFile.__init__"></a>
+<h4>HighlightingStylesFile (Constructor)</h4>
+<b>HighlightingStylesFile</b>(<i>parent: QObject = None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i> (QObject (optional))</dt>
+<dd>
+reference to the parent object (defaults to None)
+</dd>
+</dl>
+<a NAME="HighlightingStylesFile.readFile" ID="HighlightingStylesFile.readFile"></a>
+<h4>HighlightingStylesFile.readFile</h4>
+<b>readFile</b>(<i>filename: str</i>)
+
+<p>
+        Public method to read the highlighting styles data from a highlighting
+        styles JSON file.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the highlighting styles file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of read lexer style definitions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict
+</dd>
+</dl>
+<a NAME="HighlightingStylesFile.writeFile" ID="HighlightingStylesFile.writeFile"></a>
+<h4>HighlightingStylesFile.writeFile</h4>
+<b>writeFile</b>(<i>filename: str, lexers: list</i>)
+
+<p>
+        Public method to write the highlighting styles data to a highlighting
+        styles JSON file.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the highlighting styles file
+</dd>
+<dt><i>lexers</i> (list of PreferencesLexer)</dt>
+<dd>
+list of lexers for which to export the styles
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful write
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial