--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.QScintilla.MarkupProviders.HyperlinkMarkupDialog.html Tue Jan 10 19:41:15 2017 +0100 @@ -0,0 +1,145 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.QScintilla.MarkupProviders.HyperlinkMarkupDialog</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>eric6.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>Returns:</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 +</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 +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file