Updated source docu.

Tue, 03 Feb 2015 19:37:19 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 03 Feb 2015 19:37:19 +0100
changeset 4087
414a6fefc1f0
parent 4086
822f456652c5
child 4090
a53c9908854c

Updated source docu.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.QScintilla.SearchReplaceWidget.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.UI.LogView.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.UI.UserInterface.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Tue Feb 03 19:36:29 2015 +0100
+++ b/APIs/Python3/eric6.api	Tue Feb 03 19:37:19 2015 +0100
@@ -7587,6 +7587,7 @@
 eric6.QScintilla.QsciScintillaCompat.QsciScintillaCompat.zoomTo?4(zoom)
 eric6.QScintilla.QsciScintillaCompat.QsciScintillaCompat.zoomValueChanged?7
 eric6.QScintilla.QsciScintillaCompat.QsciScintillaCompat?1(parent=None)
+eric6.QScintilla.SearchReplaceWidget.SearchReplaceSlidingWidget.changeEvent?4(evt)
 eric6.QScintilla.SearchReplaceWidget.SearchReplaceSlidingWidget.findNext?4()
 eric6.QScintilla.SearchReplaceWidget.SearchReplaceSlidingWidget.findPrev?4()
 eric6.QScintilla.SearchReplaceWidget.SearchReplaceSlidingWidget.resizeEvent?4(evt)
@@ -8193,7 +8194,7 @@
 eric6.UI.LogView.LogViewer.appendToStdout?4(txt)
 eric6.UI.LogView.LogViewer.preferencesChanged?4()
 eric6.UI.LogView.LogViewer.showFind?4(txt="")
-eric6.UI.LogView.LogViewer?1(parent=None)
+eric6.UI.LogView.LogViewer?1(ui, parent=None)
 eric6.UI.LogView.LogViewerEdit.appendToStderr?4(txt)
 eric6.UI.LogView.LogViewerEdit.appendToStdout?4(txt)
 eric6.UI.LogView.LogViewerEdit.keyPressEvent?4(evt)
@@ -8354,7 +8355,7 @@
 eric6.UI.UserInterface.UserInterface.showEvent?4(evt)
 eric6.UI.UserInterface.UserInterface.showFindFileByNameDialog?4()
 eric6.UI.UserInterface.UserInterface.showFindFilesDialog?4(txt="", searchDir="", openFiles=False)
-eric6.UI.UserInterface.UserInterface.showLogTab?4(tabname)
+eric6.UI.UserInterface.UserInterface.showLogViewer?4()
 eric6.UI.UserInterface.UserInterface.showMenu?7
 eric6.UI.UserInterface.UserInterface.showNotification?4(icon, heading, text)
 eric6.UI.UserInterface.UserInterface.showPluginsAvailable?4()
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Tue Feb 03 19:36:29 2015 +0100
+++ b/Documentation/Help/source.qhp	Tue Feb 03 19:37:19 2015 +0100
@@ -7676,6 +7676,7 @@
       <keyword name="LogViewerEdit (Constructor)" id="LogViewerEdit (Constructor)" ref="eric6.UI.LogView.html#LogViewerEdit.__init__" />
       <keyword name="LogViewerEdit.__appendText" id="LogViewerEdit.__appendText" ref="eric6.UI.LogView.html#LogViewerEdit.__appendText" />
       <keyword name="LogViewerEdit.__configure" id="LogViewerEdit.__configure" ref="eric6.UI.LogView.html#LogViewerEdit.__configure" />
+      <keyword name="LogViewerEdit.__filterMessage" id="LogViewerEdit.__filterMessage" ref="eric6.UI.LogView.html#LogViewerEdit.__filterMessage" />
       <keyword name="LogViewerEdit.__find" id="LogViewerEdit.__find" ref="eric6.UI.LogView.html#LogViewerEdit.__find" />
       <keyword name="LogViewerEdit.__handleShowContextMenu" id="LogViewerEdit.__handleShowContextMenu" ref="eric6.UI.LogView.html#LogViewerEdit.__handleShowContextMenu" />
       <keyword name="LogViewerEdit.appendToStderr" id="LogViewerEdit.appendToStderr" ref="eric6.UI.LogView.html#LogViewerEdit.appendToStderr" />
@@ -9795,6 +9796,7 @@
       <keyword name="SearchReplaceSlidingWidget.__slide" id="SearchReplaceSlidingWidget.__slide" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.__slide" />
       <keyword name="SearchReplaceSlidingWidget.__slideLeft" id="SearchReplaceSlidingWidget.__slideLeft" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.__slideLeft" />
       <keyword name="SearchReplaceSlidingWidget.__slideRight" id="SearchReplaceSlidingWidget.__slideRight" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.__slideRight" />
+      <keyword name="SearchReplaceSlidingWidget.changeEvent" id="SearchReplaceSlidingWidget.changeEvent" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.changeEvent" />
       <keyword name="SearchReplaceSlidingWidget.findNext" id="SearchReplaceSlidingWidget.findNext" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.findNext" />
       <keyword name="SearchReplaceSlidingWidget.findPrev" id="SearchReplaceSlidingWidget.findPrev" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.findPrev" />
       <keyword name="SearchReplaceSlidingWidget.resizeEvent" id="SearchReplaceSlidingWidget.resizeEvent" ref="eric6.QScintilla.SearchReplaceWidget.html#SearchReplaceSlidingWidget.resizeEvent" />
@@ -12211,7 +12213,7 @@
       <keyword name="UserInterface.showEvent" id="UserInterface.showEvent" ref="eric6.UI.UserInterface.html#UserInterface.showEvent" />
       <keyword name="UserInterface.showFindFileByNameDialog" id="UserInterface.showFindFileByNameDialog" ref="eric6.UI.UserInterface.html#UserInterface.showFindFileByNameDialog" />
       <keyword name="UserInterface.showFindFilesDialog" id="UserInterface.showFindFilesDialog" ref="eric6.UI.UserInterface.html#UserInterface.showFindFilesDialog" />
-      <keyword name="UserInterface.showLogTab" id="UserInterface.showLogTab" ref="eric6.UI.UserInterface.html#UserInterface.showLogTab" />
+      <keyword name="UserInterface.showLogViewer" id="UserInterface.showLogViewer" ref="eric6.UI.UserInterface.html#UserInterface.showLogViewer" />
       <keyword name="UserInterface.showNotification" id="UserInterface.showNotification" ref="eric6.UI.UserInterface.html#UserInterface.showNotification" />
       <keyword name="UserInterface.showPluginsAvailable" id="UserInterface.showPluginsAvailable" ref="eric6.UI.UserInterface.html#UserInterface.showPluginsAvailable" />
       <keyword name="UserInterface.showPreferences" id="UserInterface.showPreferences" ref="eric6.UI.UserInterface.html#UserInterface.showPreferences" />
--- a/Documentation/Source/eric6.QScintilla.SearchReplaceWidget.html	Tue Feb 03 19:36:29 2015 +0100
+++ b/Documentation/Source/eric6.QScintilla.SearchReplaceWidget.html	Tue Feb 03 19:37:19 2015 +0100
@@ -81,6 +81,9 @@
 <td><a href="#SearchReplaceSlidingWidget.__slideRight">__slideRight</a></td>
 <td>Private slot to move the widget to the right, i.e.</td>
 </tr><tr>
+<td><a href="#SearchReplaceSlidingWidget.changeEvent">changeEvent</a></td>
+<td>Protected method handling state changes.</td>
+</tr><tr>
 <td><a href="#SearchReplaceSlidingWidget.findNext">findNext</a></td>
 <td>Public slot to find the next occurrence of text.</td>
 </tr><tr>
@@ -147,7 +150,17 @@
 <p>
         Private slot to move the widget to the right, i.e. show contents to
         the left.
-</p><a NAME="SearchReplaceSlidingWidget.findNext" ID="SearchReplaceSlidingWidget.findNext"></a>
+</p><a NAME="SearchReplaceSlidingWidget.changeEvent" ID="SearchReplaceSlidingWidget.changeEvent"></a>
+<h4>SearchReplaceSlidingWidget.changeEvent</h4>
+<b>changeEvent</b>(<i>evt</i>)
+<p>
+        Protected method handling state changes.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+event containing the state change (QEvent)
+</dd>
+</dl><a NAME="SearchReplaceSlidingWidget.findNext" ID="SearchReplaceSlidingWidget.findNext"></a>
 <h4>SearchReplaceSlidingWidget.findNext</h4>
 <b>findNext</b>(<i></i>)
 <p>
--- a/Documentation/Source/eric6.UI.LogView.html	Tue Feb 03 19:36:29 2015 +0100
+++ b/Documentation/Source/eric6.UI.LogView.html	Tue Feb 03 19:37:19 2015 +0100
@@ -82,11 +82,14 @@
 </table>
 <a NAME="LogViewer.__init__" ID="LogViewer.__init__"></a>
 <h4>LogViewer (Constructor)</h4>
-<b>LogViewer</b>(<i>parent=None</i>)
+<b>LogViewer</b>(<i>ui, parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>parent</i></dt>
+<dt><i>ui</i></dt>
+<dd>
+reference to the main window (UserInterface)
+</dd><dt><i>parent</i></dt>
 <dd>
 reference to the parent widget (QWidget)
 </dd>
@@ -162,6 +165,9 @@
 <td><a href="#LogViewerEdit.__configure">__configure</a></td>
 <td>Private method to open the configuration dialog.</td>
 </tr><tr>
+<td><a href="#LogViewerEdit.__filterMessage">__filterMessage</a></td>
+<td>Private method to filter messages.</td>
+</tr><tr>
 <td><a href="#LogViewerEdit.__find">__find</a></td>
 <td>Private slot to show the find widget.</td>
 </tr><tr>
@@ -203,14 +209,14 @@
 </dd>
 </dl><a NAME="LogViewerEdit.__appendText" ID="LogViewerEdit.__appendText"></a>
 <h4>LogViewerEdit.__appendText</h4>
-<b>__appendText</b>(<i>txt, error=False</i>)
+<b>__appendText</b>(<i>txt, isErrorMessage=False</i>)
 <p>
         Private method to append text to the end.
 </p><dl>
 <dt><i>txt</i></dt>
 <dd>
 text to insert (string)
-</dd><dt><i>error</i></dt>
+</dd><dt><i>isErrorMessage</i></dt>
 <dd>
 flag indicating to insert error text (boolean)
 </dd>
@@ -219,7 +225,27 @@
 <b>__configure</b>(<i></i>)
 <p>
         Private method to open the configuration dialog.
-</p><a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a>
+</p><a NAME="LogViewerEdit.__filterMessage" ID="LogViewerEdit.__filterMessage"></a>
+<h4>LogViewerEdit.__filterMessage</h4>
+<b>__filterMessage</b>(<i>message, isErrorMessage=False</i>)
+<p>
+        Private method to filter messages.
+</p><dl>
+<dt><i>message</i></dt>
+<dd>
+message to be checked (string)
+</dd><dt><i>isErrorMessage</i></dt>
+<dd>
+flag indicating to check an error message
+            (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating that the message should be filtered out
+            (boolean)
+</dd>
+</dl><a NAME="LogViewerEdit.__find" ID="LogViewerEdit.__find"></a>
 <h4>LogViewerEdit.__find</h4>
 <b>__find</b>(<i></i>)
 <p>
@@ -244,6 +270,11 @@
 <dd>
 text to be appended (string)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating text was appended (boolean)
+</dd>
 </dl><a NAME="LogViewerEdit.appendToStdout" ID="LogViewerEdit.appendToStdout"></a>
 <h4>LogViewerEdit.appendToStdout</h4>
 <b>appendToStdout</b>(<i>txt</i>)
@@ -254,6 +285,11 @@
 <dd>
 text to be appended (string)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating text was appended (boolean)
+</dd>
 </dl><a NAME="LogViewerEdit.keyPressEvent" ID="LogViewerEdit.keyPressEvent"></a>
 <h4>LogViewerEdit.keyPressEvent</h4>
 <b>keyPressEvent</b>(<i>evt</i>)
--- a/Documentation/Source/eric6.UI.UserInterface.html	Tue Feb 03 19:36:29 2015 +0100
+++ b/Documentation/Source/eric6.UI.UserInterface.html	Tue Feb 03 19:37:19 2015 +0100
@@ -746,8 +746,8 @@
 <td><a href="#UserInterface.showFindFilesDialog">showFindFilesDialog</a></td>
 <td>Public slot to show the Find In Files dialog.</td>
 </tr><tr>
-<td><a href="#UserInterface.showLogTab">showLogTab</a></td>
-<td>Public method to show a particular Log-Viewer tab.</td>
+<td><a href="#UserInterface.showLogViewer">showLogViewer</a></td>
+<td>Public method to show the Log-Viewer.</td>
 </tr><tr>
 <td><a href="#UserInterface.showNotification">showNotification</a></td>
 <td>Public method to show a desktop notification.</td>
@@ -2304,17 +2304,12 @@
 <dd>
 flag indicating to operate on open files (boolean)
 </dd>
-</dl><a NAME="UserInterface.showLogTab" ID="UserInterface.showLogTab"></a>
-<h4>UserInterface.showLogTab</h4>
-<b>showLogTab</b>(<i>tabname</i>)
+</dl><a NAME="UserInterface.showLogViewer" ID="UserInterface.showLogViewer"></a>
+<h4>UserInterface.showLogViewer</h4>
+<b>showLogViewer</b>(<i></i>)
 <p>
-        Public method to show a particular Log-Viewer tab.
-</p><dl>
-<dt><i>tabname</i></dt>
-<dd>
-string naming the tab to be shown (string)
-</dd>
-</dl><a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a>
+        Public method to show the Log-Viewer.
+</p><a NAME="UserInterface.showNotification" ID="UserInterface.showNotification"></a>
 <h4>UserInterface.showNotification</h4>
 <b>showNotification</b>(<i>icon, heading, text</i>)
 <p>

eric ide

mercurial