eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksImportDialog.html

Wed, 05 Jan 2022 17:28:05 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 05 Jan 2022 17:28:05 +0100
branch
eric7
changeset 8905
986278234c8a
permissions
-rw-r--r--

Updated source documentation.

<!DOCTYPE html>
<html><head>
<title>eric7.HelpViewer.HelpBookmarksImportDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpBookmarksImportDialog</h1>

<p>
Module implementing a dialog to enter the bookmarks import parameters.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#HelpBookmarksImportDialog">HelpBookmarksImportDialog</a></td>
<td>Class implementing a dialog to enter the bookmarks import parameters.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="HelpBookmarksImportDialog" ID="HelpBookmarksImportDialog"></a>
<h2>HelpBookmarksImportDialog</h2>

<p>
    Class implementing a dialog to enter the bookmarks import parameters.
</p>
<h3>Derived from</h3>
QDialog, Ui_HelpBookmarksImportDialog
<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="#HelpBookmarksImportDialog.__init__">HelpBookmarksImportDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HelpBookmarksImportDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private method to update the state of the OK button.</td>
</tr>
<tr>
<td><a href="#HelpBookmarksImportDialog.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="HelpBookmarksImportDialog.__init__" ID="HelpBookmarksImportDialog.__init__"></a>
<h4>HelpBookmarksImportDialog (Constructor)</h4>
<b>HelpBookmarksImportDialog</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="HelpBookmarksImportDialog.__updateOkButton" ID="HelpBookmarksImportDialog.__updateOkButton"></a>
<h4>HelpBookmarksImportDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)

<p>
        Private method to update the state of the OK button.
</p>
<a NAME="HelpBookmarksImportDialog.getData" ID="HelpBookmarksImportDialog.getData"></a>
<h4>HelpBookmarksImportDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to retrieve the entered data.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple containing a flag indicating to replace the existing
            bookmarks and the path of the bookmarks file to be imported
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial