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