Regenerated the source docu.

Fri, 09 Nov 2012 16:37:21 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 09 Nov 2012 16:37:21 +0100
changeset 2209
da964a932840
parent 2208
c63e2ab86189
child 2210
e02bb8cbf145

Regenerated the source docu.

APIs/Python3/eric5.api file | annotate | diff | comparison | revisions
Documentation/Source/eric5.E5Gui.E5LineEdit.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Helpviewer.HelpWebSearchWidget.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.QScintilla.SpellChecker.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric5.api	Fri Nov 09 16:36:30 2012 +0100
+++ b/APIs/Python3/eric5.api	Fri Nov 09 16:37:21 2012 +0100
@@ -1230,6 +1230,7 @@
 eric5.E5Gui.E5Led.E5Led?1(parent=None, color=None, shape=E5LedCircular, rectRatio=1)
 eric5.E5Gui.E5Led.E5LedCircular?7
 eric5.E5Gui.E5Led.E5LedRectangular?7
+eric5.E5Gui.E5LineEdit.E5ClearableLineEdit?1(parent=None, inactiveText="", side=E5LineEdit.RightSide)
 eric5.E5Gui.E5LineEdit.E5LineEdit.LeftSide?7
 eric5.E5Gui.E5LineEdit.E5LineEdit.RightSide?7
 eric5.E5Gui.E5LineEdit.E5LineEdit._updateTextMargins?5()
@@ -1244,9 +1245,9 @@
 eric5.E5Gui.E5LineEdit.E5LineEdit.textMargin?4(position)
 eric5.E5Gui.E5LineEdit.E5LineEdit.widgetSpacing?4()
 eric5.E5Gui.E5LineEdit.E5LineEdit?1(parent=None, inactiveText="")
-eric5.E5Gui.E5LineEdit.SideWidget.event?4(evt)
-eric5.E5Gui.E5LineEdit.SideWidget.sizeHintChanged?7
-eric5.E5Gui.E5LineEdit.SideWidget?1(parent=None)
+eric5.E5Gui.E5LineEdit.E5LineEditSideWidget.event?4(evt)
+eric5.E5Gui.E5LineEdit.E5LineEditSideWidget.sizeHintChanged?7
+eric5.E5Gui.E5LineEdit.E5LineEditSideWidget?1(parent=None)
 eric5.E5Gui.E5LineEditButton.E5LineEditButton.menu?4()
 eric5.E5Gui.E5LineEditButton.E5LineEditButton.paintEvent?4(evt)
 eric5.E5Gui.E5LineEditButton.E5LineEditButton.setIcon?4(icon)
@@ -2504,8 +2505,6 @@
 eric5.Helpviewer.HelpUtilities.ensureUniqueFilename?4(name, appendFormat="({0})")
 eric5.Helpviewer.HelpUtilities.filterCharsFromFilename?4(name)
 eric5.Helpviewer.HelpUtilities.getFileNameFromUrl?4(url)
-eric5.Helpviewer.HelpWebSearchWidget.HelpWebSearchEdit.mousePressEvent?4(evt)
-eric5.Helpviewer.HelpWebSearchWidget.HelpWebSearchEdit?1(mainWindow, parent=None)
 eric5.Helpviewer.HelpWebSearchWidget.HelpWebSearchWidget.clear?4()
 eric5.Helpviewer.HelpWebSearchWidget.HelpWebSearchWidget.mousePressEvent?4(evt)
 eric5.Helpviewer.HelpWebSearchWidget.HelpWebSearchWidget.openSearchManager?4()
@@ -6828,9 +6827,11 @@
 eric5.QScintilla.SpellChecker.SpellChecker.clearAll?4()
 eric5.QScintilla.SpellChecker.SpellChecker.getAvailableLanguages?4()
 eric5.QScintilla.SpellChecker.SpellChecker.getContext?4(wordStart, wordEnd)
+eric5.QScintilla.SpellChecker.SpellChecker.getDefaultPath?4(isException=False)
 eric5.QScintilla.SpellChecker.SpellChecker.getError?4()
 eric5.QScintilla.SpellChecker.SpellChecker.getLanguage?4()
 eric5.QScintilla.SpellChecker.SpellChecker.getSuggestions?4(word)
+eric5.QScintilla.SpellChecker.SpellChecker.getUserDictionaryPath?4(isException)
 eric5.QScintilla.SpellChecker.SpellChecker.ignoreAlways?4(word=None)
 eric5.QScintilla.SpellChecker.SpellChecker.initCheck?4(startPos, endPos)
 eric5.QScintilla.SpellChecker.SpellChecker.isAvailable?4()
--- a/Documentation/Source/eric5.E5Gui.E5LineEdit.html	Fri Nov 09 16:36:30 2012 +0100
+++ b/Documentation/Source/eric5.E5Gui.E5LineEdit.html	Fri Nov 09 16:37:21 2012 +0100
@@ -31,10 +31,13 @@
 <h3>Classes</h3>
 <table>
 <tr>
+<td><a href="#E5ClearableLineEdit">E5ClearableLineEdit</a></td>
+<td>Class implementing a line edit widget showing some inactive text and a clear button, if it has some contents.</td>
+</tr><tr>
 <td><a href="#E5LineEdit">E5LineEdit</a></td>
 <td>Class implementing a line edit widget showing some inactive text.</td>
 </tr><tr>
-<td><a href="#SideWidget">SideWidget</a></td>
+<td><a href="#E5LineEditSideWidget">E5LineEditSideWidget</a></td>
 <td>Class implementing the side widgets for the line edit class.</td>
 </tr>
 </table>
@@ -43,6 +46,66 @@
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
+<a NAME="E5ClearableLineEdit" ID="E5ClearableLineEdit"></a>
+<h2>E5ClearableLineEdit</h2>
+<p>
+    Class implementing a line edit widget showing some inactive text and a clear button,
+    if it has some contents.
+</p>
+<h3>Derived from</h3>
+E5LineEdit
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E5ClearableLineEdit.__init__">E5ClearableLineEdit</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E5ClearableLineEdit.__textChanged">__textChanged</a></td>
+<td>Private slot to handle changes of the text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="E5ClearableLineEdit.__init__" ID="E5ClearableLineEdit.__init__"></a>
+<h4>E5ClearableLineEdit (Constructor)</h4>
+<b>E5ClearableLineEdit</b>(<i>parent=None, inactiveText="", side=E5LineEdit.RightSide</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd><dt><i>inactiveText=</i></dt>
+<dd>
+text to be shown on inactivity (string)
+</dd><dt><i>side=</i></dt>
+<dd>
+side the clear button should be shown at (E5LineEdit.RightSide,
+            E5LineEdit.LeftSide)
+</dd>
+</dl><a NAME="E5ClearableLineEdit.__textChanged" ID="E5ClearableLineEdit.__textChanged"></a>
+<h4>E5ClearableLineEdit.__textChanged</h4>
+<b>__textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle changes of the text.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="E5LineEdit" ID="E5LineEdit"></a>
 <h2>E5LineEdit</h2>
 <p>
@@ -236,8 +299,8 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
-<a NAME="SideWidget" ID="SideWidget"></a>
-<h2>SideWidget</h2>
+<a NAME="E5LineEditSideWidget" ID="E5LineEditSideWidget"></a>
+<h2>E5LineEditSideWidget</h2>
 <p>
     Class implementing the side widgets for the line edit class.
 </p>
@@ -254,10 +317,10 @@
 <h3>Methods</h3>
 <table>
 <tr>
-<td><a href="#SideWidget.__init__">SideWidget</a></td>
+<td><a href="#E5LineEditSideWidget.__init__">E5LineEditSideWidget</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#SideWidget.event">event</a></td>
+<td><a href="#E5LineEditSideWidget.event">event</a></td>
 <td>Protected method to handle events.</td>
 </tr>
 </table>
@@ -265,9 +328,9 @@
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="SideWidget.__init__" ID="SideWidget.__init__"></a>
-<h4>SideWidget (Constructor)</h4>
-<b>SideWidget</b>(<i>parent=None</i>)
+<a NAME="E5LineEditSideWidget.__init__" ID="E5LineEditSideWidget.__init__"></a>
+<h4>E5LineEditSideWidget (Constructor)</h4>
+<b>E5LineEditSideWidget</b>(<i>parent=None</i>)
 <p>
         Constructor
 </p><dl>
@@ -275,8 +338,8 @@
 <dd>
 reference to the parent widget (QWidget)
 </dd>
-</dl><a NAME="SideWidget.event" ID="SideWidget.event"></a>
-<h4>SideWidget.event</h4>
+</dl><a NAME="E5LineEditSideWidget.event" ID="E5LineEditSideWidget.event"></a>
+<h4>E5LineEditSideWidget.event</h4>
 <b>event</b>(<i>evt</i>)
 <p>
         Protected method to handle events.
--- a/Documentation/Source/eric5.Helpviewer.HelpWebSearchWidget.html	Fri Nov 09 16:36:30 2012 +0100
+++ b/Documentation/Source/eric5.Helpviewer.HelpWebSearchWidget.html	Fri Nov 09 16:37:21 2012 +0100
@@ -31,9 +31,6 @@
 <h3>Classes</h3>
 <table>
 <tr>
-<td><a href="#HelpWebSearchEdit">HelpWebSearchEdit</a></td>
-<td>Class implementing the web search line edit.</td>
-</tr><tr>
 <td><a href="#HelpWebSearchWidget">HelpWebSearchWidget</a></td>
 <td>Class implementing a web search widget for the web browser.</td>
 </tr>
@@ -43,61 +40,6 @@
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
-<a NAME="HelpWebSearchEdit" ID="HelpWebSearchEdit"></a>
-<h2>HelpWebSearchEdit</h2>
-<p>
-    Class implementing the web search line edit.
-</p>
-<h3>Derived from</h3>
-E5LineEdit
-<h3>Class Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-<table>
-<tr>
-<td><a href="#HelpWebSearchEdit.__init__">HelpWebSearchEdit</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#HelpWebSearchEdit.mousePressEvent">mousePressEvent</a></td>
-<td>Protected method called by a mouse press event.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="HelpWebSearchEdit.__init__" ID="HelpWebSearchEdit.__init__"></a>
-<h4>HelpWebSearchEdit (Constructor)</h4>
-<b>HelpWebSearchEdit</b>(<i>mainWindow, parent=None</i>)
-<p>
-        Constructor
-</p><dl>
-<dt><i>mainWindow</i></dt>
-<dd>
-reference to the main window (HelpWindow)
-</dd><dt><i>parent</i></dt>
-<dd>
-reference to the parent widget (QWidget)
-</dd>
-</dl><a NAME="HelpWebSearchEdit.mousePressEvent" ID="HelpWebSearchEdit.mousePressEvent"></a>
-<h4>HelpWebSearchEdit.mousePressEvent</h4>
-<b>mousePressEvent</b>(<i>evt</i>)
-<p>
-        Protected method called by a mouse press event.
-</p><dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the mouse event (QMouseEvent)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
 <a NAME="HelpWebSearchWidget" ID="HelpWebSearchWidget"></a>
 <h2>HelpWebSearchWidget</h2>
 <p>
@@ -110,7 +52,7 @@
 </dd>
 </dl>
 <h3>Derived from</h3>
-QWidget
+E5ClearableLineEdit
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
@@ -164,9 +106,6 @@
 <td><a href="#HelpWebSearchWidget.__showEnginesMenu">__showEnginesMenu</a></td>
 <td>Private slot to handle the display of the engines menu.</td>
 </tr><tr>
-<td><a href="#HelpWebSearchWidget.__textChanged">__textChanged</a></td>
-<td>Private slot to handle changes of the search text.</td>
-</tr><tr>
 <td><a href="#HelpWebSearchWidget.__textEdited">__textEdited</a></td>
 <td>Private slot to handle changes of the search text.</td>
 </tr><tr>
@@ -280,17 +219,7 @@
 <b>__showEnginesMenu</b>(<i></i>)
 <p>
         Private slot to handle the display of the engines menu.
-</p><a NAME="HelpWebSearchWidget.__textChanged" ID="HelpWebSearchWidget.__textChanged"></a>
-<h4>HelpWebSearchWidget.__textChanged</h4>
-<b>__textChanged</b>(<i>txt</i>)
-<p>
-        Private slot to handle changes of the search text.
-</p><dl>
-<dt><i>txt</i></dt>
-<dd>
-search text (string)
-</dd>
-</dl><a NAME="HelpWebSearchWidget.__textEdited" ID="HelpWebSearchWidget.__textEdited"></a>
+</p><a NAME="HelpWebSearchWidget.__textEdited" ID="HelpWebSearchWidget.__textEdited"></a>
 <h4>HelpWebSearchWidget.__textEdited</h4>
 <b>__textEdited</b>(<i>txt</i>)
 <p>
--- a/Documentation/Source/eric5.QScintilla.SpellChecker.html	Fri Nov 09 16:36:30 2012 +0100
+++ b/Documentation/Source/eric5.QScintilla.SpellChecker.html	Fri Nov 09 16:37:21 2012 +0100
@@ -62,6 +62,12 @@
 <td><a href="#SpellChecker.getAvailableLanguages">getAvailableLanguages</a></td>
 <td>Public classmethod to get all available languages.</td>
 </tr><tr>
+<td><a href="#SpellChecker.getDefaultPath">getDefaultPath</a></td>
+<td>Class method to get the default path names of the user dictionaries.</td>
+</tr><tr>
+<td><a href="#SpellChecker.getUserDictionaryPath">getUserDictionaryPath</a></td>
+<td>Class method to get the path name of a user dictionary file.</td>
+</tr><tr>
 <td><a href="#SpellChecker.isAvailable">isAvailable</a></td>
 <td>Public classmethod to check, if spellchecking is available.</td>
 </tr><tr>
@@ -187,6 +193,40 @@
 <dd>
 list of available languages (list of strings)
 </dd>
+</dl><a NAME="SpellChecker.getDefaultPath" ID="SpellChecker.getDefaultPath"></a>
+<h4>SpellChecker.getDefaultPath (class method)</h4>
+<b>getDefaultPath</b>(<i>isException=False</i>)
+<p>
+        Class method to get the default path names of the user dictionaries.
+</p><dl>
+<dt><i>isException</i></dt>
+<dd>
+flag indicating to return the name of the default
+            exception dictionary (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+file name of the default user dictionary or the default user
+            exception dictionary (string)
+</dd>
+</dl><a NAME="SpellChecker.getUserDictionaryPath" ID="SpellChecker.getUserDictionaryPath"></a>
+<h4>SpellChecker.getUserDictionaryPath (class method)</h4>
+<b>getUserDictionaryPath</b>(<i>isException</i>)
+<p>
+        Class method to get the path name of a user dictionary file.
+</p><dl>
+<dt><i>isException</i></dt>
+<dd>
+flag indicating to return the name of the user
+            exception dictionary (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+file name of the user dictionary or the user exception
+            dictionary (string)
+</dd>
 </dl><a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a>
 <h4>SpellChecker.isAvailable (class method)</h4>
 <b>isAvailable</b>(<i></i>)

eric ide

mercurial