eric7/Documentation/Source/eric7.QScintilla.Editor.html

branch
eric7
changeset 8513
a7464bea3d0a
parent 8490
22230c2591c3
child 8523
14e1ee6e720b
diff -r cc82680dba7b -r a7464bea3d0a eric7/Documentation/Source/eric7.QScintilla.Editor.html
--- a/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Tue Aug 17 12:25:54 2021 +0200
+++ b/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Tue Aug 17 12:26:40 2021 +0200
@@ -273,6 +273,10 @@
 <td>Private method to show call tips provided by a plugin.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__cancelMouseHoverHelp">__cancelMouseHoverHelp</a></td>
+<td>Private slot cancelling the display of mouse hover help.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__changeBreakPoints">__changeBreakPoints</a></td>
 <td>Private slot to set changed breakpoints.</td>
 </tr>
@@ -853,6 +857,10 @@
 <td>Private method to handle the Imports Diagram context menu action.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__showMouseHoverHelp">__showMouseHoverHelp</a></td>
+<td>Private slot showing code information about the symbol under the cursor.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__showPackageDiagram">__showPackageDiagram</a></td>
 <td>Private method to handle the Package Diagram context menu action.</td>
 </tr>
@@ -1545,6 +1553,10 @@
 <td>Public method to refresh the code coverage annotations.</td>
 </tr>
 <tr>
+<td><a href="#Editor.registerMouseHoverHelpFunction">registerMouseHoverHelpFunction</a></td>
+<td>Public method to register a mouse hover help function.</td>
+</tr>
+<tr>
 <td><a href="#Editor.removeCallTipHook">removeCallTipHook</a></td>
 <td>Public method to remove a previously registered calltip provider.</td>
 </tr>
@@ -1657,6 +1669,10 @@
 <td>Public slot to check the autosave flags.</td>
 </tr>
 <tr>
+<td><a href="#Editor.showMouseHoverHelpData">showMouseHoverHelpData</a></td>
+<td>Public method to show the mouse hover help data.</td>
+</tr>
+<tr>
 <td><a href="#Editor.smartIndentLineOrSelection">smartIndentLineOrSelection</a></td>
 <td>Public slot to indent current line smartly.</td>
 </tr>
@@ -1721,6 +1737,10 @@
 <td>Public slot to unindent the current line or current selection.</td>
 </tr>
 <tr>
+<td><a href="#Editor.unregisterMouseHoverHelpFunction">unregisterMouseHoverHelpFunction</a></td>
+<td>Public method to unregister a mouse hover help function.</td>
+</tr>
+<tr>
 <td><a href="#Editor.updateMarkerMap">updateMarkerMap</a></td>
 <td>Public method to initiate an update of the marker map.</td>
 </tr>
@@ -2055,6 +2075,13 @@
 <p>
         Private method to show call tips provided by a plugin.
 </p>
+<a NAME="Editor.__cancelMouseHoverHelp" ID="Editor.__cancelMouseHoverHelp"></a>
+<h4>Editor.__cancelMouseHoverHelp</h4>
+<b>__cancelMouseHoverHelp</b>(<i></i>)
+
+<p>
+        Private slot cancelling the display of mouse hover help. 
+</p>
 <a NAME="Editor.__changeBreakPoints" ID="Editor.__changeBreakPoints"></a>
 <h4>Editor.__changeBreakPoints</h4>
 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>)
@@ -3801,6 +3828,29 @@
 <p>
         Private method to handle the Imports Diagram context menu action.
 </p>
+<a NAME="Editor.__showMouseHoverHelp" ID="Editor.__showMouseHoverHelp"></a>
+<h4>Editor.__showMouseHoverHelp</h4>
+<b>__showMouseHoverHelp</b>(<i>pos, x, y</i>)
+
+<p>
+        Private slot showing code information about the symbol under the
+        cursor.
+</p>
+<dl>
+
+<dt><i>pos</i> (int)</dt>
+<dd>
+mouse position into the document
+</dd>
+<dt><i>x</i> (int)</dt>
+<dd>
+x-value of mouse screen position
+</dd>
+<dt><i>y</i> (int)</dt>
+<dd>
+y-value of mouse screen position
+</dd>
+</dl>
 <a NAME="Editor.__showPackageDiagram" ID="Editor.__showPackageDiagram"></a>
 <h4>Editor.__showPackageDiagram</h4>
 <b>__showPackageDiagram</b>(<i></i>)
@@ -6127,6 +6177,25 @@
 <p>
         Public method to refresh the code coverage annotations.
 </p>
+<a NAME="Editor.registerMouseHoverHelpFunction" ID="Editor.registerMouseHoverHelpFunction"></a>
+<h4>Editor.registerMouseHoverHelpFunction</h4>
+<b>registerMouseHoverHelpFunction</b>(<i>func</i>)
+
+<p>
+        Public method to register a mouse hover help function.
+</p>
+<p>
+        Note: Only one plugin should provide this function. Otherwise
+        the last one wins.
+</p>
+<dl>
+
+<dt><i>func</i> (func)</dt>
+<dd>
+function accepting a reference to the calling editor and
+            the line and column position (zero based each)
+</dd>
+</dl>
 <a NAME="Editor.removeCallTipHook" ID="Editor.removeCallTipHook"></a>
 <h4>Editor.removeCallTipHook</h4>
 <b>removeCallTipHook</b>(<i>key</i>)
@@ -6558,6 +6627,28 @@
 flag indicating this editor should be saved (boolean)
 </dd>
 </dl>
+<a NAME="Editor.showMouseHoverHelpData" ID="Editor.showMouseHoverHelpData"></a>
+<h4>Editor.showMouseHoverHelpData</h4>
+<b>showMouseHoverHelpData</b>(<i>line, index, data</i>)
+
+<p>
+        Public method to show the mouse hover help data.
+</p>
+<dl>
+
+<dt><i>line</i> (int)</dt>
+<dd>
+line of mouse cursor position
+</dd>
+<dt><i>index</i> (TYPE)</dt>
+<dd>
+column of mouse cursor position
+</dd>
+<dt><i>data</i> (str)</dt>
+<dd>
+information text to be shown
+</dd>
+</dl>
 <a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a>
 <h4>Editor.smartIndentLineOrSelection</h4>
 <b>smartIndentLineOrSelection</b>(<i></i>)
@@ -6734,6 +6825,21 @@
 <p>
         Public slot to unindent the current line or current selection.
 </p>
+<a NAME="Editor.unregisterMouseHoverHelpFunction" ID="Editor.unregisterMouseHoverHelpFunction"></a>
+<h4>Editor.unregisterMouseHoverHelpFunction</h4>
+<b>unregisterMouseHoverHelpFunction</b>(<i>func</i>)
+
+<p>
+        Public method to unregister a mouse hover help function.
+</p>
+<dl>
+
+<dt><i>func</i> (func)</dt>
+<dd>
+function accepting a reference to the calling editor and
+            the line and column position (zero based each)
+</dd>
+</dl>
 <a NAME="Editor.updateMarkerMap" ID="Editor.updateMarkerMap"></a>
 <h4>Editor.updateMarkerMap</h4>
 <b>updateMarkerMap</b>(<i></i>)

eric ide

mercurial