src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarksImportDialog.html

Tue, 23 Apr 2024 11:26:04 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 23 Apr 2024 11:26:04 +0200
branch
eric7
changeset 10692
9becf9ca115c
parent 10479
856476537696
permissions
-rw-r--r--

Changed the source code and the source code documentation to improve the indication of unused method/function arguments.

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.Bookmarks.BookmarksImportDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.Bookmarks.BookmarksImportDialog</h1>
<p>
Module implementing a dialog for importing bookmarks from other sources.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#BookmarksImportDialog">BookmarksImportDialog</a></td>
<td>Class implementing a dialog for importing bookmarks from other sources.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="BookmarksImportDialog" ID="BookmarksImportDialog"></a>
<h2>BookmarksImportDialog</h2>
<p>
    Class implementing a dialog for importing bookmarks from other sources.
</p>

<h3>Derived from</h3>
QDialog, Ui_BookmarksImportDialog
<h3>Class Attributes</h3>
<table>
<tr><td>SourcesListIdRole</td></tr>
</table>

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

<h3>Methods</h3>
<table>
<tr>
<td><a href="#BookmarksImportDialog.__init__">BookmarksImportDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.__enableNextButton">__enableNextButton</a></td>
<td>Private slot to set the enabled state of the next button.</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.getImportedBookmarks">getImportedBookmarks</a></td>
<td>Public method to get the imported bookmarks.</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.on_cancelButton_clicked">on_cancelButton_clicked</a></td>
<td>Private slot documentation goes here.</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.on_filePicker_textChanged">on_filePicker_textChanged</a></td>
<td>Private slot handling changes of the file to import bookmarks form.</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.on_nextButton_clicked">on_nextButton_clicked</a></td>
<td>Private slot to switch to the next page.</td>
</tr>
<tr>
<td><a href="#BookmarksImportDialog.on_sourcesList_itemSelectionChanged">on_sourcesList_itemSelectionChanged</a></td>
<td>Private slot to handle changes of the selection of the import source.</td>
</tr>
</table>

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


<a NAME="BookmarksImportDialog.__init__" ID="BookmarksImportDialog.__init__"></a>
<h4>BookmarksImportDialog (Constructor)</h4>
<b>BookmarksImportDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="BookmarksImportDialog.__enableNextButton" ID="BookmarksImportDialog.__enableNextButton"></a>
<h4>BookmarksImportDialog.__enableNextButton</h4>
<b>__enableNextButton</b>(<i></i>)
<p>
        Private slot to set the enabled state of the next button.
</p>

<a NAME="BookmarksImportDialog.getImportedBookmarks" ID="BookmarksImportDialog.getImportedBookmarks"></a>
<h4>BookmarksImportDialog.getImportedBookmarks</h4>
<b>getImportedBookmarks</b>(<i></i>)
<p>
        Public method to get the imported bookmarks.
</p>

<dl>
<dt>Return:</dt>
<dd>
top level bookmark
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
BookmarkNode
</dd>
</dl>
<a NAME="BookmarksImportDialog.on_cancelButton_clicked" ID="BookmarksImportDialog.on_cancelButton_clicked"></a>
<h4>BookmarksImportDialog.on_cancelButton_clicked</h4>
<b>on_cancelButton_clicked</b>(<i></i>)
<p>
        Private slot documentation goes here.
</p>

<a NAME="BookmarksImportDialog.on_filePicker_textChanged" ID="BookmarksImportDialog.on_filePicker_textChanged"></a>
<h4>BookmarksImportDialog.on_filePicker_textChanged</h4>
<b>on_filePicker_textChanged</b>(<i>_txt</i>)
<p>
        Private slot handling changes of the file to import bookmarks form.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
text of the line edit (unused)
</dd>
</dl>
<a NAME="BookmarksImportDialog.on_nextButton_clicked" ID="BookmarksImportDialog.on_nextButton_clicked"></a>
<h4>BookmarksImportDialog.on_nextButton_clicked</h4>
<b>on_nextButton_clicked</b>(<i></i>)
<p>
        Private slot to switch to the next page.
</p>

<a NAME="BookmarksImportDialog.on_sourcesList_itemSelectionChanged" ID="BookmarksImportDialog.on_sourcesList_itemSelectionChanged"></a>
<h4>BookmarksImportDialog.on_sourcesList_itemSelectionChanged</h4>
<b>on_sourcesList_itemSelectionChanged</b>(<i></i>)
<p>
        Private slot to handle changes of the selection of the import source.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial