tip/src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarkPropertiesDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.HelpViewer.HelpBookmarkPropertiesDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpBookmarkPropertiesDialog</h1>
<p>
Module implementing a dialog to edit the bookmark properties.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HelpBookmarkPropertiesDialog">HelpBookmarkPropertiesDialog</a></td>
<td>Class implementing a dialog to edit the bookmark properties.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HelpBookmarkPropertiesDialog" ID="HelpBookmarkPropertiesDialog"></a>
<h2>HelpBookmarkPropertiesDialog</h2>
<p>
    Class implementing a dialog to edit the bookmark properties.
</p>

<h3>Derived from</h3>
QDialog, Ui_HelpBookmarkPropertiesDialog
<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="#HelpBookmarkPropertiesDialog.__init__">HelpBookmarkPropertiesDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HelpBookmarkPropertiesDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private method to set the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#HelpBookmarkPropertiesDialog.getData">getData</a></td>
<td>Public method to retrieve the entered data.</td>
</tr>
</table>

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


<a NAME="HelpBookmarkPropertiesDialog.__init__" ID="HelpBookmarkPropertiesDialog.__init__"></a>
<h4>HelpBookmarkPropertiesDialog (Constructor)</h4>
<b>HelpBookmarkPropertiesDialog</b>(<i>title="", url="", parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>title</i> (str (optional))</dt>
<dd>
title for the bookmark (defaults to "")
</dd>
<dt><i>url</i> (str (optional))</dt>
<dd>
URL for the bookmark (defaults to "")
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="HelpBookmarkPropertiesDialog.__updateOkButton" ID="HelpBookmarkPropertiesDialog.__updateOkButton"></a>
<h4>HelpBookmarkPropertiesDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)
<p>
        Private method to set the enabled state of the OK button.
</p>

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

<dl>
<dt>Return:</dt>
<dd>
tuple containing the title and URL for the bookmark
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>