Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.ImageMarkupDialog.html
src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.ImageMarkupDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.MarkupProviders.ImageMarkupDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.MarkupProviders.ImageMarkupDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter data for an image markup. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ImageMarkupDialog">ImageMarkupDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter data for an image markup.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="ImageMarkupDialog" ID="ImageMarkupDialog"></a> | |
| 36 <h2>ImageMarkupDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter data for an image markup. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_ImageMarkupDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>HtmlMode</td></tr><tr><td>MarkDownMode</td></tr><tr><td>RestMode</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#ImageMarkupDialog.__init__">ImageMarkupDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ImageMarkupDialog.__updateOkButton">__updateOkButton</a></td> | |
| 63 <td>Private slot to set the state of the OK button.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ImageMarkupDialog.getData">getData</a></td> | |
| 67 <td>Public method to get the entered data.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ImageMarkupDialog.on_altTextEdit_textChanged">on_altTextEdit_textChanged</a></td> | |
| 71 <td>Private slot handling changes of the alternative text.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ImageMarkupDialog.on_aspectRatioCheckBox_toggled">on_aspectRatioCheckBox_toggled</a></td> | |
| 75 <td>Private slot to adjust the height to match the original aspect ratio.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ImageMarkupDialog.on_heightSpinBox_valueChanged">on_heightSpinBox_valueChanged</a></td> | |
| 79 <td>Private slot to adjust the width spin box.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ImageMarkupDialog.on_imagePicker_textChanged">on_imagePicker_textChanged</a></td> | |
| 83 <td>Private slot handling changes of the image path.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ImageMarkupDialog.on_sizeCheckBox_toggled">on_sizeCheckBox_toggled</a></td> | |
| 87 <td>Private slot to reset the width and height spin boxes.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#ImageMarkupDialog.on_widthSpinBox_valueChanged">on_widthSpinBox_valueChanged</a></td> | |
| 91 <td>Private slot to adjust the height spin box.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="ImageMarkupDialog.__init__" ID="ImageMarkupDialog.__init__"></a> | |
| 101 <h4>ImageMarkupDialog (Constructor)</h4> | |
| 102 <b>ImageMarkupDialog</b>(<i>mode, parent=None</i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>mode</i> (int)</dt> | |
| 110 <dd> | |
| 111 mode of the dialog | |
| 112 </dd> | |
| 113 <dt><i>parent</i> (QWidget)</dt> | |
| 114 <dd> | |
| 115 reference to the parent widget | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <a NAME="ImageMarkupDialog.__updateOkButton" ID="ImageMarkupDialog.__updateOkButton"></a> | |
| 119 <h4>ImageMarkupDialog.__updateOkButton</h4> | |
| 120 <b>__updateOkButton</b>(<i></i>) | |
| 121 | |
| 122 <p> | |
| 123 Private slot to set the state of the OK button. | |
| 124 </p> | |
| 125 <a NAME="ImageMarkupDialog.getData" ID="ImageMarkupDialog.getData"></a> | |
| 126 <h4>ImageMarkupDialog.getData</h4> | |
| 127 <b>getData</b>(<i></i>) | |
| 128 | |
| 129 <p> | |
| 130 Public method to get the entered data. | |
| 131 </p> | |
| 132 <dl> | |
| 133 <dt>Return:</dt> | |
| 134 <dd> | |
| 135 tuple containing the image address, alternative text, | |
| 136 title text, flag to keep the original size, width and height | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <dl> | |
| 140 <dt>Return Type:</dt> | |
| 141 <dd> | |
| 142 tuple of (str, str, str, bool, int, int) | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="ImageMarkupDialog.on_altTextEdit_textChanged" ID="ImageMarkupDialog.on_altTextEdit_textChanged"></a> | |
| 146 <h4>ImageMarkupDialog.on_altTextEdit_textChanged</h4> | |
| 147 <b>on_altTextEdit_textChanged</b>(<i>txt</i>) | |
| 148 | |
| 149 <p> | |
| 150 Private slot handling changes of the alternative text. | |
| 151 </p> | |
| 152 <dl> | |
| 153 | |
| 154 <dt><i>txt</i> (str)</dt> | |
| 155 <dd> | |
| 156 alternative text | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <a NAME="ImageMarkupDialog.on_aspectRatioCheckBox_toggled" ID="ImageMarkupDialog.on_aspectRatioCheckBox_toggled"></a> | |
| 160 <h4>ImageMarkupDialog.on_aspectRatioCheckBox_toggled</h4> | |
| 161 <b>on_aspectRatioCheckBox_toggled</b>(<i>checked</i>) | |
| 162 | |
| 163 <p> | |
| 164 Private slot to adjust the height to match the original aspect ratio. | |
| 165 </p> | |
| 166 <dl> | |
| 167 | |
| 168 <dt><i>checked</i> (bool)</dt> | |
| 169 <dd> | |
| 170 flag indicating the state of the check box | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="ImageMarkupDialog.on_heightSpinBox_valueChanged" ID="ImageMarkupDialog.on_heightSpinBox_valueChanged"></a> | |
| 174 <h4>ImageMarkupDialog.on_heightSpinBox_valueChanged</h4> | |
| 175 <b>on_heightSpinBox_valueChanged</b>(<i>height</i>) | |
| 176 | |
| 177 <p> | |
| 178 Private slot to adjust the width spin box. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>height</i> (int)</dt> | |
| 183 <dd> | |
| 184 height for the image | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <a NAME="ImageMarkupDialog.on_imagePicker_textChanged" ID="ImageMarkupDialog.on_imagePicker_textChanged"></a> | |
| 188 <h4>ImageMarkupDialog.on_imagePicker_textChanged</h4> | |
| 189 <b>on_imagePicker_textChanged</b>(<i>address</i>) | |
| 190 | |
| 191 <p> | |
| 192 Private slot handling changes of the image path. | |
| 193 </p> | |
| 194 <dl> | |
| 195 | |
| 196 <dt><i>address</i> (str)</dt> | |
| 197 <dd> | |
| 198 image address (URL or local path) | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <a NAME="ImageMarkupDialog.on_sizeCheckBox_toggled" ID="ImageMarkupDialog.on_sizeCheckBox_toggled"></a> | |
| 202 <h4>ImageMarkupDialog.on_sizeCheckBox_toggled</h4> | |
| 203 <b>on_sizeCheckBox_toggled</b>(<i>checked</i>) | |
| 204 | |
| 205 <p> | |
| 206 Private slot to reset the width and height spin boxes. | |
| 207 </p> | |
| 208 <dl> | |
| 209 | |
| 210 <dt><i>checked</i> (bool)</dt> | |
| 211 <dd> | |
| 212 flag indicating the state of the check box | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <a NAME="ImageMarkupDialog.on_widthSpinBox_valueChanged" ID="ImageMarkupDialog.on_widthSpinBox_valueChanged"></a> | |
| 216 <h4>ImageMarkupDialog.on_widthSpinBox_valueChanged</h4> | |
| 217 <b>on_widthSpinBox_valueChanged</b>(<i>width</i>) | |
| 218 | |
| 219 <p> | |
| 220 Private slot to adjust the height spin box. | |
| 221 </p> | |
| 222 <dl> | |
| 223 | |
| 224 <dt><i>width</i> (int)</dt> | |
| 225 <dd> | |
| 226 width for the image | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <div align="right"><a href="#top">Up</a></div> | |
| 230 <hr /> | |
| 231 </body></html> |
