Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerEditorConfigInterface.html
src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerEditorConfigInterface.html
- branch
- eric7
- changeset 10784
- 521fd465b048
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServerInterface.EricServerEditorConfigInterface</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.RemoteServerInterface.EricServerEditorConfigInterface</h1> | |
| 10 <p> | |
| 11 Module implementing the Editor Config interface to the eric-ide server. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EricServerEditorConfigInterface">EricServerEditorConfigInterface</a></td> | |
| 23 <td>Class implementing the Editor Config interface to the eric-ide server.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="EricServerEditorConfigInterface" ID="EricServerEditorConfigInterface"></a> | |
| 35 <h2>EricServerEditorConfigInterface</h2> | |
| 36 <p> | |
| 37 Class implementing the Editor Config interface to the eric-ide server. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 QObject | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>None</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#EricServerEditorConfigInterface.__init__">EricServerEditorConfigInterface</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#EricServerEditorConfigInterface.callback">callback</a></td> | |
| 60 <td>Function to handle the server reply</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#EricServerEditorConfigInterface.loadEditorConfig">loadEditorConfig</a></td> | |
| 64 <td>Public method to load the editor config for the given file.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 | |
| 68 <h3>Static Methods</h3> | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 | |
| 73 | |
| 74 <a NAME="EricServerEditorConfigInterface.__init__" ID="EricServerEditorConfigInterface.__init__"></a> | |
| 75 <h4>EricServerEditorConfigInterface (Constructor)</h4> | |
| 76 <b>EricServerEditorConfigInterface</b>(<i>serverInterface</i>) | |
| 77 <p> | |
| 78 Constructor | |
| 79 </p> | |
| 80 | |
| 81 <dl> | |
| 82 | |
| 83 <dt><i>serverInterface</i> (EricServerInterface)</dt> | |
| 84 <dd> | |
| 85 reference to the eric-ide server interface | |
| 86 </dd> | |
| 87 </dl> | |
| 88 <a NAME="EricServerEditorConfigInterface.callback" ID="EricServerEditorConfigInterface.callback"></a> | |
| 89 <h4>EricServerEditorConfigInterface.callback</h4> | |
| 90 <b>callback</b>(<i>params</i>) | |
| 91 <p> | |
| 92 Function to handle the server reply | |
| 93 </p> | |
| 94 | |
| 95 <dl> | |
| 96 | |
| 97 <dt><i>reply</i> (str)</dt> | |
| 98 <dd> | |
| 99 name of the server reply | |
| 100 </dd> | |
| 101 <dt><i>params</i> (dict)</dt> | |
| 102 <dd> | |
| 103 dictionary containing the reply data | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <a NAME="EricServerEditorConfigInterface.loadEditorConfig" ID="EricServerEditorConfigInterface.loadEditorConfig"></a> | |
| 107 <h4>EricServerEditorConfigInterface.loadEditorConfig</h4> | |
| 108 <b>loadEditorConfig</b>(<i>filename</i>) | |
| 109 <p> | |
| 110 Public method to load the editor config for the given file. | |
| 111 </p> | |
| 112 | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>filename</i> (str)</dt> | |
| 116 <dd> | |
| 117 name of the file to get the editor config for | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <dl> | |
| 121 <dt>Return:</dt> | |
| 122 <dd> | |
| 123 dictionary containing the editor config data | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <dl> | |
| 127 <dt>Return Type:</dt> | |
| 128 <dd> | |
| 129 dict | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <dl> | |
| 133 | |
| 134 <dt>Raises <b>editorconfig.EditorConfigError</b>:</dt> | |
| 135 <dd> | |
| 136 raised to indicate an | |
| 137 issue loading the editor config | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <div align="right"><a href="#top">Up</a></div> | |
| 141 <hr /> | |
| 142 </body></html> |
