Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksDialog.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.Bookmarks.BookmarksDialog</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Helpviewer.Bookmarks.BookmarksDialog</h1>
<p>
Module implementing a dialog to manage bookmarks.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#BookmarksDialog">BookmarksDialog</a></td>
<td>Class implementing a dialog to manage bookmarks.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="BookmarksDialog" ID="BookmarksDialog"></a>
<h2>BookmarksDialog</h2>
<p>
    Class implementing a dialog to manage bookmarks.
</p><h4>Signals</h4>
<dl>
<dt>newUrl(const QUrl&, const QString&)</dt>
<dd>
emitted to open a URL in a new tab
</dd><dt>openUrl(const QUrl&, const QString&)</dt>
<dd>
emitted to open a URL in the current
            tab
</dd>
</dl>
<h3>Derived from</h3>
QDialog, Ui_BookmarksDialog
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#BookmarksDialog.__init__">BookmarksDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#BookmarksDialog.__activated">__activated</a></td>
<td>Private slot to handle the activation of an entry.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__customContextMenuRequested">__customContextMenuRequested</a></td>
<td>Private slot to handle the context menu request for the bookmarks tree.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__editAddress">__editAddress</a></td>
<td>Private slot to edit the address part of a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__editName">__editName</a></td>
<td>Private slot to edit the name part of a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__expandNodes">__expandNodes</a></td>
<td>Private method to expand all child nodes of a node.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__newFolder">__newFolder</a></td>
<td>Private slot to add a new bookmarks folder.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__openBookmark">__openBookmark</a></td>
<td>Private method to open a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__openBookmarkInCurrentTab">__openBookmarkInCurrentTab</a></td>
<td>Private slot to open a bookmark in the current browser tab.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td>
<td>Private slot to open a bookmark in a new browser tab.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__saveExpandedNodes">__saveExpandedNodes</a></td>
<td>Private method to save the child nodes of an expanded node.</td>
</tr><tr>
<td><a href="#BookmarksDialog.__shutdown">__shutdown</a></td>
<td>Private method to perform shutdown actions for the dialog.</td>
</tr><tr>
<td><a href="#BookmarksDialog.closeEvent">closeEvent</a></td>
<td>Protected method to handle the closing of the dialog.</td>
</tr><tr>
<td><a href="#BookmarksDialog.reject">reject</a></td>
<td>Protected method called when the dialog is rejected.</td>
</tr>
</table>
<a NAME="BookmarksDialog.__init__" ID="BookmarksDialog.__init__"></a>
<h4>BookmarksDialog (Constructor)</h4>
<b>BookmarksDialog</b>(<i>parent = None, manager = None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget
</dd><dt><i>manager</i></dt>
<dd>
reference to the bookmarks manager object (BookmarksManager)
</dd>
</dl><a NAME="BookmarksDialog.__activated" ID="BookmarksDialog.__activated"></a>
<h4>BookmarksDialog.__activated</h4>
<b>__activated</b>(<i>idx</i>)
<p>
        Private slot to handle the activation of an entry.
</p><dl>
<dt><i>idx</i></dt>
<dd>
reference to the entry index (QModelIndex)
</dd>
</dl><a NAME="BookmarksDialog.__customContextMenuRequested" ID="BookmarksDialog.__customContextMenuRequested"></a>
<h4>BookmarksDialog.__customContextMenuRequested</h4>
<b>__customContextMenuRequested</b>(<i>pos</i>)
<p>
        Private slot to handle the context menu request for the bookmarks tree.
</p><dl>
<dt><i>pos</i></dt>
<dd>
position the context menu was requested (QPoint)
</dd>
</dl><a NAME="BookmarksDialog.__editAddress" ID="BookmarksDialog.__editAddress"></a>
<h4>BookmarksDialog.__editAddress</h4>
<b>__editAddress</b>(<i></i>)
<p>
        Private slot to edit the address part of a bookmark.
</p><a NAME="BookmarksDialog.__editName" ID="BookmarksDialog.__editName"></a>
<h4>BookmarksDialog.__editName</h4>
<b>__editName</b>(<i></i>)
<p>
        Private slot to edit the name part of a bookmark.
</p><a NAME="BookmarksDialog.__expandNodes" ID="BookmarksDialog.__expandNodes"></a>
<h4>BookmarksDialog.__expandNodes</h4>
<b>__expandNodes</b>(<i>node</i>)
<p>
        Private method to expand all child nodes of a node.
</p><dl>
<dt><i>node</i></dt>
<dd>
reference to the bookmark node to expand (BookmarkNode)
</dd>
</dl><a NAME="BookmarksDialog.__newFolder" ID="BookmarksDialog.__newFolder"></a>
<h4>BookmarksDialog.__newFolder</h4>
<b>__newFolder</b>(<i></i>)
<p>
        Private slot to add a new bookmarks folder.
</p><a NAME="BookmarksDialog.__openBookmark" ID="BookmarksDialog.__openBookmark"></a>
<h4>BookmarksDialog.__openBookmark</h4>
<b>__openBookmark</b>(<i>newTab</i>)
<p>
        Private method to open a bookmark.
</p><dl>
<dt><i>newTab</i></dt>
<dd>
flag indicating to open the bookmark in a new tab (boolean)
</dd>
</dl><a NAME="BookmarksDialog.__openBookmarkInCurrentTab" ID="BookmarksDialog.__openBookmarkInCurrentTab"></a>
<h4>BookmarksDialog.__openBookmarkInCurrentTab</h4>
<b>__openBookmarkInCurrentTab</b>(<i></i>)
<p>
        Private slot to open a bookmark in the current browser tab.
</p><a NAME="BookmarksDialog.__openBookmarkInNewTab" ID="BookmarksDialog.__openBookmarkInNewTab"></a>
<h4>BookmarksDialog.__openBookmarkInNewTab</h4>
<b>__openBookmarkInNewTab</b>(<i></i>)
<p>
        Private slot to open a bookmark in a new browser tab.
</p><a NAME="BookmarksDialog.__saveExpandedNodes" ID="BookmarksDialog.__saveExpandedNodes"></a>
<h4>BookmarksDialog.__saveExpandedNodes</h4>
<b>__saveExpandedNodes</b>(<i>parent</i>)
<p>
        Private method to save the child nodes of an expanded node.
</p><dl>
<dt><i>parent</i></dt>
<dd>
index of the parent node (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating a change (boolean)
</dd>
</dl><a NAME="BookmarksDialog.__shutdown" ID="BookmarksDialog.__shutdown"></a>
<h4>BookmarksDialog.__shutdown</h4>
<b>__shutdown</b>(<i></i>)
<p>
        Private method to perform shutdown actions for the dialog.
</p><a NAME="BookmarksDialog.closeEvent" ID="BookmarksDialog.closeEvent"></a>
<h4>BookmarksDialog.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
<p>
        Protected method to handle the closing of the dialog.
</p><dl>
<dt><i>evt</i></dt>
<dd>
reference to the event object (QCloseEvent) (ignored)
</dd>
</dl><a NAME="BookmarksDialog.reject" ID="BookmarksDialog.reject"></a>
<h4>BookmarksDialog.reject</h4>
<b>reject</b>(<i></i>)
<p>
        Protected method called when the dialog is rejected.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>