Mercurial Repositories > APIs / file comparison
comparison: Documentation/source/Plugin_Apis.PluginApis.html
Documentation/source/Plugin_Apis.PluginApis.html
- branch
- eric7
- changeset 68
- 2311d81b8606
- parent 33
- aae0ec9126cc
equal
deleted
inserted
replaced
| 67:4c73000666bd | 68:2311d81b8606 |
|---|---|
| 1 <!DOCTYPE html> | 1 <!DOCTYPE html> |
| 2 <html><head> | 2 <html><head> |
| 3 <title>Plugin_Apis.PluginApis</title> | 3 <title>Plugin_Apis.PluginApis</title> |
| 4 <meta charset="UTF-8"> | 4 <meta charset="UTF-8"> |
| 5 <style> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | 6 </head> |
| 21 <body> | 7 <body> |
| 22 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 23 <h1>Plugin_Apis.PluginApis</h1> | 9 <h1>Plugin_Apis.PluginApis</h1> |
| 24 | 10 |
| 98 <p> | 84 <p> |
| 99 Constructor | 85 Constructor |
| 100 </p> | 86 </p> |
| 101 <dl> | 87 <dl> |
| 102 | 88 |
| 103 <dt><i>ui</i></dt> | 89 <dt><i>ui</i> (UserInterface)</dt> |
| 104 <dd> | 90 <dd> |
| 105 reference to the user interface object (UI.UserInterface) | 91 reference to the user interface object |
| 106 </dd> | 92 </dd> |
| 107 </dl> | 93 </dl> |
| 108 <a NAME="PluginApis.activate" ID="PluginApis.activate"></a> | 94 <a NAME="PluginApis.activate" ID="PluginApis.activate"></a> |
| 109 <h4>PluginApis.activate</h4> | 95 <h4>PluginApis.activate</h4> |
| 110 <b>activate</b>(<i></i>) | 96 <b>activate</b>(<i></i>) |
| 113 Public method to activate this plugin. | 99 Public method to activate this plugin. |
| 114 </p> | 100 </p> |
| 115 <dl> | 101 <dl> |
| 116 <dt>Return:</dt> | 102 <dt>Return:</dt> |
| 117 <dd> | 103 <dd> |
| 118 tuple of None and activation status (boolean) | 104 tuple of None and activation status |
| 105 </dd> | |
| 106 </dl> | |
| 107 <dl> | |
| 108 <dt>Return Type:</dt> | |
| 109 <dd> | |
| 110 tuple of (None, bool) | |
| 119 </dd> | 111 </dd> |
| 120 </dl> | 112 </dl> |
| 121 <a NAME="PluginApis.deactivate" ID="PluginApis.deactivate"></a> | 113 <a NAME="PluginApis.deactivate" ID="PluginApis.deactivate"></a> |
| 122 <h4>PluginApis.deactivate</h4> | 114 <h4>PluginApis.deactivate</h4> |
| 123 <b>deactivate</b>(<i></i>) | 115 <b>deactivate</b>(<i></i>) |
| 135 <p> | 127 <p> |
| 136 Module function to return the API files made available by this plugin. | 128 Module function to return the API files made available by this plugin. |
| 137 </p> | 129 </p> |
| 138 <dl> | 130 <dl> |
| 139 | 131 |
| 140 <dt><i>language</i></dt> | 132 <dt><i>language</i> (str)</dt> |
| 141 <dd> | 133 <dd> |
| 142 language to get APIs for (string) | 134 language to get APIs for |
| 143 </dd> | 135 </dd> |
| 144 </dl> | 136 </dl> |
| 145 <dl> | 137 <dl> |
| 146 <dt>Return:</dt> | 138 <dt>Return:</dt> |
| 147 <dd> | 139 <dd> |
| 148 list of API filenames (list of string) | 140 list of API filenames |
| 141 </dd> | |
| 142 </dl> | |
| 143 <dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 list of str | |
| 149 </dd> | 147 </dd> |
| 150 </dl> | 148 </dl> |
| 151 <div align="right"><a href="#top">Up</a></div> | 149 <div align="right"><a href="#top">Up</a></div> |
| 152 <hr /> | 150 <hr /> |
| 153 </body></html> | 151 </body></html> |
