Mercurial Repositories > Documentation Sets / file comparison
comparison: Documentation/source/Plugin_Documentation_Sets.PluginDocumentationSets.html
Documentation/source/Plugin_Documentation_Sets.PluginDocumentationSets.html
- changeset 1
- a1e4eb168c29
- child 53
- 9a762a7d6f42
equal
deleted
inserted
replaced
| 0:2866d286183f | 1:a1e4eb168c29 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Documentation_Sets.PluginDocumentationSets</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><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Documentation_Sets.PluginDocumentationSets</h1> | |
| 23 <p> | |
| 24 Module implementing the QtHelp documentation provider plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <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>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#PluginDocumentationSets">PluginDocumentationSets</a></td> | |
| 34 <td>Class implementing the QtHelp documentation provider plug-in.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#helpFiles">helpFiles</a></td> | |
| 41 <td>Module function to return the documentation sets provided by this plug-in.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="PluginDocumentationSets" ID="PluginDocumentationSets"></a> | |
| 46 <h2>PluginDocumentationSets</h2> | |
| 47 <p> | |
| 48 Class implementing the QtHelp documentation provider plug-in. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QObject | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#PluginDocumentationSets.__init__">PluginDocumentationSets</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PluginDocumentationSets.activate">activate</a></td> | |
| 67 <td>Public method to activate this plugin.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PluginDocumentationSets.deactivate">deactivate</a></td> | |
| 70 <td>Public method to deactivate this plugin.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <h3>Static Methods</h3> | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <a NAME="PluginDocumentationSets.__init__" ID="PluginDocumentationSets.__init__"></a> | |
| 78 <h4>PluginDocumentationSets (Constructor)</h4> | |
| 79 <b>PluginDocumentationSets</b>(<i>ui</i>) | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p><dl> | |
| 83 <dt><i>ui</i></dt> | |
| 84 <dd> | |
| 85 reference to the user interface object (UI.UserInterface) | |
| 86 </dd> | |
| 87 </dl><a NAME="PluginDocumentationSets.activate" ID="PluginDocumentationSets.activate"></a> | |
| 88 <h4>PluginDocumentationSets.activate</h4> | |
| 89 <b>activate</b>(<i></i>) | |
| 90 <p> | |
| 91 Public method to activate this plugin. | |
| 92 </p><dl> | |
| 93 <dt>Returns:</dt> | |
| 94 <dd> | |
| 95 tuple of None and activation status (boolean) | |
| 96 </dd> | |
| 97 </dl><a NAME="PluginDocumentationSets.deactivate" ID="PluginDocumentationSets.deactivate"></a> | |
| 98 <h4>PluginDocumentationSets.deactivate</h4> | |
| 99 <b>deactivate</b>(<i></i>) | |
| 100 <p> | |
| 101 Public method to deactivate this plugin. | |
| 102 </p> | |
| 103 <div align="right"><a href="#top">Up</a></div> | |
| 104 <hr /><hr /> | |
| 105 <a NAME="helpFiles" ID="helpFiles"></a> | |
| 106 <h2>helpFiles</h2> | |
| 107 <b>helpFiles</b>(<i></i>) | |
| 108 <p> | |
| 109 Module function to return the documentation sets provided by this plug-in. | |
| 110 </p><dl> | |
| 111 <dt>Returns:</dt> | |
| 112 <dd> | |
| 113 dictionary with documentation set type as key and list of | |
| 114 documentation files as values | |
| 115 </dd> | |
| 116 </dl><dl> | |
| 117 <dt>Return Type:</dt> | |
| 118 <dd> | |
| 119 dict (key: str, value: list of str) | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <div align="right"><a href="#top">Up</a></div> | |
| 123 <hr /> | |
| 124 </body></html> |
