--- a/src/eric7/Documentation/Source/eric7.QScintilla.MiniEditor.html Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.MiniEditor.html Thu Dec 21 12:03:40 2023 +0100
@@ -484,21 +484,21 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file to open (string)
+name of the file to open
</dd>
-<dt><i>filetype</i></dt>
+<dt><i>filetype</i> (str)</dt>
<dd>
-type of the source file (string)
+type of the source file
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
</dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-object name of the window (string)
+object name of the window
</dd>
</dl>
<a NAME="MiniEditor.__about" ID="MiniEditor.__about"></a>
@@ -524,14 +524,14 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
filename used to determine the associated lexer
- language (string)
+ language
</dd>
-<dt><i>pyname</i></dt>
+<dt><i>pyname</i> (str)</dt>
<dd>
-name of the pygments lexer to use (string)
+name of the pygments lexer to use
</dd>
</dl>
<a NAME="MiniEditor.__bindName" ID="MiniEditor.__bindName"></a>
@@ -543,16 +543,21 @@
</p>
<dl>
-<dt><i>line0</i></dt>
+<dt><i>line0</i> (str)</dt>
<dd>
first line of text to use in the generation process
- (string)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-dummy file name to be used for binding a lexer (string)
+dummy file name to be used for binding a lexer
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="MiniEditor.__checkActions" ID="MiniEditor.__checkActions"></a>
@@ -565,10 +570,9 @@
</p>
<dl>
-<dt><i>setSb</i></dt>
+<dt><i>setSb</i> (bool)</dt>
<dd>
flag indicating an update of the status bar is wanted
- (boolean)
</dd>
</dl>
<a NAME="MiniEditor.__checkLanguage" ID="MiniEditor.__checkLanguage"></a>
@@ -587,9 +591,9 @@
</p>
<dl>
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
<dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
</dd>
</dl>
<a NAME="MiniEditor.__convertTabs" ID="MiniEditor.__convertTabs"></a>
@@ -679,11 +683,11 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
line number of the cursor
</dd>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
position in line of the cursor
</dd>
@@ -722,6 +726,12 @@
the word at that current position
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="MiniEditor.__getEditorConfig" ID="MiniEditor.__getEditorConfig"></a>
<h4>MiniEditor.__getEditorConfig</h4>
<b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>)
@@ -837,7 +847,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the generated menu (QMenu)
+reference to the generated menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
</dd>
</dl>
<a NAME="MiniEditor.__languageMenuTriggered" ID="MiniEditor.__languageMenuTriggered"></a>
@@ -849,9 +865,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
<dd>
-reference to the action that was triggered (QAction)
+reference to the action that was triggered
</dd>
</dl>
<a NAME="MiniEditor.__loadConfiguration" ID="MiniEditor.__loadConfiguration"></a>
@@ -911,13 +927,13 @@
</p>
<dl>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
<dd>
-name of the file to load (string)
+name of the file to load
</dd>
-<dt><i>filetype</i></dt>
+<dt><i>filetype</i> (str)</dt>
<dd>
-type of the source file (string)
+type of the source file
</dd>
</dl>
<a NAME="MiniEditor.__markOccurrences" ID="MiniEditor.__markOccurrences"></a>
@@ -937,7 +953,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, if it is ok to continue (boolean)
+flag indicating, if it is ok to continue
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="MiniEditor.__modificationChanged" ID="MiniEditor.__modificationChanged"></a>
@@ -949,7 +971,7 @@
</p>
<dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
<dd>
modification status
</dd>
@@ -991,10 +1013,9 @@
</p>
<dl>
-<dt><i>printer</i></dt>
+<dt><i>printer</i> (QScintilla.Printer.Printer)</dt>
<dd>
reference to the printer object
- (QScintilla.Printer.Printer)
</dd>
</dl>
<a NAME="MiniEditor.__printPreviewFile" ID="MiniEditor.__printPreviewFile"></a>
@@ -1020,13 +1041,13 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (EricAction)</dt>
<dd>
-reference to the action object (EricAction)
+reference to the action object
</dd>
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
<dd>
-category the action belongs to (string)
+category the action belongs to
</dd>
</dl>
<a NAME="MiniEditor.__redo" ID="MiniEditor.__redo"></a>
@@ -1067,7 +1088,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="MiniEditor.__saveAs" ID="MiniEditor.__saveAs"></a>
@@ -1080,7 +1107,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="MiniEditor.__saveCopy" ID="MiniEditor.__saveCopy"></a>
@@ -1172,9 +1205,9 @@
</p>
<dl>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
<dd>
-name of the file to register (string)
+name of the file to register
</dd>
</dl>
<a NAME="MiniEditor.__setEolMode" ID="MiniEditor.__setEolMode"></a>
@@ -1200,9 +1233,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag to indicate usage of a monospace font (boolean)
+flag to indicate usage of a monospace font
</dd>
</dl>
<a NAME="MiniEditor.__setSbFile" ID="MiniEditor.__setSbFile"></a>
@@ -1262,9 +1295,9 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
<dd>
-position the menu should be shown at (QPoint)
+position the menu should be shown at
</dd>
</dl>
<a NAME="MiniEditor.__showPreferences" ID="MiniEditor.__showPreferences"></a>
@@ -1283,15 +1316,21 @@
</p>
<dl>
-<dt><i>fullFileName</i></dt>
+<dt><i>fullFileName</i> (str)</dt>
<dd>
-full pathname of the given file (string)
+full pathname of the given file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-filename part (string)
+filename part
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="MiniEditor.__styleNeeded" ID="MiniEditor.__styleNeeded"></a>
@@ -1303,9 +1342,9 @@
</p>
<dl>
-<dt><i>position</i></dt>
+<dt><i>position</i> (int)</dt>
<dd>
-end position, that needs styling (integer)
+end position, that needs styling
</dd>
</dl>
<a NAME="MiniEditor.__undo" ID="MiniEditor.__undo"></a>
@@ -1392,9 +1431,9 @@
</p>
<dl>
-<dt><i>value</i></dt>
+<dt><i>value</i> (int)</dt>
<dd>
-zoom value to be set (integer)
+zoom value to be set
</dd>
</dl>
<a NAME="MiniEditor.activeWindow" ID="MiniEditor.activeWindow"></a>
@@ -1407,7 +1446,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the text edit component (QsciScintillaCompat)
+reference to the text edit component
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QsciScintillaCompat
</dd>
</dl>
<a NAME="MiniEditor.clearSearchIndicators" ID="MiniEditor.clearSearchIndicators"></a>
@@ -1433,9 +1478,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QCloseEvent)</dt>
<dd>
-close event (QCloseEvent)
+close event
</dd>
</dl>
<a NAME="MiniEditor.getFileName" ID="MiniEditor.getFileName"></a>
@@ -1448,7 +1493,13 @@
<dl>
<dt>Return:</dt>
<dd>
-filename of the displayed file (string)
+filename of the displayed file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="MiniEditor.getLanguage" ID="MiniEditor.getLanguage"></a>
@@ -1492,7 +1543,7 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
list to return (must be 'search' or 'replace')
</dd>
@@ -1500,7 +1551,13 @@
<dl>
<dt>Return:</dt>
<dd>
-the requested history list (list of strings)
+the requested history list
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="MiniEditor.getSearchSelectionHighlight" ID="MiniEditor.getSearchSelectionHighlight"></a>
@@ -1575,19 +1632,19 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
filename used to determine the associated lexer
- language (string)
+ language
</dd>
-<dt><i>initTextDisplay</i></dt>
+<dt><i>initTextDisplay</i> (bool)</dt>
<dd>
flag indicating an initialization of the text
- display is required as well (boolean)
+ display is required as well
</dd>
-<dt><i>pyname</i></dt>
+<dt><i>pyname</i> (str)</dt>
<dd>
-name of the pygments lexer to use (string)
+name of the pygments lexer to use
</dd>
</dl>
<a NAME="MiniEditor.setSearchIndicator" ID="MiniEditor.setSearchIndicator"></a>
@@ -1599,13 +1656,13 @@
</p>
<dl>
-<dt><i>startPos</i></dt>
+<dt><i>startPos</i> (int)</dt>
<dd>
-start position of the indicator (integer)
+start position of the indicator
</dd>
-<dt><i>indicLength</i></dt>
+<dt><i>indicLength</i> (int)</dt>
<dd>
-length of the indicator (integer)
+length of the indicator
</dd>
</dl>
<a NAME="MiniEditor.setText" ID="MiniEditor.setText"></a>
@@ -1617,13 +1674,13 @@
</p>
<dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-text to be set (string)
+text to be set
</dd>
-<dt><i>filetype</i></dt>
+<dt><i>filetype</i> (str)</dt>
<dd>
-type of the source file (string)
+type of the source file
</dd>
</dl>
<a NAME="MiniEditor.setWindowModified" ID="MiniEditor.setWindowModified"></a>
@@ -1665,7 +1722,13 @@
<dl>
<dt>Return:</dt>
<dd>
-selection or current word (string)
+selection or current word
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1760,9 +1823,9 @@
</p>
<dl>
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (int)</dt>
<dd>
-the scintilla command to be performed (integer)
+the scintilla command to be performed
</dd>
</dl>
<a NAME="MiniScintilla.encloseSelectedText" ID="MiniScintilla.encloseSelectedText"></a>
