Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html
eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.PluginEricapi</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 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> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.PluginEricapi</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the Ericapi plugin. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#EricapiPlugin">EricapiPlugin</a></td> | |
| 39 <td>Class implementing the Ericapi plugin.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 | |
| 46 <tr> | |
| 47 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 48 <td>Public method to support the display of some executable info.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /> | |
| 52 <hr /> | |
| 53 <a NAME="EricapiPlugin" ID="EricapiPlugin"></a> | |
| 54 <h2>EricapiPlugin</h2> | |
| 55 | |
| 56 <p> | |
| 57 Class implementing the Ericapi plugin. | |
| 58 </p> | |
| 59 <h3>Derived from</h3> | |
| 60 QObject | |
| 61 <h3>Class Attributes</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 | |
| 75 <tr> | |
| 76 <td><a href="#EricapiPlugin.__init__">EricapiPlugin</a></td> | |
| 77 <td>Constructor</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#EricapiPlugin.__doEricapi">__doEricapi</a></td> | |
| 81 <td>Private slot to perform the eric7_api api generation.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#EricapiPlugin.__initialize">__initialize</a></td> | |
| 85 <td>Private slot to (re)initialize the plugin.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td> | |
| 89 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#EricapiPlugin.activate">activate</a></td> | |
| 93 <td>Public method to activate this plugin.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#EricapiPlugin.deactivate">deactivate</a></td> | |
| 97 <td>Public method to deactivate this plugin.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 | |
| 102 <table> | |
| 103 <tr><td>None</td></tr> | |
| 104 </table> | |
| 105 | |
| 106 <a NAME="EricapiPlugin.__init__" ID="EricapiPlugin.__init__"></a> | |
| 107 <h4>EricapiPlugin (Constructor)</h4> | |
| 108 <b>EricapiPlugin</b>(<i>ui</i>) | |
| 109 | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>ui</i></dt> | |
| 116 <dd> | |
| 117 reference to the user interface object (UI.UserInterface) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a> | |
| 121 <h4>EricapiPlugin.__doEricapi</h4> | |
| 122 <b>__doEricapi</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Private slot to perform the eric7_api api generation. | |
| 126 </p> | |
| 127 <a NAME="EricapiPlugin.__initialize" ID="EricapiPlugin.__initialize"></a> | |
| 128 <h4>EricapiPlugin.__initialize</h4> | |
| 129 <b>__initialize</b>(<i></i>) | |
| 130 | |
| 131 <p> | |
| 132 Private slot to (re)initialize the plugin. | |
| 133 </p> | |
| 134 <a NAME="EricapiPlugin.__projectShowMenu" ID="EricapiPlugin.__projectShowMenu"></a> | |
| 135 <h4>EricapiPlugin.__projectShowMenu</h4> | |
| 136 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | |
| 137 | |
| 138 <p> | |
| 139 Private slot called, when the the project menu or a submenu is | |
| 140 about to be shown. | |
| 141 </p> | |
| 142 <dl> | |
| 143 | |
| 144 <dt><i>menuName</i></dt> | |
| 145 <dd> | |
| 146 name of the menu to be shown (string) | |
| 147 </dd> | |
| 148 <dt><i>menu</i></dt> | |
| 149 <dd> | |
| 150 reference to the menu (QMenu) | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a> | |
| 154 <h4>EricapiPlugin.activate</h4> | |
| 155 <b>activate</b>(<i></i>) | |
| 156 | |
| 157 <p> | |
| 158 Public method to activate this plugin. | |
| 159 </p> | |
| 160 <dl> | |
| 161 <dt>Return:</dt> | |
| 162 <dd> | |
| 163 tuple of None and activation status (boolean) | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a> | |
| 167 <h4>EricapiPlugin.deactivate</h4> | |
| 168 <b>deactivate</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Public method to deactivate this plugin. | |
| 172 </p> | |
| 173 <div align="right"><a href="#top">Up</a></div> | |
| 174 <hr /> | |
| 175 <hr /> | |
| 176 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 177 <h2>exeDisplayData</h2> | |
| 178 <b>exeDisplayData</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Public method to support the display of some executable info. | |
| 182 </p> | |
| 183 <dl> | |
| 184 <dt>Return:</dt> | |
| 185 <dd> | |
| 186 dictionary containing the data to query the presence of | |
| 187 the executable | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <div align="right"><a href="#top">Up</a></div> | |
| 191 <hr /> | |
| 192 </body></html> |
