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