--- a/Documentation/Source/eric5.UI.EmailDialog.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.UI.EmailDialog.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.UI.EmailDialog</h1> <p> -Module implementing a dialog to send bug reports. +Module implementing a dialog to send bug reports. </p> <h3>Global Attributes</h3> <table> @@ -32,21 +32,21 @@ <table> <tr> <td><a href="#EmailDialog">EmailDialog</a></td> -<td>Class implementing a dialog to send bug reports.</td> +<td>Class implementing a dialog to send bug reports.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#_encode_base64">_encode_base64</a></td> -<td>Function to encode the message's payload in Base64.</td> +<td>Function to encode the message's payload in Base64.</td> </tr> </table> <hr /><hr /> <a NAME="EmailDialog" ID="EmailDialog"></a> <h2>EmailDialog</h2> <p> - Class implementing a dialog to send bug reports. + Class implementing a dialog to send bug reports. </p> <h3>Derived from</h3> QDialog, Ui_EmailDialog @@ -58,166 +58,166 @@ <table> <tr> <td><a href="#EmailDialog.__init__">EmailDialog</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#EmailDialog.__createMultipartMail">__createMultipartMail</a></td> -<td>Private method to create a multipart mail message.</td> +<td>Private method to create a multipart mail message.</td> </tr><tr> <td><a href="#EmailDialog.__createSimpleMail">__createSimpleMail</a></td> -<td>Private method to create a simple mail message.</td> +<td>Private method to create a simple mail message.</td> </tr><tr> <td><a href="#EmailDialog.__sendmail">__sendmail</a></td> -<td>Private method to actually send the message.</td> +<td>Private method to actually send the message.</td> </tr><tr> <td><a href="#EmailDialog.attachFile">attachFile</a></td> -<td>Public method to add an attachment.</td> +<td>Public method to add an attachment.</td> </tr><tr> <td><a href="#EmailDialog.keyPressEvent">keyPressEvent</a></td> -<td>Re-implemented to handle the user pressing the escape key.</td> +<td>Re-implemented to handle the user pressing the escape key.</td> </tr><tr> <td><a href="#EmailDialog.on_addButton_clicked">on_addButton_clicked</a></td> -<td>Private slot to handle the Add...</td> +<td>Private slot to handle the Add...</td> </tr><tr> <td><a href="#EmailDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> -<td>Private slot called by a button of the button box clicked.</td> +<td>Private slot called by a button of the button box clicked.</td> </tr><tr> <td><a href="#EmailDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> -<td>Private slot to handle the rejected signal of the button box.</td> +<td>Private slot to handle the rejected signal of the button box.</td> </tr><tr> <td><a href="#EmailDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> -<td>Private slot to handle the Delete button.</td> +<td>Private slot to handle the Delete button.</td> </tr><tr> <td><a href="#EmailDialog.on_message_textChanged">on_message_textChanged</a></td> -<td>Private slot to handle the textChanged signal of the message edit.</td> +<td>Private slot to handle the textChanged signal of the message edit.</td> </tr><tr> <td><a href="#EmailDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> -<td>Private slot to send the email message.</td> +<td>Private slot to send the email message.</td> </tr><tr> <td><a href="#EmailDialog.on_subject_textChanged">on_subject_textChanged</a></td> -<td>Private slot to handle the textChanged signal of the subject edit.</td> +<td>Private slot to handle the textChanged signal of the subject edit.</td> </tr> </table> <a NAME="EmailDialog.__init__" ID="EmailDialog.__init__"></a> <h4>EmailDialog (Constructor)</h4> <b>EmailDialog</b>(<i>mode = "bug", parent = None</i>) <p> - Constructor + Constructor </p><dl> <dt><i>mode</i></dt> <dd> -mode of this dialog (string, "bug" or "feature") +mode of this dialog (string, "bug" or "feature") </dd><dt><i>parent</i></dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog (QWidget) </dd> </dl><a NAME="EmailDialog.__createMultipartMail" ID="EmailDialog.__createMultipartMail"></a> <h4>EmailDialog.__createMultipartMail</h4> <b>__createMultipartMail</b>(<i></i>) <p> - Private method to create a multipart mail message. + Private method to create a multipart mail message. </p><dl> <dt>Returns:</dt> <dd> -string containing the mail message +string containing the mail message </dd> </dl><a NAME="EmailDialog.__createSimpleMail" ID="EmailDialog.__createSimpleMail"></a> <h4>EmailDialog.__createSimpleMail</h4> <b>__createSimpleMail</b>(<i></i>) <p> - Private method to create a simple mail message. + Private method to create a simple mail message. </p><dl> <dt>Returns:</dt> <dd> -string containing the mail message +string containing the mail message </dd> </dl><a NAME="EmailDialog.__sendmail" ID="EmailDialog.__sendmail"></a> <h4>EmailDialog.__sendmail</h4> <b>__sendmail</b>(<i>msg</i>) <p> - Private method to actually send the message. + Private method to actually send the message. </p><dl> <dt><i>msg</i></dt> <dd> -the message to be sent (string) +the message to be sent (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -flag indicating success (boolean) +flag indicating success (boolean) </dd> </dl><a NAME="EmailDialog.attachFile" ID="EmailDialog.attachFile"></a> <h4>EmailDialog.attachFile</h4> <b>attachFile</b>(<i>fname, deleteFile</i>) <p> - Public method to add an attachment. + Public method to add an attachment. </p><dl> <dt><i>fname</i></dt> <dd> -name of the file to be attached (string) +name of the file to be attached (string) </dd><dt><i>deleteFile</i></dt> <dd> -flag indicating to delete the file after it has - been sent (boolean) +flag indicating to delete the file after it has + been sent (boolean) </dd> </dl><a NAME="EmailDialog.keyPressEvent" ID="EmailDialog.keyPressEvent"></a> <h4>EmailDialog.keyPressEvent</h4> <b>keyPressEvent</b>(<i>ev</i>) <p> - Re-implemented to handle the user pressing the escape key. + Re-implemented to handle the user pressing the escape key. </p><dl> <dt><i>ev</i></dt> <dd> -key event (QKeyEvent) +key event (QKeyEvent) </dd> </dl><a NAME="EmailDialog.on_addButton_clicked" ID="EmailDialog.on_addButton_clicked"></a> <h4>EmailDialog.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) <p> - Private slot to handle the Add... button. + Private slot to handle the Add... button. </p><a NAME="EmailDialog.on_buttonBox_clicked" ID="EmailDialog.on_buttonBox_clicked"></a> <h4>EmailDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> - Private slot called by a button of the button box clicked. + Private slot called by a button of the button box clicked. </p><dl> <dt><i>button</i></dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked (QAbstractButton) </dd> </dl><a NAME="EmailDialog.on_buttonBox_rejected" ID="EmailDialog.on_buttonBox_rejected"></a> <h4>EmailDialog.on_buttonBox_rejected</h4> <b>on_buttonBox_rejected</b>(<i></i>) <p> - Private slot to handle the rejected signal of the button box. + Private slot to handle the rejected signal of the button box. </p><a NAME="EmailDialog.on_deleteButton_clicked" ID="EmailDialog.on_deleteButton_clicked"></a> <h4>EmailDialog.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) <p> - Private slot to handle the Delete button. + Private slot to handle the Delete button. </p><a NAME="EmailDialog.on_message_textChanged" ID="EmailDialog.on_message_textChanged"></a> <h4>EmailDialog.on_message_textChanged</h4> <b>on_message_textChanged</b>(<i></i>) <p> - Private slot to handle the textChanged signal of the message edit. + Private slot to handle the textChanged signal of the message edit. </p><dl> <dt><i>txt</i></dt> <dd> -changed text (string) +changed text (string) </dd> </dl><a NAME="EmailDialog.on_sendButton_clicked" ID="EmailDialog.on_sendButton_clicked"></a> <h4>EmailDialog.on_sendButton_clicked</h4> <b>on_sendButton_clicked</b>(<i></i>) <p> - Private slot to send the email message. + Private slot to send the email message. </p><a NAME="EmailDialog.on_subject_textChanged" ID="EmailDialog.on_subject_textChanged"></a> <h4>EmailDialog.on_subject_textChanged</h4> <b>on_subject_textChanged</b>(<i>txt</i>) <p> - Private slot to handle the textChanged signal of the subject edit. + Private slot to handle the textChanged signal of the subject edit. </p><dl> <dt><i>txt</i></dt> <dd> -changed text (string) +changed text (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -226,13 +226,13 @@ <h2>_encode_base64</h2> <b>_encode_base64</b>(<i>msg</i>) <p> - Function to encode the message's payload in Base64. + Function to encode the message's payload in Base64. </p><p> - Note: It adds an appropriate Content-Transfer-Encoding header. + Note: It adds an appropriate Content-Transfer-Encoding header. </p><dl> <dt><i>msg</i></dt> <dd> -reference to the message object (email.Message) +reference to the message object (email.Message) </dd> </dl> <div align="right"><a href="#top">Up</a></div>