--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/source/Plugin_Documentation_Sets.PluginDocumentationSets.html Sat Oct 15 15:23:08 2016 +0200 @@ -0,0 +1,124 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Documentation_Sets.PluginDocumentationSets</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Documentation_Sets.PluginDocumentationSets</h1> +<p> +Module implementing the QtHelp documentation provider plug-in. +</p> +<h3>Global Attributes</h3> +<table> +<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> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PluginDocumentationSets">PluginDocumentationSets</a></td> +<td>Class implementing the QtHelp documentation provider plug-in.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#helpFiles">helpFiles</a></td> +<td>Module function to return the documentation sets provided by this plug-in.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="PluginDocumentationSets" ID="PluginDocumentationSets"></a> +<h2>PluginDocumentationSets</h2> +<p> + Class implementing the QtHelp documentation provider plug-in. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PluginDocumentationSets.__init__">PluginDocumentationSets</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PluginDocumentationSets.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#PluginDocumentationSets.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PluginDocumentationSets.__init__" ID="PluginDocumentationSets.__init__"></a> +<h4>PluginDocumentationSets (Constructor)</h4> +<b>PluginDocumentationSets</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the user interface object (UI.UserInterface) +</dd> +</dl><a NAME="PluginDocumentationSets.activate" ID="PluginDocumentationSets.activate"></a> +<h4>PluginDocumentationSets.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="PluginDocumentationSets.deactivate" ID="PluginDocumentationSets.deactivate"></a> +<h4>PluginDocumentationSets.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plugin. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="helpFiles" ID="helpFiles"></a> +<h2>helpFiles</h2> +<b>helpFiles</b>(<i></i>) +<p> + Module function to return the documentation sets provided by this plug-in. +</p><dl> +<dt>Returns:</dt> +<dd> +dictionary with documentation set type as key and list of + documentation files as values +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +dict (key: str, value: list of str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file