Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.EmailDialog.html
Documentation/Source/eric5.UI.EmailDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.UI.EmailDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.UI.EmailDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to send bug reports. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EmailDialog">EmailDialog</a></td> | |
| 23 <td>Class implementing a dialog to send bug reports.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="EmailDialog" ID="EmailDialog"></a> | |
| 32 <h2>EmailDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to send bug reports. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_EmailDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#EmailDialog.__init__">EmailDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#EmailDialog.__createMultipartMail">__createMultipartMail</a></td> | |
| 49 <td>Private method to create a multipart mail message.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#EmailDialog.__createSimpleMail">__createSimpleMail</a></td> | |
| 52 <td>Private method to create a simple mail message.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#EmailDialog.__sendmail">__sendmail</a></td> | |
| 55 <td>Private method to actually send the message.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#EmailDialog.attachFile">attachFile</a></td> | |
| 58 <td>Public method to add an attachment.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#EmailDialog.keyPressEvent">keyPressEvent</a></td> | |
| 61 <td>Re-implemented to handle the user pressing the escape key.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#EmailDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 64 <td>Private slot to handle the Add...</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EmailDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 67 <td>Private slot called by a button of the button box clicked.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EmailDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> | |
| 70 <td>Private slot to handle the rejected signal of the button box.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EmailDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 73 <td>Private slot to handle the Delete button.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EmailDialog.on_message_textChanged">on_message_textChanged</a></td> | |
| 76 <td>Private slot to handle the textChanged signal of the message edit.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#EmailDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 79 <td>Private slot to send the email message.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#EmailDialog.on_subject_textChanged">on_subject_textChanged</a></td> | |
| 82 <td>Private slot to handle the textChanged signal of the subject edit.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <a NAME="EmailDialog.__init__" ID="EmailDialog.__init__"></a> | |
| 86 <h4>EmailDialog (Constructor)</h4> | |
| 87 <b>EmailDialog</b>(<i>mode = "bug", parent = None</i>) | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p><dl> | |
| 91 <dt><i>mode</i></dt> | |
| 92 <dd> | |
| 93 mode of this dialog (string, "bug" or "feature") | |
| 94 </dd><dt><i>parent</i></dt> | |
| 95 <dd> | |
| 96 parent widget of this dialog (QWidget) | |
| 97 </dd> | |
| 98 </dl><a NAME="EmailDialog.__createMultipartMail" ID="EmailDialog.__createMultipartMail"></a> | |
| 99 <h4>EmailDialog.__createMultipartMail</h4> | |
| 100 <b>__createMultipartMail</b>(<i></i>) | |
| 101 <p> | |
| 102 Private method to create a multipart mail message. | |
| 103 </p><dl> | |
| 104 <dt>Returns:</dt> | |
| 105 <dd> | |
| 106 string containing the mail message | |
| 107 </dd> | |
| 108 </dl><a NAME="EmailDialog.__createSimpleMail" ID="EmailDialog.__createSimpleMail"></a> | |
| 109 <h4>EmailDialog.__createSimpleMail</h4> | |
| 110 <b>__createSimpleMail</b>(<i></i>) | |
| 111 <p> | |
| 112 Private method to create a simple mail message. | |
| 113 </p><dl> | |
| 114 <dt>Returns:</dt> | |
| 115 <dd> | |
| 116 string containing the mail message | |
| 117 </dd> | |
| 118 </dl><a NAME="EmailDialog.__sendmail" ID="EmailDialog.__sendmail"></a> | |
| 119 <h4>EmailDialog.__sendmail</h4> | |
| 120 <b>__sendmail</b>(<i>msg</i>) | |
| 121 <p> | |
| 122 Private method to actually send the message. | |
| 123 </p><dl> | |
| 124 <dt><i>msg</i></dt> | |
| 125 <dd> | |
| 126 the message to be sent (string) | |
| 127 </dd> | |
| 128 </dl><dl> | |
| 129 <dt>Returns:</dt> | |
| 130 <dd> | |
| 131 flag indicating success (boolean) | |
| 132 </dd> | |
| 133 </dl><a NAME="EmailDialog.attachFile" ID="EmailDialog.attachFile"></a> | |
| 134 <h4>EmailDialog.attachFile</h4> | |
| 135 <b>attachFile</b>(<i>fname, deleteFile</i>) | |
| 136 <p> | |
| 137 Public method to add an attachment. | |
| 138 </p><dl> | |
| 139 <dt><i>fname</i></dt> | |
| 140 <dd> | |
| 141 name of the file to be attached (string) | |
| 142 </dd><dt><i>deleteFile</i></dt> | |
| 143 <dd> | |
| 144 flag indicating to delete the file after it has | |
| 145 been sent (boolean) | |
| 146 </dd> | |
| 147 </dl><a NAME="EmailDialog.keyPressEvent" ID="EmailDialog.keyPressEvent"></a> | |
| 148 <h4>EmailDialog.keyPressEvent</h4> | |
| 149 <b>keyPressEvent</b>(<i>ev</i>) | |
| 150 <p> | |
| 151 Re-implemented to handle the user pressing the escape key. | |
| 152 </p><dl> | |
| 153 <dt><i>ev</i></dt> | |
| 154 <dd> | |
| 155 key event (QKeyEvent) | |
| 156 </dd> | |
| 157 </dl><a NAME="EmailDialog.on_addButton_clicked" ID="EmailDialog.on_addButton_clicked"></a> | |
| 158 <h4>EmailDialog.on_addButton_clicked</h4> | |
| 159 <b>on_addButton_clicked</b>(<i></i>) | |
| 160 <p> | |
| 161 Private slot to handle the Add... button. | |
| 162 </p><a NAME="EmailDialog.on_buttonBox_clicked" ID="EmailDialog.on_buttonBox_clicked"></a> | |
| 163 <h4>EmailDialog.on_buttonBox_clicked</h4> | |
| 164 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 165 <p> | |
| 166 Private slot called by a button of the button box clicked. | |
| 167 </p><dl> | |
| 168 <dt><i>button</i></dt> | |
| 169 <dd> | |
| 170 button that was clicked (QAbstractButton) | |
| 171 </dd> | |
| 172 </dl><a NAME="EmailDialog.on_buttonBox_rejected" ID="EmailDialog.on_buttonBox_rejected"></a> | |
| 173 <h4>EmailDialog.on_buttonBox_rejected</h4> | |
| 174 <b>on_buttonBox_rejected</b>(<i></i>) | |
| 175 <p> | |
| 176 Private slot to handle the rejected signal of the button box. | |
| 177 </p><a NAME="EmailDialog.on_deleteButton_clicked" ID="EmailDialog.on_deleteButton_clicked"></a> | |
| 178 <h4>EmailDialog.on_deleteButton_clicked</h4> | |
| 179 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 180 <p> | |
| 181 Private slot to handle the Delete button. | |
| 182 </p><a NAME="EmailDialog.on_message_textChanged" ID="EmailDialog.on_message_textChanged"></a> | |
| 183 <h4>EmailDialog.on_message_textChanged</h4> | |
| 184 <b>on_message_textChanged</b>(<i></i>) | |
| 185 <p> | |
| 186 Private slot to handle the textChanged signal of the message edit. | |
| 187 </p><dl> | |
| 188 <dt><i>txt</i></dt> | |
| 189 <dd> | |
| 190 changed text (string) | |
| 191 </dd> | |
| 192 </dl><a NAME="EmailDialog.on_sendButton_clicked" ID="EmailDialog.on_sendButton_clicked"></a> | |
| 193 <h4>EmailDialog.on_sendButton_clicked</h4> | |
| 194 <b>on_sendButton_clicked</b>(<i></i>) | |
| 195 <p> | |
| 196 Private slot to send the email message. | |
| 197 </p><a NAME="EmailDialog.on_subject_textChanged" ID="EmailDialog.on_subject_textChanged"></a> | |
| 198 <h4>EmailDialog.on_subject_textChanged</h4> | |
| 199 <b>on_subject_textChanged</b>(<i>txt</i>) | |
| 200 <p> | |
| 201 Private slot to handle the textChanged signal of the subject edit. | |
| 202 </p><dl> | |
| 203 <dt><i>txt</i></dt> | |
| 204 <dd> | |
| 205 changed text (string) | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /> | |
| 210 </body></html> |
