Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.ViewManager.ViewManager.html	Sun Sep 29 18:22:08 2013 +0200
+++ b/Documentation/Source/eric5.ViewManager.ViewManager.html	Sun Sep 29 18:23:27 2013 +0200
@@ -313,7 +313,7 @@
 <td>Private method to handle the calltips action.</td>
 </tr><tr>
 <td><a href="#ViewManager.__editSmartIndent">__editSmartIndent</a></td>
-<td>Private method to handle the smart indent action</td>
+<td>Private method to handle the smart indent action.</td>
 </tr><tr>
 <td><a href="#ViewManager.__editSortSelectedLines">__editSortSelectedLines</a></td>
 <td>Private slot to sort the selected lines.</td>
@@ -490,10 +490,10 @@
 <td>Private slot to handle the incremental quick search.</td>
 </tr><tr>
 <td><a href="#ViewManager.__quickSearchEnter">__quickSearchEnter</a></td>
-<td>Private slot to handle the incremental quick search return pressed (jump back to text)</td>
+<td>Private slot to handle the incremental quick search return pressed (jump back to text).</td>
 </tr><tr>
 <td><a href="#ViewManager.__quickSearchEscape">__quickSearchEscape</a></td>
-<td>Private slot to handle the incremental quick search escape pressed (jump back to text)</td>
+<td>Private slot to handle the incremental quick search escape pressed (jump back to text).</td>
 </tr><tr>
 <td><a href="#ViewManager.__quickSearchExtend">__quickSearchExtend</a></td>
 <td>Private method to handle the quicksearch extend action.</td>
@@ -745,16 +745,16 @@
 <td>Public method defining the user interface actions.</td>
 </tr><tr>
 <td><a href="#ViewManager.initBookmarkMenu">initBookmarkMenu</a></td>
-<td>Public method to create the Bookmark menu</td>
+<td>Public method to create the Bookmark menu.</td>
 </tr><tr>
 <td><a href="#ViewManager.initBookmarkToolbar">initBookmarkToolbar</a></td>
-<td>Public method to create the Bookmark toolbar</td>
+<td>Public method to create the Bookmark toolbar.</td>
 </tr><tr>
 <td><a href="#ViewManager.initEditMenu">initEditMenu</a></td>
-<td>Public method to create the Edit menu</td>
+<td>Public method to create the Edit menu.</td>
 </tr><tr>
 <td><a href="#ViewManager.initEditToolbar">initEditToolbar</a></td>
-<td>Public method to create the Edit toolbar</td>
+<td>Public method to create the Edit toolbar.</td>
 </tr><tr>
 <td><a href="#ViewManager.initFileMenu">initFileMenu</a></td>
 <td>Public method to create the File menu.</td>
@@ -763,19 +763,19 @@
 <td>Public method to create the File toolbar.</td>
 </tr><tr>
 <td><a href="#ViewManager.initMacroMenu">initMacroMenu</a></td>
-<td>Public method to create the Macro menu</td>
+<td>Public method to create the Macro menu.</td>
 </tr><tr>
 <td><a href="#ViewManager.initSearchToolbars">initSearchToolbars</a></td>
-<td>Public method to create the Search toolbars</td>
+<td>Public method to create the Search toolbars.</td>
 </tr><tr>
 <td><a href="#ViewManager.initSpellingToolbar">initSpellingToolbar</a></td>
-<td>Public method to create the Spelling toolbar</td>
+<td>Public method to create the Spelling toolbar.</td>
 </tr><tr>
 <td><a href="#ViewManager.initViewMenu">initViewMenu</a></td>
-<td>Public method to create the View menu</td>
+<td>Public method to create the View menu.</td>
 </tr><tr>
 <td><a href="#ViewManager.initViewToolbar">initViewToolbar</a></td>
-<td>Public method to create the View toolbar</td>
+<td>Public method to create the View toolbar.</td>
 </tr><tr>
 <td><a href="#ViewManager.insertNumber">insertNumber</a></td>
 <td>Private slot to insert a number text into the active window.</td>
@@ -1155,7 +1155,7 @@
 <h4>ViewManager.__editSmartIndent</h4>
 <b>__editSmartIndent</b>(<i></i>)
 <p>
-        Private method to handle the smart indent action
+        Private method to handle the smart indent action.
 </p><a NAME="ViewManager.__editSortSelectedLines" ID="ViewManager.__editSortSelectedLines"></a>
 <h4>ViewManager.__editSortSelectedLines</h4>
 <b>__editSortSelectedLines</b>(<i></i>)
@@ -1166,7 +1166,12 @@
 <b>__editSpellingDictionary</b>(<i>dictionaryFile</i>)
 <p>
         Private slot to edit the given spelling dictionary.
-</p><a NAME="ViewManager.__editStreamComment" ID="ViewManager.__editStreamComment"></a>
+</p><dl>
+<dt><i>dictionaryFile</i></dt>
+<dd>
+file name of the dictionary to edit (string)
+</dd>
+</dl><a NAME="ViewManager.__editStreamComment" ID="ViewManager.__editStreamComment"></a>
 <h4>ViewManager.__editStreamComment</h4>
 <b>__editStreamComment</b>(<i></i>)
 <p>
@@ -1206,7 +1211,13 @@
 <b>__editorAutoCompletionAPIsAvailable</b>(<i>available</i>)
 <p>
         Private method to handle the availability of API autocompletion signal.
-</p><a NAME="ViewManager.__editorCommand" ID="ViewManager.__editorCommand"></a>
+</p><dl>
+<dt><i>available</i></dt>
+<dd>
+flag indicating the availability of API
+        autocompletion (boolean)
+</dd>
+</dl><a NAME="ViewManager.__editorCommand" ID="ViewManager.__editorCommand"></a>
 <h4>ViewManager.__editorCommand</h4>
 <b>__editorCommand</b>(<i>cmd</i>)
 <p>
@@ -1330,7 +1341,12 @@
 <b>__initContextMenuExporters</b>(<i></i>)
 <p>
         Private method used to setup the Exporters sub menu.
-</p><a NAME="ViewManager.__initEditActions" ID="ViewManager.__initEditActions"></a>
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the generated menu (QMenu)
+</dd>
+</dl><a NAME="ViewManager.__initEditActions" ID="ViewManager.__initEditActions"></a>
 <h4>ViewManager.__initEditActions</h4>
 <b>__initEditActions</b>(<i></i>)
 <p>
@@ -1491,13 +1507,13 @@
 <b>__quickSearchEnter</b>(<i></i>)
 <p>
         Private slot to handle the incremental quick search return pressed
-        (jump back to text)
+        (jump back to text).
 </p><a NAME="ViewManager.__quickSearchEscape" ID="ViewManager.__quickSearchEscape"></a>
 <h4>ViewManager.__quickSearchEscape</h4>
 <b>__quickSearchEscape</b>(<i></i>)
 <p>
         Private slot to handle the incremental quick search escape pressed
-        (jump back to text)
+        (jump back to text).
 </p><a NAME="ViewManager.__quickSearchExtend" ID="ViewManager.__quickSearchExtend"></a>
 <h4>ViewManager.__quickSearchExtend</h4>
 <b>__quickSearchExtend</b>(<i></i>)
@@ -1669,7 +1685,13 @@
 <b>__splitOrientation</b>(<i>checked</i>)
 <p>
         Private method to handle the split orientation action.
-</p><a NAME="ViewManager.__splitView" ID="ViewManager.__splitView"></a>
+</p><dl>
+<dt><i>checked</i></dt>
+<dd>
+flag indicating the checked state of the action
+            (boolean). True means splitting horizontally.
+</dd>
+</dl><a NAME="ViewManager.__splitView" ID="ViewManager.__splitView"></a>
 <h4>ViewManager.__splitView</h4>
 <b>__splitView</b>(<i></i>)
 <p>
@@ -1733,7 +1755,7 @@
 <h4>ViewManager._addView</h4>
 <b>_addView</b>(<i>win, fn=None, noName=""</i>)
 <p>
-        Protected method to add a view (i.e. window)
+        Protected method to add a view (i.e. window).
 </p><dl>
 <dt><i>win</i></dt>
 <dd>
@@ -1825,7 +1847,7 @@
 <h4>ViewManager._removeAllViews</h4>
 <b>_removeAllViews</b>(<i></i>)
 <p>
-        Protected method to remove all views (i.e. windows)
+        Protected method to remove all views (i.e. windows).
 </p><dl>
 <dt>Raises <b>RuntimeError</b>:</dt>
 <dd>
@@ -1835,7 +1857,7 @@
 <h4>ViewManager._removeView</h4>
 <b>_removeView</b>(<i>win</i>)
 <p>
-        Protected method to remove a view (i.e. window)
+        Protected method to remove a view (i.e. window).
 </p><dl>
 <dt><i>win</i></dt>
 <dd>
@@ -1850,7 +1872,7 @@
 <h4>ViewManager._showView</h4>
 <b>_showView</b>(<i>win, fn=None</i>)
 <p>
