Documentation/Source/eric6.Helpviewer.QtHelpDocumentationDialog.html

changeset 3673
e26d7d0c1088
child 5227
5bffd1a6741f
diff -r f0cb7579c0b4 -r e26d7d0c1088 Documentation/Source/eric6.Helpviewer.QtHelpDocumentationDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Helpviewer.QtHelpDocumentationDialog.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Helpviewer.QtHelpDocumentationDialog</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>eric6.Helpviewer.QtHelpDocumentationDialog</h1>
+<p>
+Module implementing a dialog to manage the QtHelp documentation database.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td>
+<td>Class implementing a dialog to manage the QtHelp documentation database.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a>
+<h2>QtHelpDocumentationDialog</h2>
+<p>
+    Class implementing a dialog to manage the QtHelp documentation database.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_QtHelpDocumentationDialog
+<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="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td>
+<td>Public method to get the list of tabs to close.</td>
+</tr><tr>
+<td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td>
+<td>Public slot to test the dialog for changes.</td>
+</tr><tr>
+<td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td>
+<td>Private slot to add documents to the help database.</td>
+</tr><tr>
+<td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td>
+<td>Private slot handling a change of the documents selection.</td>
+</tr><tr>
+<td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
+<td>Private slot to remove a document from the help database.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a>
+<h4>QtHelpDocumentationDialog (Constructor)</h4>
+<b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>engine</i></dt>
+<dd>
+reference to the help engine (QHelpEngine)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a>
+<h4>QtHelpDocumentationDialog.getTabsToClose</h4>
+<b>getTabsToClose</b>(<i></i>)
+<p>
+        Public method to get the list of tabs to close.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of tab ids to be closed (list of integers)
+</dd>
+</dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a>
+<h4>QtHelpDocumentationDialog.hasChanges</h4>
+<b>hasChanges</b>(<i></i>)
+<p>
+        Public slot to test the dialog for changes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating presence of changes
+</dd>
+</dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a>
+<h4>QtHelpDocumentationDialog.on_addButton_clicked</h4>
+<b>on_addButton_clicked</b>(<i></i>)
+<p>
+        Private slot to add documents to the help database.
+</p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a>
+<h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4>
+<b>on_documentsList_itemSelectionChanged</b>(<i></i>)
+<p>
+        Private slot handling a change of the documents selection.
+</p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a>
+<h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4>
+<b>on_removeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to remove a document from the help database.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial