Updated source documentation.

Sat, 27 Oct 2018 11:54:26 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 27 Oct 2018 11:54:26 +0200
changeset 6561
ca224a174b4f
parent 6560
12bf4c8aa165
child 6562
375a82cba3b6

Updated source documentation.

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.E5Network.E5GoogleMail.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Preferences.ConfigurationPages.EmailPage.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Sat Oct 27 11:53:33 2018 +0200
+++ b/APIs/Python3/eric6.api	Sat Oct 27 11:54:26 2018 +0200
@@ -1436,6 +1436,7 @@
 eric6.E5Network.E5GoogleMail._prepareMessage_v2?5(message)
 eric6.E5Network.E5GoogleMail._prepareMessage_v3?5(message)
 eric6.E5Network.E5GoogleMail.getCredentials?4()
+eric6.E5Network.E5GoogleMail.isCredentialsFileAvailable?4()
 eric6.E5Network.E5NetworkHeaderDetailsDialog.E5NetworkHeaderDetailsDialog.setData?4(name, value)
 eric6.E5Network.E5NetworkHeaderDetailsDialog.E5NetworkHeaderDetailsDialog?1(parent=None)
 eric6.E5Network.E5NetworkIcon.E5NetworkIcon.isOnline?4()
@@ -7359,6 +7360,7 @@
 eric6.Preferences.ConfigurationPages.EditorTypingPage.EditorTypingPage.save?4()
 eric6.Preferences.ConfigurationPages.EditorTypingPage.EditorTypingPage?1()
 eric6.Preferences.ConfigurationPages.EditorTypingPage.create?4(dlg)
+eric6.Preferences.ConfigurationPages.EmailPage.EmailPage.on_googleHelpButton_clicked?4()
 eric6.Preferences.ConfigurationPages.EmailPage.EmailPage.on_mailAuthenticationGroup_toggled?4(checked)
 eric6.Preferences.ConfigurationPages.EmailPage.EmailPage.on_mailPasswordEdit_textChanged?4(txt)
 eric6.Preferences.ConfigurationPages.EmailPage.EmailPage.on_mailServerEdit_textChanged?4(txt)
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sat Oct 27 11:53:33 2018 +0200
+++ b/Documentation/Help/source.qhp	Sat Oct 27 11:54:26 2018 +0200
@@ -5753,6 +5753,7 @@
       <keyword name="EmailPage (Module)" id="EmailPage (Module)" ref="eric6.Preferences.ConfigurationPages.EmailPage.html" />
       <keyword name="EmailPage.__updatePortSpin" id="EmailPage.__updatePortSpin" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.__updatePortSpin" />
       <keyword name="EmailPage.__updateTestButton" id="EmailPage.__updateTestButton" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.__updateTestButton" />
+      <keyword name="EmailPage.on_googleHelpButton_clicked" id="EmailPage.on_googleHelpButton_clicked" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.on_googleHelpButton_clicked" />
       <keyword name="EmailPage.on_mailAuthenticationGroup_toggled" id="EmailPage.on_mailAuthenticationGroup_toggled" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.on_mailAuthenticationGroup_toggled" />
       <keyword name="EmailPage.on_mailPasswordEdit_textChanged" id="EmailPage.on_mailPasswordEdit_textChanged" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.on_mailPasswordEdit_textChanged" />
       <keyword name="EmailPage.on_mailServerEdit_textChanged" id="EmailPage.on_mailServerEdit_textChanged" ref="eric6.Preferences.ConfigurationPages.EmailPage.html#EmailPage.on_mailServerEdit_textChanged" />
@@ -19060,6 +19061,7 @@
       <keyword name="ircFilter" id="ircFilter" ref="eric6.Network.IRC.IrcUtilities.html#ircFilter" />
       <keyword name="ircTimestamp" id="ircTimestamp" ref="eric6.Network.IRC.IrcUtilities.html#ircTimestamp" />
       <keyword name="isConfigured" id="isConfigured" ref="eric6.Preferences.__init__.html#isConfigured" />
+      <keyword name="isCredentialsFileAvailable" id="isCredentialsFileAvailable" ref="eric6.E5Network.E5GoogleMail.html#isCredentialsFileAvailable" />
       <keyword name="isCupsAvailable" id="isCupsAvailable" ref="eric6.WebBrowser.Tools.FilePrinter.html#isCupsAvailable" />
       <keyword name="isDrive" id="isDrive" ref="eric6.Utilities.__init__.html#isDrive" />
       <keyword name="isExecutable" id="isExecutable" ref="eric6.Utilities.__init__.html#isExecutable" />
--- a/Documentation/Source/eric6.E5Network.E5GoogleMail.html	Sat Oct 27 11:53:33 2018 +0200
+++ b/Documentation/Source/eric6.E5Network.E5GoogleMail.html	Sat Oct 27 11:54:26 2018 +0200
@@ -48,6 +48,9 @@
 </tr><tr>
 <td><a href="#getCredentials">getCredentials</a></td>
 <td>Module function to get the Google credentials.</td>
+</tr><tr>
+<td><a href="#isCredentialsFileAvailable">isCredentialsFileAvailable</a></td>
+<td>Module function to check, if the credentials file has been installed.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -151,5 +154,23 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="isCredentialsFileAvailable" ID="isCredentialsFileAvailable"></a>
+<h2>isCredentialsFileAvailable</h2>
+<b>isCredentialsFileAvailable</b>(<i></i>)
+<p>
+    Module function to check, if the credentials file has been installed.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating, that the credentials file is there
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file
--- a/Documentation/Source/eric6.Preferences.ConfigurationPages.EmailPage.html	Sat Oct 27 11:53:33 2018 +0200
+++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.EmailPage.html	Sat Oct 27 11:54:26 2018 +0200
@@ -69,6 +69,9 @@
 <td><a href="#EmailPage.__updateTestButton">__updateTestButton</a></td>
 <td>Private slot to update the enabled state of the test button.</td>
 </tr><tr>
+<td><a href="#EmailPage.on_googleHelpButton_clicked">on_googleHelpButton_clicked</a></td>
+<td>Private slot to show some help text "how to turn on the Gmail API".</td>
+</tr><tr>
 <td><a href="#EmailPage.on_mailAuthenticationGroup_toggled">on_mailAuthenticationGroup_toggled</a></td>
 <td>Private slot to handle a change of the state of the authentication group.</td>
 </tr><tr>
@@ -117,6 +120,11 @@
 <b>__updateTestButton</b>(<i></i>)
 <p>
         Private slot to update the enabled state of the test button.
+</p><a NAME="EmailPage.on_googleHelpButton_clicked" ID="EmailPage.on_googleHelpButton_clicked"></a>
+<h4>EmailPage.on_googleHelpButton_clicked</h4>
+<b>on_googleHelpButton_clicked</b>(<i></i>)
+<p>
+        Private slot to show some help text "how to turn on the Gmail API".
 </p><a NAME="EmailPage.on_mailAuthenticationGroup_toggled" ID="EmailPage.on_mailAuthenticationGroup_toggled"></a>
 <h4>EmailPage.on_mailAuthenticationGroup_toggled</h4>
 <b>on_mailAuthenticationGroup_toggled</b>(<i>checked</i>)

eric ide

mercurial