-        Protected method to show a view (i.e. window)
+        Protected method to show a view (i.e. window).
 </p><dl>
 <dt><i>win</i></dt>
 <dd>
@@ -1901,7 +1923,12 @@
 <b>addToExtrasMenu</b>(<i>menu</i>)
 <p>
         Public method to add some actions to the extras menu.
-</p><a NAME="ViewManager.addToRecentList" ID="ViewManager.addToRecentList"></a>
+</p><dl>
+<dt><i>menu</i></dt>
+<dd>
+reference to the menu to add actions to (QMenu)
+</dd>
+</dl><a NAME="ViewManager.addToRecentList" ID="ViewManager.addToRecentList"></a>
 <h4>ViewManager.addToRecentList</h4>
 <b>addToRecentList</b>(<i>fn</i>)
 <p>
@@ -2311,7 +2338,7 @@
 <h4>ViewManager.initBookmarkMenu</h4>
 <b>initBookmarkMenu</b>(<i></i>)
 <p>
-        Public method to create the Bookmark menu
+        Public method to create the Bookmark menu.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -2321,7 +2348,7 @@
 <h4>ViewManager.initBookmarkToolbar</h4>
 <b>initBookmarkToolbar</b>(<i>toolbarManager</i>)
 <p>
-        Public method to create the Bookmark toolbar
+        Public method to create the Bookmark toolbar.
 </p><dl>
 <dt><i>toolbarManager</i></dt>
 <dd>
@@ -2336,7 +2363,7 @@
 <h4>ViewManager.initEditMenu</h4>
 <b>initEditMenu</b>(<i></i>)
 <p>
-        Public method to create the Edit menu
+        Public method to create the Edit menu.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -2346,7 +2373,7 @@
 <h4>ViewManager.initEditToolbar</h4>
 <b>initEditToolbar</b>(<i>toolbarManager</i>)
 <p>
-        Public method to create the Edit toolbar
+        Public method to create the Edit toolbar.
 </p><dl>
 <dt><i>toolbarManager</i></dt>
 <dd>
@@ -2386,7 +2413,7 @@
 <h4>ViewManager.initMacroMenu</h4>
 <b>initMacroMenu</b>(<i></i>)
 <p>
-        Public method to create the Macro menu
+        Public method to create the Macro menu.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -2396,7 +2423,7 @@
 <h4>ViewManager.initSearchToolbars</h4>
 <b>initSearchToolbars</b>(<i>toolbarManager</i>)
 <p>
-        Public method to create the Search toolbars
+        Public method to create the Search toolbars.
 </p><dl>
 <dt><i>toolbarManager</i></dt>
 <dd>
@@ -2411,7 +2438,7 @@
 <h4>ViewManager.initSpellingToolbar</h4>
 <b>initSpellingToolbar</b>(<i>toolbarManager</i>)
 <p>
-        Public method to create the Spelling toolbar
+        Public method to create the Spelling toolbar.
 </p><dl>
 <dt><i>toolbarManager</i></dt>
 <dd>
@@ -2426,7 +2453,7 @@
 <h4>ViewManager.initViewMenu</h4>
 <b>initViewMenu</b>(<i></i>)
 <p>
-        Public method to create the View menu
+        Public method to create the View menu.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -2436,7 +2463,7 @@
 <h4>ViewManager.initViewToolbar</h4>
 <b>initViewToolbar</b>(<i>toolbarManager</i>)
 <p>
-        Public method to create the View toolbar
+        Public method to create the View toolbar.
 </p><dl>
 <dt><i>toolbarManager</i></dt>
 <dd>
@@ -2534,6 +2561,9 @@
 </dd><dt><i>selEnd</i></dt>
 <dd>
 end of an area to be selected (integer)
+</dd><dt><i>pos</i></dt>
+<dd>
+position within the line to place the cursor at (integer)
 </dd>
 </dl><a NAME="ViewManager.preferencesChanged" ID="ViewManager.preferencesChanged"></a>
 <h4>ViewManager.preferencesChanged</h4>
@@ -2892,13 +2922,13 @@
 <h4>ViewManager.textForFind</h4>
 <b>textForFind</b>(<i>getCurrentWord=True</i>)
 <p>
-        Public method to determine the selection or the current word for the next
-        find operation.
+        Public method to determine the selection or the current word for the
+        next find operation.
 </p><dl>
 <dt><i>getCurrentWord</i></dt>
 <dd>
-flag indicating to return the current word, if no selected
-            text was found (boolean)
+flag indicating to return the current word, if
+            no selected text was found (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>