src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerEditorConfigInterface.html

branch
eric7
changeset 10784
521fd465b048
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerEditorConfigInterface.html	Fri Jun 14 11:23:45 2024 +0200
@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.RemoteServerInterface.EricServerEditorConfigInterface</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.RemoteServerInterface.EricServerEditorConfigInterface</h1>
+<p>
+Module implementing the Editor Config interface to the eric-ide server.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#EricServerEditorConfigInterface">EricServerEditorConfigInterface</a></td>
+<td>Class implementing the Editor Config interface to the eric-ide server.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="EricServerEditorConfigInterface" ID="EricServerEditorConfigInterface"></a>
+<h2>EricServerEditorConfigInterface</h2>
+<p>
+    Class implementing the Editor Config interface to the eric-ide server.
+</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="#EricServerEditorConfigInterface.__init__">EricServerEditorConfigInterface</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricServerEditorConfigInterface.callback">callback</a></td>
+<td>Function to handle the server reply</td>
+</tr>
+<tr>
+<td><a href="#EricServerEditorConfigInterface.loadEditorConfig">loadEditorConfig</a></td>
+<td>Public method to load the editor config for the given file.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="EricServerEditorConfigInterface.__init__" ID="EricServerEditorConfigInterface.__init__"></a>
+<h4>EricServerEditorConfigInterface (Constructor)</h4>
+<b>EricServerEditorConfigInterface</b>(<i>serverInterface</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>serverInterface</i> (EricServerInterface)</dt>
+<dd>
+reference to the eric-ide server interface
+</dd>
+</dl>
+<a NAME="EricServerEditorConfigInterface.callback" ID="EricServerEditorConfigInterface.callback"></a>
+<h4>EricServerEditorConfigInterface.callback</h4>
+<b>callback</b>(<i>params</i>)
+<p>
+            Function to handle the server reply
+</p>
+
+<dl>
+
+<dt><i>reply</i> (str)</dt>
+<dd>
+name of the server reply
+</dd>
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the reply data
+</dd>
+</dl>
+<a NAME="EricServerEditorConfigInterface.loadEditorConfig" ID="EricServerEditorConfigInterface.loadEditorConfig"></a>
+<h4>EricServerEditorConfigInterface.loadEditorConfig</h4>
+<b>loadEditorConfig</b>(<i>filename</i>)
+<p>
+        Public method to load the editor config for the given file.
+</p>
+
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the file to get the editor config for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the editor config data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>editorconfig.EditorConfigError</b>:</dt>
+<dd>
+raised to indicate an
+            issue loading the editor config
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial