Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.ViewManager.ViewManager.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.ViewManager.ViewManager.html	Mon Feb 01 10:38:16 2021 +0100
@@ -410,6 +410,10 @@
 <td>Private method to handle the indent action.</td>
 </tr>
 <tr>
+<td><a href="#ViewManager.__editInsertDocstring">__editInsertDocstring</a></td>
+<td>Private method to insert a docstring.</td>
+</tr>
+<tr>
 <td><a href="#ViewManager.__editJoin">__editJoin</a></td>
 <td>Private method to handle the join action.</td>
 </tr>
@@ -1653,6 +1657,13 @@
 <p>
         Private method to handle the indent action.
 </p>
+<a NAME="ViewManager.__editInsertDocstring" ID="ViewManager.__editInsertDocstring"></a>
+<h4>ViewManager.__editInsertDocstring</h4>
+<b>__editInsertDocstring</b>(<i></i>)
+
+<p>
+        Private method to insert a docstring.
+</p>
 <a NAME="ViewManager.__editJoin" ID="ViewManager.__editJoin"></a>
 <h4>ViewManager.__editJoin</h4>
 <b>__editJoin</b>(<i></i>)
@@ -1958,7 +1969,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 pixmap for the eol indicator (QPixmap)
 </dd>
@@ -2059,7 +2070,7 @@
         Private method used to setup the Exporters sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
@@ -2126,7 +2137,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the support status
 </dd>
@@ -2810,7 +2821,7 @@
         the currently active editor.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the filename filter (string) or None
 </dd>
@@ -2831,7 +2842,7 @@
             3: CWD
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of directory to start (string)
 </dd>
@@ -2961,7 +2972,7 @@
         Public method to return the active (i.e. current) window.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the active editor
 </dd>
@@ -3034,7 +3045,7 @@
         Public method to signal if cascading of managed windows is available.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating cascading of windows is available
 </dd>
@@ -3054,7 +3065,7 @@
         Public method to signal if splitting of the view is available.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating splitting of the view is available.
 </dd>
@@ -3067,7 +3078,7 @@
         Public method to signal if tiling of managed windows is available.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating tiling of windows is available
 </dd>
@@ -3108,7 +3119,7 @@
         Public method to check the dirty status of all editors.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating successful reset of all dirty flags
 </dd>
@@ -3139,7 +3150,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating successful reset of the dirty flag
 </dd>
@@ -3166,7 +3177,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating successful reset of the dirty flag
 </dd>
@@ -3207,7 +3218,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the new editor object (Editor.Editor) and the new
             editor assembly object (EditorAssembly.EditorAssembly)
@@ -3228,7 +3239,7 @@
         Public method to close the current window.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -3252,7 +3263,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success
 </dd>
@@ -3288,7 +3299,7 @@
         If it cannot close all editor windows, it aborts the shutdown process.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -3312,7 +3323,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success
 </dd>
@@ -3332,7 +3343,7 @@
         focus in checks.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating focus in checks should be performed (boolean)
 </dd>
@@ -3372,7 +3383,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating if event was filtered out
 </dd>
@@ -3392,7 +3403,7 @@
         Public method to get a reference to the APIs manager.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the APIs manager object (eric6.QScintilla.APIsManager)
 </dd>
@@ -3414,7 +3425,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of all actions (list of E5Action)
 </dd>
@@ -3427,7 +3438,7 @@
         Public method to retrieve the filename of the active window.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 filename of active window (string)
 </dd>
@@ -3465,7 +3476,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of two values giving a flag indicating a new window
             creation and a reference to the editor displaying this file
@@ -3485,7 +3496,7 @@
         Public method to get the most recently opened file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 path of the most recently opened file (string)
 </dd>
@@ -3498,7 +3509,7 @@
         Public method to get a number from the active window.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 selected text of the active window (string)
 </dd>
@@ -3518,7 +3529,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 a reference to the editor displaying this file or None, if
             no editor was found
@@ -3539,7 +3550,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 count of editors displaying this file (integer)
 </dd>
@@ -3552,7 +3563,7 @@
         Public method to get references to all open editors.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of references to all open editors (list of
             QScintilla.editor)
@@ -3566,7 +3577,7 @@
         Public method to get the number of open editors.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 number of open editors (integer)
 </dd>
@@ -3586,7 +3597,7 @@
         Note: This method should be implemented by subclasses.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of list of editor references
 </dd>
@@ -3605,7 +3616,7 @@
         Public method returning a list of the filenames of all editors.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of all opened filenames (list of strings)
 </dd>
@@ -3625,7 +3636,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the requested history list (list of strings)
 </dd>
@@ -3638,7 +3649,7 @@
         Public method to get the orientation of the split view.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 orientation of the split (Qt.Horizontal or Qt.Vertical)
 </dd>
@@ -3665,7 +3676,7 @@
         Public method to create the Bookmark menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3686,7 +3697,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated toolbar
 </dd>
@@ -3699,7 +3710,7 @@
         Public method to create the Edit menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3720,7 +3731,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated toolbar
 </dd>
@@ -3733,7 +3744,7 @@
         Public method to create the File menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3754,7 +3765,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated toolbar
 </dd>
@@ -3767,7 +3778,7 @@
         Public method to create the Macro menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3780,7 +3791,7 @@
         Public method to create the Search menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3807,7 +3818,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 a tuple of the generated toolbar (search, quicksearch)
 </dd>
@@ -3828,7 +3839,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated toolbar
 </dd>
@@ -3841,7 +3852,7 @@
         Public method to create the View menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated menu
 </dd>
@@ -3862,7 +3873,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the generated toolbar
 </dd>
@@ -3903,7 +3914,7 @@
         Public method to check the connection status of the IDE.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the connection status (boolean)
 </dd>
@@ -3924,7 +3935,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the support status
 </dd>
@@ -3985,7 +3996,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the new editor object
 </dd>
@@ -4064,7 +4075,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the opened editor
 </dd>
@@ -4205,7 +4216,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating successful deletion
 </dd>
@@ -4224,7 +4235,7 @@
         Public method to get a reference to the replace widget.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the replace widget (SearchReplaceSlidingWidget)
 </dd>
@@ -4302,7 +4313,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -4322,7 +4333,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
@@ -4349,7 +4360,7 @@
         Public method to get a reference to the search widget.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the search widget (SearchReplaceSlidingWidget)
 </dd>
@@ -4642,7 +4653,7 @@
         Public method to get the number of split views.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 number of split views
 </dd>
@@ -4677,7 +4688,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 selection or current word (string)
 </dd>