Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginEricdoc.html
Documentation/Source/eric5.Plugins.PluginEricdoc.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.PluginEricdoc</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Plugins.PluginEricdoc</h1> | |
| 12 <p> | |
| 13 Module implementing the Ericdoc plugin. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <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> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EricdocPlugin">EricdocPlugin</a></td> | |
| 23 <td>Class implementing the Ericdoc plugin.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 30 <td>Public method to support the display of some executable info.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <hr /><hr /> | |
| 34 <a NAME="EricdocPlugin" ID="EricdocPlugin"></a> | |
| 35 <h2>EricdocPlugin</h2> | |
| 36 <p> | |
| 37 Class implementing the Ericdoc plugin. | |
| 38 </p> | |
| 39 <h3>Derived from</h3> | |
| 40 QObject | |
| 41 <h3>Class Attributes</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <h3>Methods</h3> | |
| 46 <table> | |
| 47 <tr> | |
| 48 <td><a href="#EricdocPlugin.__init__">EricdocPlugin</a></td> | |
| 49 <td>Constructor</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#EricdocPlugin.__doEricdoc">__doEricdoc</a></td> | |
| 52 <td>Private slot to perform the eric5-doc api documentation generation.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#EricdocPlugin.__initialize">__initialize</a></td> | |
| 55 <td>Private slot to (re)initialize the plugin.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#EricdocPlugin.__projectShowMenu">__projectShowMenu</a></td> | |
| 58 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#EricdocPlugin.activate">activate</a></td> | |
| 61 <td>Public method to activate this plugin.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EricdocPlugin.deactivate">deactivate</a></td> | |
| 64 <td>Public method to deactivate this plugin.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 <a NAME="EricdocPlugin.__init__" ID="EricdocPlugin.__init__"></a> | |
| 68 <h4>EricdocPlugin (Constructor)</h4> | |
| 69 <b>EricdocPlugin</b>(<i>ui</i>) | |
| 70 <p> | |
| 71 Constructor | |
| 72 </p><dl> | |
| 73 <dt><i>ui</i></dt> | |
| 74 <dd> | |
| 75 reference to the user interface object (UI.UserInterface) | |
| 76 </dd> | |
| 77 </dl><a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> | |
| 78 <h4>EricdocPlugin.__doEricdoc</h4> | |
| 79 <b>__doEricdoc</b>(<i></i>) | |
| 80 <p> | |
| 81 Private slot to perform the eric5-doc api documentation generation. | |
| 82 </p><a NAME="EricdocPlugin.__initialize" ID="EricdocPlugin.__initialize"></a> | |
| 83 <h4>EricdocPlugin.__initialize</h4> | |
| 84 <b>__initialize</b>(<i></i>) | |
| 85 <p> | |
| 86 Private slot to (re)initialize the plugin. | |
| 87 </p><a NAME="EricdocPlugin.__projectShowMenu" ID="EricdocPlugin.__projectShowMenu"></a> | |
| 88 <h4>EricdocPlugin.__projectShowMenu</h4> | |
| 89 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | |
| 90 <p> | |
| 91 Private slot called, when the the project menu or a submenu is | |
| 92 about to be shown. | |
| 93 </p><dl> | |
| 94 <dt><i>menuName</i></dt> | |
| 95 <dd> | |
| 96 name of the menu to be shown (string) | |
| 97 </dd><dt><i>menu</i></dt> | |
| 98 <dd> | |
| 99 reference to the menu (QMenu) | |
| 100 </dd> | |
| 101 </dl><a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> | |
| 102 <h4>EricdocPlugin.activate</h4> | |
| 103 <b>activate</b>(<i></i>) | |
| 104 <p> | |
| 105 Public method to activate this plugin. | |
| 106 </p><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 tuple of None and activation status (boolean) | |
| 110 </dd> | |
| 111 </dl><a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> | |
| 112 <h4>EricdocPlugin.deactivate</h4> | |
| 113 <b>deactivate</b>(<i></i>) | |
| 114 <p> | |
| 115 Public method to deactivate this plugin. | |
| 116 </p> | |
| 117 <div align="right"><a href="#top">Up</a></div> | |
| 118 <hr /><hr /> | |
| 119 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 120 <h2>exeDisplayData</h2> | |
| 121 <b>exeDisplayData</b>(<i></i>) | |
| 122 <p> | |
| 123 Public method to support the display of some executable info. | |
| 124 </p><dl> | |
| 125 <dt>Returns:</dt> | |
| 126 <dd> | |
| 127 dictionary containing the data to query the presence of | |
| 128 the executable | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <div align="right"><a href="#top">Up</a></div> | |
| 132 <hr /> | |
| 133 </body></html> |
