src/eric7/Documentation/Source/eric7.RemoteServer.EricServerEditorConfigRequestHandler.html

Fri, 14 Jun 2024 11:23:45 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 14 Jun 2024 11:23:45 +0200
branch
eric7
changeset 10784
521fd465b048
permissions
-rw-r--r--

Added source documentation for the eric-ide server.

10784
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.RemoteServer.EricServerEditorConfigRequestHandler</title>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.RemoteServer.EricServerEditorConfigRequestHandler</h1>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 Module implementing the editor config request handler of the eric-ide server.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <td><a href="#EricServerEditorConfigRequestHandler">EricServerEditorConfigRequestHandler</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <td>Class implementing the editor config request handler of the eric-ide server.</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Functions</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <a NAME="EricServerEditorConfigRequestHandler" ID="EricServerEditorConfigRequestHandler"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <h2>EricServerEditorConfigRequestHandler</h2>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 Class implementing the editor config request handler of the eric-ide server.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <h3>Derived from</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 EricServerBaseRequestHandler
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Class Attributes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Class Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <h3>Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <td><a href="#EricServerEditorConfigRequestHandler.__init__">EricServerEditorConfigRequestHandler</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <td>Constructor</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td><a href="#EricServerEditorConfigRequestHandler.__loadEditorConfig">__loadEditorConfig</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td>Private method to load the EditorConfig properties for the given file name.</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <h3>Static Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <a NAME="EricServerEditorConfigRequestHandler.__init__" ID="EricServerEditorConfigRequestHandler.__init__"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <h4>EricServerEditorConfigRequestHandler (Constructor)</h4>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <b>EricServerEditorConfigRequestHandler</b>(<i>server</i>)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 Constructor
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <dt><i>server</i> (EricServer)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 reference to the eric-ide server object
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <a NAME="EricServerEditorConfigRequestHandler.__loadEditorConfig" ID="EricServerEditorConfigRequestHandler.__loadEditorConfig"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <h4>EricServerEditorConfigRequestHandler.__loadEditorConfig</h4>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <b>__loadEditorConfig</b>(<i>params</i>)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 Private method to load the EditorConfig properties for the given
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 file name.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <dt><i>params</i> (dict)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 dictionary containing the request data
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dt>Return:</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 dictionary containing the reply data
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <dt>Return Type:</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 dict
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <div align="right"><a href="#top">Up</a></div>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </body></html>

eric ide

mercurial