tip/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog</h1>
<p>
Module implementing a dialog to enter data to insert a hyperlink.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HyperlinkMarkupDialog">HyperlinkMarkupDialog</a></td>
<td>Class implementing a dialog to enter data to insert a hyperlink.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="HyperlinkMarkupDialog" ID="HyperlinkMarkupDialog"></a>
<h2>HyperlinkMarkupDialog</h2>
<p>
    Class implementing a dialog to enter data to insert a hyperlink.
</p>

<h3>Derived from</h3>
QDialog, Ui_HyperlinkMarkupDialog
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#HyperlinkMarkupDialog.__init__">HyperlinkMarkupDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HyperlinkMarkupDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private method to update the state of the OK button.</td>
</tr>
<tr>
<td><a href="#HyperlinkMarkupDialog.getData">getData</a></td>
<td>Public method to get the entered data.</td>
</tr>
<tr>
<td><a href="#HyperlinkMarkupDialog.on_targetEdit_textChanged">on_targetEdit_textChanged</a></td>
<td>Private slot handling a change of the link target.</td>
</tr>
<tr>
<td><a href="#HyperlinkMarkupDialog.on_textEdit_textChanged">on_textEdit_textChanged</a></td>
<td>Private slot handling a change of the link text.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HyperlinkMarkupDialog.__init__" ID="HyperlinkMarkupDialog.__init__"></a>
<h4>HyperlinkMarkupDialog (Constructor)</h4>
<b>HyperlinkMarkupDialog</b>(<i>textMayBeEmpty, targetMayBeEmpty, noTitle=False, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>textMayBeEmpty</i> (bool)</dt>
<dd>
flag indicating, that the link text may
            be empty
</dd>
<dt><i>targetMayBeEmpty</i> (bool)</dt>
<dd>
flag indicating, that the link target may
            be empty
</dd>
<dt><i>noTitle</i> (bool)</dt>
<dd>
flag indicating, that no title is supported
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HyperlinkMarkupDialog.__updateOkButton" ID="HyperlinkMarkupDialog.__updateOkButton"></a>
<h4>HyperlinkMarkupDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)
<p>
        Private method to update the state of the OK button.
</p>

<a NAME="HyperlinkMarkupDialog.getData" ID="HyperlinkMarkupDialog.getData"></a>
<h4>HyperlinkMarkupDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the link text, link target and the optional
            link title
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str)
</dd>
</dl>
<a NAME="HyperlinkMarkupDialog.on_targetEdit_textChanged" ID="HyperlinkMarkupDialog.on_targetEdit_textChanged"></a>
<h4>HyperlinkMarkupDialog.on_targetEdit_textChanged</h4>
<b>on_targetEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot handling a change of the link target.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
link target (unused)
</dd>
</dl>
<a NAME="HyperlinkMarkupDialog.on_textEdit_textChanged" ID="HyperlinkMarkupDialog.on_textEdit_textChanged"></a>
<h4>HyperlinkMarkupDialog.on_textEdit_textChanged</h4>
<b>on_textEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot handling a change of the link text.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
link text (unused)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>