eric6/Documentation/Source/eric6.QScintilla.MiniEditor.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8166
bd5cd5858503
--- a/eric6/Documentation/Source/eric6.QScintilla.MiniEditor.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.MiniEditor.html	Mon Feb 01 10:38:16 2021 +0100
@@ -515,7 +515,7 @@
 filename used to determine the associated lexer
             language (string)
 </dd>
-<dt><i>pyname=</i></dt>
+<dt><i>pyname</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
@@ -536,7 +536,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 dummy file name to be used for binding a lexer (string)
 </dd>
@@ -696,7 +696,7 @@
         Private method to get the word at the current position.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word at that current position
 </dd>
@@ -731,7 +731,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 value of requested setting or None if nothing was found and
             nodefault parameter was True
@@ -758,7 +758,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 override value; None in case nothing is defined
 </dd>
@@ -788,7 +788,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word at that position
 </dd>
@@ -814,7 +814,7 @@
         Private method used to setup the Languages context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
@@ -863,7 +863,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 EditorConfig dictionary
 </dd>
@@ -907,7 +907,7 @@
         Private method to ask the user to save the file, if it was modified.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating, if it is ok to continue (boolean)
 </dd>
@@ -1030,7 +1030,7 @@
         Private slot to save a file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -1043,7 +1043,7 @@
         Private slot to save a file with a new name.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -1070,7 +1070,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success
 </dd>
@@ -1117,7 +1117,7 @@
         Private method to select a specific pygments lexer.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the selected pygments lexer
 </dd>
@@ -1247,7 +1247,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 filename part (string)
 </dd>
@@ -1295,7 +1295,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success
 </dd>
@@ -1363,7 +1363,7 @@
         Public method to fulfill the ViewManager interface.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the text edit component (QsciScintillaCompat)
 </dd>
@@ -1397,7 +1397,7 @@
         Public method to return the name of the file being displayed.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 filename of the displayed file (string)
 </dd>
@@ -1423,7 +1423,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 language of the editor
 </dd>
@@ -1449,7 +1449,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the requested history list (list of strings)
 </dd>
@@ -1467,7 +1467,7 @@
 <dd>
 line number to go to
 </dd>
-<dt><i>pos=</i> (int)</dt>
+<dt><i>pos</i> (int)</dt>
 <dd>
 position in line to go to
 </dd>
@@ -1491,7 +1491,7 @@
 flag indicating an initialization of the text
             display is required as well (boolean)
 </dd>
-<dt><i>pyname=</i></dt>
+<dt><i>pyname</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
@@ -1569,7 +1569,7 @@
         next find operation.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 selection or current word (string)
 </dd>
@@ -1589,7 +1589,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>None</td></tr>
+<tr><td>EncloseChars</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -1605,6 +1605,10 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#MiniScintilla.encloseSelectedText">encloseSelectedText</a></td>
+<td>Local function to enclose the current selection with some characters.</td>
+</tr>
+<tr>
 <td><a href="#MiniScintilla.focusInEvent">focusInEvent</a></td>
 <td>Protected method called when the editor receives focus.</td>
 </tr>
@@ -1617,6 +1621,10 @@
 <td>Public method to return the name of the file being displayed.</td>
 </tr>
 <tr>
+<td><a href="#MiniScintilla.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method to handle the user input a key at a time.</td>
+</tr>
+<tr>
 <td><a href="#MiniScintilla.removeTrailingWhitespace">removeTrailingWhitespace</a></td>
 <td>Public method to remove trailing whitespace.</td>
 </tr>
@@ -1636,9 +1644,25 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
+</dd>
+</dl>
+<a NAME="MiniScintilla.encloseSelectedText" ID="MiniScintilla.encloseSelectedText"></a>
+<h4>MiniScintilla.encloseSelectedText</h4>
+<b>encloseSelectedText</b>(<i></i>)
+
+<p>
+            Local function to enclose the current selection with some
+            characters.
+</p>
+<dl>
+
+<dt><i>encString</i> (str)</dt>
+<dd>
+string to use to enclose the selection
+                (one or two characters)
 </dd>
 </dl>
 <a NAME="MiniScintilla.focusInEvent" ID="MiniScintilla.focusInEvent"></a>
@@ -1656,9 +1680,9 @@
 </p>
 <dl>
 
-<dt><i>event</i></dt>
+<dt><i>event</i> (QFocusEvent)</dt>
 <dd>
-the event object (QFocusEvent)
+the event object
 </dd>
 </dl>
 <a NAME="MiniScintilla.focusOutEvent" ID="MiniScintilla.focusOutEvent"></a>
@@ -1670,9 +1694,9 @@
 </p>
 <dl>
 
-<dt><i>event</i></dt>
+<dt><i>event</i> (QFocusEvent)</dt>
 <dd>
-the event object (QFocusEvent)
+the event object
 </dd>
 </dl>
 <a NAME="MiniScintilla.getFileName" ID="MiniScintilla.getFileName"></a>
@@ -1683,9 +1707,29 @@
         Public method to return the name of the file being displayed.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
+<dd>
+filename of the displayed file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
 <dd>
-filename of the displayed file (string)
+str
+</dd>
+</dl>
+<a NAME="MiniScintilla.keyPressEvent" ID="MiniScintilla.keyPressEvent"></a>
+<h4>MiniScintilla.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>ev</i>)
+
+<p>
+        Protected method to handle the user input a key at a time.
+</p>
+<dl>
+
+<dt><i>ev</i> (QKeyEvent)</dt>
+<dd>
+key event
 </dd>
 </dl>
 <a NAME="MiniScintilla.removeTrailingWhitespace" ID="MiniScintilla.removeTrailingWhitespace"></a>

eric ide

mercurial