src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpSearchWidget.html

branch
eric7
changeset 9686
2eee7a645cba
child 10479
856476537696
diff -r b43e04854aba -r 2eee7a645cba src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpSearchWidget.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpSearchWidget.html	Mon Jan 09 11:22:56 2023 +0100
@@ -0,0 +1,214 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QtHelpInterface.HelpSearchWidget</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.QtHelpInterface.HelpSearchWidget</h1>
+
+<p>
+Module implementing a window for showing the QtHelp index.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#HelpSearchWidget">HelpSearchWidget</a></td>
+<td>Class implementing a window for showing the QtHelp index.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a>
+<h2>HelpSearchWidget</h2>
+
+<p>
+    Class implementing a window for showing the QtHelp index.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>escapePressed()</dt>
+<dd>
+emitted when the ESC key was pressed
+</dd>
+<dt>newBackgroundTab(QUrl, str)</dt>
+<dd>
+emitted to open a search result entry
+        in a new background tab
+</dd>
+<dt>newTab(QUrl, str)</dt>
+<dd>
+emitted to open a search result entry in a
+        new tab
+</dd>
+<dt>newWindow(QUrl, str)</dt>
+<dd>
+emitted to open a search result entry in a
+        new window
+</dd>
+<dt>openUrl(QUrl, str)</dt>
+<dd>
+emitted to open a search result entry in the
+        current tab
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget
+<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="#HelpSearchWidget.__init__">HelpSearchWidget</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.__linkActivated">__linkActivated</a></td>
+<td>Private slot handling the activation of an entry.</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.__search">__search</a></td>
+<td>Private slot to perform a search of the database.</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td>
+<td>Private slot to handle the end of the search.</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td>
+<td>Private slot to handle the start of a search.</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.__showContextMenu">__showContextMenu</a></td>
+<td>Private slot to show a context menu.</td>
+</tr>
+<tr>
+<td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method handling key press events.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a>
+<h4>HelpSearchWidget (Constructor)</h4>
+<b>HelpSearchWidget</b>(<i>engine, internal=False, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>engine</i> (QHelpSearchEngine)</dt>
+<dd>
+reference to the help search engine
+</dd>
+<dt><i>internal</i> (bool)</dt>
+<dd>
+flag indicating the internal help viewer
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a>
+<h4>HelpSearchWidget.__linkActivated</h4>
+<b>__linkActivated</b>(<i>url</i>)
+
+<p>
+        Private slot handling the activation of an entry.
+</p>
+<dl>
+
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL of the activated entry
+</dd>
+</dl>
+<a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a>
+<h4>HelpSearchWidget.__search</h4>
+<b>__search</b>(<i></i>)
+
+<p>
+        Private slot to perform a search of the database.
+</p>
+<a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a>
+<h4>HelpSearchWidget.__searchingFinished</h4>
+<b>__searchingFinished</b>(<i>hits</i>)
+
+<p>
+        Private slot to handle the end of the search.
+</p>
+<dl>
+
+<dt><i>hits</i> (int)</dt>
+<dd>
+number of hits (unused)
+</dd>
+</dl>
+<a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a>
+<h4>HelpSearchWidget.__searchingStarted</h4>
+<b>__searchingStarted</b>(<i></i>)
+
+<p>
+        Private slot to handle the start of a search.
+</p>
+<a NAME="HelpSearchWidget.__showContextMenu" ID="HelpSearchWidget.__showContextMenu"></a>
+<h4>HelpSearchWidget.__showContextMenu</h4>
+<b>__showContextMenu</b>(<i>pos</i>)
+
+<p>
+        Private slot to show a context menu.
+</p>
+<dl>
+
+<dt><i>pos</i> (QPoint)</dt>
+<dd>
+position for the context menu
+</dd>
+</dl>
+<a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a>
+<h4>HelpSearchWidget.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method handling key press events.
+</p>
+<dl>
+
+<dt><i>evt</i> (QKeyEvent)</dt>
+<dd>
+reference to the key press event
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial