--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.ImageMarkupDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,245 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.QScintilla.MarkupProviders.ImageMarkupDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.QScintilla.MarkupProviders.ImageMarkupDialog</h1> + +<p> +Module implementing a dialog to enter data for an image markup. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ImageMarkupDialog">ImageMarkupDialog</a></td> +<td>Class implementing a dialog to enter data for an image markup.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ImageMarkupDialog" ID="ImageMarkupDialog"></a> +<h2>ImageMarkupDialog</h2> + +<p> + Class implementing a dialog to enter data for an image markup. +</p> +<h3>Derived from</h3> +QDialog, Ui_ImageMarkupDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>HtmlMode</td></tr><tr><td>MarkDownMode</td></tr><tr><td>RestMode</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ImageMarkupDialog.__init__">ImageMarkupDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private slot to set the state of the OK button.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_altTextEdit_textChanged">on_altTextEdit_textChanged</a></td> +<td>Private slot handling changes of the alternative text.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_aspectRatioCheckBox_toggled">on_aspectRatioCheckBox_toggled</a></td> +<td>Private slot to adjust the height to match the original aspect ratio.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_heightSpinBox_valueChanged">on_heightSpinBox_valueChanged</a></td> +<td>Private slot to adjust the width spin box.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_imagePicker_textChanged">on_imagePicker_textChanged</a></td> +<td>Private slot handling changes of the image path.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_sizeCheckBox_toggled">on_sizeCheckBox_toggled</a></td> +<td>Private slot to reset the width and height spin boxes.</td> +</tr> +<tr> +<td><a href="#ImageMarkupDialog.on_widthSpinBox_valueChanged">on_widthSpinBox_valueChanged</a></td> +<td>Private slot to adjust the height spin box.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ImageMarkupDialog.__init__" ID="ImageMarkupDialog.__init__"></a> +<h4>ImageMarkupDialog (Constructor)</h4> +<b>ImageMarkupDialog</b>(<i>mode, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>mode</i> (int)</dt> +<dd> +mode of the dialog +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="ImageMarkupDialog.__updateOkButton" ID="ImageMarkupDialog.__updateOkButton"></a> +<h4>ImageMarkupDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) + +<p> + Private slot to set the state of the OK button. +</p> +<a NAME="ImageMarkupDialog.getData" ID="ImageMarkupDialog.getData"></a> +<h4>ImageMarkupDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to get the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the image address, alternative text, + title text, flag to keep the original size, width and height +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, bool, int, int) +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_altTextEdit_textChanged" ID="ImageMarkupDialog.on_altTextEdit_textChanged"></a> +<h4>ImageMarkupDialog.on_altTextEdit_textChanged</h4> +<b>on_altTextEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot handling changes of the alternative text. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +alternative text +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_aspectRatioCheckBox_toggled" ID="ImageMarkupDialog.on_aspectRatioCheckBox_toggled"></a> +<h4>ImageMarkupDialog.on_aspectRatioCheckBox_toggled</h4> +<b>on_aspectRatioCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot to adjust the height to match the original aspect ratio. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +flag indicating the state of the check box +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_heightSpinBox_valueChanged" ID="ImageMarkupDialog.on_heightSpinBox_valueChanged"></a> +<h4>ImageMarkupDialog.on_heightSpinBox_valueChanged</h4> +<b>on_heightSpinBox_valueChanged</b>(<i>height</i>) + +<p> + Private slot to adjust the width spin box. +</p> +<dl> + +<dt><i>height</i> (int)</dt> +<dd> +height for the image +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_imagePicker_textChanged" ID="ImageMarkupDialog.on_imagePicker_textChanged"></a> +<h4>ImageMarkupDialog.on_imagePicker_textChanged</h4> +<b>on_imagePicker_textChanged</b>(<i>address</i>) + +<p> + Private slot handling changes of the image path. +</p> +<dl> + +<dt><i>address</i> (str)</dt> +<dd> +image address (URL or local path) +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_sizeCheckBox_toggled" ID="ImageMarkupDialog.on_sizeCheckBox_toggled"></a> +<h4>ImageMarkupDialog.on_sizeCheckBox_toggled</h4> +<b>on_sizeCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot to reset the width and height spin boxes. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +flag indicating the state of the check box +</dd> +</dl> +<a NAME="ImageMarkupDialog.on_widthSpinBox_valueChanged" ID="ImageMarkupDialog.on_widthSpinBox_valueChanged"></a> +<h4>ImageMarkupDialog.on_widthSpinBox_valueChanged</h4> +<b>on_widthSpinBox_valueChanged</b>(<i>width</i>) + +<p> + Private slot to adjust the height spin box. +</p> +<dl> + +<dt><i>width</i> (int)</dt> +<dd> +width for the image +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file